Skip to content

Commit 2f9da91

Browse files
authored
feat/1098 - SDK: Add remaining Transfer types (#1099)
* feat: adding shielding transfer args * feat: hook up additional transfer build functions * docs: regenerate docs based on updated types
1 parent 06d1455 commit 2f9da91

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+1419
-343
lines changed

packages/sdk/docs/classes/Crypto.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Class Crypto handles AES encryption tasks
4040

4141
#### Defined in
4242

43-
[sdk/src/crypto/crypto.ts:20](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/crypto/crypto.ts#L20)
43+
[sdk/src/crypto/crypto.ts:20](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/crypto/crypto.ts#L20)
4444

4545
## Properties
4646

@@ -52,7 +52,7 @@ WebAssembly Memory for crypto
5252

5353
#### Defined in
5454

55-
[sdk/src/crypto/crypto.ts:20](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/crypto/crypto.ts#L20)
55+
[sdk/src/crypto/crypto.ts:20](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/crypto/crypto.ts#L20)
5656

5757
## Methods
5858

@@ -75,7 +75,7 @@ decrypted text
7575

7676
#### Defined in
7777

78-
[sdk/src/crypto/crypto.ts:115](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/crypto/crypto.ts#L115)
78+
[sdk/src/crypto/crypto.ts:115](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/crypto/crypto.ts#L115)
7979

8080
___
8181

@@ -100,7 +100,7 @@ crypto record
100100

101101
#### Defined in
102102

103-
[sdk/src/crypto/crypto.ts:61](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/crypto/crypto.ts#L61)
103+
[sdk/src/crypto/crypto.ts:61](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/crypto/crypto.ts#L61)
104104

105105
___
106106

@@ -126,7 +126,7 @@ array of encrypted bytes
126126

127127
#### Defined in
128128

129-
[sdk/src/crypto/crypto.ts:98](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/crypto/crypto.ts#L98)
129+
[sdk/src/crypto/crypto.ts:98](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/crypto/crypto.ts#L98)
130130

131131
___
132132

@@ -153,7 +153,7 @@ crypto record used for storage
153153

154154
#### Defined in
155155

156-
[sdk/src/crypto/crypto.ts:30](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/crypto/crypto.ts#L30)
156+
[sdk/src/crypto/crypto.ts:30](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/crypto/crypto.ts#L30)
157157

158158
___
159159

@@ -178,4 +178,4 @@ encryption parameters
178178

179179
#### Defined in
180180

181-
[sdk/src/crypto/crypto.ts:73](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/crypto/crypto.ts#L73)
181+
[sdk/src/crypto/crypto.ts:73](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/crypto/crypto.ts#L73)

packages/sdk/docs/classes/Ledger.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Functionality for interacting with NamadaApp for Ledger Hardware Wallets
4242

4343
#### Defined in
4444

45-
[sdk/src/ledger.ts:53](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/ledger.ts#L53)
45+
[sdk/src/ledger.ts:53](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/ledger.ts#L53)
4646

4747
## Properties
4848

@@ -54,7 +54,7 @@ Inititalized NamadaApp class from Zondax package
5454

5555
#### Defined in
5656

57-
[sdk/src/ledger.ts:53](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/ledger.ts#L53)
57+
[sdk/src/ledger.ts:53](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/ledger.ts#L53)
5858

5959
## Methods
6060

@@ -75,7 +75,7 @@ void
7575

7676
#### Defined in
7777

78-
[sdk/src/ledger.ts:174](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/ledger.ts#L174)
78+
[sdk/src/ledger.ts:174](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/ledger.ts#L174)
7979

8080
___
8181

@@ -102,7 +102,7 @@ Address and public key
102102

103103
#### Defined in
104104

105-
[sdk/src/ledger.ts:96](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/ledger.ts#L96)
105+
[sdk/src/ledger.ts:96](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/ledger.ts#L96)
106106

107107
___
108108

@@ -123,7 +123,7 @@ Error message if error is found
123123

124124
#### Defined in
125125

126-
[sdk/src/ledger.ts:157](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/ledger.ts#L157)
126+
[sdk/src/ledger.ts:157](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/ledger.ts#L157)
127127

128128
___
129129

@@ -150,7 +150,7 @@ Address and public key
150150

151151
#### Defined in
152152

153-
[sdk/src/ledger.ts:116](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/ledger.ts#L116)
153+
[sdk/src/ledger.ts:116](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/ledger.ts#L116)
154154

155155
___
156156

@@ -178,7 +178,7 @@ Response signature
178178

179179
#### Defined in
180180

181-
[sdk/src/ledger.ts:142](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/ledger.ts#L142)
181+
[sdk/src/ledger.ts:142](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/ledger.ts#L142)
182182

183183
___
184184

@@ -199,7 +199,7 @@ Version and info of NamadaApp
199199

200200
#### Defined in
201201

202-
[sdk/src/ledger.ts:79](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/ledger.ts#L79)
202+
[sdk/src/ledger.ts:79](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/ledger.ts#L79)
203203

204204
___
205205

@@ -225,4 +225,4 @@ Ledger class instance
225225

226226
#### Defined in
227227

228-
[sdk/src/ledger.ts:61](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/ledger.ts#L61)
228+
[sdk/src/ledger.ts:61](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/ledger.ts#L61)

packages/sdk/docs/classes/Masp.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Class representing utilities related to MASP
4141

4242
#### Defined in
4343

44-
[sdk/src/masp.ts:10](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/masp.ts#L10)
44+
[sdk/src/masp.ts:10](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/masp.ts#L10)
4545

4646
## Properties
4747

@@ -53,7 +53,7 @@ Instance of Sdk struct from wasm lib
5353

5454
#### Defined in
5555

56-
[sdk/src/masp.ts:10](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/masp.ts#L10)
56+
[sdk/src/masp.ts:10](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/masp.ts#L10)
5757

5858
## Methods
5959

@@ -80,7 +80,7 @@ void
8080

8181
#### Defined in
8282

83-
[sdk/src/masp.ts:69](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/masp.ts#L69)
83+
[sdk/src/masp.ts:69](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/masp.ts#L69)
8484

8585
___
8686

@@ -107,7 +107,7 @@ void
107107

108108
#### Defined in
109109

110-
[sdk/src/masp.ts:47](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/masp.ts#L47)
110+
[sdk/src/masp.ts:47](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/masp.ts#L47)
111111

112112
___
113113

@@ -134,7 +134,7 @@ void
134134

135135
#### Defined in
136136

137-
[sdk/src/masp.ts:58](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/masp.ts#L58)
137+
[sdk/src/masp.ts:58](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/masp.ts#L58)
138138

139139
___
140140

@@ -154,7 +154,7 @@ void
154154

155155
#### Defined in
156156

157-
[sdk/src/masp.ts:26](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/masp.ts#L26)
157+
[sdk/src/masp.ts:26](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/masp.ts#L26)
158158

159159
___
160160

@@ -174,7 +174,7 @@ True if MASP parameters are loaded
174174

175175
#### Defined in
176176

177-
[sdk/src/masp.ts:17](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/masp.ts#L17)
177+
[sdk/src/masp.ts:17](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/masp.ts#L17)
178178

179179
___
180180

@@ -200,4 +200,4 @@ void
200200

201201
#### Defined in
202202

203-
[sdk/src/masp.ts:36](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/masp.ts#L36)
203+
[sdk/src/masp.ts:36](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/masp.ts#L36)

packages/sdk/docs/classes/Mnemonic.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Class for accessing mnemonic functionality from wasm
3838

3939
#### Defined in
4040

41-
[sdk/src/mnemonic.ts:18](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/mnemonic.ts#L18)
41+
[sdk/src/mnemonic.ts:18](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/mnemonic.ts#L18)
4242

4343
## Properties
4444

@@ -50,7 +50,7 @@ Memory accessor for crypto lib
5050

5151
#### Defined in
5252

53-
[sdk/src/mnemonic.ts:18](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/mnemonic.ts#L18)
53+
[sdk/src/mnemonic.ts:18](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/mnemonic.ts#L18)
5454

5555
## Methods
5656

@@ -76,7 +76,7 @@ Promise that resolves to array of words
7676

7777
#### Defined in
7878

79-
[sdk/src/mnemonic.ts:26](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/mnemonic.ts#L26)
79+
[sdk/src/mnemonic.ts:26](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/mnemonic.ts#L26)
8080

8181
___
8282

@@ -101,7 +101,7 @@ Seed bytes
101101

102102
#### Defined in
103103

104-
[sdk/src/mnemonic.ts:44](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/mnemonic.ts#L44)
104+
[sdk/src/mnemonic.ts:44](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/mnemonic.ts#L44)
105105

106106
___
107107

@@ -131,4 +131,4 @@ Object with validation result and error message if invalid
131131

132132
#### Defined in
133133

134-
[sdk/src/mnemonic.ts:62](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/mnemonic.ts#L62)
134+
[sdk/src/mnemonic.ts:62](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/mnemonic.ts#L62)

packages/sdk/docs/classes/Rpc.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ API for executing RPC requests with Namada
5151

5252
#### Defined in
5353

54-
[sdk/src/rpc/rpc.ts:36](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L36)
54+
[sdk/src/rpc/rpc.ts:36](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L36)
5555

5656
## Properties
5757

@@ -63,7 +63,7 @@ Instance of Query struct from wasm lib
6363

6464
#### Defined in
6565

66-
[sdk/src/rpc/rpc.ts:38](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L38)
66+
[sdk/src/rpc/rpc.ts:38](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L38)
6767

6868
___
6969

@@ -75,7 +75,7 @@ Instance of Sdk struct from wasm lib
7575

7676
#### Defined in
7777

78-
[sdk/src/rpc/rpc.ts:37](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L37)
78+
[sdk/src/rpc/rpc.ts:37](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L37)
7979

8080
## Methods
8181

@@ -102,7 +102,7 @@ TxResponseProps object
102102

103103
#### Defined in
104104

105-
[sdk/src/rpc/rpc.ts:223](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L223)
105+
[sdk/src/rpc/rpc.ts:223](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L223)
106106

107107
___
108108

@@ -122,7 +122,7 @@ Array of all validator addresses
122122

123123
#### Defined in
124124

125-
[sdk/src/rpc/rpc.ts:78](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L78)
125+
[sdk/src/rpc/rpc.ts:78](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L78)
126126

127127
___
128128

@@ -149,7 +149,7 @@ Query balances from chain
149149

150150
#### Defined in
151151

152-
[sdk/src/rpc/rpc.ts:48](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L48)
152+
[sdk/src/rpc/rpc.ts:48](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L48)
153153

154154
___
155155

@@ -169,7 +169,7 @@ Object
169169

170170
#### Defined in
171171

172-
[sdk/src/rpc/rpc.ts:203](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L203)
172+
[sdk/src/rpc/rpc.ts:203](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L203)
173173

174174
___
175175

@@ -195,7 +195,7 @@ Promise resolving to delegators votes
195195

196196
#### Defined in
197197

198-
[sdk/src/rpc/rpc.ts:102](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L102)
198+
[sdk/src/rpc/rpc.ts:102](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L102)
199199

200200
___
201201

@@ -215,7 +215,7 @@ Query gas costs
215215

216216
#### Defined in
217217

218-
[sdk/src/rpc/rpc.ts:194](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L194)
218+
[sdk/src/rpc/rpc.ts:194](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L194)
219219

220220
___
221221

@@ -235,7 +235,7 @@ Address of native token
235235

236236
#### Defined in
237237

238-
[sdk/src/rpc/rpc.ts:57](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L57)
238+
[sdk/src/rpc/rpc.ts:57](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L57)
239239

240240
___
241241

@@ -262,7 +262,7 @@ String of public key if found
262262

263263
#### Defined in
264264

265-
[sdk/src/rpc/rpc.ts:68](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L68)
265+
[sdk/src/rpc/rpc.ts:68](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L68)
266266

267267
___
268268

@@ -288,7 +288,7 @@ Promise resolving to pending ethereum transfers
288288

289289
#### Defined in
290290

291-
[sdk/src/rpc/rpc.ts:185](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L185)
291+
[sdk/src/rpc/rpc.ts:185](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L185)
292292

293293
___
294294

@@ -314,7 +314,7 @@ Promise resolving to staking positions
314314

315315
#### Defined in
316316

317-
[sdk/src/rpc/rpc.ts:139](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L139)
317+
[sdk/src/rpc/rpc.ts:139](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L139)
318318

319319
___
320320

@@ -340,7 +340,7 @@ Promise resolving to staking totals
340340

341341
#### Defined in
342342

343-
[sdk/src/rpc/rpc.ts:112](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L112)
343+
[sdk/src/rpc/rpc.ts:112](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L112)
344344

345345
___
346346

@@ -364,7 +364,7 @@ Total bonds amount
364364

365365
#### Defined in
366366

367-
[sdk/src/rpc/rpc.ts:175](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L175)
367+
[sdk/src/rpc/rpc.ts:175](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L175)
368368

369369
___
370370

@@ -391,7 +391,7 @@ Promise resolving to total delegations
391391

392392
#### Defined in
393393

394-
[sdk/src/rpc/rpc.ts:89](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L89)
394+
[sdk/src/rpc/rpc.ts:89](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L89)
395395

396396
___
397397

@@ -415,4 +415,4 @@ Sync the shielded context
415415

416416
#### Defined in
417417

418-
[sdk/src/rpc/rpc.ts:241](https://github.com/anoma/namada-interface/blob/48e796bf/packages/sdk/src/rpc/rpc.ts#L241)
418+
[sdk/src/rpc/rpc.ts:241](https://github.com/anoma/namada-interface/blob/fed376fb8f8e78431a4124d1835f659952e931ac/packages/sdk/src/rpc/rpc.ts#L241)

0 commit comments

Comments
 (0)