Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update README addressing WalletConnect Rust SDKs #86

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 8 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,16 @@
# WalletConnect Rust SDK
# Reown Rust

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.
This repo contains various internal utilities, including a Rust client for the relay.

Examples:
- [HTTP client](examples/http_client.rs)
- [WebSocket client](examples/websocket_client.rs)
- [Webhook dispatch](examples/webhook.rs)
## WalletConnect Rust SDK

## `relay_client`
Reown is currently not planning to build a WalletConnect SDK for Rust, and we are not accepting contributions for this. However, you are welcome to build your own client or contribute to an existing community one.

The core Relay client. Provides access to all available Relay RPC methods to build on top of.
These community resources may be useful for you, but they have not been tested by, and are not endorced by Reown:

## `relay_rpc`
- [walletconnect-client](https://lib.rs/crates/walletconnect-client) crate
- [PR](https://github.com/reown-com/reown-rust/pull/48) adding Sign Client to this repo

Provides all of the Relay domain types (e.g. `ClientId`, `ProjectId` etc.) as well as auth token generation and validation functionality.

### `cacao` feature

To aid IDE integration you may want to add this to your local `relay_rpc/Cargo.toml` file:

```toml
[features]
default = ["cacao"]
```

# License
## License

[Apache License (Version 2.0)](LICENSE)
Loading