-
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.
- Loading branch information
1 parent
9b78bb8
commit 489e2e3
Showing
1 changed file
with
23 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Rust Sign API SDK | ||
|
||
This crate implements Sign API, described in: | ||
https://specs.walletconnect.com/2.0/specs/clients/sign/ | ||
|
||
There is a simple Sign API client example built on top of the websocket client, which can be run as follows: | ||
- In a browser, open: https://react-app.walletconnect.com/ | ||
- Click on "Goerli" and then "connect" | ||
- In a new pop-up, click "New Pairing" | ||
- Copy the Pairing URI | ||
- In the terminal, cd _path/to/WalletConnectRust/sign_api_ | ||
- .../sign_api$ cargo run --example session "_copied URI_" | ||
- DApp should now display the session window | ||
- Click disconnect to terminate session and pairing | ||
|
||
__Warning: this Rust Sign API SDK is community-maintained and may be lacking features and stability or security fixes that other versions of the Sign API SDK receive. We strongly recommend using the JavaScript or other Sign API SDKs instead.__ | ||
|
||
## Disclaimer | ||
|
||
Please note that this crate is still under development, and thus: | ||
- Is incomplete | ||
- Might lack testing in places | ||
- Being developed from a wallet perspective, and thus some DApp specific SDK details might have been overlooked |