Skip to content

Commit 9a47cc9

Browse files
committed
Move the rust implementation of vss-server to root
There is now only one implementation in this repository, so we move it to the root of the repository.
1 parent cc8391e commit 9a47cc9

38 files changed

Lines changed: 13 additions & 32 deletions

.github/workflows/implementation-tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,5 +43,5 @@ jobs:
4343
4444
- name: Run postgres backend test suite
4545
run: |
46-
cd vss-server/rust/impls
46+
cd vss-server/impls
4747
cargo test -- --test-threads=1

.github/workflows/ldk-node-integration-tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848
4949
- name: Build and Deploy VSS Server
5050
run: |
51-
cd vss-server/rust
51+
cd vss-server
5252
RUSTFLAGS="--cfg noop_authorizer" cargo build --no-default-features
5353
./target/debug/vss-server server/vss-server-config.toml&
5454
- name: Pin packages to allow for MSRV

.github/workflows/ping-tests.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,9 @@ jobs:
3939
rustup toolchain install ${{ matrix.toolchain }} --profile minimal --component rustfmt
4040
rustup default ${{ matrix.toolchain }}
4141
- name: Check formatting
42-
run: cd rust && cargo fmt --all -- --check
42+
run: cargo fmt --all -- --check
4343
- name: Build and Deploy VSS Server
4444
run: |
45-
cd rust
4645
RUSTFLAGS="--cfg noop_authorizer" cargo build --no-default-features
4746
./target/debug/vss-server server/vss-server-config.toml&
4847

.github/workflows/server-tests.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,12 @@ jobs:
4040
rustup default ${{ matrix.toolchain }}
4141
- name: Build and Deploy VSS Server
4242
run: |
43-
cd rust
4443
RUSTFLAGS="--cfg noop_authorizer" cargo build --no-default-features
4544
./target/debug/vss-server server/vss-server-config.toml&
4645
- name: Run the server tests
4746
run: |
4847
sleep 5
49-
cd rust/server
48+
cd server
5049
RUSTFLAGS="--cfg vss_client_v050_compatibility" cargo test
5150
cargo update -p vss-client-ng@0.6.0 --verbose
5251
RUSTFLAGS="--cfg vss_client_main_compatibility" cargo test

.gitignore

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1 @@
1-
.protoc-version
2-
.idea/*
3-
*.ipr
4-
*.iws
5-
.settings/*
6-
.project
7-
.gradle/*
8-
gradle/*
9-
gradlew*
10-
build/*
11-
app/build/*
12-
app/bin/*
13-
app/.classpath
14-
app/.project
15-
app/.settings
16-
1+
/target
File renamed without changes.
File renamed without changes.

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,14 @@ See the [VSS API contract] for details.
6464
### Implementation
6565

6666
VSS has a Rust-based implementation and is ready to use.
67-
[VSS-rust-client] is a Rust-based client with support for client-side encryption, key obfuscation, retry mechanisms, and
67+
[VSS-client] is a Rust-based client with support for client-side encryption, key obfuscation, retry mechanisms, and
6868
LNURL-auth.
6969
VSS is also integrated with [LDK-node] v0.4.x as alpha support.
7070

7171
### Development
7272

73-
* **Build & Deploy**: Refer to language-specific folder for instructions related to building and deploying VSS.
73+
* **Build & Deploy**: Refer to [docs/getting-started.md](docs/getting-started.md) for instructions related to
74+
building and deploying VSS.
7475
* **Hosting**: VSS can either be self-hosted or deployed in the cloud. If a service provider is hosting VSS for multiple
7576
users, it must be configured with **HTTPS**, **Authentication/Authorization**, and **rate-limiting**.
7677
* **Authentication and Authorization**: VSS supports authentication via
@@ -80,7 +81,7 @@ VSS is also integrated with [LDK-node] v0.4.x as alpha support.
8081
* **Scaling**: VSS itself is stateless and can be horizontally scaled easily. VSS can be configured to point to a
8182
PostgreSQL cluster, and further scaling considerations need to be addressed in the PostgreSQL cluster.
8283
* **Using with LDK-node**: [LDK-node] can be easily configured to run with VSS as primary storage. It is integrated in
83-
LDK-node (written in Rust) using [VSS-rust-client], and there is also support for other languages such as Swift,
84+
LDK-node (written in Rust) using [VSS-client], and there is also support for other languages such as Swift,
8485
Kotlin and Python through [UniFFI] bindings.
8586
```rust
8687
use ldk_node::Builder;
@@ -93,7 +94,7 @@ VSS is also integrated with [LDK-node] v0.4.x as alpha support.
9394
}
9495
```
9596
* **Using with Other Applications**: VSS is designed to store application-related metadata. Clients can use
96-
the [VSS-rust-client] directly for this purpose. This can help provide a complete user data recovery solution for
97+
the [VSS-client] directly for this purpose. This can help provide a complete user data recovery solution for
9798
applications, as well as enable turn-key multi-device support in the future.
9899

99100
### Authentication
@@ -126,7 +127,7 @@ development of VSS, you can reach out to us in the [LDK Discord] in the `#vss` c
126127

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

129-
[VSS-rust-client]: https://github.com/lightningdevkit/vss-rust-client
130+
[VSS-client]: https://github.com/lightningdevkit/vss-client
130131

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

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)