Skip to content

Commit c9bc79f

Browse files
committed
Merge branch 'merge-v0.7.x' of https://github.com/WalletConnect/walletconnect-docs into v0.7.x
2 parents 931ded3 + 4513ccd commit c9bc79f

File tree

7 files changed

+16
-156
lines changed

7 files changed

+16
-156
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ To reference all the Bridge API calls go to [Bridge API](bridge-api.md)
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.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)

SUMMARY.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
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 v0.7.x](README.md)
4+
- [Quick Start](quick-start.md)
5+
- [Technical Specification](tech-spec.md)
6+
- [Bridge API](bridge-api.md)
-336 KB
Binary file not shown.
-344 KB
Binary file not shown.

bridge-api.md

Lines changed: 0 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -1,137 +0,0 @@
1-
# Bridge API
2-
3-
## For Dapps
4-
5-
### Create a new Session
6-
7-
```bash
8-
POST https://bridge.walletconnect.org/session/new
9-
10-
Response:
11-
Status: 200
12-
Content-Type: application/json; charset=utf-8
13-
Body:
14-
{
15-
"sessionId": <someSessionId>
16-
}
17-
```
18-
19-
### Get Session details \(short-polling\)
20-
21-
```bash
22-
GET https://bridge.walletconnect.org/session/<sessionId>
23-
24-
Response (when details exist):
25-
Status: 200
26-
Content-Type: application/json; charset=utf-8
27-
Body:
28-
{
29-
"encryptionPayload": <encryptedSessionPayload>
30-
}
31-
32-
Response (when details do not yet exist):
33-
Status: 204
34-
```
35-
36-
### Create new Call Request
37-
38-
```bash
39-
POST https://bridge.walletconnect.org/session/<sessionId>/call/new
40-
Content-Type: application/json
41-
Body:
42-
{
43-
"encryptionPayload": <encryptedCallRequestPayload>,
44-
"dappName": <ExampleDappName>
45-
}
46-
47-
Response:
48-
Status: 200
49-
Content-Type: application/json; charset=utf-8
50-
Body:
51-
{
52-
"callId": <callId>
53-
}
54-
```
55-
56-
### Get Call status \(short-polling\)
57-
58-
```bash
59-
GET https://bridge.walletconnect.org/call-status/<callId>
60-
61-
Response (when status does exist):
62-
Status: 200
63-
Content-Type: application/json; charset=utf-8
64-
{
65-
"encryptionPayload": <encryptedCallStatus>
66-
}
67-
68-
Response (when status does not yet exist):
69-
Status: 204
70-
```
71-
72-
## For Wallets
73-
74-
### Update Session details
75-
76-
```bash
77-
PUT https://bridge.walletconnect.org/session/<sessionId>
78-
Content-Type: application/json
79-
Body:
80-
{
81-
"encryptionPayload":<someEncryptedSessionPayload>,
82-
"push": {
83-
"type": <pushType>,
84-
"token": <pushToken>,
85-
"webhook": <pushWebhook>
86-
}
87-
}
88-
89-
Response:
90-
Status: 200
91-
```
92-
93-
### Get Call Request details
94-
95-
```bash
96-
GET https://bridge.walletconnect.org/session/<sessionId>/call/<callId>
97-
98-
Response:
99-
Status: 200
100-
Content-Type: application/json; charset=utf-8
101-
Body:
102-
{
103-
"encryptionPayload": <encryptedCallRequest>
104-
}
105-
```
106-
107-
### Get All Call Requests available
108-
109-
```bash
110-
GET https://bridge.walletconnect.org/session/<sessionId>/calls
111-
112-
Response:
113-
Status: 200
114-
Content-Type: application/json; charset=utf-8
115-
Body:
116-
{
117-
<callId>: {
118-
"encryptionPayload": <encryptedCallRequest>
119-
},
120-
...
121-
}
122-
```
123-
124-
### Add Call Status
125-
126-
```bash
127-
POST https://bridge.walletconnect.org/call-status/<callId>/new
128-
Content-Type: application/json
129-
Body:
130-
{
131-
"encryptionPayload": <encryptedCallStatus>
132-
}
133-
134-
Response:
135-
Status: 200
136-
```
137-

quick-start.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,4 +331,3 @@ const signedMessage = await web3.eth.sign(msg)
331331
*/
332332
const signedTypedData = await web3.eth.signTypedData(msg)
333333
```
334-

tech-spec.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,17 @@ The core of the design is enable data to be realyed between a desktop Dapp and a
2323

2424
The session data includes 3 parameters:
2525

26-
* Session ID
27-
* Bridge Url
28-
* Symmetric Key
26+
- Session ID
27+
- Bridge Url
28+
- Symmetric Key
2929

3030
Provided with the symmetric key the Dapp and the Wallet can now relay data in and end-to-end encrypted communication. From the Bridge viewpoint it is simply relaying encrypted payload between two parties. The Wallet will also be notified about Dapp requests that require User consent thus it can optionally share push notification data with the Bridge to trigger notifications on the User's device
3131

3232
The push notification data includes:
3333

34-
* Push Type
35-
* Push Token
36-
* Push Webhook
34+
- Push Type
35+
- Push Token
36+
- Push Webhook
3737

3838
Given the technical overview of the core design, in the next section we will describe the detailed communication between the Dapp and the Wallet.
3939

@@ -43,8 +43,8 @@ The WalletConnect protocol has fundamentally 2 types of communications that are
4343

4444
The 2 types of communication are:
4545

46-
* Session Requests
47-
* Call Requests
46+
- Session Requests
47+
- Call Requests
4848

4949
Session requests are similar to when a Dapp requests Metamask the User's accounts with the difference that instead of prompting the User to unlock Metamask, the User is prompted to scan the WalletConnect QR Code with the mobile Wallet. Analogous to the EIP 1102, the User can approve or reject the session request to expose the User's accounts from the Wallet to Dapp.
5050

0 commit comments

Comments
 (0)