@dfinity/nns 8.2.1 → 8.2.2-next-2025-02-10
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 +38 -38
- package/dist/candid/genesis_token.did +1 -1
- package/dist/candid/governance.certified.idl.js +5 -0
- package/dist/candid/governance.d.ts +7 -0
- package/dist/candid/governance.did +57 -6
- package/dist/candid/governance.idl.js +5 -0
- package/dist/candid/governance_test.certified.idl.js +5 -0
- package/dist/candid/governance_test.d.ts +7 -0
- package/dist/candid/governance_test.did +9 -1
- package/dist/candid/governance_test.idl.js +5 -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-F7TL6GWF.js +19 -0
- package/dist/esm/chunk-F7TL6GWF.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 -2
- package/dist/types/governance.canister.d.ts +4 -3
- package/package.json +7 -7
- package/dist/esm/chunk-IFLPNY6Z.js +0 -19
- package/dist/esm/chunk-IFLPNY6Z.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#L92)
|
|
177
177
|
|
|
178
178
|
#### Methods
|
|
179
179
|
|
|
@@ -217,7 +217,7 @@ Parameters:
|
|
|
217
217
|
| -------- | ------------------------------------------------------------- |
|
|
218
218
|
| `create` | `(options?: GovernanceCanisterOptions) => GovernanceCanister` |
|
|
219
219
|
|
|
220
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
220
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L107)
|
|
221
221
|
|
|
222
222
|
##### :gear: listNeurons
|
|
223
223
|
|
|
@@ -228,13 +228,13 @@ If an array of neuron IDs is provided, precisely those neurons will be fetched.
|
|
|
228
228
|
If `certified` is true, the request is fetched as an update call, otherwise
|
|
229
229
|
it is fetched using a query call.
|
|
230
230
|
|
|
231
|
-
The backend treats `includeEmptyNeurons` as
|
|
231
|
+
The backend treats `includeEmptyNeurons` as false if absent.
|
|
232
232
|
|
|
233
|
-
| Method | Type
|
|
234
|
-
| ------------- |
|
|
235
|
-
| `listNeurons` | `({ certified, neuronIds, includeEmptyNeurons, includePublicNeurons, }: { certified: boolean; neuronIds?: bigint[] or undefined; includeEmptyNeurons?: boolean or undefined; includePublicNeurons?: boolean or undefined; }) => Promise
|
|
233
|
+
| Method | Type |
|
|
234
|
+
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
235
|
+
| `listNeurons` | `({ certified, neuronIds, includeEmptyNeurons, includePublicNeurons, neuronSubaccounts, }: { certified: boolean; neuronIds?: bigint[] or undefined; includeEmptyNeurons?: boolean or undefined; includePublicNeurons?: boolean or undefined; neuronSubaccounts?: NeuronSubaccount[] or undefined; }) => Promise<...>` |
|
|
236
236
|
|
|
237
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
237
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L147)
|
|
238
238
|
|
|
239
239
|
##### :gear: listKnownNeurons
|
|
240
240
|
|
|
@@ -248,7 +248,7 @@ it is fetched using a query call.
|
|
|
248
248
|
| ------------------ | ------------------------------------------------- |
|
|
249
249
|
| `listKnownNeurons` | `(certified?: boolean) => Promise<KnownNeuron[]>` |
|
|
250
250
|
|
|
251
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
251
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L193)
|
|
252
252
|
|
|
253
253
|
##### :gear: getLastestRewardEvent
|
|
254
254
|
|
|
@@ -261,7 +261,7 @@ it's fetched using a query call.
|
|
|
261
261
|
| ----------------------- | ----------------------------------------------- |
|
|
262
262
|
| `getLastestRewardEvent` | `(certified?: boolean) => Promise<RewardEvent>` |
|
|
263
263
|
|
|
264
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
264
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L215)
|
|
265
265
|
|
|
266
266
|
##### :gear: listProposals
|
|
267
267
|
|
|
@@ -280,7 +280,7 @@ Parameters:
|
|
|
280
280
|
- `request`: the options to list the proposals (limit number of results, topics to search for, etc.)
|
|
281
281
|
- `certified`: query or update calls
|
|
282
282
|
|
|
283
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
283
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L231)
|
|
284
284
|
|
|
285
285
|
##### :gear: stakeNeuron
|
|
286
286
|
|
|
@@ -288,7 +288,7 @@ Parameters:
|
|
|
288
288
|
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
289
289
|
| `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<...>` |
|
|
290
290
|
|
|
291
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
291
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L250)
|
|
292
292
|
|
|
293
293
|
##### :gear: increaseDissolveDelay
|
|
294
294
|
|
|
@@ -298,7 +298,7 @@ Increases dissolve delay of a neuron
|
|
|
298
298
|
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
299
299
|
| `increaseDissolveDelay` | `({ neuronId, additionalDissolveDelaySeconds, }: { neuronId: bigint; additionalDissolveDelaySeconds: number; }) => Promise<void>` |
|
|
300
300
|
|
|
301
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
301
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L311)
|
|
302
302
|
|
|
303
303
|
##### :gear: setDissolveDelay
|
|
304
304
|
|
|
@@ -309,7 +309,7 @@ The new date is now + dissolveDelaySeconds.
|
|
|
309
309
|
| ------------------ | ------------------------------------------------------------------------------------------------------------- |
|
|
310
310
|
| `setDissolveDelay` | `({ neuronId, dissolveDelaySeconds, }: { neuronId: bigint; dissolveDelaySeconds: number; }) => Promise<void>` |
|
|
311
311
|
|
|
312
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
312
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L337)
|
|
313
313
|
|
|
314
314
|
##### :gear: startDissolving
|
|
315
315
|
|
|
@@ -319,7 +319,7 @@ Start dissolving process of a neuron
|
|
|
319
319
|
| ----------------- | ------------------------------------- |
|
|
320
320
|
| `startDissolving` | `(neuronId: bigint) => Promise<void>` |
|
|
321
321
|
|
|
322
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
322
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L360)
|
|
323
323
|
|
|
324
324
|
##### :gear: stopDissolving
|
|
325
325
|
|
|
@@ -329,7 +329,7 @@ Stop dissolving process of a neuron
|
|
|
329
329
|
| ---------------- | ------------------------------------- |
|
|
330
330
|
| `stopDissolving` | `(neuronId: bigint) => Promise<void>` |
|
|
331
331
|
|
|
332
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
332
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L374)
|
|
333
333
|
|
|
334
334
|
##### :gear: joinCommunityFund
|
|
335
335
|
|
|
@@ -339,7 +339,7 @@ Neuron joins the community fund
|
|
|
339
339
|
| ------------------- | ------------------------------------- |
|
|
340
340
|
| `joinCommunityFund` | `(neuronId: bigint) => Promise<void>` |
|
|
341
341
|
|
|
342
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
342
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L388)
|
|
343
343
|
|
|
344
344
|
##### :gear: autoStakeMaturity
|
|
345
345
|
|
|
@@ -354,7 +354,7 @@ Parameters:
|
|
|
354
354
|
- `neuronId`: The id of the neuron for which to request a change of the auto stake feature
|
|
355
355
|
- `autoStake`: `true` to enable the auto-stake maturity for this neuron, `false` to turn it off
|
|
356
356
|
|
|
357
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
357
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L406)
|
|
358
358
|
|
|
359
359
|
##### :gear: leaveCommunityFund
|
|
360
360
|
|
|
@@ -364,7 +364,7 @@ Neuron leaves the community fund
|
|
|
364
364
|
| -------------------- | ------------------------------------- |
|
|
365
365
|
| `leaveCommunityFund` | `(neuronId: bigint) => Promise<void>` |
|
|
366
366
|
|
|
367
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
367
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L421)
|
|
368
368
|
|
|
369
369
|
##### :gear: setVisibility
|
|
370
370
|
|
|
@@ -374,7 +374,7 @@ Set visibility of a neuron
|
|
|
374
374
|
| --------------- | ------------------------------------------------------------------- |
|
|
375
375
|
| `setVisibility` | `(neuronId: bigint, visibility: NeuronVisibility) => Promise<void>` |
|
|
376
376
|
|
|
377
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
377
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L435)
|
|
378
378
|
|
|
379
379
|
##### :gear: setNodeProviderAccount
|
|
380
380
|
|
|
@@ -385,7 +385,7 @@ Where the reward is paid to.
|
|
|
385
385
|
| ------------------------ | ---------------------------------------------- |
|
|
386
386
|
| `setNodeProviderAccount` | `(accountIdentifier: string) => Promise<void>` |
|
|
387
387
|
|
|
388
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
388
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L455)
|
|
389
389
|
|
|
390
390
|
##### :gear: mergeNeurons
|
|
391
391
|
|
|
@@ -395,7 +395,7 @@ Merge two neurons
|
|
|
395
395
|
| -------------- | --------------------------------------------------------------------------------- |
|
|
396
396
|
| `mergeNeurons` | `(request: { sourceNeuronId: bigint; targetNeuronId: bigint; }) => Promise<void>` |
|
|
397
397
|
|
|
398
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
398
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L475)
|
|
399
399
|
|
|
400
400
|
##### :gear: simulateMergeNeurons
|
|
401
401
|
|
|
@@ -405,7 +405,7 @@ Simulate merging two neurons
|
|
|
405
405
|
| ---------------------- | --------------------------------------------------------------------------------------- |
|
|
406
406
|
| `simulateMergeNeurons` | `(request: { sourceNeuronId: bigint; targetNeuronId: bigint; }) => Promise<NeuronInfo>` |
|
|
407
407
|
|
|
408
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
408
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L492)
|
|
409
409
|
|
|
410
410
|
##### :gear: splitNeuron
|
|
411
411
|
|
|
@@ -415,7 +415,7 @@ Splits a neuron creating a new one
|
|
|
415
415
|
| ------------- | ----------------------------------------------------------------------------------- |
|
|
416
416
|
| `splitNeuron` | `({ neuronId, amount, }: { neuronId: bigint; amount: bigint; }) => Promise<bigint>` |
|
|
417
417
|
|
|
418
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
418
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L537)
|
|
419
419
|
|
|
420
420
|
##### :gear: getProposal
|
|
421
421
|
|
|
@@ -428,7 +428,7 @@ it is fetched using a query call.
|
|
|
428
428
|
| ------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
|
429
429
|
| `getProposal` | `({ proposalId, certified, }: { proposalId: bigint; certified?: boolean or undefined; }) => Promise<ProposalInfo or undefined>` |
|
|
430
430
|
|
|
431
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
431
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L577)
|
|
432
432
|
|
|
433
433
|
##### :gear: makeProposal
|
|
434
434
|
|
|
@@ -438,7 +438,7 @@ Create new proposal
|
|
|
438
438
|
| -------------- | ---------------------------------------------------------------- |
|
|
439
439
|
| `makeProposal` | `(request: MakeProposalRequest) => Promise<bigint or undefined>` |
|
|
440
440
|
|
|
441
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
441
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L595)
|
|
442
442
|
|
|
443
443
|
##### :gear: registerVote
|
|
444
444
|
|
|
@@ -448,7 +448,7 @@ Registers vote for a proposal from the neuron passed.
|
|
|
448
448
|
| -------------- | ----------------------------------------------------------------------------------------------------------- |
|
|
449
449
|
| `registerVote` | `({ neuronId, vote, proposalId, }: { neuronId: bigint; vote: Vote; proposalId: bigint; }) => Promise<void>` |
|
|
450
450
|
|
|
451
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
451
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L616)
|
|
452
452
|
|
|
453
453
|
##### :gear: setFollowees
|
|
454
454
|
|
|
@@ -458,7 +458,7 @@ Edit neuron followees per topic
|
|
|
458
458
|
| -------------- | ------------------------------------------------- |
|
|
459
459
|
| `setFollowees` | `(followRequest: FollowRequest) => Promise<void>` |
|
|
460
460
|
|
|
461
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
461
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L638)
|
|
462
462
|
|
|
463
463
|
##### :gear: disburse
|
|
464
464
|
|
|
@@ -468,7 +468,7 @@ Disburse neuron on Account
|
|
|
468
468
|
| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
469
469
|
| `disburse` | `({ neuronId, toAccountId, amount, }: { neuronId: bigint; toAccountId?: string or undefined; amount?: bigint or undefined; }) => Promise<void>` |
|
|
470
470
|
|
|
471
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
471
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L653)
|
|
472
472
|
|
|
473
473
|
##### :gear: refreshVotingPower
|
|
474
474
|
|
|
@@ -480,7 +480,7 @@ parameter of the neuron to the current time).
|
|
|
480
480
|
| -------------------- | --------------------------------------------------------- |
|
|
481
481
|
| `refreshVotingPower` | `({ neuronId, }: { neuronId: bigint; }) => Promise<void>` |
|
|
482
482
|
|
|
483
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
483
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L689)
|
|
484
484
|
|
|
485
485
|
##### :gear: mergeMaturity
|
|
486
486
|
|
|
@@ -490,7 +490,7 @@ Merge Maturity of a neuron
|
|
|
490
490
|
| --------------- | ------------------------------------------------------------------------------------------------------- |
|
|
491
491
|
| `mergeMaturity` | `({ neuronId, percentageToMerge, }: { neuronId: bigint; percentageToMerge: number; }) => Promise<void>` |
|
|
492
492
|
|
|
493
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
493
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L711)
|
|
494
494
|
|
|
495
495
|
##### :gear: stakeMaturity
|
|
496
496
|
|
|
@@ -505,7 +505,7 @@ Parameters:
|
|
|
505
505
|
- `neuronId`: The id of the neuron for which to stake the maturity
|
|
506
506
|
- `percentageToStake`: Optional. Percentage of the current maturity to stake. If not provided, all of the neuron's current maturity will be staked.
|
|
507
507
|
|
|
508
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
508
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L740)
|
|
509
509
|
|
|
510
510
|
##### :gear: spawnNeuron
|
|
511
511
|
|
|
@@ -515,7 +515,7 @@ Merge Maturity of a neuron
|
|
|
515
515
|
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
516
516
|
| `spawnNeuron` | `({ neuronId, percentageToSpawn, newController, nonce, }: { neuronId: bigint; percentageToSpawn?: number or undefined; newController?: Principal or undefined; nonce?: bigint or undefined; }) => Promise<bigint>` |
|
|
517
517
|
|
|
518
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
518
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L762)
|
|
519
519
|
|
|
520
520
|
##### :gear: addHotkey
|
|
521
521
|
|
|
@@ -525,7 +525,7 @@ Add hotkey to neuron
|
|
|
525
525
|
| ----------- | ------------------------------------------------------------------------------------------ |
|
|
526
526
|
| `addHotkey` | `({ neuronId, principal, }: { neuronId: bigint; principal: Principal; }) => Promise<void>` |
|
|
527
527
|
|
|
528
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
528
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L809)
|
|
529
529
|
|
|
530
530
|
##### :gear: removeHotkey
|
|
531
531
|
|
|
@@ -535,7 +535,7 @@ Remove hotkey to neuron
|
|
|
535
535
|
| -------------- | ------------------------------------------------------------------------------------------ |
|
|
536
536
|
| `removeHotkey` | `({ neuronId, principal, }: { neuronId: bigint; principal: Principal; }) => Promise<void>` |
|
|
537
537
|
|
|
538
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
538
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L829)
|
|
539
539
|
|
|
540
540
|
##### :gear: claimOrRefreshNeuronFromAccount
|
|
541
541
|
|
|
@@ -545,7 +545,7 @@ Gets the NeuronID of a newly created neuron.
|
|
|
545
545
|
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
|
|
546
546
|
| `claimOrRefreshNeuronFromAccount` | `({ memo, controller, }: { memo: bigint; controller?: Principal or undefined; }) => Promise<bigint or undefined>` |
|
|
547
547
|
|
|
548
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
548
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L847)
|
|
549
549
|
|
|
550
550
|
##### :gear: claimOrRefreshNeuron
|
|
551
551
|
|
|
@@ -556,7 +556,7 @@ Uses query call only.
|
|
|
556
556
|
| ---------------------- | ------------------------------------------------------------------------ |
|
|
557
557
|
| `claimOrRefreshNeuron` | `(request: ClaimOrRefreshNeuronRequest) => Promise<bigint or undefined>` |
|
|
558
558
|
|
|
559
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
559
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L878)
|
|
560
560
|
|
|
561
561
|
##### :gear: getNeuron
|
|
562
562
|
|
|
@@ -566,7 +566,7 @@ Return the data of the neuron provided as id.
|
|
|
566
566
|
| ----------- | ----------------------------------------------------------------------------------------------------------- |
|
|
567
567
|
| `getNeuron` | `({ certified, neuronId, }: { certified: boolean; neuronId: bigint; }) => Promise<NeuronInfo or undefined>` |
|
|
568
568
|
|
|
569
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
569
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L903)
|
|
570
570
|
|
|
571
571
|
##### :gear: getNetworkEconomicsParameters
|
|
572
572
|
|
|
@@ -576,7 +576,7 @@ Return the [Network Economics](https://github.com/dfinity/ic/blob/d90e934eb440c7
|
|
|
576
576
|
| ------------------------------- | ------------------------------------------------------------------------ |
|
|
577
577
|
| `getNetworkEconomicsParameters` | `({ certified, }: { certified: boolean; }) => Promise<NetworkEconomics>` |
|
|
578
578
|
|
|
579
|
-
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#
|
|
579
|
+
[:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L924)
|
|
580
580
|
|
|
581
581
|
### :factory: SnsWasmCanister
|
|
582
582
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Generated from IC repo commit
|
|
1
|
+
// Generated from IC repo commit 14c8f44 (2025-02-07 tags: release-2025-02-06_12-26-revert-hashes-in-blocks) '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;
|
|
@@ -745,15 +745,20 @@ export const idlFactory = ({ IDL }) => {
|
|
|
745
745
|
const ListKnownNeuronsResponse = IDL.Record({
|
|
746
746
|
'known_neurons' : IDL.Vec(KnownNeuron),
|
|
747
747
|
});
|
|
748
|
+
const NeuronSubaccount = IDL.Record({ 'subaccount' : IDL.Vec(IDL.Nat8) });
|
|
748
749
|
const ListNeurons = IDL.Record({
|
|
750
|
+
'page_size' : IDL.Opt(IDL.Nat64),
|
|
749
751
|
'include_public_neurons_in_full_neurons' : IDL.Opt(IDL.Bool),
|
|
750
752
|
'neuron_ids' : IDL.Vec(IDL.Nat64),
|
|
753
|
+
'page_number' : IDL.Opt(IDL.Nat64),
|
|
751
754
|
'include_empty_neurons_readable_by_caller' : IDL.Opt(IDL.Bool),
|
|
755
|
+
'neuron_subaccounts' : IDL.Opt(IDL.Vec(NeuronSubaccount)),
|
|
752
756
|
'include_neurons_readable_by_caller' : IDL.Bool,
|
|
753
757
|
});
|
|
754
758
|
const ListNeuronsResponse = IDL.Record({
|
|
755
759
|
'neuron_infos' : IDL.Vec(IDL.Tuple(IDL.Nat64, NeuronInfo)),
|
|
756
760
|
'full_neurons' : IDL.Vec(Neuron),
|
|
761
|
+
'total_pages_available' : IDL.Opt(IDL.Nat64),
|
|
757
762
|
});
|
|
758
763
|
const DateRangeFilter = IDL.Record({
|
|
759
764
|
'start_timestamp_seconds' : IDL.Opt(IDL.Nat64),
|
|
@@ -352,14 +352,18 @@ export interface ListKnownNeuronsResponse {
|
|
|
352
352
|
known_neurons: Array<KnownNeuron>;
|
|
353
353
|
}
|
|
354
354
|
export interface ListNeurons {
|
|
355
|
+
page_size: [] | [bigint];
|
|
355
356
|
include_public_neurons_in_full_neurons: [] | [boolean];
|
|
356
357
|
neuron_ids: BigUint64Array | bigint[];
|
|
358
|
+
page_number: [] | [bigint];
|
|
357
359
|
include_empty_neurons_readable_by_caller: [] | [boolean];
|
|
360
|
+
neuron_subaccounts: [] | [Array<NeuronSubaccount>];
|
|
358
361
|
include_neurons_readable_by_caller: boolean;
|
|
359
362
|
}
|
|
360
363
|
export interface ListNeuronsResponse {
|
|
361
364
|
neuron_infos: Array<[bigint, NeuronInfo]>;
|
|
362
365
|
full_neurons: Array<Neuron>;
|
|
366
|
+
total_pages_available: [] | [bigint];
|
|
363
367
|
}
|
|
364
368
|
export interface ListNodeProviderRewardsRequest {
|
|
365
369
|
date_filter: [] | [DateRangeFilter];
|
|
@@ -551,6 +555,9 @@ export interface NeuronStakeTransfer {
|
|
|
551
555
|
transfer_timestamp: bigint;
|
|
552
556
|
block_height: bigint;
|
|
553
557
|
}
|
|
558
|
+
export interface NeuronSubaccount {
|
|
559
|
+
subaccount: Uint8Array | number[];
|
|
560
|
+
}
|
|
554
561
|
export interface NeuronSubsetMetrics {
|
|
555
562
|
total_maturity_e8s_equivalent: [] | [bigint];
|
|
556
563
|
maturity_e8s_equivalent_buckets: Array<[bigint, bigint]>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Generated from IC repo commit
|
|
1
|
+
// Generated from IC repo commit 14c8f44 (2025-02-07 tags: release-2025-02-06_12-26-revert-hashes-in-blocks) 'rs/nns/governance/canister/governance.did' by import-candid
|
|
2
2
|
type AccountIdentifier = record {
|
|
3
3
|
hash : blob;
|
|
4
4
|
};
|
|
@@ -435,16 +435,43 @@ type ListKnownNeuronsResponse = record {
|
|
|
435
435
|
known_neurons : vec KnownNeuron;
|
|
436
436
|
};
|
|
437
437
|
|
|
438
|
+
// Parameters of the list_neurons method.
|
|
438
439
|
type ListNeurons = record {
|
|
439
|
-
|
|
440
|
+
// These fields select neurons to be in the result set.
|
|
440
441
|
neuron_ids : vec nat64;
|
|
441
|
-
include_empty_neurons_readable_by_caller : opt bool;
|
|
442
442
|
include_neurons_readable_by_caller : bool;
|
|
443
|
+
|
|
444
|
+
// Only has an effect when include_neurons_readable_by_caller.
|
|
445
|
+
include_empty_neurons_readable_by_caller : opt bool;
|
|
446
|
+
|
|
447
|
+
// When a public neuron is a member of the result set, include it in the
|
|
448
|
+
// full_neurons field (of ListNeuronsResponse). This does not affect which
|
|
449
|
+
// neurons are part of the result set.
|
|
450
|
+
include_public_neurons_in_full_neurons : opt bool;
|
|
451
|
+
|
|
452
|
+
page_number: opt nat64;
|
|
453
|
+
page_size: opt nat64;
|
|
454
|
+
neuron_subaccounts: opt vec NeuronSubaccount;
|
|
455
|
+
};
|
|
456
|
+
|
|
457
|
+
type NeuronSubaccount = record {
|
|
458
|
+
subaccount : blob;
|
|
443
459
|
};
|
|
444
460
|
|
|
461
|
+
// Output of the list_neurons method.
|
|
445
462
|
type ListNeuronsResponse = record {
|
|
463
|
+
// Per the NeuronInfo type, this is a redacted view of the neurons in the
|
|
464
|
+
// result set consisting of information that require no special privileges to
|
|
465
|
+
// view.
|
|
446
466
|
neuron_infos : vec record { nat64; NeuronInfo };
|
|
467
|
+
|
|
468
|
+
// If the caller has the necessary special privileges (or the neuron is
|
|
469
|
+
// public, and the request sets include_public_neurons_in_full_neurons to
|
|
470
|
+
// true), then all the information about the neurons in the result set is made
|
|
471
|
+
// available here.
|
|
447
472
|
full_neurons : vec Neuron;
|
|
473
|
+
|
|
474
|
+
total_pages_available: opt nat64;
|
|
448
475
|
};
|
|
449
476
|
|
|
450
477
|
type ListNodeProviderRewardsRequest = record {
|
|
@@ -491,6 +518,8 @@ type MakingSnsProposal = record {
|
|
|
491
518
|
proposer_id : opt NeuronId;
|
|
492
519
|
};
|
|
493
520
|
|
|
521
|
+
// Not to be confused with ManageNeuronRequest. (Yes, this is very structurally
|
|
522
|
+
// similar to that, but not actually exactly equivalent.)
|
|
494
523
|
type ManageNeuron = record {
|
|
495
524
|
id : opt NeuronId;
|
|
496
525
|
command : opt Command;
|
|
@@ -516,13 +545,22 @@ type ManageNeuronCommandRequest = variant {
|
|
|
516
545
|
// KEEP THIS IN SYNC WITH COMMAND!
|
|
517
546
|
};
|
|
518
547
|
|
|
548
|
+
// Parameters of the manage_neuron method.
|
|
519
549
|
type ManageNeuronRequest = record {
|
|
520
|
-
|
|
521
|
-
command : opt ManageNeuronCommandRequest;
|
|
550
|
+
// Which neuron to operate on.
|
|
522
551
|
neuron_id_or_subaccount : opt NeuronIdOrSubaccount;
|
|
552
|
+
|
|
553
|
+
// What operation to perform on the neuron.
|
|
554
|
+
command : opt ManageNeuronCommandRequest;
|
|
555
|
+
|
|
556
|
+
// Deprecated. Use neuron_id_or_subaccount instead.
|
|
557
|
+
id : opt NeuronId;
|
|
523
558
|
};
|
|
524
559
|
|
|
560
|
+
// Output of the manage_neuron method.
|
|
525
561
|
type ManageNeuronResponse = record {
|
|
562
|
+
// Corresponds to the command field in ManageNeuronRequest, which determines
|
|
563
|
+
// what operation was performed.
|
|
526
564
|
command : opt Command_1;
|
|
527
565
|
};
|
|
528
566
|
|
|
@@ -728,14 +766,26 @@ type NeuronInFlightCommand = record {
|
|
|
728
766
|
timestamp : nat64;
|
|
729
767
|
};
|
|
730
768
|
|
|
731
|
-
//
|
|
769
|
+
// A limit view of Neuron that allows some aspects of all neurons to be read by
|
|
770
|
+
// anyone (i.e. without having to be the neuron's controller nor one of its
|
|
771
|
+
// hotkeys).
|
|
772
|
+
//
|
|
773
|
+
// As such, the meaning of each field in this type is generally the same as the
|
|
774
|
+
// one of the same (or at least similar) name in Neuron.
|
|
732
775
|
type NeuronInfo = record {
|
|
733
776
|
dissolve_delay_seconds : nat64;
|
|
734
777
|
recent_ballots : vec BallotInfo;
|
|
735
778
|
neuron_type : opt int32;
|
|
736
779
|
created_timestamp_seconds : nat64;
|
|
737
780
|
state : int32;
|
|
781
|
+
|
|
782
|
+
// The amount of ICP (and staked maturity) locked in this neuron.
|
|
783
|
+
//
|
|
784
|
+
// This is the foundation of the neuron's voting power.
|
|
785
|
+
//
|
|
786
|
+
// cached_neuron_stake_e8s - neuron_fees_e8s + staked_maturity_e8s_equivalent
|
|
738
787
|
stake_e8s : nat64;
|
|
788
|
+
|
|
739
789
|
joined_community_fund_timestamp_seconds : opt nat64;
|
|
740
790
|
retrieved_at_timestamp_seconds : nat64;
|
|
741
791
|
visibility : opt int32;
|
|
@@ -750,6 +800,7 @@ type NeuronInfo = record {
|
|
|
750
800
|
// Now that this is set to deciding_voting_power, this actually does get
|
|
751
801
|
// zeroed out.
|
|
752
802
|
voting_power : nat64;
|
|
803
|
+
|
|
753
804
|
voting_power_refreshed_timestamp_seconds : opt nat64;
|
|
754
805
|
deciding_voting_power : opt nat64;
|
|
755
806
|
potential_voting_power : opt nat64;
|
|
@@ -745,15 +745,20 @@ export const idlFactory = ({ IDL }) => {
|
|
|
745
745
|
const ListKnownNeuronsResponse = IDL.Record({
|
|
746
746
|
'known_neurons' : IDL.Vec(KnownNeuron),
|
|
747
747
|
});
|
|
748
|
+
const NeuronSubaccount = IDL.Record({ 'subaccount' : IDL.Vec(IDL.Nat8) });
|
|
748
749
|
const ListNeurons = IDL.Record({
|
|
750
|
+
'page_size' : IDL.Opt(IDL.Nat64),
|
|
749
751
|
'include_public_neurons_in_full_neurons' : IDL.Opt(IDL.Bool),
|
|
750
752
|
'neuron_ids' : IDL.Vec(IDL.Nat64),
|
|
753
|
+
'page_number' : IDL.Opt(IDL.Nat64),
|
|
751
754
|
'include_empty_neurons_readable_by_caller' : IDL.Opt(IDL.Bool),
|
|
755
|
+
'neuron_subaccounts' : IDL.Opt(IDL.Vec(NeuronSubaccount)),
|
|
752
756
|
'include_neurons_readable_by_caller' : IDL.Bool,
|
|
753
757
|
});
|
|
754
758
|
const ListNeuronsResponse = IDL.Record({
|
|
755
759
|
'neuron_infos' : IDL.Vec(IDL.Tuple(IDL.Nat64, NeuronInfo)),
|
|
756
760
|
'full_neurons' : IDL.Vec(Neuron),
|
|
761
|
+
'total_pages_available' : IDL.Opt(IDL.Nat64),
|
|
757
762
|
});
|
|
758
763
|
const DateRangeFilter = IDL.Record({
|
|
759
764
|
'start_timestamp_seconds' : IDL.Opt(IDL.Nat64),
|
|
@@ -745,15 +745,20 @@ export const idlFactory = ({ IDL }) => {
|
|
|
745
745
|
const ListKnownNeuronsResponse = IDL.Record({
|
|
746
746
|
'known_neurons' : IDL.Vec(KnownNeuron),
|
|
747
747
|
});
|
|
748
|
+
const NeuronSubaccount = IDL.Record({ 'subaccount' : IDL.Vec(IDL.Nat8) });
|
|
748
749
|
const ListNeurons = IDL.Record({
|
|
750
|
+
'page_size' : IDL.Opt(IDL.Nat64),
|
|
749
751
|
'include_public_neurons_in_full_neurons' : IDL.Opt(IDL.Bool),
|
|
750
752
|
'neuron_ids' : IDL.Vec(IDL.Nat64),
|
|
753
|
+
'page_number' : IDL.Opt(IDL.Nat64),
|
|
751
754
|
'include_empty_neurons_readable_by_caller' : IDL.Opt(IDL.Bool),
|
|
755
|
+
'neuron_subaccounts' : IDL.Opt(IDL.Vec(NeuronSubaccount)),
|
|
752
756
|
'include_neurons_readable_by_caller' : IDL.Bool,
|
|
753
757
|
});
|
|
754
758
|
const ListNeuronsResponse = IDL.Record({
|
|
755
759
|
'neuron_infos' : IDL.Vec(IDL.Tuple(IDL.Nat64, NeuronInfo)),
|
|
756
760
|
'full_neurons' : IDL.Vec(Neuron),
|
|
761
|
+
'total_pages_available' : IDL.Opt(IDL.Nat64),
|
|
757
762
|
});
|
|
758
763
|
const DateRangeFilter = IDL.Record({
|
|
759
764
|
'start_timestamp_seconds' : IDL.Opt(IDL.Nat64),
|
|
@@ -352,14 +352,18 @@ export interface ListKnownNeuronsResponse {
|
|
|
352
352
|
known_neurons: Array<KnownNeuron>;
|
|
353
353
|
}
|
|
354
354
|
export interface ListNeurons {
|
|
355
|
+
page_size: [] | [bigint];
|
|
355
356
|
include_public_neurons_in_full_neurons: [] | [boolean];
|
|
356
357
|
neuron_ids: BigUint64Array | bigint[];
|
|
358
|
+
page_number: [] | [bigint];
|
|
357
359
|
include_empty_neurons_readable_by_caller: [] | [boolean];
|
|
360
|
+
neuron_subaccounts: [] | [Array<NeuronSubaccount>];
|
|
358
361
|
include_neurons_readable_by_caller: boolean;
|
|
359
362
|
}
|
|
360
363
|
export interface ListNeuronsResponse {
|
|
361
364
|
neuron_infos: Array<[bigint, NeuronInfo]>;
|
|
362
365
|
full_neurons: Array<Neuron>;
|
|
366
|
+
total_pages_available: [] | [bigint];
|
|
363
367
|
}
|
|
364
368
|
export interface ListNodeProviderRewardsRequest {
|
|
365
369
|
date_filter: [] | [DateRangeFilter];
|
|
@@ -551,6 +555,9 @@ export interface NeuronStakeTransfer {
|
|
|
551
555
|
transfer_timestamp: bigint;
|
|
552
556
|
block_height: bigint;
|
|
553
557
|
}
|
|
558
|
+
export interface NeuronSubaccount {
|
|
559
|
+
subaccount: Uint8Array | number[];
|
|
560
|
+
}
|
|
554
561
|
export interface NeuronSubsetMetrics {
|
|
555
562
|
total_maturity_e8s_equivalent: [] | [bigint];
|
|
556
563
|
maturity_e8s_equivalent_buckets: Array<[bigint, bigint]>;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Generated from IC repo commit
|
|
1
|
+
// Generated from IC repo commit 14c8f44 (2025-02-07 tags: release-2025-02-06_12-26-revert-hashes-in-blocks) 'rs/nns/governance/canister/governance_test.did' by import-candid
|
|
2
2
|
type AccountIdentifier = record {
|
|
3
3
|
hash : blob;
|
|
4
4
|
};
|
|
@@ -439,11 +439,19 @@ type ListNeurons = record {
|
|
|
439
439
|
neuron_ids : vec nat64;
|
|
440
440
|
include_empty_neurons_readable_by_caller : opt bool;
|
|
441
441
|
include_neurons_readable_by_caller : bool;
|
|
442
|
+
page_number: opt nat64;
|
|
443
|
+
page_size: opt nat64;
|
|
444
|
+
neuron_subaccounts: opt vec NeuronSubaccount;
|
|
445
|
+
};
|
|
446
|
+
|
|
447
|
+
type NeuronSubaccount = record {
|
|
448
|
+
subaccount : blob;
|
|
442
449
|
};
|
|
443
450
|
|
|
444
451
|
type ListNeuronsResponse = record {
|
|
445
452
|
neuron_infos : vec record { nat64; NeuronInfo };
|
|
446
453
|
full_neurons : vec Neuron;
|
|
454
|
+
total_pages_available: opt nat64;
|
|
447
455
|
};
|
|
448
456
|
|
|
449
457
|
type ListNodeProviderRewardsRequest = record {
|
|
@@ -745,15 +745,20 @@ export const idlFactory = ({ IDL }) => {
|
|
|
745
745
|
const ListKnownNeuronsResponse = IDL.Record({
|
|
746
746
|
'known_neurons' : IDL.Vec(KnownNeuron),
|
|
747
747
|
});
|
|
748
|
+
const NeuronSubaccount = IDL.Record({ 'subaccount' : IDL.Vec(IDL.Nat8) });
|
|
748
749
|
const ListNeurons = IDL.Record({
|
|
750
|
+
'page_size' : IDL.Opt(IDL.Nat64),
|
|
749
751
|
'include_public_neurons_in_full_neurons' : IDL.Opt(IDL.Bool),
|
|
750
752
|
'neuron_ids' : IDL.Vec(IDL.Nat64),
|
|
753
|
+
'page_number' : IDL.Opt(IDL.Nat64),
|
|
751
754
|
'include_empty_neurons_readable_by_caller' : IDL.Opt(IDL.Bool),
|
|
755
|
+
'neuron_subaccounts' : IDL.Opt(IDL.Vec(NeuronSubaccount)),
|
|
752
756
|
'include_neurons_readable_by_caller' : IDL.Bool,
|
|
753
757
|
});
|
|
754
758
|
const ListNeuronsResponse = IDL.Record({
|
|
755
759
|
'neuron_infos' : IDL.Vec(IDL.Tuple(IDL.Nat64, NeuronInfo)),
|
|
756
760
|
'full_neurons' : IDL.Vec(Neuron),
|
|
761
|
+
'total_pages_available' : IDL.Opt(IDL.Nat64),
|
|
757
762
|
});
|
|
758
763
|
const DateRangeFilter = IDL.Record({
|
|
759
764
|
'start_timestamp_seconds' : IDL.Opt(IDL.Nat64),
|
package/dist/candid/sns_wasm.did
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Generated from IC repo commit
|
|
1
|
+
// Generated from IC repo commit 14c8f44 (2025-02-07 tags: release-2025-02-06_12-26-revert-hashes-in-blocks) 'rs/nns/sns-wasm/canister/sns-wasm.did' by import-candid
|
|
2
2
|
type AddWasmRequest = record {
|
|
3
3
|
hash : blob;
|
|
4
4
|
wasm : opt SnsWasm;
|