feat: initial commit

Author: heilhead

.github/workflows/ci.yaml

@@ -0,0 +1,73 @@
+name: ci
+
+on:
+  pull_request:
+    paths-ignore:
+      - ".github/**"
+      - "docs/**"
+      - "README.md"
+
+  push:
+    branches: ["main"]
+    paths-ignore:
+      - ".github/**"
+      - "docs/**"
+      - "README.md"
+
+concurrency:
+  # Support push/pr as event types with different behaviors each:
+  # 1. push: queue up builds
+  # 2. pr: only allow one run per PR
+  group: ${{ github.workflow }}-${{ github.event_name }}${{ github.event.pull_request.number }}
+  # If there is already a workflow running for the same pull request, cancel it
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+jobs:
+  tasks:
+    name: "${{ matrix.cargo.name }}"
+    runs-on:
+      group: ubuntu-runners
+    strategy:
+      fail-fast: false
+      matrix:
+        cargo:
+          - name: "Clippy"
+            cmd: clippy
+            args: --workspace --all-features --tests -- -D clippy::all -W clippy::style
+            rust: stable
+          - name: "Formatting"
+            cmd: fmt
+            args: --all -- --check
+            rust: nightly
+          - name: "Tests"
+            cmd: nextest
+            args: run --workspace --retries 3
+            rust: stable
+          - name: "Documentation Tests"
+            cmd: test
+            args: --workspace --doc
+            rust: stable
+    env:
+      RUST_BACKTRACE: full
+    steps:
+      - uses: actions/checkout@v3
+
+      # Install Rust toolchain
+      - name: "Install Rust ${{ matrix.cargo.rust }}"
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.cargo.rust }}
+          profile: default
+          override: true
+
+      - uses: Swatinem/rust-cache@v2
+
+      - uses: taiki-e/install-action@v1
+        with:
+          tool: nextest
+
+      - name: "Cargo ${{ matrix.cargo.name }}"
+        uses: actions-rs/cargo@v1
+        with:
+          command: ${{ matrix.cargo.cmd }}
+          args: ${{ matrix.cargo.args }}

.github/workflows/release.yaml

@@ -0,0 +1,47 @@
+name: "release"
+
+on:
+  push:
+    branches: ["main"]
+    paths-ignore:
+      - ".github/**"
+      - "docs/**"
+      - "README.md"
+
+jobs:
+  release:
+    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
+        with:
+          check: true
+          check-latest-tag-only: true
+          release: true
+          git-user: "github-actions"
+          git-user-email: "[email protected]"
+
+      - name: "Generate Changelog"
+        run: cog changelog --at ${{ steps.release.outputs.version }} -t full_hash > GITHUB_CHANGELOG.md
+
+      - name: "Update Github release notes"
+        uses: softprops/action-gh-release@v1
+        with:
+          body_path: GITHUB_CHANGELOG.md
+          tag_name: ${{ steps.release.outputs.version }}
+          token: ${{ secrets.RELEASE_TOKEN }}

Cargo.toml

@@ -0,0 +1,34 @@
+# Root Crate
+[package]
+name = "walletconnect_sdk"
+version = "0.1.0"
+edition = "2021"
+authors = ["WalletConnect Team"]
+license = "Apache-2.0"
+
+[workspace]
+members = [
+    "relay_client",
+    "relay_rpc"
+]
+
+[features]
+full = [
+    "client",
+    "rpc",
+]
+client = ["dep:relay_client"]
+rpc = ["dep:relay_rpc"]
+
+[dependencies]
+relay_client = { path = "./relay_client", optional = true }
+relay_rpc = { path = "./relay_rpc", optional = true }
+
+[dev-dependencies]
+anyhow = "1"
+structopt = { version = "0.3", default-features = false }
+tokio = { version = "1.22", features = ["full"] }
+
+[[example]]
+name = "basic_client"
+required-features = ["full"]

clippy.toml

@@ -0,0 +1,4 @@
+await-holding-invalid-types = [
+  "tracing::trace::Entered",
+  "tracing::trace::EnteredSpan",
+]

cog.toml

@@ -0,0 +1,19 @@
+pre_bump_hooks = [
+    "cargo check",
+]
+
+tag_prefix = "v"
+
+[commit_types]
+tests = { changelog_title = "Tests" }
+
+[changelog]
+path        = "CHANGELOG.md"
+template    = "remote"
+remote      = "github.com"
+owner       = "WalletConnect"
+repository  = "WalletConnectRust"
+
+authors = [
+    { signature = "Ivan Reshetnikov", username = "heilhead" }
+]

examples/basic_client.rs

@@ -0,0 +1,114 @@
+use {
+    relay_client::{
+        Client,
+        CloseFrame,
+        ConnectionHandler,
+        ConnectionOptions,
+        Error,
+        PublishedMessage,
+    },
+    relay_rpc::{
+        auth::{ed25519_dalek::Keypair, rand, AuthToken},
+        domain::{AuthSubject, Topic},
+    },
+    std::{sync::Arc, time::Duration},
+    structopt::StructOpt,
+};
+
+#[derive(StructOpt)]
+struct Args {
+    /// Specify WebSocket address.
+    #[structopt(short, long, default_value = "wss://relay.walletconnect.com")]
+    address: String,
+
+    /// Specify WalletConnect project ID.
+    #[structopt(short, long, default_value = "3cbaa32f8fbf3cdcc87d27ca1fa68069")]
+    project_id: String,
+}
+
+struct Handler {
+    name: &'static str,
+}
+
+impl Handler {
+    fn new(name: &'static str) -> Self {
+        Self { name }
+    }
+}
+
+impl ConnectionHandler for Handler {
+    fn connected(&mut self) {
+        println!("[{}] connection open", self.name);
+    }
+
+    fn disconnected(&mut self, frame: Option<CloseFrame<'static>>) {
+        println!("[{}] connection closed: frame={frame:?}", self.name);
+    }
+
+    fn message_received(&mut self, message: PublishedMessage) {
+        println!(
+            "[{}] inbound message: topic={} message={}",
+            self.name, message.topic, message.message
+        );
+    }
+
+    fn inbound_error(&mut self, error: Error) {
+        println!("[{}] inbound error: {error}", self.name);
+    }
+
+    fn outbound_error(&mut self, error: Error) {
+        println!("[{}] outbound error: {error}", self.name);
+    }
+}
+
+fn create_conn_opts(address: &str, project_id: &str) -> ConnectionOptions {
+    let key = Keypair::generate(&mut rand::thread_rng());
+
+    let auth = AuthToken::new(AuthSubject::generate())
+        .aud(address)
+        .ttl(Duration::from_secs(60 * 60))
+        .as_jwt(&key)
+        .unwrap();
+
+    ConnectionOptions::new(project_id, auth).with_address(address)
+}
+
+#[tokio::main]
+async fn main() -> anyhow::Result<()> {
+    let args = Args::from_args();
+
+    let client1 = Client::new(Handler::new("client1"));
+    client1
+        .connect(create_conn_opts(&args.address, &args.project_id))
+        .await?;
+
+    let client2 = Client::new(Handler::new("client2"));
+    client2
+        .connect(create_conn_opts(&args.address, &args.project_id))
+        .await?;
+
+    let topic = Topic::generate();
+
+    let subscription_id = client1.subscribe(topic.clone()).await?;
+    println!("[client1] subscribed: topic={topic} subscription_id={subscription_id}");
+
+    client2
+        .publish(
+            topic.clone(),
+            Arc::from("Hello WalletConnect!"),
+            0,
+            Duration::from_secs(60),
+        )
+        .await?;
+
+    println!("[client2] published message with topic: {topic}");
+
+    drop(client1);
+    drop(client2);
+
+    tokio::time::sleep(Duration::from_millis(100)).await;
+
+    println!("clients disconnected");
+
+    Ok(())
+}

justfile

@@ -0,0 +1,91 @@
+binary-crate            := "."
+
+export JUST_ROOT        := justfile_directory()
+
+# Default to listing recipes
+_default:
+  @just --list --list-prefix '  > '
+
+# Open project documentation in your local browser
+open-docs: (_build-docs "open")
+  @echo '==> Opening documentation in system browser'
+
+# Fast check project for errors
+check:
+  @echo '==> Checking project for compile errors'
+  cargo check --workspace
+
+# Build service for development
+build:
+  @echo '==> Building project'
+  cargo build
+
+# Build project documentation
+build-docs: (_build-docs "")
+
+# Run project test suite, skipping storage tests
+test:
+  @echo '==> Testing project (default)'
+  cargo test --workspace
+
+# Run project test suite, testing all features
+test-all:
+  @echo '==> Testing project (all features)'
+  cargo test --workspace --all-features
+
+# Run test from project documentation
+test-doc:
+  @echo '==> Testing project docs'
+  cargo test --workspace --doc
+
+# Clean build artifacts
+clean:
+  @echo '==> Cleaning project target/*'
+  cargo clean
+
+# Lint the project for any quality issues
+lint: check fmt clippy commit-check
+
+# Run project linter
+clippy:
+  #!/bin/bash
+  set -euo pipefail
+
+  if command -v cargo-clippy >/dev/null; then
+    echo '==> Running clippy'
+    cargo clippy --workspace --all-features --tests -- -D clippy::all -W clippy::style
+  else
+    echo '==> clippy not found in PATH, skipping'
+    echo '    ^^^^^^ To install `rustup component add clippy`, see https://github.com/rust-lang/rust-clippy for details'
+  fi
+
+# Run code formatting check
+fmt:
+  #!/bin/bash
+  set -euo pipefail
+
+  if command -v cargo-fmt >/dev/null; then
+    echo '==> Running rustfmt'
+    cargo +nightly fmt --all -- --check
+  else
+    echo '==> rustfmt not found in PATH, skipping'
+    echo '    ^^^^^^ To install `rustup component add rustfmt`, see https://github.com/rust-lang/rustfmt for details'
+  fi
+
+# Run commit checker
+commit-check:
+  #!/bin/bash
+  set -euo pipefail
+
+  if command -v cog >/dev/null; then
+    echo '==> Running cog check'
+    cog check --from-latest-tag
+  else
+    echo '==> cog not found in PATH, skipping'
+    echo '    ^^^ To install `cargo install --locked cocogitto`, see https://github.com/cocogitto/cocogitto for details'
+  fi
+
+# Build project documentation
+_build-docs $open="":
+  @echo "==> Building project documentation @$JUST_ROOT/target/doc"
+  @cargo doc --all-features --workspace --no-deps ${open:+--open}