Skip to content

Commit f3089ff

Browse files
pedrouidpedrouid
authored
Merge pull request WalletConnect#17 from WalletConnect/v1.0.0-beta
V1.0.0 beta
2 parents 339ff1c + 39b126e commit f3089ff

10 files changed

+615
-366
lines changed

‎README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
1-
# WalletConnect v0.7.x
1+
# WalletConnect v1.0.0-beta
22

33
## Introduction
44

5-
Wallet Connect is a simple solution that enables communication between desktop Dapps and mobile Wallets using a QR Code to establish a session. It's an open protocol and does not require the User to have specific hardware or install any software. The protocol is agnostic to any mobile Wallets that wishes to support it and enables Dapp developers to integrate with several mobile Wallets through a single implementation.
5+
WalletConnect is an open protocol to communicate securely between Wallets and Dapps (Web3 Apps). The protocol establishes a remote connection between two apps and/or devices using a Bridge server to relay payloads. These payloads are symmetrically encrypted through a shared key between the two peers. The connection is initiated by one peer displaying a QR Code or deep link with a standard WalletConnect URI and is established when the counter-party approves this connection request. It also includes an optional Push server to allow Native applications to notify the user of incoming payloads for establishes connections.
66

77
## Getting Started
88

9-
Currently the WalletConnect protocol has implementations in Javascript for Browser SDK, Wallet SDK, Push Notification Webhook and in Python for the Bridge Server.
9+
Currently the WalletConnect protocol has references implementations written in Typescript for the Client SDK (browser/react-native), the Bridge Server and the Push server.
1010

11-
To quickly setup for your Dapp or Wallet, go to [Quick Start](quick-start.md)
11+
To quickly setup for your Dapp or Wallet, go to [Quick Start](quick-start.md) for code examples.
1212

13-
To read the technical specification of the WalletConnect protocol, go to [Technical Specification](tech-spec.md)
13+
To read in more detail about the WalletConnect protocol, go to [Technical Specification](tech-spec.md)
1414

15-
To reference all the Bridge API calls go to [Bridge API](bridge-api.md)
15+
Additionally you can also consult the API references for [Client SDK](bridge-sdk.md), [Bridge Server](bridge-server.md) and [Push Server](push-server.md)
1616

1717
## Community
1818

1919
Share your experience, contribute or ask questions with the WalletConnect Community
2020

21-
* Github: [https://github.com/walletconnect](https://github.com/walletconnect)
22-
* Telegram: [https://t.me/walletconnect](https://t.me/walletconnect)
23-
* Forum: [https://discuss.walletconnect.org](https://discuss.walletconnect.org)
24-
* Discord: [https://discord.walletconnect.org](https://discord.walletconnect.org)
25-
21+
- Github: [https://github.walletconnect.org](https://github.walletconnect.org)
22+
- Forum: [https://discuss.walletconnect.org](https://discuss.walletconnect.org)
23+
- Discord: [https://discord.walletconnect.org](https://discord.walletconnect.org)
24+
- Telegram: [https://telegram.walletconnect.org](https://telegram.walletconnect.org)
25+
- Twitter: [https://twitter.walletconnect.org](https://twitter.walletconnect.org)

‎SUMMARY.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Table of contents
22

3-
* [WalletConnect v0.7.x](README.md)
4-
* [Quick Start](quick-start.md)
5-
* [Technical Specification](tech-spec.md)
6-
* [Bridge API](bridge-api.md)
7-
3+
- [WalletConnect v1.0.0-beta](README.md)
4+
- [Quick Start (Examples)](quick-start.md)
5+
- [Technical Specification](tech-spec.md)
6+
- [Client SDK API Reference](client-sdk.md)
7+
- [Bridge Server API Reference](bridge-server.md)
8+
- [Push Server API Reference](push-server.md)

‎assets/walletconnect-accounts-diagram.png

-336 KB
Binary file not shown.

‎assets/walletconnect-transaction-diagram.png

-344 KB
Binary file not shown.

‎bridge-api.md

-137
This file was deleted.

‎bridge-server.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Bridge Server API Reference
2+
3+
## Test Hello World
4+
5+
```bash
6+
GET https://bridge.walletconnect.org/hello
7+
8+
Response:
9+
Status: 200
10+
Content-Type: text/plain; charset=utf-8
11+
Body: Hello World, this is WalletConnect v1.0.0-beta
12+
```
13+
14+
## Get Bridge Server Info
15+
16+
```bash
17+
GET https://bridge.walletconnect.org/info
18+
19+
Response:
20+
Status: 200
21+
Content-Type: application/json; charset=utf-8
22+
Body:
23+
{
24+
"name": "WalletConnect Bridge Server",
25+
"repository": "walletconnect-bridge",
26+
"version": "1.0.0-beta"
27+
}
28+
```
29+
30+
## Subscribe Push Notification Webhook
31+
32+
```bash
33+
POST https://bridge.walletconnect.org/subscribe
34+
Content-Type: application/json
35+
Body:
36+
{
37+
"topic": <client_id>,
38+
"webhook": <push_notification_webhook>
39+
}
40+
41+
Response:
42+
Status: 200
43+
Content-Type: application/json; charset=utf-8
44+
Body:
45+
{
46+
"success": true
47+
}
48+
```

‎client-sdk.md

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Client SDK API Reference
2+
3+
## Register Event Subscription
4+
5+
```typescript
6+
function on(
7+
event: string,
8+
callback: (error: Error | null, payload: any | null) => void
9+
): void;
10+
```
11+
12+
Events: `connect`, `disconnect`, `session_update`, `call_request`, `wc_sessionRequest`, `wc_sessionUpdate`, `wc_exchangeKey`
13+
14+
## Create New Session
15+
16+
```typescript
17+
async function createSession(): Promise<void>;
18+
```
19+
20+
## Approve Session Request
21+
22+
```typescript
23+
function approveSession({
24+
chainId: number, // Required
25+
accounts: string[] // Required
26+
}): void;
27+
```
28+
29+
## Reject Session Request
30+
31+
```typescript
32+
function rejectSession({
33+
message: string // Optional
34+
}): void;
35+
```
36+
37+
## Update Session
38+
39+
```typescript
40+
function updateSession({
41+
chainId: number, // Required
42+
accounts: string[] // Required
43+
}): void;
44+
```
45+
46+
## Kill Session (disconnect)
47+
48+
```typescript
49+
function killSession({
50+
message: string // Optional
51+
}): void;
52+
```
53+
54+
## Send Transaction (eth_sendTransaction)
55+
56+
```typescript
57+
async function sendTransaction({
58+
from: string, // Required
59+
to: string, // Required
60+
gasLimit: string, // Required
61+
gasPrice: string, // Required
62+
value: string, // Required
63+
data: string, // Required
64+
nonde: string // Required
65+
}): Promise<string>;
66+
```
67+
68+
Returns: Transaction hash
69+
70+
## Sign Message (eth_sign)
71+
72+
```typescript
73+
async function signMessage(params: string[]): Promise<string>;
74+
```
75+
76+
Returns: Signature
77+
78+
## Sign Typed Data (eth_signTypedData)
79+
80+
```typescript
81+
async function signTypedData(params: any[]): Promise<string>;
82+
```
83+
84+
Returns: Signature
85+
86+
## Approve Call Request
87+
88+
```typescript
89+
function approveRequest({
90+
id: number, // Required
91+
result: any // Required
92+
}): void;
93+
```
94+
95+
## Reject Call Request
96+
97+
```typescript
98+
function rejectRequest({
99+
id: number, // Required
100+
result: null // Required
101+
}): void;
102+
```

0 commit comments

Comments
 (0)