@dfinity/sns 3.4.0 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +126 -97
- package/dist/candid/sns_governance.certified.idl.js +42 -0
- package/dist/candid/sns_governance.d.ts +18 -9
- package/dist/candid/sns_governance.did +23 -12
- package/dist/candid/sns_governance.idl.js +42 -0
- package/dist/candid/sns_governance_test.certified.idl.js +42 -0
- package/dist/candid/sns_governance_test.d.ts +18 -9
- package/dist/candid/sns_governance_test.did +23 -12
- package/dist/candid/sns_governance_test.idl.js +42 -0
- package/dist/candid/sns_root.did +1 -1
- package/dist/candid/sns_swap.did +1 -1
- package/dist/cjs/index.cjs.js +1 -1
- package/dist/cjs/index.cjs.js.map +3 -3
- package/dist/esm/{chunk-CMVA2R27.js → chunk-63KCLBLM.js} +2 -2
- package/dist/esm/chunk-ERFZ4WF4.js +2 -0
- package/dist/esm/chunk-ERFZ4WF4.js.map +7 -0
- package/dist/esm/{chunk-Q55ZUKOX.js → chunk-TJDVNGQZ.js} +2 -2
- package/dist/esm/chunk-TJDVNGQZ.js.map +7 -0
- package/dist/esm/governance.canister.js +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +3 -3
- package/dist/esm/sns.js +1 -1
- package/dist/esm/sns.wrapper.js +1 -1
- package/dist/types/converters/governance.converters.d.ts +2 -1
- package/dist/types/governance.canister.d.ts +7 -2
- package/dist/types/index.d.ts +1 -1
- package/dist/types/sns.wrapper.d.ts +2 -1
- package/dist/types/types/governance.params.d.ts +14 -2
- package/package.json +3 -3
- package/dist/esm/chunk-IVTJXPAO.js +0 -2
- package/dist/esm/chunk-IVTJXPAO.js.map +0 -7
- package/dist/esm/chunk-Q55ZUKOX.js.map +0 -7
- /package/dist/esm/{chunk-CMVA2R27.js.map → chunk-63KCLBLM.js.map} +0 -0
package/README.md
CHANGED
|
@@ -100,11 +100,28 @@ Lookup for the canister ids of a Sns and initialize the wrapper to access its fe
|
|
|
100
100
|
|
|
101
101
|
### :factory: SnsGovernanceCanister
|
|
102
102
|
|
|
103
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
103
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L67)
|
|
104
104
|
|
|
105
|
-
#### Methods
|
|
105
|
+
#### Static Methods
|
|
106
106
|
|
|
107
107
|
- [create](#gear-create)
|
|
108
|
+
|
|
109
|
+
##### :gear: create
|
|
110
|
+
|
|
111
|
+
Instantiate a canister to interact with the governance of a Sns project.
|
|
112
|
+
|
|
113
|
+
| Method | Type |
|
|
114
|
+
| -------- | ------------------------------------------------------------------ |
|
|
115
|
+
| `create` | `(options: SnsCanisterOptions<_SERVICE>) => SnsGovernanceCanister` |
|
|
116
|
+
|
|
117
|
+
Parameters:
|
|
118
|
+
|
|
119
|
+
- `options`: Miscellaneous options to initialize the canister. Its ID being the only mandatory parammeter.
|
|
120
|
+
|
|
121
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L73)
|
|
122
|
+
|
|
123
|
+
#### Methods
|
|
124
|
+
|
|
108
125
|
- [listNeurons](#gear-listneurons)
|
|
109
126
|
- [listProposals](#gear-listproposals)
|
|
110
127
|
- [listTopics](#gear-listtopics)
|
|
@@ -127,24 +144,11 @@ Lookup for the canister ids of a Sns and initialize the wrapper to access its fe
|
|
|
127
144
|
- [setDissolveTimestamp](#gear-setdissolvetimestamp)
|
|
128
145
|
- [increaseDissolveDelay](#gear-increasedissolvedelay)
|
|
129
146
|
- [setTopicFollowees](#gear-settopicfollowees)
|
|
147
|
+
- [setFollowing](#gear-setfollowing)
|
|
130
148
|
- [registerVote](#gear-registervote)
|
|
131
149
|
- [refreshNeuron](#gear-refreshneuron)
|
|
132
150
|
- [claimNeuron](#gear-claimneuron)
|
|
133
151
|
|
|
134
|
-
##### :gear: create
|
|
135
|
-
|
|
136
|
-
Instantiate a canister to interact with the governance of a Sns project.
|
|
137
|
-
|
|
138
|
-
| Method | Type |
|
|
139
|
-
| -------- | ------------------------------------------------------------------ |
|
|
140
|
-
| `create` | `(options: SnsCanisterOptions<_SERVICE>) => SnsGovernanceCanister` |
|
|
141
|
-
|
|
142
|
-
Parameters:
|
|
143
|
-
|
|
144
|
-
- `options`: Miscellaneous options to initialize the canister. Its ID being the only mandatory parammeter.
|
|
145
|
-
|
|
146
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L71)
|
|
147
|
-
|
|
148
152
|
##### :gear: listNeurons
|
|
149
153
|
|
|
150
154
|
List the neurons of the Sns
|
|
@@ -153,7 +157,7 @@ List the neurons of the Sns
|
|
|
153
157
|
| ------------- | ----------------------------------------------------- |
|
|
154
158
|
| `listNeurons` | `(params: SnsListNeuronsParams) => Promise<Neuron[]>` |
|
|
155
159
|
|
|
156
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
160
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L87)
|
|
157
161
|
|
|
158
162
|
##### :gear: listProposals
|
|
159
163
|
|
|
@@ -163,7 +167,7 @@ List the proposals of the Sns
|
|
|
163
167
|
| --------------- | -------------------------------------------------------------------- |
|
|
164
168
|
| `listProposals` | `(params: SnsListProposalsParams) => Promise<ListProposalsResponse>` |
|
|
165
169
|
|
|
166
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
170
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L101)
|
|
167
171
|
|
|
168
172
|
##### :gear: listTopics
|
|
169
173
|
|
|
@@ -173,7 +177,7 @@ List the topics of the Sns
|
|
|
173
177
|
| ------------ | -------------------------------------------------------------- |
|
|
174
178
|
| `listTopics` | `(params: SnsListTopicsParams) => Promise<ListTopicsResponse>` |
|
|
175
179
|
|
|
176
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
180
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L116)
|
|
177
181
|
|
|
178
182
|
##### :gear: getProposal
|
|
179
183
|
|
|
@@ -183,7 +187,7 @@ Get the proposal of the Sns
|
|
|
183
187
|
| ------------- | --------------------------------------------------------- |
|
|
184
188
|
| `getProposal` | `(params: SnsGetProposalParams) => Promise<ProposalData>` |
|
|
185
189
|
|
|
186
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
190
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L127)
|
|
187
191
|
|
|
188
192
|
##### :gear: listNervousSystemFunctions
|
|
189
193
|
|
|
@@ -194,7 +198,7 @@ Neurons can follow other neurons in specific Nervous System Functions.
|
|
|
194
198
|
| ---------------------------- | ---------------------------------------------------------------------- |
|
|
195
199
|
| `listNervousSystemFunctions` | `(params: QueryParams) => Promise<ListNervousSystemFunctionsResponse>` |
|
|
196
200
|
|
|
197
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
201
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L146)
|
|
198
202
|
|
|
199
203
|
##### :gear: metadata
|
|
200
204
|
|
|
@@ -204,7 +208,7 @@ Get the Sns metadata (title, description, etc.)
|
|
|
204
208
|
| ---------- | ------------------------------------------------------- |
|
|
205
209
|
| `metadata` | `(params: QueryParams) => Promise<GetMetadataResponse>` |
|
|
206
210
|
|
|
207
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
211
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L154)
|
|
208
212
|
|
|
209
213
|
##### :gear: nervousSystemParameters
|
|
210
214
|
|
|
@@ -214,7 +218,7 @@ Get the Sns nervous system parameters (default followees, max dissolve delay, ma
|
|
|
214
218
|
| ------------------------- | ----------------------------------------------------------- |
|
|
215
219
|
| `nervousSystemParameters` | `(params: QueryParams) => Promise<NervousSystemParameters>` |
|
|
216
220
|
|
|
217
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
221
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L160)
|
|
218
222
|
|
|
219
223
|
##### :gear: getNeuron
|
|
220
224
|
|
|
@@ -224,7 +228,7 @@ Get the neuron of the Sns
|
|
|
224
228
|
| ----------- | ------------------------------------------------- |
|
|
225
229
|
| `getNeuron` | `(params: SnsGetNeuronParams) => Promise<Neuron>` |
|
|
226
230
|
|
|
227
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
231
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L168)
|
|
228
232
|
|
|
229
233
|
##### :gear: queryNeuron
|
|
230
234
|
|
|
@@ -234,7 +238,7 @@ Same as `getNeuron` but returns undefined instead of raising error when not foun
|
|
|
234
238
|
| ------------- | -------------------------------------------------------------- |
|
|
235
239
|
| `queryNeuron` | `(params: SnsGetNeuronParams) => Promise<Neuron or undefined>` |
|
|
236
240
|
|
|
237
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
241
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L186)
|
|
238
242
|
|
|
239
243
|
##### :gear: manageNeuron
|
|
240
244
|
|
|
@@ -244,7 +248,7 @@ Manage neuron. For advanced users.
|
|
|
244
248
|
| -------------- | ---------------------------------------------------------- |
|
|
245
249
|
| `manageNeuron` | `(request: ManageNeuron) => Promise<ManageNeuronResponse>` |
|
|
246
250
|
|
|
247
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
251
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L206)
|
|
248
252
|
|
|
249
253
|
##### :gear: addNeuronPermissions
|
|
250
254
|
|
|
@@ -254,7 +258,7 @@ Add permissions to a neuron for a specific principal
|
|
|
254
258
|
| ---------------------- | ------------------------------------------------------- |
|
|
255
259
|
| `addNeuronPermissions` | `(params: SnsNeuronPermissionsParams) => Promise<void>` |
|
|
256
260
|
|
|
257
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
261
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L219)
|
|
258
262
|
|
|
259
263
|
##### :gear: removeNeuronPermissions
|
|
260
264
|
|
|
@@ -264,7 +268,7 @@ Remove permissions to a neuron for a specific principal
|
|
|
264
268
|
| ------------------------- | ------------------------------------------------------- |
|
|
265
269
|
| `removeNeuronPermissions` | `(params: SnsNeuronPermissionsParams) => Promise<void>` |
|
|
266
270
|
|
|
267
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
271
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L229)
|
|
268
272
|
|
|
269
273
|
##### :gear: splitNeuron
|
|
270
274
|
|
|
@@ -274,7 +278,7 @@ Split neuron
|
|
|
274
278
|
| ------------- | ------------------------------------------------------------------ |
|
|
275
279
|
| `splitNeuron` | `(params: SnsSplitNeuronParams) => Promise<NeuronId or undefined>` |
|
|
276
280
|
|
|
277
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
281
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L239)
|
|
278
282
|
|
|
279
283
|
##### :gear: disburse
|
|
280
284
|
|
|
@@ -284,7 +288,7 @@ Disburse neuron on Account
|
|
|
284
288
|
| ---------- | ---------------------------------------------------- |
|
|
285
289
|
| `disburse` | `(params: SnsDisburseNeuronParams) => Promise<void>` |
|
|
286
290
|
|
|
287
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
291
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L270)
|
|
288
292
|
|
|
289
293
|
##### :gear: startDissolving
|
|
290
294
|
|
|
@@ -294,7 +298,7 @@ Start dissolving process of a neuron
|
|
|
294
298
|
| ----------------- | --------------------------------------- |
|
|
295
299
|
| `startDissolving` | `(neuronId: NeuronId) => Promise<void>` |
|
|
296
300
|
|
|
297
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
301
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L278)
|
|
298
302
|
|
|
299
303
|
##### :gear: stopDissolving
|
|
300
304
|
|
|
@@ -304,7 +308,7 @@ Stop dissolving process of a neuron
|
|
|
304
308
|
| ---------------- | --------------------------------------- |
|
|
305
309
|
| `stopDissolving` | `(neuronId: NeuronId) => Promise<void>` |
|
|
306
310
|
|
|
307
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
311
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L286)
|
|
308
312
|
|
|
309
313
|
##### :gear: stakeMaturity
|
|
310
314
|
|
|
@@ -319,7 +323,7 @@ Parameters:
|
|
|
319
323
|
- `neuronId`: The id of the neuron for which to stake the maturity
|
|
320
324
|
- `percentageToStake`: Optional. Percentage of the current maturity to stake. If not provided, all of the neuron's current maturity will be staked.
|
|
321
325
|
|
|
322
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
326
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L298)
|
|
323
327
|
|
|
324
328
|
##### :gear: disburseMaturity
|
|
325
329
|
|
|
@@ -335,7 +339,7 @@ Parameters:
|
|
|
335
339
|
- `neuronId`: The id of the neuron for which to disburse the maturity
|
|
336
340
|
- `percentageToDisburse`: What percentage of the available maturity to disburse.
|
|
337
341
|
|
|
338
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
342
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L319)
|
|
339
343
|
|
|
340
344
|
##### :gear: autoStakeMaturity
|
|
341
345
|
|
|
@@ -350,7 +354,7 @@ Parameters:
|
|
|
350
354
|
- `neuronId`: The id of the neuron for which to request a change of the auto stake feature
|
|
351
355
|
- `autoStake`: `true` to enable the auto-stake maturity for this neuron, `false` to turn it off
|
|
352
356
|
|
|
353
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
357
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L335)
|
|
354
358
|
|
|
355
359
|
##### :gear: setDissolveTimestamp
|
|
356
360
|
|
|
@@ -360,7 +364,7 @@ Increase dissolve delay of a neuron
|
|
|
360
364
|
| ---------------------- | ---------------------------------------------------------- |
|
|
361
365
|
| `setDissolveTimestamp` | `(params: SnsSetDissolveTimestampParams) => Promise<void>` |
|
|
362
366
|
|
|
363
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
367
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L345)
|
|
364
368
|
|
|
365
369
|
##### :gear: increaseDissolveDelay
|
|
366
370
|
|
|
@@ -370,17 +374,27 @@ Increase dissolve delay of a neuron
|
|
|
370
374
|
| ----------------------- | ----------------------------------------------------------- |
|
|
371
375
|
| `increaseDissolveDelay` | `(params: SnsIncreaseDissolveDelayParams) => Promise<void>` |
|
|
372
376
|
|
|
373
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
377
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L355)
|
|
374
378
|
|
|
375
379
|
##### :gear: setTopicFollowees
|
|
376
380
|
|
|
377
|
-
Sets followees of a neuron for a specific Nervous System Function
|
|
381
|
+
Sets followees of a neuron for a specific Nervous System Function
|
|
378
382
|
|
|
379
383
|
| Method | Type |
|
|
380
384
|
| ------------------- | ------------------------------------------------- |
|
|
381
385
|
| `setTopicFollowees` | `(params: SnsSetTopicFollowees) => Promise<void>` |
|
|
382
386
|
|
|
383
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
387
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L366)
|
|
388
|
+
|
|
389
|
+
##### :gear: setFollowing
|
|
390
|
+
|
|
391
|
+
Sets followees of a neuron for topics
|
|
392
|
+
|
|
393
|
+
| Method | Type |
|
|
394
|
+
| -------------- | -------------------------------------------------- |
|
|
395
|
+
| `setFollowing` | `(params: SnsSetFollowingParams) => Promise<void>` |
|
|
396
|
+
|
|
397
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L374)
|
|
384
398
|
|
|
385
399
|
##### :gear: registerVote
|
|
386
400
|
|
|
@@ -390,7 +404,7 @@ Registers vote for a proposal from the neuron passed.
|
|
|
390
404
|
| -------------- | -------------------------------------------------- |
|
|
391
405
|
| `registerVote` | `(params: SnsRegisterVoteParams) => Promise<void>` |
|
|
392
406
|
|
|
393
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
407
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L382)
|
|
394
408
|
|
|
395
409
|
##### :gear: refreshNeuron
|
|
396
410
|
|
|
@@ -400,7 +414,7 @@ Refresh neuron
|
|
|
400
414
|
| --------------- | --------------------------------------- |
|
|
401
415
|
| `refreshNeuron` | `(neuronId: NeuronId) => Promise<void>` |
|
|
402
416
|
|
|
403
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
417
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L390)
|
|
404
418
|
|
|
405
419
|
##### :gear: claimNeuron
|
|
406
420
|
|
|
@@ -410,16 +424,15 @@ Claim neuron
|
|
|
410
424
|
| ------------- | -------------------------------------------------------------------------------- |
|
|
411
425
|
| `claimNeuron` | `({ memo, controller, subaccount, }: SnsClaimNeuronParams) => Promise<NeuronId>` |
|
|
412
426
|
|
|
413
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#
|
|
427
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/governance.canister.ts#L400)
|
|
414
428
|
|
|
415
429
|
### :factory: SnsRootCanister
|
|
416
430
|
|
|
417
431
|
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/root.canister.ts#L10)
|
|
418
432
|
|
|
419
|
-
#### Methods
|
|
433
|
+
#### Static Methods
|
|
420
434
|
|
|
421
435
|
- [create](#gear-create)
|
|
422
|
-
- [listSnsCanisters](#gear-listsnscanisters)
|
|
423
436
|
|
|
424
437
|
##### :gear: create
|
|
425
438
|
|
|
@@ -429,6 +442,10 @@ Claim neuron
|
|
|
429
442
|
|
|
430
443
|
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/root.canister.ts#L11)
|
|
431
444
|
|
|
445
|
+
#### Methods
|
|
446
|
+
|
|
447
|
+
- [listSnsCanisters](#gear-listsnscanisters)
|
|
448
|
+
|
|
432
449
|
##### :gear: listSnsCanisters
|
|
433
450
|
|
|
434
451
|
List the canisters that are part of the Sns.
|
|
@@ -449,9 +466,20 @@ Parameters:
|
|
|
449
466
|
|
|
450
467
|
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L33)
|
|
451
468
|
|
|
452
|
-
#### Methods
|
|
469
|
+
#### Static Methods
|
|
453
470
|
|
|
454
471
|
- [create](#gear-create)
|
|
472
|
+
|
|
473
|
+
##### :gear: create
|
|
474
|
+
|
|
475
|
+
| Method | Type |
|
|
476
|
+
| -------- | ------------------------------------------------------------ |
|
|
477
|
+
| `create` | `(options: SnsCanisterOptions<_SERVICE>) => SnsSwapCanister` |
|
|
478
|
+
|
|
479
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L34)
|
|
480
|
+
|
|
481
|
+
#### Methods
|
|
482
|
+
|
|
455
483
|
- [state](#gear-state)
|
|
456
484
|
- [notifyPaymentFailure](#gear-notifypaymentfailure)
|
|
457
485
|
- [notifyParticipation](#gear-notifyparticipation)
|
|
@@ -463,14 +491,6 @@ Parameters:
|
|
|
463
491
|
- [getLifecycle](#gear-getlifecycle)
|
|
464
492
|
- [getFinalizationStatus](#gear-getfinalizationstatus)
|
|
465
493
|
|
|
466
|
-
##### :gear: create
|
|
467
|
-
|
|
468
|
-
| Method | Type |
|
|
469
|
-
| -------- | ------------------------------------------------------------ |
|
|
470
|
-
| `create` | `(options: SnsCanisterOptions<_SERVICE>) => SnsSwapCanister` |
|
|
471
|
-
|
|
472
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/swap.canister.ts#L34)
|
|
473
|
-
|
|
474
494
|
##### :gear: state
|
|
475
495
|
|
|
476
496
|
Get the state of the swap
|
|
@@ -577,7 +597,7 @@ Sns wrapper - notably used by NNS-dapp - ease the access to a particular Sns.
|
|
|
577
597
|
It knows all the Sns' canisters, wrap and enhance their available features.
|
|
578
598
|
A wrapper either performs query or update calls.
|
|
579
599
|
|
|
580
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
600
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L86)
|
|
581
601
|
|
|
582
602
|
#### Constructors
|
|
583
603
|
|
|
@@ -617,6 +637,7 @@ Parameters:
|
|
|
617
637
|
- [setDissolveTimestamp](#gear-setdissolvetimestamp)
|
|
618
638
|
- [increaseDissolveDelay](#gear-increasedissolvedelay)
|
|
619
639
|
- [setTopicFollowees](#gear-settopicfollowees)
|
|
640
|
+
- [setFollowing](#gear-setfollowing)
|
|
620
641
|
- [registerVote](#gear-registervote)
|
|
621
642
|
- [swapState](#gear-swapstate)
|
|
622
643
|
- [notifyPaymentFailure](#gear-notifypaymentfailure)
|
|
@@ -639,7 +660,7 @@ Parameters:
|
|
|
639
660
|
| ------------- | ------------------------------------------------------------------------ |
|
|
640
661
|
| `listNeurons` | `(params: Omit<SnsListNeuronsParams, "certified">) => Promise<Neuron[]>` |
|
|
641
662
|
|
|
642
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
663
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L132)
|
|
643
664
|
|
|
644
665
|
##### :gear: listProposals
|
|
645
666
|
|
|
@@ -647,7 +668,7 @@ Parameters:
|
|
|
647
668
|
| --------------- | --------------------------------------------------------------------------------------- |
|
|
648
669
|
| `listProposals` | `(params: Omit<SnsListProposalsParams, "certified">) => Promise<ListProposalsResponse>` |
|
|
649
670
|
|
|
650
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
671
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L136)
|
|
651
672
|
|
|
652
673
|
##### :gear: getProposal
|
|
653
674
|
|
|
@@ -655,7 +676,7 @@ Parameters:
|
|
|
655
676
|
| ------------- | ---------------------------------------------------------------------------- |
|
|
656
677
|
| `getProposal` | `(params: Omit<SnsGetProposalParams, "certified">) => Promise<ProposalData>` |
|
|
657
678
|
|
|
658
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
679
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L141)
|
|
659
680
|
|
|
660
681
|
##### :gear: listNervousSystemFunctions
|
|
661
682
|
|
|
@@ -663,7 +684,7 @@ Parameters:
|
|
|
663
684
|
| ---------------------------- | ----------------------------------------------------------------------------------------- |
|
|
664
685
|
| `listNervousSystemFunctions` | `(params: Omit<QueryParams, "certified">) => Promise<ListNervousSystemFunctionsResponse>` |
|
|
665
686
|
|
|
666
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
687
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L146)
|
|
667
688
|
|
|
668
689
|
##### :gear: metadata
|
|
669
690
|
|
|
@@ -671,7 +692,7 @@ Parameters:
|
|
|
671
692
|
| ---------- | ------------------------------------------------------------------------------------------------------- |
|
|
672
693
|
| `metadata` | `(params: Omit<QueryParams, "certified">) => Promise<[GetMetadataResponse, IcrcTokenMetadataResponse]>` |
|
|
673
694
|
|
|
674
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
695
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L151)
|
|
675
696
|
|
|
676
697
|
##### :gear: nervousSystemParameters
|
|
677
698
|
|
|
@@ -679,7 +700,7 @@ Parameters:
|
|
|
679
700
|
| ------------------------- | ------------------------------------------------------------------------------ |
|
|
680
701
|
| `nervousSystemParameters` | `(params: Omit<QueryParams, "certified">) => Promise<NervousSystemParameters>` |
|
|
681
702
|
|
|
682
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
703
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L159)
|
|
683
704
|
|
|
684
705
|
##### :gear: ledgerMetadata
|
|
685
706
|
|
|
@@ -687,7 +708,7 @@ Parameters:
|
|
|
687
708
|
| ---------------- | -------------------------------------------------------------------------------- |
|
|
688
709
|
| `ledgerMetadata` | `(params: Omit<QueryParams, "certified">) => Promise<IcrcTokenMetadataResponse>` |
|
|
689
710
|
|
|
690
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
711
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L164)
|
|
691
712
|
|
|
692
713
|
##### :gear: transactionFee
|
|
693
714
|
|
|
@@ -695,7 +716,7 @@ Parameters:
|
|
|
695
716
|
| ---------------- | ------------------------------------------------------------- |
|
|
696
717
|
| `transactionFee` | `(params: Omit<QueryParams, "certified">) => Promise<bigint>` |
|
|
697
718
|
|
|
698
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
719
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L169)
|
|
699
720
|
|
|
700
721
|
##### :gear: totalTokensSupply
|
|
701
722
|
|
|
@@ -703,7 +724,7 @@ Parameters:
|
|
|
703
724
|
| ------------------- | ------------------------------------------------------------- |
|
|
704
725
|
| `totalTokensSupply` | `(params: Omit<QueryParams, "certified">) => Promise<bigint>` |
|
|
705
726
|
|
|
706
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
727
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L174)
|
|
707
728
|
|
|
708
729
|
##### :gear: balance
|
|
709
730
|
|
|
@@ -711,7 +732,7 @@ Parameters:
|
|
|
711
732
|
| --------- | --------------------------------------------------------------- |
|
|
712
733
|
| `balance` | `(params: Omit<BalanceParams, "certified">) => Promise<bigint>` |
|
|
713
734
|
|
|
714
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
735
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L179)
|
|
715
736
|
|
|
716
737
|
##### :gear: transfer
|
|
717
738
|
|
|
@@ -719,7 +740,7 @@ Parameters:
|
|
|
719
740
|
| ---------- | --------------------------------------------- |
|
|
720
741
|
| `transfer` | `(params: TransferParams) => Promise<bigint>` |
|
|
721
742
|
|
|
722
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
743
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L183)
|
|
723
744
|
|
|
724
745
|
##### :gear: getNeuron
|
|
725
746
|
|
|
@@ -727,7 +748,7 @@ Parameters:
|
|
|
727
748
|
| ----------- | -------------------------------------------------------------------- |
|
|
728
749
|
| `getNeuron` | `(params: Omit<SnsGetNeuronParams, "certified">) => Promise<Neuron>` |
|
|
729
750
|
|
|
730
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
751
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L186)
|
|
731
752
|
|
|
732
753
|
##### :gear: queryNeuron
|
|
733
754
|
|
|
@@ -735,7 +756,7 @@ Parameters:
|
|
|
735
756
|
| ------------- | --------------------------------------------------------------------------------- |
|
|
736
757
|
| `queryNeuron` | `(params: Omit<SnsGetNeuronParams, "certified">) => Promise<Neuron or undefined>` |
|
|
737
758
|
|
|
738
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
759
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L190)
|
|
739
760
|
|
|
740
761
|
##### :gear: nextNeuronAccount
|
|
741
762
|
|
|
@@ -755,7 +776,7 @@ This is how the backend can identify which neuron is being claimed.
|
|
|
755
776
|
| ------------------- | ------------------------------------------------------------------------------ |
|
|
756
777
|
| `nextNeuronAccount` | `(controller: Principal) => Promise<{ account: IcrcAccount; index: bigint; }>` |
|
|
757
778
|
|
|
758
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
779
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L211)
|
|
759
780
|
|
|
760
781
|
##### :gear: stakeNeuron
|
|
761
782
|
|
|
@@ -769,7 +790,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
769
790
|
| ------------- | ------------------------------------------------------------------------------------------------ |
|
|
770
791
|
| `stakeNeuron` | `({ stakeE8s, source, controller, createdAt, fee, }: SnsStakeNeuronParams) => Promise<NeuronId>` |
|
|
771
792
|
|
|
772
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
793
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L258)
|
|
773
794
|
|
|
774
795
|
##### :gear: increaseStakeNeuron
|
|
775
796
|
|
|
@@ -783,7 +804,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
783
804
|
| --------------------- | ---------------------------------------------------------------------------------- |
|
|
784
805
|
| `increaseStakeNeuron` | `({ stakeE8s, source, neuronId, }: SnsIncreaseStakeNeuronParams) => Promise<void>` |
|
|
785
806
|
|
|
786
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
807
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L305)
|
|
787
808
|
|
|
788
809
|
##### :gear: getNeuronBalance
|
|
789
810
|
|
|
@@ -791,7 +812,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
791
812
|
| ------------------ | ----------------------------------------- |
|
|
792
813
|
| `getNeuronBalance` | `(neuronId: NeuronId) => Promise<bigint>` |
|
|
793
814
|
|
|
794
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
815
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L324)
|
|
795
816
|
|
|
796
817
|
##### :gear: addNeuronPermissions
|
|
797
818
|
|
|
@@ -799,7 +820,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
799
820
|
| ---------------------- | ------------------------------------------------------- |
|
|
800
821
|
| `addNeuronPermissions` | `(params: SnsNeuronPermissionsParams) => Promise<void>` |
|
|
801
822
|
|
|
802
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
823
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L333)
|
|
803
824
|
|
|
804
825
|
##### :gear: refreshNeuron
|
|
805
826
|
|
|
@@ -807,7 +828,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
807
828
|
| --------------- | --------------------------------------- |
|
|
808
829
|
| `refreshNeuron` | `(neuronId: NeuronId) => Promise<void>` |
|
|
809
830
|
|
|
810
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
831
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L337)
|
|
811
832
|
|
|
812
833
|
##### :gear: claimNeuron
|
|
813
834
|
|
|
@@ -815,7 +836,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
815
836
|
| ------------- | ----------------------------------------------------- |
|
|
816
837
|
| `claimNeuron` | `(params: SnsClaimNeuronParams) => Promise<NeuronId>` |
|
|
817
838
|
|
|
818
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
839
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L341)
|
|
819
840
|
|
|
820
841
|
##### :gear: removeNeuronPermissions
|
|
821
842
|
|
|
@@ -823,7 +844,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
823
844
|
| ------------------------- | ------------------------------------------------------- |
|
|
824
845
|
| `removeNeuronPermissions` | `(params: SnsNeuronPermissionsParams) => Promise<void>` |
|
|
825
846
|
|
|
826
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
847
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L345)
|
|
827
848
|
|
|
828
849
|
##### :gear: splitNeuron
|
|
829
850
|
|
|
@@ -831,7 +852,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
831
852
|
| ------------- | ------------------------------------------------------------------ |
|
|
832
853
|
| `splitNeuron` | `(params: SnsSplitNeuronParams) => Promise<NeuronId or undefined>` |
|
|
833
854
|
|
|
834
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
855
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L350)
|
|
835
856
|
|
|
836
857
|
##### :gear: disburse
|
|
837
858
|
|
|
@@ -839,7 +860,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
839
860
|
| ---------- | ---------------------------------------------------- |
|
|
840
861
|
| `disburse` | `(params: SnsDisburseNeuronParams) => Promise<void>` |
|
|
841
862
|
|
|
842
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
863
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L354)
|
|
843
864
|
|
|
844
865
|
##### :gear: startDissolving
|
|
845
866
|
|
|
@@ -847,7 +868,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
847
868
|
| ----------------- | --------------------------------------- |
|
|
848
869
|
| `startDissolving` | `(neuronId: NeuronId) => Promise<void>` |
|
|
849
870
|
|
|
850
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
871
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L358)
|
|
851
872
|
|
|
852
873
|
##### :gear: stopDissolving
|
|
853
874
|
|
|
@@ -855,7 +876,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
855
876
|
| ---------------- | --------------------------------------- |
|
|
856
877
|
| `stopDissolving` | `(neuronId: NeuronId) => Promise<void>` |
|
|
857
878
|
|
|
858
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
879
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L362)
|
|
859
880
|
|
|
860
881
|
##### :gear: setDissolveTimestamp
|
|
861
882
|
|
|
@@ -863,7 +884,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
863
884
|
| ---------------------- | ---------------------------------------------------------- |
|
|
864
885
|
| `setDissolveTimestamp` | `(params: SnsSetDissolveTimestampParams) => Promise<void>` |
|
|
865
886
|
|
|
866
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
887
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L366)
|
|
867
888
|
|
|
868
889
|
##### :gear: increaseDissolveDelay
|
|
869
890
|
|
|
@@ -871,7 +892,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
871
892
|
| ----------------------- | ----------------------------------------------------------- |
|
|
872
893
|
| `increaseDissolveDelay` | `(params: SnsIncreaseDissolveDelayParams) => Promise<void>` |
|
|
873
894
|
|
|
874
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
895
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L371)
|
|
875
896
|
|
|
876
897
|
##### :gear: setTopicFollowees
|
|
877
898
|
|
|
@@ -879,7 +900,15 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
879
900
|
| ------------------- | ------------------------------------------------- |
|
|
880
901
|
| `setTopicFollowees` | `(params: SnsSetTopicFollowees) => Promise<void>` |
|
|
881
902
|
|
|
882
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
903
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L376)
|
|
904
|
+
|
|
905
|
+
##### :gear: setFollowing
|
|
906
|
+
|
|
907
|
+
| Method | Type |
|
|
908
|
+
| -------------- | -------------------------------------------------- |
|
|
909
|
+
| `setFollowing` | `(params: SnsSetFollowingParams) => Promise<void>` |
|
|
910
|
+
|
|
911
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L380)
|
|
883
912
|
|
|
884
913
|
##### :gear: registerVote
|
|
885
914
|
|
|
@@ -887,7 +916,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
887
916
|
| -------------- | -------------------------------------------------- |
|
|
888
917
|
| `registerVote` | `(params: SnsRegisterVoteParams) => Promise<void>` |
|
|
889
918
|
|
|
890
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
919
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L384)
|
|
891
920
|
|
|
892
921
|
##### :gear: swapState
|
|
893
922
|
|
|
@@ -895,7 +924,7 @@ This is a convenient method that transfers the stake to the neuron subaccount an
|
|
|
895
924
|
| ----------- | ----------------------------------------------------------------------- |
|
|
896
925
|
| `swapState` | `(params: Omit<QueryParams, "certified">) => Promise<GetStateResponse>` |
|
|
897
926
|
|
|
898
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
927
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L387)
|
|
899
928
|
|
|
900
929
|
##### :gear: notifyPaymentFailure
|
|
901
930
|
|
|
@@ -909,7 +938,7 @@ Always certified
|
|
|
909
938
|
| ---------------------- | ------------------------------------ |
|
|
910
939
|
| `notifyPaymentFailure` | `() => Promise<Ticket or undefined>` |
|
|
911
940
|
|
|
912
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
941
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L400)
|
|
913
942
|
|
|
914
943
|
##### :gear: notifyParticipation
|
|
915
944
|
|
|
@@ -917,7 +946,7 @@ Always certified
|
|
|
917
946
|
| --------------------- | ---------------------------------------------------------------------------- |
|
|
918
947
|
| `notifyParticipation` | `(params: RefreshBuyerTokensRequest) => Promise<RefreshBuyerTokensResponse>` |
|
|
919
948
|
|
|
920
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
949
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L404)
|
|
921
950
|
|
|
922
951
|
##### :gear: getUserCommitment
|
|
923
952
|
|
|
@@ -925,7 +954,7 @@ Always certified
|
|
|
925
954
|
| ------------------- | -------------------------------------------------------------------- |
|
|
926
955
|
| `getUserCommitment` | `(params: GetBuyerStateRequest) => Promise<BuyerState or undefined>` |
|
|
927
956
|
|
|
928
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
957
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L409)
|
|
929
958
|
|
|
930
959
|
##### :gear: getOpenTicket
|
|
931
960
|
|
|
@@ -933,7 +962,7 @@ Always certified
|
|
|
933
962
|
| --------------- | -------------------------------------------------------------------------- |
|
|
934
963
|
| `getOpenTicket` | `(params: Omit<QueryParams, "certified">) => Promise<Ticket or undefined>` |
|
|
935
964
|
|
|
936
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
965
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L414)
|
|
937
966
|
|
|
938
967
|
##### :gear: newSaleTicket
|
|
939
968
|
|
|
@@ -941,7 +970,7 @@ Always certified
|
|
|
941
970
|
| --------------- | -------------------------------------------------- |
|
|
942
971
|
| `newSaleTicket` | `(params: NewSaleTicketParams) => Promise<Ticket>` |
|
|
943
972
|
|
|
944
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
973
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L420)
|
|
945
974
|
|
|
946
975
|
##### :gear: getLifecycle
|
|
947
976
|
|
|
@@ -949,7 +978,7 @@ Always certified
|
|
|
949
978
|
| -------------- | ---------------------------------------------------------------------------------------- |
|
|
950
979
|
| `getLifecycle` | `(params: Omit<QueryParams, "certified">) => Promise<GetLifecycleResponse or undefined>` |
|
|
951
980
|
|
|
952
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
981
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L423)
|
|
953
982
|
|
|
954
983
|
##### :gear: getFinalizationStatus
|
|
955
984
|
|
|
@@ -957,7 +986,7 @@ Always certified
|
|
|
957
986
|
| ----------------------- | ----------------------------------------------------------------------------------------------------- |
|
|
958
987
|
| `getFinalizationStatus` | `(params: Omit<QueryParams, "certified">) => Promise<GetAutoFinalizationStatusResponse or undefined>` |
|
|
959
988
|
|
|
960
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
989
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L428)
|
|
961
990
|
|
|
962
991
|
##### :gear: getSaleParameters
|
|
963
992
|
|
|
@@ -965,7 +994,7 @@ Always certified
|
|
|
965
994
|
| ------------------- | --------------------------------------------------------------------------------------------- |
|
|
966
995
|
| `getSaleParameters` | `(params: Omit<QueryParams, "certified">) => Promise<GetSaleParametersResponse or undefined>` |
|
|
967
996
|
|
|
968
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
997
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L433)
|
|
969
998
|
|
|
970
999
|
##### :gear: getDerivedState
|
|
971
1000
|
|
|
@@ -973,7 +1002,7 @@ Always certified
|
|
|
973
1002
|
| ----------------- | ------------------------------------------------------------------------------------------- |
|
|
974
1003
|
| `getDerivedState` | `(params: Omit<QueryParams, "certified">) => Promise<GetDerivedStateResponse or undefined>` |
|
|
975
1004
|
|
|
976
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
1005
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L438)
|
|
977
1006
|
|
|
978
1007
|
##### :gear: getTransactions
|
|
979
1008
|
|
|
@@ -981,7 +1010,7 @@ Always certified
|
|
|
981
1010
|
| ----------------- | -------------------------------------------------------------------- |
|
|
982
1011
|
| `getTransactions` | `(params: GetAccountTransactionsParams) => Promise<GetTransactions>` |
|
|
983
1012
|
|
|
984
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
1013
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L444)
|
|
985
1014
|
|
|
986
1015
|
##### :gear: stakeMaturity
|
|
987
1016
|
|
|
@@ -989,7 +1018,7 @@ Always certified
|
|
|
989
1018
|
| --------------- | --------------------------------------------------------- |
|
|
990
1019
|
| `stakeMaturity` | `(params: SnsNeuronStakeMaturityParams) => Promise<void>` |
|
|
991
1020
|
|
|
992
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
1021
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L449)
|
|
993
1022
|
|
|
994
1023
|
##### :gear: disburseMaturity
|
|
995
1024
|
|
|
@@ -997,7 +1026,7 @@ Always certified
|
|
|
997
1026
|
| ------------------ | ------------------------------------------------------------ |
|
|
998
1027
|
| `disburseMaturity` | `(params: SnsNeuronDisburseMaturityParams) => Promise<void>` |
|
|
999
1028
|
|
|
1000
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
1029
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L453)
|
|
1001
1030
|
|
|
1002
1031
|
##### :gear: autoStakeMaturity
|
|
1003
1032
|
|
|
@@ -1005,6 +1034,6 @@ Always certified
|
|
|
1005
1034
|
| ------------------- | ------------------------------------------------------------- |
|
|
1006
1035
|
| `autoStakeMaturity` | `(params: SnsNeuronAutoStakeMaturityParams) => Promise<void>` |
|
|
1007
1036
|
|
|
1008
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#
|
|
1037
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/sns/src/sns.wrapper.ts#L457)
|
|
1009
1038
|
|
|
1010
1039
|
<!-- TSDOC_END -->
|