Skip to content

Commit f6830d9

Browse files
committedOct 25, 2024··
Add README section for API contract.
1 parent 1ffb0fa commit f6830d9

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed
 

‎README.md

+6
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ VSS execution is split into two phases: Phase I prioritizes recovery and single-
5656
multi-device use. Phase I is ready to use and integrated within [LDK-node]. Phase II will be subject to monitoring for
5757
demand from wallets and may slip to a later date. Refer to [LDK-Roadmap] for more details.
5858

59+
### API
60+
61+
See the [VSS API contract] for details.
62+
5963
### Implementation
6064

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

114+
[VSS API contract]: https://github.com/lightningdevkit/vss-server/blob/main/proto/vss.proto
115+
110116
[VSS-rust-client]: https://github.com/lightningdevkit/vss-rust-client
111117

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

0 commit comments

Comments
 (0)
Please sign in to comment.