@dfinity/nns 8.0.1 → 8.1.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 +45 -32
- package/dist/candid/genesis_token.did +1 -1
- package/dist/candid/governance.certified.idl.js +23 -0
- package/dist/candid/governance.d.ts +14 -0
- package/dist/candid/governance.did +126 -2
- package/dist/candid/governance.idl.js +23 -0
- package/dist/candid/governance_test.certified.idl.js +23 -0
- package/dist/candid/governance_test.d.ts +14 -0
- package/dist/candid/governance_test.did +50 -2
- package/dist/candid/governance_test.idl.js +23 -0
- package/dist/candid/sns_wasm.did +1 -1
- package/dist/cjs/index.cjs.js +1 -1
- package/dist/cjs/index.cjs.js.map +3 -3
- package/dist/esm/chunk-2ADVJRZS.js +19 -0
- package/dist/esm/chunk-2ADVJRZS.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/types/canisters/governance/request.converters.d.ts +3 -0
- package/dist/types/governance.canister.d.ts +10 -0
- package/dist/types/types/governance_converters.d.ts +14 -0
- package/package.json +3 -3
- package/dist/esm/chunk-XGNDCDDQ.js +0 -19
- package/dist/esm/chunk-XGNDCDDQ.js.map +0 -7
package/README.md
CHANGED
|
@@ -173,7 +173,7 @@ Parameters:
|
|
|
173
173
|
|
|
174
174
|
### :factory: GovernanceCanister
|
|
175
175
|
|
|
176
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
176
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L89)
|
|
177
177
|
|
|
178
178
|
#### Methods
|
|
179
179
|
|
|
@@ -200,6 +200,7 @@ Parameters:
|
|
|
200
200
|
- [registerVote](#gear-registervote)
|
|
201
201
|
- [setFollowees](#gear-setfollowees)
|
|
202
202
|
- [disburse](#gear-disburse)
|
|
203
|
+
- [refreshVotingPower](#gear-refreshvotingpower)
|
|
203
204
|
- [mergeMaturity](#gear-mergematurity)
|
|
204
205
|
- [stakeMaturity](#gear-stakematurity)
|
|
205
206
|
- [spawnNeuron](#gear-spawnneuron)
|
|
@@ -215,7 +216,7 @@ Parameters:
|
|
|
215
216
|
| -------- | ------------------------------------------------------------- |
|
|
216
217
|
| `create` | `(options?: GovernanceCanisterOptions) => GovernanceCanister` |
|
|
217
218
|
|
|
218
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
219
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L104)
|
|
219
220
|
|
|
220
221
|
##### :gear: listNeurons
|
|
221
222
|
|
|
@@ -232,7 +233,7 @@ The backend treats `includeEmptyNeurons` as true if absent.
|
|
|
232
233
|
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
233
234
|
| `listNeurons` | `({ certified, neuronIds, includeEmptyNeurons, includePublicNeurons, }: { certified: boolean; neuronIds?: bigint[] or undefined; includeEmptyNeurons?: boolean or undefined; includePublicNeurons?: boolean or undefined; }) => Promise<NeuronInfo[]>` |
|
|
234
235
|
|
|
235
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
236
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L144)
|
|
236
237
|
|
|
237
238
|
##### :gear: listKnownNeurons
|
|
238
239
|
|
|
@@ -246,7 +247,7 @@ it is fetched using a query call.
|
|
|
246
247
|
| ------------------ | ------------------------------------------------- |
|
|
247
248
|
| `listKnownNeurons` | `(certified?: boolean) => Promise<KnownNeuron[]>` |
|
|
248
249
|
|
|
249
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
250
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L187)
|
|
250
251
|
|
|
251
252
|
##### :gear: getLastestRewardEvent
|
|
252
253
|
|
|
@@ -259,7 +260,7 @@ it's fetched using a query call.
|
|
|
259
260
|
| ----------------------- | ----------------------------------------------- |
|
|
260
261
|
| `getLastestRewardEvent` | `(certified?: boolean) => Promise<RewardEvent>` |
|
|
261
262
|
|
|
262
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
263
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L209)
|
|
263
264
|
|
|
264
265
|
##### :gear: listProposals
|
|
265
266
|
|
|
@@ -278,7 +279,7 @@ Parameters:
|
|
|
278
279
|
- `request`: the options to list the proposals (limit number of results, topics to search for, etc.)
|
|
279
280
|
- `certified`: query or update calls
|
|
280
281
|
|
|
281
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
282
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L225)
|
|
282
283
|
|
|
283
284
|
##### :gear: stakeNeuron
|
|
284
285
|
|
|
@@ -286,7 +287,7 @@ Parameters:
|
|
|
286
287
|
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
287
288
|
| `stakeNeuron` | `({ stake, principal, fromSubAccount, ledgerCanister, createdAt, fee, }: { stake: bigint; principal: Principal; fromSubAccount?: number[] or undefined; ledgerCanister: LedgerCanister; createdAt?: bigint or undefined; fee?: bigint or undefined; }) => Promise<...>` |
|
|
288
289
|
|
|
289
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
290
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L244)
|
|
290
291
|
|
|
291
292
|
##### :gear: increaseDissolveDelay
|
|
292
293
|
|
|
@@ -296,7 +297,7 @@ Increases dissolve delay of a neuron
|
|
|
296
297
|
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
297
298
|
| `increaseDissolveDelay` | `({ neuronId, additionalDissolveDelaySeconds, }: { neuronId: bigint; additionalDissolveDelaySeconds: number; }) => Promise<void>` |
|
|
298
299
|
|
|
299
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
300
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L305)
|
|
300
301
|
|
|
301
302
|
##### :gear: setDissolveDelay
|
|
302
303
|
|
|
@@ -307,7 +308,7 @@ The new date is now + dissolveDelaySeconds.
|
|
|
307
308
|
| ------------------ | ------------------------------------------------------------------------------------------------------------- |
|
|
308
309
|
| `setDissolveDelay` | `({ neuronId, dissolveDelaySeconds, }: { neuronId: bigint; dissolveDelaySeconds: number; }) => Promise<void>` |
|
|
309
310
|
|
|
310
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
311
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L331)
|
|
311
312
|
|
|
312
313
|
##### :gear: startDissolving
|
|
313
314
|
|
|
@@ -317,7 +318,7 @@ Start dissolving process of a neuron
|
|
|
317
318
|
| ----------------- | ------------------------------------- |
|
|
318
319
|
| `startDissolving` | `(neuronId: bigint) => Promise<void>` |
|
|
319
320
|
|
|
320
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
321
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L354)
|
|
321
322
|
|
|
322
323
|
##### :gear: stopDissolving
|
|
323
324
|
|
|
@@ -327,7 +328,7 @@ Stop dissolving process of a neuron
|
|
|
327
328
|
| ---------------- | ------------------------------------- |
|
|
328
329
|
| `stopDissolving` | `(neuronId: bigint) => Promise<void>` |
|
|
329
330
|
|
|
330
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
331
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L368)
|
|
331
332
|
|
|
332
333
|
##### :gear: joinCommunityFund
|
|
333
334
|
|
|
@@ -337,7 +338,7 @@ Neuron joins the community fund
|
|
|
337
338
|
| ------------------- | ------------------------------------- |
|
|
338
339
|
| `joinCommunityFund` | `(neuronId: bigint) => Promise<void>` |
|
|
339
340
|
|
|
340
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
341
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L382)
|
|
341
342
|
|
|
342
343
|
##### :gear: autoStakeMaturity
|
|
343
344
|
|
|
@@ -352,7 +353,7 @@ Parameters:
|
|
|
352
353
|
- `neuronId`: The id of the neuron for which to request a change of the auto stake feature
|
|
353
354
|
- `autoStake`: `true` to enable the auto-stake maturity for this neuron, `false` to turn it off
|
|
354
355
|
|
|
355
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
356
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L400)
|
|
356
357
|
|
|
357
358
|
##### :gear: leaveCommunityFund
|
|
358
359
|
|
|
@@ -362,7 +363,7 @@ Neuron leaves the community fund
|
|
|
362
363
|
| -------------------- | ------------------------------------- |
|
|
363
364
|
| `leaveCommunityFund` | `(neuronId: bigint) => Promise<void>` |
|
|
364
365
|
|
|
365
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
366
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L415)
|
|
366
367
|
|
|
367
368
|
##### :gear: setVisibility
|
|
368
369
|
|
|
@@ -372,7 +373,7 @@ Set visibility of a neuron
|
|
|
372
373
|
| --------------- | ------------------------------------------------------------------- |
|
|
373
374
|
| `setVisibility` | `(neuronId: bigint, visibility: NeuronVisibility) => Promise<void>` |
|
|
374
375
|
|
|
375
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
376
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L429)
|
|
376
377
|
|
|
377
378
|
##### :gear: setNodeProviderAccount
|
|
378
379
|
|
|
@@ -383,7 +384,7 @@ Where the reward is paid to.
|
|
|
383
384
|
| ------------------------ | ---------------------------------------------- |
|
|
384
385
|
| `setNodeProviderAccount` | `(accountIdentifier: string) => Promise<void>` |
|
|
385
386
|
|
|
386
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
387
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L449)
|
|
387
388
|
|
|
388
389
|
##### :gear: mergeNeurons
|
|
389
390
|
|
|
@@ -393,7 +394,7 @@ Merge two neurons
|
|
|
393
394
|
| -------------- | --------------------------------------------------------------------------------- |
|
|
394
395
|
| `mergeNeurons` | `(request: { sourceNeuronId: bigint; targetNeuronId: bigint; }) => Promise<void>` |
|
|
395
396
|
|
|
396
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
397
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L469)
|
|
397
398
|
|
|
398
399
|
##### :gear: simulateMergeNeurons
|
|
399
400
|
|
|
@@ -403,7 +404,7 @@ Simulate merging two neurons
|
|
|
403
404
|
| ---------------------- | --------------------------------------------------------------------------------------- |
|
|
404
405
|
| `simulateMergeNeurons` | `(request: { sourceNeuronId: bigint; targetNeuronId: bigint; }) => Promise<NeuronInfo>` |
|
|
405
406
|
|
|
406
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
407
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L486)
|
|
407
408
|
|
|
408
409
|
##### :gear: splitNeuron
|
|
409
410
|
|
|
@@ -413,7 +414,7 @@ Splits a neuron creating a new one
|
|
|
413
414
|
| ------------- | ----------------------------------------------------------------------------------- |
|
|
414
415
|
| `splitNeuron` | `({ neuronId, amount, }: { neuronId: bigint; amount: bigint; }) => Promise<bigint>` |
|
|
415
416
|
|
|
416
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
417
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L531)
|
|
417
418
|
|
|
418
419
|
##### :gear: getProposal
|
|
419
420
|
|
|
@@ -426,7 +427,7 @@ it is fetched using a query call.
|
|
|
426
427
|
| ------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
|
427
428
|
| `getProposal` | `({ proposalId, certified, }: { proposalId: bigint; certified?: boolean or undefined; }) => Promise<ProposalInfo or undefined>` |
|
|
428
429
|
|
|
429
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
430
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L571)
|
|
430
431
|
|
|
431
432
|
##### :gear: makeProposal
|
|
432
433
|
|
|
@@ -436,7 +437,7 @@ Create new proposal
|
|
|
436
437
|
| -------------- | ---------------------------------------------------------------- |
|
|
437
438
|
| `makeProposal` | `(request: MakeProposalRequest) => Promise<bigint or undefined>` |
|
|
438
439
|
|
|
439
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
440
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L589)
|
|
440
441
|
|
|
441
442
|
##### :gear: registerVote
|
|
442
443
|
|
|
@@ -446,7 +447,7 @@ Registers vote for a proposal from the neuron passed.
|
|
|
446
447
|
| -------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
447
448
|
| `registerVote` | `({ neuronId, vote, proposalId, }: { neuronId: bigint; vote: Vote; proposalId: bigint; }) => Promise<void>` |
|
|
448
449
|
|
|
449
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
450
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L610)
|
|
450
451
|
|
|
451
452
|
##### :gear: setFollowees
|
|
452
453
|
|
|
@@ -456,7 +457,7 @@ Edit neuron followees per topic
|
|
|
456
457
|
| -------------- | ------------------------------------------------- |
|
|
457
458
|
| `setFollowees` | `(followRequest: FollowRequest) => Promise<void>` |
|
|
458
459
|
|
|
459
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
460
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L632)
|
|
460
461
|
|
|
461
462
|
##### :gear: disburse
|
|
462
463
|
|
|
@@ -466,7 +467,19 @@ Disburse neuron on Account
|
|
|
466
467
|
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
467
468
|
| `disburse` | `({ neuronId, toAccountId, amount, }: { neuronId: bigint; toAccountId?: string or undefined; amount?: bigint or undefined; }) => Promise<void>` |
|
|
468
469
|
|
|
469
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
470
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L647)
|
|
471
|
+
|
|
472
|
+
##### :gear: refreshVotingPower
|
|
473
|
+
|
|
474
|
+
Refreshes voting power of a neuron
|
|
475
|
+
(Resets the `votingPowerRefreshedTimestampSeconds`
|
|
476
|
+
parameter of the neuron to the current time).
|
|
477
|
+
|
|
478
|
+
| Method | Type |
|
|
479
|
+
| -------------------- | --------------------------------------------------------- |
|
|
480
|
+
| `refreshVotingPower` | `({ neuronId, }: { neuronId: bigint; }) => Promise<void>` |
|
|
481
|
+
|
|
482
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L683)
|
|
470
483
|
|
|
471
484
|
##### :gear: mergeMaturity
|
|
472
485
|
|
|
@@ -476,7 +489,7 @@ Merge Maturity of a neuron
|
|
|
476
489
|
| --------------- | ------------------------------------------------------------------------------------------------------- |
|
|
477
490
|
| `mergeMaturity` | `({ neuronId, percentageToMerge, }: { neuronId: bigint; percentageToMerge: number; }) => Promise<void>` |
|
|
478
491
|
|
|
479
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
492
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L705)
|
|
480
493
|
|
|
481
494
|
##### :gear: stakeMaturity
|
|
482
495
|
|
|
@@ -491,7 +504,7 @@ Parameters:
|
|
|
491
504
|
- `neuronId`: The id of the neuron for which to stake the maturity
|
|
492
505
|
- `percentageToStake`: Optional. Percentage of the current maturity to stake. If not provided, all of the neuron's current maturity will be staked.
|
|
493
506
|
|
|
494
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
507
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L734)
|
|
495
508
|
|
|
496
509
|
##### :gear: spawnNeuron
|
|
497
510
|
|
|
@@ -501,7 +514,7 @@ Merge Maturity of a neuron
|
|
|
501
514
|
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
502
515
|
| `spawnNeuron` | `({ neuronId, percentageToSpawn, newController, nonce, }: { neuronId: bigint; percentageToSpawn?: number or undefined; newController?: Principal or undefined; nonce?: bigint or undefined; }) => Promise<bigint>` |
|
|
503
516
|
|
|
504
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
517
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L756)
|
|
505
518
|
|
|
506
519
|
##### :gear: addHotkey
|
|
507
520
|
|
|
@@ -511,7 +524,7 @@ Add hotkey to neuron
|
|
|
511
524
|
| ----------- | ------------------------------------------------------------------------------------------ |
|
|
512
525
|
| `addHotkey` | `({ neuronId, principal, }: { neuronId: bigint; principal: Principal; }) => Promise<void>` |
|
|
513
526
|
|
|
514
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
527
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L803)
|
|
515
528
|
|
|
516
529
|
##### :gear: removeHotkey
|
|
517
530
|
|
|
@@ -521,7 +534,7 @@ Remove hotkey to neuron
|
|
|
521
534
|
| -------------- | ------------------------------------------------------------------------------------------ |
|
|
522
535
|
| `removeHotkey` | `({ neuronId, principal, }: { neuronId: bigint; principal: Principal; }) => Promise<void>` |
|
|
523
536
|
|
|
524
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
537
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L823)
|
|
525
538
|
|
|
526
539
|
##### :gear: claimOrRefreshNeuronFromAccount
|
|
527
540
|
|
|
@@ -531,7 +544,7 @@ Gets the NeuronID of a newly created neuron.
|
|
|
531
544
|
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
532
545
|
| `claimOrRefreshNeuronFromAccount` | `({ memo, controller, }: { memo: bigint; controller?: Principal or undefined; }) => Promise<bigint or undefined>` |
|
|
533
546
|
|
|
534
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
547
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L841)
|
|
535
548
|
|
|
536
549
|
##### :gear: claimOrRefreshNeuron
|
|
537
550
|
|
|
@@ -542,7 +555,7 @@ Uses query call only.
|
|
|
542
555
|
| ---------------------- | ------------------------------------------------------------------------ |
|
|
543
556
|
| `claimOrRefreshNeuron` | `(request: ClaimOrRefreshNeuronRequest) => Promise<bigint or undefined>` |
|
|
544
557
|
|
|
545
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
558
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L872)
|
|
546
559
|
|
|
547
560
|
##### :gear: getNeuron
|
|
548
561
|
|
|
@@ -552,7 +565,7 @@ Return the data of the neuron provided as id.
|
|
|
552
565
|
| ----------- | ----------------------------------------------------------------------------------------------------------- |
|
|
553
566
|
| `getNeuron` | `({ certified, neuronId, }: { certified: boolean; neuronId: bigint; }) => Promise<NeuronInfo or undefined>` |
|
|
554
567
|
|
|
555
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
568
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L897)
|
|
556
569
|
|
|
557
570
|
### :factory: SnsWasmCanister
|
|
558
571
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Generated from IC repo commit
|
|
1
|
+
// Generated from IC repo commit 0f35ac817b (2024-12-06) 'rs/nns/gtc/canister/gtc.did' by import-candid
|
|
2
2
|
type AccountState = record {
|
|
3
3
|
authenticated_principal_id : opt principal;
|
|
4
4
|
successfully_transferred_neurons : vec TransferredNeuron;
|
|
@@ -22,6 +22,7 @@ export const idlFactory = ({ IDL }) => {
|
|
|
22
22
|
'topic' : IDL.Int32,
|
|
23
23
|
'followees' : IDL.Vec(NeuronId),
|
|
24
24
|
});
|
|
25
|
+
const RefreshVotingPower = IDL.Record({});
|
|
25
26
|
const ClaimOrRefreshNeuronFromAccount = IDL.Record({
|
|
26
27
|
'controller' : IDL.Opt(IDL.Principal),
|
|
27
28
|
'memo' : IDL.Nat64,
|
|
@@ -86,6 +87,7 @@ export const idlFactory = ({ IDL }) => {
|
|
|
86
87
|
'Spawn' : Spawn,
|
|
87
88
|
'Split' : Split,
|
|
88
89
|
'Follow' : Follow,
|
|
90
|
+
'RefreshVotingPower' : RefreshVotingPower,
|
|
89
91
|
'ClaimOrRefresh' : ClaimOrRefresh,
|
|
90
92
|
'Configure' : Configure,
|
|
91
93
|
'RegisterVote' : RegisterVote,
|
|
@@ -274,6 +276,10 @@ export const idlFactory = ({ IDL }) => {
|
|
|
274
276
|
'use_registry_derived_rewards' : IDL.Opt(IDL.Bool),
|
|
275
277
|
'rewards' : IDL.Vec(RewardNodeProvider),
|
|
276
278
|
});
|
|
279
|
+
const VotingPowerEconomics = IDL.Record({
|
|
280
|
+
'start_reducing_voting_power_after_seconds' : IDL.Opt(IDL.Nat64),
|
|
281
|
+
'clear_following_after_seconds' : IDL.Opt(IDL.Nat64),
|
|
282
|
+
});
|
|
277
283
|
const Decimal = IDL.Record({ 'human_readable' : IDL.Opt(IDL.Text) });
|
|
278
284
|
const NeuronsFundMatchedFundingCurveCoefficients = IDL.Record({
|
|
279
285
|
'contribution_threshold_xdr' : IDL.Opt(Decimal),
|
|
@@ -290,6 +296,7 @@ export const idlFactory = ({ IDL }) => {
|
|
|
290
296
|
});
|
|
291
297
|
const NetworkEconomics = IDL.Record({
|
|
292
298
|
'neuron_minimum_stake_e8s' : IDL.Nat64,
|
|
299
|
+
'voting_power_economics' : IDL.Opt(VotingPowerEconomics),
|
|
293
300
|
'max_proposals_to_keep_per_topic' : IDL.Nat32,
|
|
294
301
|
'neuron_management_fee_per_proposal_e8s' : IDL.Nat64,
|
|
295
302
|
'reject_cost_e8s' : IDL.Nat64,
|
|
@@ -602,9 +609,11 @@ export const idlFactory = ({ IDL }) => {
|
|
|
602
609
|
'recent_ballots' : IDL.Vec(BallotInfo),
|
|
603
610
|
'voting_power_refreshed_timestamp_seconds' : IDL.Opt(IDL.Nat64),
|
|
604
611
|
'kyc_verified' : IDL.Bool,
|
|
612
|
+
'potential_voting_power' : IDL.Opt(IDL.Nat64),
|
|
605
613
|
'neuron_type' : IDL.Opt(IDL.Int32),
|
|
606
614
|
'not_for_profit' : IDL.Bool,
|
|
607
615
|
'maturity_e8s_equivalent' : IDL.Nat64,
|
|
616
|
+
'deciding_voting_power' : IDL.Opt(IDL.Nat64),
|
|
608
617
|
'cached_neuron_stake_e8s' : IDL.Nat64,
|
|
609
618
|
'created_timestamp_seconds' : IDL.Nat64,
|
|
610
619
|
'auto_stake_maturity' : IDL.Opt(IDL.Bool),
|
|
@@ -669,7 +678,9 @@ export const idlFactory = ({ IDL }) => {
|
|
|
669
678
|
'dissolve_delay_seconds' : IDL.Nat64,
|
|
670
679
|
'recent_ballots' : IDL.Vec(BallotInfo),
|
|
671
680
|
'voting_power_refreshed_timestamp_seconds' : IDL.Opt(IDL.Nat64),
|
|
681
|
+
'potential_voting_power' : IDL.Opt(IDL.Nat64),
|
|
672
682
|
'neuron_type' : IDL.Opt(IDL.Int32),
|
|
683
|
+
'deciding_voting_power' : IDL.Opt(IDL.Nat64),
|
|
673
684
|
'created_timestamp_seconds' : IDL.Nat64,
|
|
674
685
|
'state' : IDL.Int32,
|
|
675
686
|
'stake_e8s' : IDL.Nat64,
|
|
@@ -790,6 +801,7 @@ export const idlFactory = ({ IDL }) => {
|
|
|
790
801
|
'Spawn' : Spawn,
|
|
791
802
|
'Split' : Split,
|
|
792
803
|
'Follow' : Follow,
|
|
804
|
+
'RefreshVotingPower' : RefreshVotingPower,
|
|
793
805
|
'ClaimOrRefresh' : ClaimOrRefresh,
|
|
794
806
|
'Configure' : Configure,
|
|
795
807
|
'RegisterVote' : RegisterVote,
|
|
@@ -808,6 +820,7 @@ export const idlFactory = ({ IDL }) => {
|
|
|
808
820
|
})
|
|
809
821
|
);
|
|
810
822
|
const SpawnResponse = IDL.Record({ 'created_neuron_id' : IDL.Opt(NeuronId) });
|
|
823
|
+
const RefreshVotingPowerResponse = IDL.Record({});
|
|
811
824
|
const ClaimOrRefreshResponse = IDL.Record({
|
|
812
825
|
'refreshed_neuron_id' : IDL.Opt(NeuronId),
|
|
813
826
|
});
|
|
@@ -835,6 +848,7 @@ export const idlFactory = ({ IDL }) => {
|
|
|
835
848
|
'Spawn' : SpawnResponse,
|
|
836
849
|
'Split' : SpawnResponse,
|
|
837
850
|
'Follow' : IDL.Record({}),
|
|
851
|
+
'RefreshVotingPower' : RefreshVotingPowerResponse,
|
|
838
852
|
'ClaimOrRefresh' : ClaimOrRefreshResponse,
|
|
839
853
|
'Configure' : IDL.Record({}),
|
|
840
854
|
'RegisterVote' : IDL.Record({}),
|
|
@@ -991,6 +1005,7 @@ export const init = ({ IDL }) => {
|
|
|
991
1005
|
'topic' : IDL.Int32,
|
|
992
1006
|
'followees' : IDL.Vec(NeuronId),
|
|
993
1007
|
});
|
|
1008
|
+
const RefreshVotingPower = IDL.Record({});
|
|
994
1009
|
const ClaimOrRefreshNeuronFromAccount = IDL.Record({
|
|
995
1010
|
'controller' : IDL.Opt(IDL.Principal),
|
|
996
1011
|
'memo' : IDL.Nat64,
|
|
@@ -1055,6 +1070,7 @@ export const init = ({ IDL }) => {
|
|
|
1055
1070
|
'Spawn' : Spawn,
|
|
1056
1071
|
'Split' : Split,
|
|
1057
1072
|
'Follow' : Follow,
|
|
1073
|
+
'RefreshVotingPower' : RefreshVotingPower,
|
|
1058
1074
|
'ClaimOrRefresh' : ClaimOrRefresh,
|
|
1059
1075
|
'Configure' : Configure,
|
|
1060
1076
|
'RegisterVote' : RegisterVote,
|
|
@@ -1243,6 +1259,10 @@ export const init = ({ IDL }) => {
|
|
|
1243
1259
|
'use_registry_derived_rewards' : IDL.Opt(IDL.Bool),
|
|
1244
1260
|
'rewards' : IDL.Vec(RewardNodeProvider),
|
|
1245
1261
|
});
|
|
1262
|
+
const VotingPowerEconomics = IDL.Record({
|
|
1263
|
+
'start_reducing_voting_power_after_seconds' : IDL.Opt(IDL.Nat64),
|
|
1264
|
+
'clear_following_after_seconds' : IDL.Opt(IDL.Nat64),
|
|
1265
|
+
});
|
|
1246
1266
|
const Decimal = IDL.Record({ 'human_readable' : IDL.Opt(IDL.Text) });
|
|
1247
1267
|
const NeuronsFundMatchedFundingCurveCoefficients = IDL.Record({
|
|
1248
1268
|
'contribution_threshold_xdr' : IDL.Opt(Decimal),
|
|
@@ -1259,6 +1279,7 @@ export const init = ({ IDL }) => {
|
|
|
1259
1279
|
});
|
|
1260
1280
|
const NetworkEconomics = IDL.Record({
|
|
1261
1281
|
'neuron_minimum_stake_e8s' : IDL.Nat64,
|
|
1282
|
+
'voting_power_economics' : IDL.Opt(VotingPowerEconomics),
|
|
1262
1283
|
'max_proposals_to_keep_per_topic' : IDL.Nat32,
|
|
1263
1284
|
'neuron_management_fee_per_proposal_e8s' : IDL.Nat64,
|
|
1264
1285
|
'reject_cost_e8s' : IDL.Nat64,
|
|
@@ -1571,9 +1592,11 @@ export const init = ({ IDL }) => {
|
|
|
1571
1592
|
'recent_ballots' : IDL.Vec(BallotInfo),
|
|
1572
1593
|
'voting_power_refreshed_timestamp_seconds' : IDL.Opt(IDL.Nat64),
|
|
1573
1594
|
'kyc_verified' : IDL.Bool,
|
|
1595
|
+
'potential_voting_power' : IDL.Opt(IDL.Nat64),
|
|
1574
1596
|
'neuron_type' : IDL.Opt(IDL.Int32),
|
|
1575
1597
|
'not_for_profit' : IDL.Bool,
|
|
1576
1598
|
'maturity_e8s_equivalent' : IDL.Nat64,
|
|
1599
|
+
'deciding_voting_power' : IDL.Opt(IDL.Nat64),
|
|
1577
1600
|
'cached_neuron_stake_e8s' : IDL.Nat64,
|
|
1578
1601
|
'created_timestamp_seconds' : IDL.Nat64,
|
|
1579
1602
|
'auto_stake_maturity' : IDL.Opt(IDL.Bool),
|
|
@@ -91,6 +91,7 @@ export type Command =
|
|
|
91
91
|
| { Spawn: Spawn }
|
|
92
92
|
| { Split: Split }
|
|
93
93
|
| { Follow: Follow }
|
|
94
|
+
| { RefreshVotingPower: RefreshVotingPower }
|
|
94
95
|
| { ClaimOrRefresh: ClaimOrRefresh }
|
|
95
96
|
| { Configure: Configure }
|
|
96
97
|
| { RegisterVote: RegisterVote }
|
|
@@ -105,6 +106,7 @@ export type Command_1 =
|
|
|
105
106
|
| { Spawn: SpawnResponse }
|
|
106
107
|
| { Split: SpawnResponse }
|
|
107
108
|
| { Follow: {} }
|
|
109
|
+
| { RefreshVotingPower: RefreshVotingPowerResponse }
|
|
108
110
|
| { ClaimOrRefresh: ClaimOrRefreshResponse }
|
|
109
111
|
| { Configure: {} }
|
|
110
112
|
| { RegisterVote: {} }
|
|
@@ -401,6 +403,7 @@ export type ManageNeuronCommandRequest =
|
|
|
401
403
|
| { Spawn: Spawn }
|
|
402
404
|
| { Split: Split }
|
|
403
405
|
| { Follow: Follow }
|
|
406
|
+
| { RefreshVotingPower: RefreshVotingPower }
|
|
404
407
|
| { ClaimOrRefresh: ClaimOrRefresh }
|
|
405
408
|
| { Configure: Configure }
|
|
406
409
|
| { RegisterVote: RegisterVote }
|
|
@@ -457,6 +460,7 @@ export interface Motion {
|
|
|
457
460
|
}
|
|
458
461
|
export interface NetworkEconomics {
|
|
459
462
|
neuron_minimum_stake_e8s: bigint;
|
|
463
|
+
voting_power_economics: [] | [VotingPowerEconomics];
|
|
460
464
|
max_proposals_to_keep_per_topic: number;
|
|
461
465
|
neuron_management_fee_per_proposal_e8s: bigint;
|
|
462
466
|
reject_cost_e8s: bigint;
|
|
@@ -473,9 +477,11 @@ export interface Neuron {
|
|
|
473
477
|
recent_ballots: Array<BallotInfo>;
|
|
474
478
|
voting_power_refreshed_timestamp_seconds: [] | [bigint];
|
|
475
479
|
kyc_verified: boolean;
|
|
480
|
+
potential_voting_power: [] | [bigint];
|
|
476
481
|
neuron_type: [] | [number];
|
|
477
482
|
not_for_profit: boolean;
|
|
478
483
|
maturity_e8s_equivalent: bigint;
|
|
484
|
+
deciding_voting_power: [] | [bigint];
|
|
479
485
|
cached_neuron_stake_e8s: bigint;
|
|
480
486
|
created_timestamp_seconds: bigint;
|
|
481
487
|
auto_stake_maturity: [] | [boolean];
|
|
@@ -520,7 +526,9 @@ export interface NeuronInfo {
|
|
|
520
526
|
dissolve_delay_seconds: bigint;
|
|
521
527
|
recent_ballots: Array<BallotInfo>;
|
|
522
528
|
voting_power_refreshed_timestamp_seconds: [] | [bigint];
|
|
529
|
+
potential_voting_power: [] | [bigint];
|
|
523
530
|
neuron_type: [] | [number];
|
|
531
|
+
deciding_voting_power: [] | [bigint];
|
|
524
532
|
created_timestamp_seconds: bigint;
|
|
525
533
|
state: number;
|
|
526
534
|
stake_e8s: bigint;
|
|
@@ -716,6 +724,8 @@ export interface ProposalInfo {
|
|
|
716
724
|
proposer: [] | [NeuronId];
|
|
717
725
|
executed_timestamp_seconds: bigint;
|
|
718
726
|
}
|
|
727
|
+
export type RefreshVotingPower = {};
|
|
728
|
+
export type RefreshVotingPowerResponse = {};
|
|
719
729
|
export interface RegisterVote {
|
|
720
730
|
vote: number;
|
|
721
731
|
proposal: [] | [ProposalId];
|
|
@@ -881,6 +891,10 @@ export interface UpdateCanisterSettings {
|
|
|
881
891
|
export interface UpdateNodeProvider {
|
|
882
892
|
reward_account: [] | [AccountIdentifier];
|
|
883
893
|
}
|
|
894
|
+
export interface VotingPowerEconomics {
|
|
895
|
+
start_reducing_voting_power_after_seconds: [] | [bigint];
|
|
896
|
+
clear_following_after_seconds: [] | [bigint];
|
|
897
|
+
}
|
|
884
898
|
export interface VotingRewardParameters {
|
|
885
899
|
reward_rate_transition_duration: [] | [Duration];
|
|
886
900
|
initial_reward_rate: [] | [Percentage];
|