@dfinity/nns 8.5.0 → 9.0.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 CHANGED
@@ -176,7 +176,7 @@ Parameters:
176
176
 
177
177
  ### :factory: GovernanceCanister
178
178
 
179
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L96)
179
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L100)
180
180
 
181
181
  #### Static Methods
182
182
 
@@ -188,13 +188,13 @@ Parameters:
188
188
  | -------- | ------------------------------------------------------------- |
189
189
  | `create` | `(options?: GovernanceCanisterOptions) => GovernanceCanister` |
190
190
 
191
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L111)
191
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L115)
192
192
 
193
193
  #### Methods
194
194
 
195
195
  - [listNeurons](#gear-listneurons)
196
196
  - [listKnownNeurons](#gear-listknownneurons)
197
- - [getLastestRewardEvent](#gear-getlastestrewardevent)
197
+ - [getLatestRewardEvent](#gear-getlatestrewardevent)
198
198
  - [listProposals](#gear-listproposals)
199
199
  - [stakeNeuron](#gear-stakeneuron)
200
200
  - [increaseDissolveDelay](#gear-increasedissolvedelay)
@@ -225,6 +225,8 @@ Parameters:
225
225
  - [getNeuron](#gear-getneuron)
226
226
  - [getNetworkEconomicsParameters](#gear-getnetworkeconomicsparameters)
227
227
  - [disburseMaturity](#gear-disbursematurity)
228
+ - [setFollowing](#gear-setfollowing)
229
+ - [getMetrics](#gear-getmetrics)
228
230
 
229
231
  ##### :gear: listNeurons
230
232
 
@@ -244,7 +246,7 @@ combined into a single return value.
244
246
  | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
245
247
  | `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<...>` |
246
248
 
247
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L154)
249
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L158)
248
250
 
249
251
  ##### :gear: listKnownNeurons
250
252
 
@@ -258,20 +260,20 @@ it is fetched using a query call.
258
260
  | ------------------ | ------------------------------------------------- |
259
261
  | `listKnownNeurons` | `(certified?: boolean) => Promise<KnownNeuron[]>` |
260
262
 
261
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L287)
263
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L291)
262
264
 
263
- ##### :gear: getLastestRewardEvent
265
+ ##### :gear: getLatestRewardEvent
264
266
 
265
267
  Returns the latest reward event.
266
268
 
267
269
  If `certified` is true, the request is fetched as an update call, otherwise
268
270
  it's fetched using a query call.
269
271
 
270
- | Method | Type |
271
- | ----------------------- | ----------------------------------------------- |
272
- | `getLastestRewardEvent` | `(certified?: boolean) => Promise<RewardEvent>` |
272
+ | Method | Type |
273
+ | ---------------------- | ----------------------------------------------- |
274
+ | `getLatestRewardEvent` | `(certified?: boolean) => Promise<RewardEvent>` |
273
275
 
274
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L309)
276
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L313)
275
277
 
276
278
  ##### :gear: listProposals
277
279
 
@@ -290,7 +292,7 @@ Parameters:
290
292
  - `request`: the options to list the proposals (limit number of results, topics to search for, etc.)
291
293
  - `certified`: query or update calls
292
294
 
293
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L322)
295
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L326)
294
296
 
295
297
  ##### :gear: stakeNeuron
296
298
 
@@ -298,7 +300,7 @@ Parameters:
298
300
  | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
299
301
  | `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<...>` |
300
302
 
301
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L341)
303
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L345)
302
304
 
303
305
  ##### :gear: increaseDissolveDelay
304
306
 
@@ -308,7 +310,7 @@ Increases dissolve delay of a neuron
308
310
  | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
309
311
  | `increaseDissolveDelay` | `({ neuronId, additionalDissolveDelaySeconds, }: { neuronId: bigint; additionalDissolveDelaySeconds: number; }) => Promise<void>` |
310
312
 
311
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L402)
313
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L406)
312
314
 
313
315
  ##### :gear: setDissolveDelay
314
316
 
@@ -319,7 +321,7 @@ The new date is now + dissolveDelaySeconds.
319
321
  | ------------------ | ------------------------------------------------------------------------------------------------------------- |
320
322
  | `setDissolveDelay` | `({ neuronId, dissolveDelaySeconds, }: { neuronId: bigint; dissolveDelaySeconds: number; }) => Promise<void>` |
321
323
 
322
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L428)
324
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L432)
323
325
 
324
326
  ##### :gear: startDissolving
325
327
 
@@ -329,7 +331,7 @@ Start dissolving process of a neuron
329
331
  | ----------------- | ------------------------------------- |
330
332
  | `startDissolving` | `(neuronId: bigint) => Promise<void>` |
331
333
 
332
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L451)
334
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L455)
333
335
 
334
336
  ##### :gear: stopDissolving
335
337
 
@@ -339,7 +341,7 @@ Stop dissolving process of a neuron
339
341
  | ---------------- | ------------------------------------- |
340
342
  | `stopDissolving` | `(neuronId: bigint) => Promise<void>` |
341
343
 
342
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L465)
344
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L469)
343
345
 
344
346
  ##### :gear: joinCommunityFund
345
347
 
@@ -349,7 +351,7 @@ Neuron joins the community fund
349
351
  | ------------------- | ------------------------------------- |
350
352
  | `joinCommunityFund` | `(neuronId: bigint) => Promise<void>` |
351
353
 
352
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L479)
354
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L483)
353
355
 
354
356
  ##### :gear: autoStakeMaturity
355
357
 
@@ -364,7 +366,7 @@ Parameters:
364
366
  - `neuronId`: The id of the neuron for which to request a change of the auto stake feature
365
367
  - `autoStake`: `true` to enable the auto-stake maturity for this neuron, `false` to turn it off
366
368
 
367
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L497)
369
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L501)
368
370
 
369
371
  ##### :gear: leaveCommunityFund
370
372
 
@@ -374,7 +376,7 @@ Neuron leaves the community fund
374
376
  | -------------------- | ------------------------------------- |
375
377
  | `leaveCommunityFund` | `(neuronId: bigint) => Promise<void>` |
376
378
 
377
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L512)
379
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L516)
378
380
 
379
381
  ##### :gear: setVisibility
380
382
 
@@ -384,7 +386,7 @@ Set visibility of a neuron
384
386
  | --------------- | ------------------------------------------------------------------- |
385
387
  | `setVisibility` | `(neuronId: bigint, visibility: NeuronVisibility) => Promise<void>` |
386
388
 
387
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L527)
389
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L531)
388
390
 
389
391
  ##### :gear: setNodeProviderAccount
390
392
 
@@ -395,7 +397,7 @@ Where the reward is paid to.
395
397
  | ------------------------ | ---------------------------------------------- |
396
398
  | `setNodeProviderAccount` | `(accountIdentifier: string) => Promise<void>` |
397
399
 
398
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L547)
400
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L551)
399
401
 
400
402
  ##### :gear: mergeNeurons
401
403
 
@@ -405,7 +407,7 @@ Merge two neurons
405
407
  | -------------- | --------------------------------------------------------------------------------- |
406
408
  | `mergeNeurons` | `(request: { sourceNeuronId: bigint; targetNeuronId: bigint; }) => Promise<void>` |
407
409
 
408
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L567)
410
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L571)
409
411
 
410
412
  ##### :gear: simulateMergeNeurons
411
413
 
@@ -415,7 +417,7 @@ Simulate merging two neurons
415
417
  | ---------------------- | --------------------------------------------------------------------------------------- |
416
418
  | `simulateMergeNeurons` | `(request: { sourceNeuronId: bigint; targetNeuronId: bigint; }) => Promise<NeuronInfo>` |
417
419
 
418
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L584)
420
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L588)
419
421
 
420
422
  ##### :gear: splitNeuron
421
423
 
@@ -425,7 +427,11 @@ Splits a neuron creating a new one
425
427
  | ------------- | ----------------------------------------------------------------------------------- |
426
428
  | `splitNeuron` | `({ neuronId, amount, }: { neuronId: bigint; amount: bigint; }) => Promise<bigint>` |
427
429
 
428
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L629)
430
+ Returns:
431
+
432
+ newNeuronId
433
+
434
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L633)
429
435
 
430
436
  ##### :gear: getProposal
431
437
 
@@ -438,7 +444,7 @@ it is fetched using a query call.
438
444
  | ------------- | ------------------------------------------------------------------------------------------------------------------------------- |
439
445
  | `getProposal` | `({ proposalId, certified, }: { proposalId: bigint; certified?: boolean or undefined; }) => Promise<ProposalInfo or undefined>` |
440
446
 
441
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L669)
447
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L673)
442
448
 
443
449
  ##### :gear: makeProposal
444
450
 
@@ -448,7 +454,11 @@ Create new proposal
448
454
  | -------------- | ---------------------------------------------------------------- |
449
455
  | `makeProposal` | `(request: MakeProposalRequest) => Promise<bigint or undefined>` |
450
456
 
451
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L687)
457
+ Returns:
458
+
459
+ The newly created proposal ID or undefined if the success response returned by the Governance canister does not provide such information.
460
+
461
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L691)
452
462
 
453
463
  ##### :gear: registerVote
454
464
 
@@ -458,7 +468,7 @@ Registers vote for a proposal from the neuron passed.
458
468
  | -------------- | ----------------------------------------------------------------------------------------------------------- |
459
469
  | `registerVote` | `({ neuronId, vote, proposalId, }: { neuronId: bigint; vote: Vote; proposalId: bigint; }) => Promise<void>` |
460
470
 
461
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L708)
471
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L712)
462
472
 
463
473
  ##### :gear: setFollowees
464
474
 
@@ -468,7 +478,7 @@ Edit neuron followees per topic
468
478
  | -------------- | ------------------------------------------------- |
469
479
  | `setFollowees` | `(followRequest: FollowRequest) => Promise<void>` |
470
480
 
471
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L730)
481
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L734)
472
482
 
473
483
  ##### :gear: disburse
474
484
 
@@ -478,7 +488,7 @@ Disburse neuron on Account
478
488
  | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
479
489
  | `disburse` | `({ neuronId, toAccountId, amount, }: { neuronId: bigint; toAccountId?: string or undefined; amount?: bigint or undefined; }) => Promise<void>` |
480
490
 
481
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L745)
491
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L749)
482
492
 
483
493
  ##### :gear: refreshVotingPower
484
494
 
@@ -490,7 +500,7 @@ parameter of the neuron to the current time).
490
500
  | -------------------- | --------------------------------------------------------- |
491
501
  | `refreshVotingPower` | `({ neuronId, }: { neuronId: bigint; }) => Promise<void>` |
492
502
 
493
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L781)
503
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L785)
494
504
 
495
505
  ##### :gear: mergeMaturity
496
506
 
@@ -500,7 +510,7 @@ Merge Maturity of a neuron
500
510
  | --------------- | ------------------------------------------------------------------------------------------------------- |
501
511
  | `mergeMaturity` | `({ neuronId, percentageToMerge, }: { neuronId: bigint; percentageToMerge: number; }) => Promise<void>` |
502
512
 
503
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L803)
513
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L807)
504
514
 
505
515
  ##### :gear: stakeMaturity
506
516
 
@@ -515,7 +525,7 @@ Parameters:
515
525
  - `neuronId`: The id of the neuron for which to stake the maturity
516
526
  - `percentageToStake`: Optional. Percentage of the current maturity to stake. If not provided, all of the neuron's current maturity will be staked.
517
527
 
518
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L832)
528
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L836)
519
529
 
520
530
  ##### :gear: spawnNeuron
521
531
 
@@ -525,7 +535,7 @@ Merge Maturity of a neuron
525
535
  | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
526
536
  | `spawnNeuron` | `({ neuronId, percentageToSpawn, newController, nonce, }: { neuronId: bigint; percentageToSpawn?: number or undefined; newController?: Principal or undefined; nonce?: bigint or undefined; }) => Promise<bigint>` |
527
537
 
528
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L854)
538
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L858)
529
539
 
530
540
  ##### :gear: addHotkey
531
541
 
@@ -535,7 +545,7 @@ Add hotkey to neuron
535
545
  | ----------- | ------------------------------------------------------------------------------------------ |
536
546
  | `addHotkey` | `({ neuronId, principal, }: { neuronId: bigint; principal: Principal; }) => Promise<void>` |
537
547
 
538
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L901)
548
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L905)
539
549
 
540
550
  ##### :gear: removeHotkey
541
551
 
@@ -545,7 +555,7 @@ Remove hotkey to neuron
545
555
  | -------------- | ------------------------------------------------------------------------------------------ |
546
556
  | `removeHotkey` | `({ neuronId, principal, }: { neuronId: bigint; principal: Principal; }) => Promise<void>` |
547
557
 
548
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L921)
558
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L925)
549
559
 
550
560
  ##### :gear: claimOrRefreshNeuronFromAccount
551
561
 
@@ -555,7 +565,7 @@ Gets the NeuronID of a newly created neuron.
555
565
  | --------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
556
566
  | `claimOrRefreshNeuronFromAccount` | `({ memo, controller, }: { memo: bigint; controller?: Principal or undefined; }) => Promise<bigint or undefined>` |
557
567
 
558
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L939)
568
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L943)
559
569
 
560
570
  ##### :gear: claimOrRefreshNeuron
561
571
 
@@ -566,7 +576,7 @@ Uses query call only.
566
576
  | ---------------------- | ------------------------------------------------------------------------ |
567
577
  | `claimOrRefreshNeuron` | `(request: ClaimOrRefreshNeuronRequest) => Promise<bigint or undefined>` |
568
578
 
569
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L970)
579
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L974)
570
580
 
571
581
  ##### :gear: getNeuron
572
582
 
@@ -576,7 +586,7 @@ Return the data of the neuron provided as id.
576
586
  | ----------- | ----------------------------------------------------------------------------------------------------------- |
577
587
  | `getNeuron` | `({ certified, neuronId, }: { certified: boolean; neuronId: bigint; }) => Promise<NeuronInfo or undefined>` |
578
588
 
579
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L995)
589
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L999)
580
590
 
581
591
  ##### :gear: getNetworkEconomicsParameters
582
592
 
@@ -586,7 +596,7 @@ Return the [Network Economics](https://github.com/dfinity/ic/blob/d90e934eb440c7
586
596
  | ------------------------------- | ------------------------------------------------------------------------ |
587
597
  | `getNetworkEconomicsParameters` | `({ certified, }: { certified: boolean; }) => Promise<NetworkEconomics>` |
588
598
 
589
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L1016)
599
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L1020)
590
600
 
591
601
  ##### :gear: disburseMaturity
592
602
 
@@ -603,7 +613,30 @@ Parameters:
603
613
  - `params.percentageToDisburse`: The percentage of the neuron's maturity to disburse, between 1 and 100 (inclusive).
604
614
  - `params.accountIdentifier`: Optional. The account identifier to which the maturity will be disbursed. If not provided, the maturity will be disbursed to the caller's Main account.
605
615
 
606
- [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L1044)
616
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L1048)
617
+
618
+ ##### :gear: setFollowing
619
+
620
+ Set the following topics for a neuron.
621
+
622
+ | Method | Type |
623
+ | -------------- | -------------------------------------------------------------------------------------------------------------- |
624
+ | `setFollowing` | `({ neuronId, topicFollowing, }: { neuronId: bigint; topicFollowing: FolloweesForTopic[]; }) => Promise<void>` |
625
+
626
+ Parameters:
627
+
628
+ - `params.neuronId`: The id of the neuron for which to set the following topics
629
+ - `params.topicFollowing`: The topics and the followees for each topic that the neuron should follow.
630
+
631
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L1076)
632
+
633
+ ##### :gear: getMetrics
634
+
635
+ | Method | Type |
636
+ | ------------ | ------------------------------------------------------------------------------- |
637
+ | `getMetrics` | `({ certified, }: { certified: boolean; }) => Promise<GovernanceCachedMetrics>` |
638
+
639
+ [:link: Source](https://github.com/dfinity/ic-js/tree/main/packages/nns/src/governance.canister.ts#L1091)
607
640
 
608
641
  ### :factory: SnsWasmCanister
609
642
 
@@ -1,4 +1,4 @@
1
- // Generated from IC repo commit b72c6253fa (2025-06-10) 'rs/nns/gtc/canister/gtc.did' by import-candid
1
+ // Generated from IC repo commit e915efe (2025-07-02 tags: release-2025-07-03_03-27-base) '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;
@@ -83,6 +83,13 @@ export const idlFactory = ({ IDL }) => {
83
83
  'new_controller' : IDL.Opt(IDL.Principal),
84
84
  'nonce' : IDL.Nat64,
85
85
  });
86
+ const FolloweesForTopic = IDL.Record({
87
+ 'topic' : IDL.Opt(IDL.Int32),
88
+ 'followees' : IDL.Opt(IDL.Vec(NeuronId)),
89
+ });
90
+ const SetFollowing = IDL.Record({
91
+ 'topic_following' : IDL.Opt(IDL.Vec(FolloweesForTopic)),
92
+ });
86
93
  const StakeMaturity = IDL.Record({
87
94
  'percentage_to_stake' : IDL.Opt(IDL.Nat32),
88
95
  });
@@ -103,6 +110,7 @@ export const idlFactory = ({ IDL }) => {
103
110
  'RegisterVote' : RegisterVote,
104
111
  'Merge' : Merge,
105
112
  'DisburseToNeuron' : DisburseToNeuron,
113
+ 'SetFollowing' : SetFollowing,
106
114
  'MakeProposal' : Proposal,
107
115
  'StakeMaturity' : StakeMaturity,
108
116
  'MergeMaturity' : MergeMaturity,
@@ -424,6 +432,7 @@ export const idlFactory = ({ IDL }) => {
424
432
  'not_dissolving_neurons_e8s_buckets_ect' : IDL.Vec(
425
433
  IDL.Tuple(IDL.Nat64, IDL.Float64)
426
434
  ),
435
+ 'spawning_neurons_count' : IDL.Nat64,
427
436
  'declining_voting_power_neuron_subset_metrics' : IDL.Opt(
428
437
  NeuronSubsetMetrics
429
438
  ),
@@ -830,6 +839,7 @@ export const idlFactory = ({ IDL }) => {
830
839
  'RegisterVote' : RegisterVote,
831
840
  'Merge' : Merge,
832
841
  'DisburseToNeuron' : DisburseToNeuron,
842
+ 'SetFollowing' : SetFollowing,
833
843
  'MakeProposal' : MakeProposalRequest,
834
844
  'StakeMaturity' : StakeMaturity,
835
845
  'MergeMaturity' : MergeMaturity,
@@ -856,6 +866,7 @@ export const idlFactory = ({ IDL }) => {
856
866
  'target_neuron_info' : IDL.Opt(NeuronInfo),
857
867
  'source_neuron_info' : IDL.Opt(NeuronInfo),
858
868
  });
869
+ const SetFollowingResponse = IDL.Record({});
859
870
  const MakeProposalResponse = IDL.Record({
860
871
  'message' : IDL.Opt(IDL.Text),
861
872
  'proposal_id' : IDL.Opt(ProposalId),
@@ -881,6 +892,7 @@ export const idlFactory = ({ IDL }) => {
881
892
  'RegisterVote' : IDL.Record({}),
882
893
  'Merge' : MergeResponse,
883
894
  'DisburseToNeuron' : SpawnResponse,
895
+ 'SetFollowing' : SetFollowingResponse,
884
896
  'MakeProposal' : MakeProposalResponse,
885
897
  'StakeMaturity' : StakeMaturityResponse,
886
898
  'MergeMaturity' : MergeMaturityResponse,
@@ -1093,6 +1105,13 @@ export const init = ({ IDL }) => {
1093
1105
  'new_controller' : IDL.Opt(IDL.Principal),
1094
1106
  'nonce' : IDL.Nat64,
1095
1107
  });
1108
+ const FolloweesForTopic = IDL.Record({
1109
+ 'topic' : IDL.Opt(IDL.Int32),
1110
+ 'followees' : IDL.Opt(IDL.Vec(NeuronId)),
1111
+ });
1112
+ const SetFollowing = IDL.Record({
1113
+ 'topic_following' : IDL.Opt(IDL.Vec(FolloweesForTopic)),
1114
+ });
1096
1115
  const StakeMaturity = IDL.Record({
1097
1116
  'percentage_to_stake' : IDL.Opt(IDL.Nat32),
1098
1117
  });
@@ -1113,6 +1132,7 @@ export const init = ({ IDL }) => {
1113
1132
  'RegisterVote' : RegisterVote,
1114
1133
  'Merge' : Merge,
1115
1134
  'DisburseToNeuron' : DisburseToNeuron,
1135
+ 'SetFollowing' : SetFollowing,
1116
1136
  'MakeProposal' : Proposal,
1117
1137
  'StakeMaturity' : StakeMaturity,
1118
1138
  'MergeMaturity' : MergeMaturity,
@@ -1434,6 +1454,7 @@ export const init = ({ IDL }) => {
1434
1454
  'not_dissolving_neurons_e8s_buckets_ect' : IDL.Vec(
1435
1455
  IDL.Tuple(IDL.Nat64, IDL.Float64)
1436
1456
  ),
1457
+ 'spawning_neurons_count' : IDL.Nat64,
1437
1458
  'declining_voting_power_neuron_subset_metrics' : IDL.Opt(
1438
1459
  NeuronSubsetMetrics
1439
1460
  ),
@@ -103,6 +103,7 @@ export type Command =
103
103
  | { RegisterVote: RegisterVote }
104
104
  | { Merge: Merge }
105
105
  | { DisburseToNeuron: DisburseToNeuron }
106
+ | { SetFollowing: SetFollowing }
106
107
  | { MakeProposal: Proposal }
107
108
  | { StakeMaturity: StakeMaturity }
108
109
  | { MergeMaturity: MergeMaturity }
@@ -119,6 +120,7 @@ export type Command_1 =
119
120
  | { RegisterVote: {} }
120
121
  | { Merge: MergeResponse }
121
122
  | { DisburseToNeuron: SpawnResponse }
123
+ | { SetFollowing: SetFollowingResponse }
122
124
  | { MakeProposal: MakeProposalResponse }
123
125
  | { StakeMaturity: StakeMaturityResponse }
124
126
  | { MergeMaturity: MergeMaturityResponse }
@@ -216,6 +218,10 @@ export interface Follow {
216
218
  export interface Followees {
217
219
  followees: Array<NeuronId>;
218
220
  }
221
+ export interface FolloweesForTopic {
222
+ topic: [] | [number];
223
+ followees: [] | [Array<NeuronId>];
224
+ }
219
225
  export interface GetNeuronsFundAuditInfoRequest {
220
226
  nns_proposal_id: [] | [ProposalId];
221
227
  }
@@ -272,6 +278,7 @@ export interface GovernanceCachedMetrics {
272
278
  total_voting_power_non_self_authenticating_controller: [] | [bigint];
273
279
  total_staked_maturity_e8s_equivalent: bigint;
274
280
  not_dissolving_neurons_e8s_buckets_ect: Array<[bigint, number]>;
281
+ spawning_neurons_count: bigint;
275
282
  declining_voting_power_neuron_subset_metrics: [] | [NeuronSubsetMetrics];
276
283
  total_staked_e8s_ect: bigint;
277
284
  not_dissolving_neurons_staked_maturity_e8s_equivalent_sum: bigint;
@@ -423,6 +430,7 @@ export type ManageNeuronCommandRequest =
423
430
  | { RegisterVote: RegisterVote }
424
431
  | { Merge: Merge }
425
432
  | { DisburseToNeuron: DisburseToNeuron }
433
+ | { SetFollowing: SetFollowing }
426
434
  | { MakeProposal: MakeProposalRequest }
427
435
  | { StakeMaturity: StakeMaturity }
428
436
  | { MergeMaturity: MergeMaturity }
@@ -811,6 +819,10 @@ export interface SetDefaultFollowees {
811
819
  export interface SetDissolveTimestamp {
812
820
  dissolve_timestamp_seconds: bigint;
813
821
  }
822
+ export interface SetFollowing {
823
+ topic_following: [] | [Array<FolloweesForTopic>];
824
+ }
825
+ export type SetFollowingResponse = {};
814
826
  export interface SetOpenTimeWindowRequest {
815
827
  open_time_window: [] | [TimeWindow];
816
828
  }
@@ -1,4 +1,4 @@
1
- // Generated from IC repo commit b72c6253fa (2025-06-10) 'rs/nns/governance/canister/governance.did' by import-candid
1
+ // Generated from IC repo commit e915efe (2025-07-02 tags: release-2025-07-03_03-27-base) 'rs/nns/governance/canister/governance.did' by import-candid
2
2
  type AccountIdentifier = record {
3
3
  hash : blob;
4
4
  };
@@ -139,6 +139,18 @@ type DisburseMaturityResponse = record {
139
139
  amount_disbursed_e8s : opt nat64;
140
140
  };
141
141
 
142
+ type SetFollowing = record {
143
+ topic_following : opt vec FolloweesForTopic;
144
+ };
145
+
146
+ type FolloweesForTopic = record {
147
+ followees : opt vec NeuronId;
148
+ topic : opt int32;
149
+ };
150
+
151
+ type SetFollowingResponse = record {
152
+ };
153
+
142
154
  // KEEP THIS IN SYNC WITH ManageNeuronCommandRequest!
143
155
  type Command = variant {
144
156
  Spawn : Spawn;
@@ -155,6 +167,7 @@ type Command = variant {
155
167
  Disburse : Disburse;
156
168
  RefreshVotingPower : RefreshVotingPower;
157
169
  DisburseMaturity : DisburseMaturity;
170
+ SetFollowing : SetFollowing;
158
171
 
159
172
  // KEEP THIS IN SYNC WITH ManageNeuronCommandRequest!
160
173
  };
@@ -175,6 +188,7 @@ type Command_1 = variant {
175
188
  Disburse : DisburseResponse;
176
189
  RefreshVotingPower : RefreshVotingPowerResponse;
177
190
  DisburseMaturity : DisburseMaturityResponse;
191
+ SetFollowing : SetFollowingResponse;
178
192
  };
179
193
 
180
194
  type Command_2 = variant {
@@ -362,6 +376,7 @@ type GovernanceCachedMetrics = record {
362
376
  not_dissolving_neurons_e8s_buckets_seed : vec record { nat64; float64 };
363
377
  timestamp_seconds : nat64;
364
378
  seed_neuron_count : nat64;
379
+ spawning_neurons_count : nat64;
365
380
 
366
381
  non_self_authenticating_controller_neuron_subset_metrics : opt NeuronSubsetMetrics;
367
382
  public_neuron_subset_metrics : opt NeuronSubsetMetrics;
@@ -549,6 +564,7 @@ type ManageNeuronCommandRequest = variant {
549
564
  Disburse : Disburse;
550
565
  RefreshVotingPower : RefreshVotingPower;
551
566
  DisburseMaturity : DisburseMaturity;
567
+ SetFollowing : SetFollowing;
552
568
 
553
569
  // KEEP THIS IN SYNC WITH COMMAND!
554
570
  };
@@ -83,6 +83,13 @@ export const idlFactory = ({ IDL }) => {
83
83
  'new_controller' : IDL.Opt(IDL.Principal),
84
84
  'nonce' : IDL.Nat64,
85
85
  });
86
+ const FolloweesForTopic = IDL.Record({
87
+ 'topic' : IDL.Opt(IDL.Int32),
88
+ 'followees' : IDL.Opt(IDL.Vec(NeuronId)),
89
+ });
90
+ const SetFollowing = IDL.Record({
91
+ 'topic_following' : IDL.Opt(IDL.Vec(FolloweesForTopic)),
92
+ });
86
93
  const StakeMaturity = IDL.Record({
87
94
  'percentage_to_stake' : IDL.Opt(IDL.Nat32),
88
95
  });
@@ -103,6 +110,7 @@ export const idlFactory = ({ IDL }) => {
103
110
  'RegisterVote' : RegisterVote,
104
111
  'Merge' : Merge,
105
112
  'DisburseToNeuron' : DisburseToNeuron,
113
+ 'SetFollowing' : SetFollowing,
106
114
  'MakeProposal' : Proposal,
107
115
  'StakeMaturity' : StakeMaturity,
108
116
  'MergeMaturity' : MergeMaturity,
@@ -424,6 +432,7 @@ export const idlFactory = ({ IDL }) => {
424
432
  'not_dissolving_neurons_e8s_buckets_ect' : IDL.Vec(
425
433
  IDL.Tuple(IDL.Nat64, IDL.Float64)
426
434
  ),
435
+ 'spawning_neurons_count' : IDL.Nat64,
427
436
  'declining_voting_power_neuron_subset_metrics' : IDL.Opt(
428
437
  NeuronSubsetMetrics
429
438
  ),
@@ -830,6 +839,7 @@ export const idlFactory = ({ IDL }) => {
830
839
  'RegisterVote' : RegisterVote,
831
840
  'Merge' : Merge,
832
841
  'DisburseToNeuron' : DisburseToNeuron,
842
+ 'SetFollowing' : SetFollowing,
833
843
  'MakeProposal' : MakeProposalRequest,
834
844
  'StakeMaturity' : StakeMaturity,
835
845
  'MergeMaturity' : MergeMaturity,
@@ -856,6 +866,7 @@ export const idlFactory = ({ IDL }) => {
856
866
  'target_neuron_info' : IDL.Opt(NeuronInfo),
857
867
  'source_neuron_info' : IDL.Opt(NeuronInfo),
858
868
  });
869
+ const SetFollowingResponse = IDL.Record({});
859
870
  const MakeProposalResponse = IDL.Record({
860
871
  'message' : IDL.Opt(IDL.Text),
861
872
  'proposal_id' : IDL.Opt(ProposalId),
@@ -881,6 +892,7 @@ export const idlFactory = ({ IDL }) => {
881
892
  'RegisterVote' : IDL.Record({}),
882
893
  'Merge' : MergeResponse,
883
894
  'DisburseToNeuron' : SpawnResponse,
895
+ 'SetFollowing' : SetFollowingResponse,
884
896
  'MakeProposal' : MakeProposalResponse,
885
897
  'StakeMaturity' : StakeMaturityResponse,
886
898
  'MergeMaturity' : MergeMaturityResponse,
@@ -1109,6 +1121,13 @@ export const init = ({ IDL }) => {
1109
1121
  'new_controller' : IDL.Opt(IDL.Principal),
1110
1122
  'nonce' : IDL.Nat64,
1111
1123
  });
1124
+ const FolloweesForTopic = IDL.Record({
1125
+ 'topic' : IDL.Opt(IDL.Int32),
1126
+ 'followees' : IDL.Opt(IDL.Vec(NeuronId)),
1127
+ });
1128
+ const SetFollowing = IDL.Record({
1129
+ 'topic_following' : IDL.Opt(IDL.Vec(FolloweesForTopic)),
1130
+ });
1112
1131
  const StakeMaturity = IDL.Record({
1113
1132
  'percentage_to_stake' : IDL.Opt(IDL.Nat32),
1114
1133
  });
@@ -1129,6 +1148,7 @@ export const init = ({ IDL }) => {
1129
1148
  'RegisterVote' : RegisterVote,
1130
1149
  'Merge' : Merge,
1131
1150
  'DisburseToNeuron' : DisburseToNeuron,
1151
+ 'SetFollowing' : SetFollowing,
1132
1152
  'MakeProposal' : Proposal,
1133
1153
  'StakeMaturity' : StakeMaturity,
1134
1154
  'MergeMaturity' : MergeMaturity,
@@ -1450,6 +1470,7 @@ export const init = ({ IDL }) => {
1450
1470
  'not_dissolving_neurons_e8s_buckets_ect' : IDL.Vec(
1451
1471
  IDL.Tuple(IDL.Nat64, IDL.Float64)
1452
1472
  ),
1473
+ 'spawning_neurons_count' : IDL.Nat64,
1453
1474
  'declining_voting_power_neuron_subset_metrics' : IDL.Opt(
1454
1475
  NeuronSubsetMetrics
1455
1476
  ),