From ed9ac2c67bf433167ab74b67215ac6be1f16800f Mon Sep 17 00:00:00 2001 From: Ivan Reshetnikov Date: Tue, 14 Feb 2023 08:28:40 +0100 Subject: [PATCH 1/4] docs: basic readme --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 298bc5f..e8837af 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -# WalletConnectRust -WalletConnect Rust Client +# WalletConnect Rust SDK + +This is the foundation for the WalletConnect Rust SDK. Currently, there's only the core client and the RPC types required to communicate with the Relay. + +See the [basic example](examples/basic_client.rs). + +## `relay_client` + +The core Relay client. Provides access to all available Relay RPC methods to build on top of. + +## `relay_rpc` + +Provides all of the Relay domain types (e.g. `ClientId`, `ProjectId` etc.) as well as auth token generation and validation functionality. + +# License + +[Apache License (Version 2.0)](LICENSE) From bfc1de08abf03e2375dfd35319a3e03e6b2fdcb9 Mon Sep 17 00:00:00 2001 From: Ivan Reshetnikov Date: Tue, 14 Feb 2023 08:29:24 +0100 Subject: [PATCH 2/4] ci: release workflow now requires tests --- .github/workflows/ci.yaml | 7 ------- .github/workflows/release.yaml | 15 +++++---------- 2 files changed, 5 insertions(+), 17 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index ee19ed5..a345472 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -7,13 +7,6 @@ on: - "docs/**" - "README.md" - push: - branches: ["main"] - paths-ignore: - - ".github/**" - - "docs/**" - - "README.md" - workflow_dispatch: concurrency: diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 1fc103c..0db8d32 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -11,23 +11,18 @@ on: workflow_dispatch: jobs: + run-tests: + uses: ./.github/workflows/ci.yaml + secrets: inherit + release: + needs: [run-tests] runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 with: fetch-depth: 0 - - name: "Install Rust toolchain (stable)" - uses: actions-rs/toolchain@v1 - with: - toolchain: stable - profile: minimal - default: true - - - name: Cache cargo registry - uses: Swatinem/rust-cache@v2 - - name: "Cocogitto release" id: release uses: cocogitto/cocogitto-action@v3 From 493330cb452787c474cadc8c040b3e8f85e1b5be Mon Sep 17 00:00:00 2001 From: Ivan Reshetnikov Date: Tue, 14 Feb 2023 08:36:22 +0100 Subject: [PATCH 3/4] ci: add spellcheck --- .github/workflows/ci.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index a345472..6f8f2d6 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -66,3 +66,15 @@ jobs: with: command: ${{ matrix.cargo.cmd }} args: ${{ matrix.cargo.args }} + + misspell: + name: spellcheck + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + + - name: misspell + uses: reviewdog/action-misspell@v1 + with: + github_token: ${{ secrets.github_token }} + locale: "US" From 54b15dd029322fb9ddfa98a4aec7ffb09b7bd1ec Mon Sep 17 00:00:00 2001 From: Ivan Reshetnikov Date: Tue, 14 Feb 2023 08:39:02 +0100 Subject: [PATCH 4/4] chore: update ci step name --- .github/workflows/ci.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 6f8f2d6..ab21328 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -68,7 +68,7 @@ jobs: args: ${{ matrix.cargo.args }} misspell: - name: spellcheck + name: Spellcheck runs-on: ubuntu-latest steps: - uses: actions/checkout@v3