Skip to content

Commit 51c20aa

Browse files
committed
Add README section for API contract.
1 parent c50a759 commit 51c20aa

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
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
@@ -77,7 +81,8 @@ VSS is also integrated with [LDK-node] v0.4.x as alpha support.
7781
* **Scaling**: VSS itself is stateless and can be horizontally scaled easily. VSS can be configured to point to a
7882
PostgreSQL cluster, and further scaling considerations need to be addressed in the PostgreSQL cluster.
7983
* **Using with LDK-node**: [LDK-node] can be easily configured to run with VSS as primary storage. It is integrated in
80-
LDK-node (written in Rust) using [VSS-rust-client], and there is also support for other languages such as Swift, Kotlin,
84+
LDK-node (written in Rust) using [VSS-rust-client], and there is also support for other languages such as Swift,
85+
Kotlin,
8186
and Python through [UniFFI] bindings.
8287
```rust
8388
use ldk_node::Builder;
@@ -107,6 +112,8 @@ If you encounter any issues or have questions, feel free to open an issue on
107112
the [GitHub repository](https://github.com/lightningdevkit/vss-server/issues). For further assistance or to discuss the
108113
development of VSS, you can reach out to us in the [LDK Discord] in the `#vss` channel.
109114

115+
[VSS API contract]: https://github.com/lightningdevkit/vss-server/blob/main/proto/vss.proto
116+
110117
[VSS-rust-client]: https://github.com/lightningdevkit/vss-rust-client
111118

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

0 commit comments

Comments
 (0)