-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update README addressing WalletConnect Rust SDKs
- Loading branch information
1 parent
51e984e
commit 85dd3f9
Showing
1 changed file
with
8 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |