Skip to content

Commit 5046727

Browse files
chore: add Sign API README.md
1 parent fc737a0 commit 5046727

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

sign_api/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Rust Sign API SDK
2+
3+
This crate implements Sign API, described in:
4+
https://specs.walletconnect.com/2.0/specs/clients/sign/
5+
6+
There is a simple Sign API client example built on top of the websocket client, which can be run as follows:
7+
- In a browser, open: https://react-app.walletconnect.com/
8+
- Click on "Goerli" and then "connect"
9+
- In a new pop-up, click "New Pairing"
10+
- Copy the Pairing URI
11+
- In the terminal, cd _path/to/WalletConnectRust/sign_api_
12+
- .../sign_api$ cargo run --example session "_copied URI_"
13+
- DApp should now display the session window
14+
- Click disconnect to terminate session and pairing
15+
16+
__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.__
17+
18+
## Disclaimer
19+
20+
Please note that this crate is still under development, and thus:
21+
- Is incomplete
22+
- Might lack testing in places
23+
- Being developed from a wallet perspective, and thus some DApp specific SDK details might have been overlooked

0 commit comments

Comments
 (0)