Skip to content

Commit

Permalink
Add README section for API contract.
Browse files Browse the repository at this point in the history
  • Loading branch information
G8XSU committed Oct 25, 2024
1 parent 1ffb0fa commit f6830d9
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ VSS execution is split into two phases: Phase I prioritizes recovery and single-
multi-device use. Phase I is ready to use and integrated within [LDK-node]. Phase II will be subject to monitoring for
demand from wallets and may slip to a later date. Refer to [LDK-Roadmap] for more details.

### API

See the [VSS API contract] for details.

### Implementation

Currently, VSS-server has a Java-based implementation and is ready to use. Support for a Rust-based VSS-server is a work
Expand Down Expand Up @@ -107,6 +111,8 @@ If you encounter any issues or have questions, feel free to open an issue on
the [GitHub repository](https://github.com/lightningdevkit/vss-server/issues). For further assistance or to discuss the
development of VSS, you can reach out to us in the [LDK Discord] in the `#vss` channel.

[VSS API contract]: https://github.com/lightningdevkit/vss-server/blob/main/proto/vss.proto

[VSS-rust-client]: https://github.com/lightningdevkit/vss-rust-client

[LDK-node]: https://github.com/lightningdevkit/ldk-node
Expand Down

0 comments on commit f6830d9

Please sign in to comment.