Skip to content

Commit 4a5fd28

Browse files
committed
Update README section for Implementation details.
1 parent cfb7297 commit 4a5fd28

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,29 @@ 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+
### Implementation
60+
61+
Currently, VSS-server has a Java-based implementation and is ready to use. Support for a Rust-based VSS-server is a work
62+
in progress.
63+
[VSS-rust-client] is a Rust-based client with support for client-side encryption, key obfuscation, retry mechanisms, and
64+
LNURL-auth.
65+
VSS is also integrated with [LDK-node] v0.4.x as alpha support.
66+
5967
### Summary
6068

6169
In summary, VSS is an open-source project that offers a server-side cloud storage solution for non-custodial Lightning
6270
wallets. It provides multi-device access, recovery capabilities, and various features to ensure user privacy and data
6371
verifiability. By leveraging VSS, wallet developers can focus on building innovative Lightning wallets without the
6472
burden of implementing complex storage solutions from scratch.
6573

74+
### Support
75+
76+
If you encounter any issues or have questions, feel free to open an issue on
77+
the [GitHub repository](https://github.com/lightningdevkit/vss-server/issues). For further assistance or to discuss the
78+
development of VSS, you can reach out to us in the [LDK Discord] in the `#vss` channel.
79+
80+
[VSS-rust-client]: https://github.com/lightningdevkit/vss-rust-client
81+
6682
[LDK-node]: https://github.com/lightningdevkit/ldk-node
6783

6884
[LDK-Roadmap]: https://lightningdevkit.org/blog/ldk-roadmap/#vss

0 commit comments

Comments
 (0)