Skip to content

Commit 156fc16

Browse files
committed
Some rewording to provide context for req and resp types
1 parent d784c3e commit 156fc16

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

packages/libs/snap/README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ const isConnected = await window.ethereum.request({
139139
});
140140
```
141141

142-
**Response**: `CheckConnectionResponse`
142+
**Response**: [`CheckConnectionResponse`](#type-definitions)
143143

144144
---
145145

@@ -159,13 +159,13 @@ const account = await window.ethereum.request({
159159
});
160160
```
161161

162-
**Response**: `SnapAccount`
162+
**Response**: [`SnapAccount`](#type-definitions)
163163

164164
---
165165

166166
### kda_addHardwareAccount
167167

168-
**Description**: Adds a new hardware account from the Kadena Ledger App. NOTE: The Snap doesn't currently support signing with these hardware accounts.
168+
**Description**: Adds a new hardware account from the Kadena Ledger App. Please note that the Snap doesn't currently support signing with these hardware accounts.
169169

170170
**Request Example**:
171171

@@ -186,7 +186,7 @@ const account = await window.ethereum.request({
186186
});
187187
```
188188

189-
**Response**: `SnapAccount`
189+
**Response**: [`SnapAccount`](#type-definitions)
190190

191191
---
192192

@@ -252,13 +252,13 @@ const accounts = await window.ethereum.request({
252252
});
253253
```
254254

255-
**Response**: `SnapAccount[]`
255+
**Response**: [`SnapAccount[]`](#type-definitions)
256256

257257
---
258258

259259
### kda_getHardwareAccounts
260260

261-
**Description**: Retrieves all hardware accounts from the Kadena Snap. NOTE: The Snap doesn't currently support signing with these hardware accounts.
261+
**Description**: Retrieves all hardware accounts from the Kadena Snap. Please note that the Snap doesn't currently support signing with these hardware accounts.
262262

263263
**Request Example**:
264264

@@ -272,7 +272,7 @@ const hardwareAccounts = await window.ethereum.request({
272272
});
273273
```
274274

275-
**Response**: `SnapAccount[]`
275+
**Response**: [`SnapAccount[]`](#type-definitions)
276276

277277
---
278278

@@ -292,7 +292,7 @@ const networks = await window.ethereum.request({
292292
});
293293
```
294294

295-
**Response**: `SnapNetwork[]`
295+
**Response**: [`SnapNetwork[]`](#type-definitions)
296296

297297
---
298298

@@ -325,7 +325,7 @@ await window.ethereum.request({
325325
});
326326
```
327327

328-
**Response**: `SnapNetwork`
328+
**Response**: [`SnapNetwork`](#type-definitions)
329329

330330
---
331331

@@ -368,7 +368,7 @@ const activeNetwork = await window.ethereum.request({
368368
});
369369
```
370370

371-
**Response**: `GetActiveNetworkResponse`
371+
**Response**: [`GetActiveNetworkResponse`](#type-definitions)
372372

373373
---
374374

@@ -449,7 +449,7 @@ await window.ethereum.request({
449449

450450
### kda_signTransaction
451451

452-
**Description**: Signs a transaction using the Kadena Snap.
452+
**Description**: Signs a transaction using the Kadena Snap. The transaction is expected to be a stringified JSON of the type [`ICommandPayload`](https://github.com/kadena-community/kadena.js/blob/f88301538ee41b77b957edf58a8a5edb4fba44cb/packages/libs/types/src/PactCommand.ts#L176).
453453

454454
**Request Example**:
455455

@@ -469,7 +469,7 @@ const signature = await window.ethereum.request({
469469
});
470470
```
471471

472-
**Response**: `SignTransactionResponse`
472+
**Response**: [`SignTransactionResponse`](#type-definitions)
473473

474474
---
475475

0 commit comments

Comments
 (0)