Overview

Namespaces

• NnsGenesisTokenDid
• NnsGovernanceDid
• NnsGovernanceTestDid
• SnsWasmDid

Enumerations

CanisterAction

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:173

Enumeration Members

Start

Start: 2

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:178

Stop

Stop: 1

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:176

Unspecified

Unspecified: 0

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:174

---

CanisterInstallMode

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:189

Enumeration Members

Install

Install: 1

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:191

Reinstall

Reinstall: 2

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:192

Unspecified

Unspecified: 0

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:190

Upgrade

Upgrade: 3

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:193

---

LogVisibility

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:164

Enumeration Members

Controllers

Controllers: 1

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:167

Public

Public: 2

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:169

Unspecified

Unspecified: 0

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:165

---

NeuronState

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:7

Enumeration Members

Dissolved

Dissolved: 3

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:11

Dissolving

Dissolving: 2

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:10

Locked

Locked: 1

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:9

Spawning

Spawning: 4

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:12

Unspecified

Unspecified: 0

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:8

---

NeuronType

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:151

Enumeration Members

Ect

Ect: 2

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:160

Seed

Seed: 1

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:157

Unspecified

Unspecified: 0

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:154

---

NeuronVisibility

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:182

Enumeration Members

Private

Private: 1

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:184

Public

Public: 2

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:185

Unspecified

Unspecified: 0

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:183

---

NnsFunction

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:88

Enumeration Members

AddApiBoundaryNodes

AddApiBoundaryNodes: 43

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:132

AddFirewallRules

AddFirewallRules: 25

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:114

AddNodeToSubnet

AddNodeToSubnet: 2

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:91

AddOrRemoveDataCenters

AddOrRemoveDataCenters: 21

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:110

AddSnsWasm

AddSnsWasm: 30

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:119

AssignNoid

AssignNoid: 8

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:97

BitcoinSetConfig

BitcoinSetConfig: 39

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:128

BlessReplicaVersion

BlessReplicaVersion: 5

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:94

ChangeSubnetMembership

ChangeSubnetMembership: 31

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:120

ChangeSubnetTypeAssignment

ChangeSubnetTypeAssignment: 33

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:122

ClearProvisionalWhitelist

ClearProvisionalWhitelist: 12

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:101

CompleteCanisterMigration

CompleteCanisterMigration: 29

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:118

CreateSubnet

CreateSubnet: 1

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:90

DeployGuestosToAllSubnetNodes

DeployGuestosToAllSubnetNodes: 11

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:100

DeployGuestosToAllUnassignedNodes

DeployGuestosToAllUnassignedNodes: 48

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:140

DeployGuestosToSomeApiBoundaryNodes

DeployGuestosToSomeApiBoundaryNodes: 47

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:139

DeployHostosToSomeNodes

DeployHostosToSomeNodes: 51

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:143

HardResetNnsRootToVersion

HardResetNnsRootToVersion: 42

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:131

IcpXdrConversionRate

IcpXdrConversionRate: 10

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:99

InsertSnsWasmUpgradePathEntries

InsertSnsWasmUpgradePathEntries: 37

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:126

NnsCanisterInstall

NnsCanisterInstall: 3

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:92

NnsCanisterUpgrade

NnsCanisterUpgrade: 4

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:93

NnsRootUpgrade

NnsRootUpgrade: 9

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:98

PauseCanisterMigrations

PauseCanisterMigrations: 53

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:145

PrepareCanisterMigration

PrepareCanisterMigration: 28

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:117

RecoverSubnet

RecoverSubnet: 6

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:95

RemoveApiBoundaryNodes

RemoveApiBoundaryNodes: 44

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:133

RemoveFirewallRules

RemoveFirewallRules: 26

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:115

RemoveNodeOperators

RemoveNodeOperators: 23

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:112

RemoveNodes

RemoveNodes: 18

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:107

RemoveNodesFromSubnet

RemoveNodesFromSubnet: 13

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:102

RerouteCanisterRanges

RerouteCanisterRanges: 24

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:113

RetireReplicaVersion

RetireReplicaVersion: 36

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:125

ReviseElectedGuestosVersions

ReviseElectedGuestosVersions: 38

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:127

ReviseElectedHostosVersions

ReviseElectedHostosVersions: 50

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:142

SetAuthorizedSubnetworks

SetAuthorizedSubnetworks: 14

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:103

SetFirewallConfig

SetFirewallConfig: 15

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:104

SetSubnetOperationalLevel

SetSubnetOperationalLevel: 55

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:147

StopOrStartNnsCanister

StopOrStartNnsCanister: 17

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:106

SubnetRentalRequest

SubnetRentalRequest: 52

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:144

UninstallCode

UninstallCode: 19

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:108

UnpauseCanisterMigrations

UnpauseCanisterMigrations: 54

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:146

Unspecified

Unspecified: 0

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:89

UpdateAllowedPrincipals

UpdateAllowedPrincipals: 35

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:124

UpdateApiBoundaryNodeDomain

UpdateApiBoundaryNodeDomain: 45

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:137

Deprecated

UpdateApiBoundaryNodesVersion

UpdateApiBoundaryNodesVersion: 46

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:138

UpdateConfigOfSubnet

UpdateConfigOfSubnet: 7

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:96

UpdateElectedHostosVersions

UpdateElectedHostosVersions: 40

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:129

UpdateFirewallRules

UpdateFirewallRules: 27

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:116

UpdateNodeOperatorConfig

UpdateNodeOperatorConfig: 16

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:105

UpdateNodeRewardsTable

UpdateNodeRewardsTable: 20

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:109

UpdateNodesHostosVersion

UpdateNodesHostosVersion: 41

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:130

UpdateSnsWasmSnsSubnetIds

UpdateSnsWasmSnsSubnetIds: 34

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:123

UpdateSshReadOnlyAccessForAllUnassignedNodes

UpdateSshReadOnlyAccessForAllUnassignedNodes: 49

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:141

UpdateSubnetType

UpdateSubnetType: 32

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:121

UpdateUnassignedNodesConfig

UpdateUnassignedNodesConfig: 22

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:111

---

ProposalRewardStatus

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:42

Enumeration Members

AcceptVotes

AcceptVotes: 1

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:47

Ineligible

Ineligible: 4

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:57

ReadyToSettle

ReadyToSettle: 2

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:51

Settled

Settled: 3

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:54

Unknown

Unknown: 0

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:43

---

ProposalStatus

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:62

Enumeration Members

Accepted

Accepted: 3

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:73

Executed

Executed: 4

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:76

Failed

Failed: 5

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:79

Open

Open: 1

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:66

Rejected

Rejected: 2

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:69

Unknown

Unknown: 0

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:63

---

Topic

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:15

Enumeration Members

ApiBoundaryNodeManagement

ApiBoundaryNodeManagement: 15

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:34

ExchangeRate

ExchangeRate: 2

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:18

Governance

Governance: 4

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:20

IcOsVersionDeployment

IcOsVersionDeployment: 12

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:31

IcOsVersionElection

IcOsVersionElection: 13

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:32

Kyc

Kyc: 9

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:25

NetworkCanisterManagement

NetworkCanisterManagement: 8

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:24

NetworkEconomics

NetworkEconomics: 3

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:19

NeuronManagement

NeuronManagement: 1

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:17

NodeAdmin

NodeAdmin: 5

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:21

NodeProviderRewards

NodeProviderRewards: 10

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:26

ParticipantManagement

ParticipantManagement: 6

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:22

ProtocolCanisterManagement

ProtocolCanisterManagement: 17

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:36

ServiceNervousSystemManagement

ServiceNervousSystemManagement: 18

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:37

SnsAndCommunityFund

SnsAndCommunityFund: 14

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:33

SnsDecentralizationSale

SnsDecentralizationSale: 11

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:30

Deprecated

SubnetManagement

SubnetManagement: 7

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:23

SubnetRental

SubnetRental: 16

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:35

Unspecified

Unspecified: 0

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:16

---

Vote

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:82

Enumeration Members

No

No: 2

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:85

Unspecified

Unspecified: 0

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:83

Yes

Yes: 1

Defined in: packages/canisters/src/nns/enums/governance.enums.ts:84

Classes

CouldNotClaimNeuronError

Defined in: packages/canisters/src/nns/errors/governance.errors.ts:5

Extends

• StakeNeuronError

Constructors

Constructor

new CouldNotClaimNeuronError(message?): CouldNotClaimNeuronError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

CouldNotClaimNeuronError

Inherited from

StakeNeuronError.constructor

Constructor

new CouldNotClaimNeuronError(message?, options?): CouldNotClaimNeuronError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

CouldNotClaimNeuronError

Inherited from

StakeNeuronError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

StakeNeuronError.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

StakeNeuronError.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

StakeNeuronError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

StakeNeuronError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

StakeNeuronError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

StakeNeuronError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

StakeNeuronError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

StakeNeuronError.prepareStackTrace

---

GovernanceError

Defined in: packages/canisters/src/nns/errors/governance.errors.ts:14

Extends

• Error

Constructors

Constructor

new GovernanceError(detail): GovernanceError

Defined in: packages/canisters/src/nns/errors/governance.errors.ts:15

Parameters

detail

GovernanceError

Returns

GovernanceError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

detail

readonly detail: GovernanceError

Defined in: packages/canisters/src/nns/errors/governance.errors.ts:15

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

---

InsufficientAmountError

Defined in: packages/canisters/src/nns/errors/governance.errors.ts:7

Extends

• StakeNeuronError

Constructors

Constructor

new InsufficientAmountError(minimumAmount): InsufficientAmountError

Defined in: packages/canisters/src/nns/errors/governance.errors.ts:8

Parameters

minimumAmount

bigint

Returns

InsufficientAmountError

Overrides

StakeNeuronError.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

StakeNeuronError.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

StakeNeuronError.message

minimumAmount

readonly minimumAmount: bigint

Defined in: packages/canisters/src/nns/errors/governance.errors.ts:8

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

StakeNeuronError.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

StakeNeuronError.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

StakeNeuronError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

StakeNeuronError.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

StakeNeuronError.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

StakeNeuronError.prepareStackTrace

---

NnsGenesisTokenCanister

Defined in: packages/canisters/src/nns/genesis_token.canister.ts:11

Methods

claimNeurons()

claimNeurons(__namedParameters): Promise<bigint[]>

Defined in: packages/canisters/src/nns/genesis_token.canister.ts:29

Parameters

__namedParameters

hexPubKey

string

Returns

Promise<bigint[]>

create()

static create(options): NnsGenesisTokenCanister

Defined in: packages/canisters/src/nns/genesis_token.canister.ts:16

Parameters

options

CanisterOptions<_SERVICE> = {}

Returns

NnsGenesisTokenCanister

---

NnsGovernanceCanister

Defined in: packages/canisters/src/nns/governance.canister.ts:95

Methods

addHotkey()

addHotkey(__namedParameters): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:915

Add hotkey to neuron

Parameters

__namedParameters

neuronId

bigint

principal

Principal

Returns

Promise<void>

Throws

GovernanceError

autoStakeMaturity()

autoStakeMaturity(params): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:506

Changes auto-stake maturity for this Neuron. While on, auto-stake maturity will cause all the maturity generated by voting rewards to this neuron to be automatically staked and contribute to the voting power of the neuron.

Parameters

params

autoStake

boolean

neuronId

bigint

Returns

Promise<void>

Throws

GovernanceError

claimOrRefreshNeuron()

claimOrRefreshNeuron(request): Promise<bigint | undefined>

Defined in: packages/canisters/src/nns/governance.canister.ts:984

Refreshes neuron and returns neuronId when successful Uses query call only.

Parameters

request

ClaimOrRefreshNeuronRequest

Returns

Promise<bigint | undefined>

Throws

UnrecognizedTypeError

claimOrRefreshNeuronFromAccount()

claimOrRefreshNeuronFromAccount(__namedParameters): Promise<bigint | undefined>

Defined in: packages/canisters/src/nns/governance.canister.ts:953

Gets the NeuronID of a newly created neuron.

Parameters

__namedParameters

controller?

Principal

memo

bigint

Returns

Promise<bigint | undefined>

disburse()

disburse(__namedParameters): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:759

Disburse neuron on Account

Parameters

__namedParameters

amount?

bigint

neuronId

bigint

toAccountId?

string

Returns

Promise<void>

Throws

GovernanceError

Throws

InvalidAccountIDError

disburseMaturity()

disburseMaturity(params): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:1059

Disburses a neuron’s maturity (always certified). Reference: https://github.com/dfinity/ic/blob/ca2be53acf413bb92478ee7694ac0fb92af07030/rs/sns/governance/src/governance.rs#L1614

Parameters

params

neuronId

bigint

The id of the neuron for which to disburse maturity

percentageToDisburse

number

The percentage of the neuron’s maturity to disburse, between 1 and 100 (inclusive).

toAccount?

Account

Optional. The ICRC account to which the maturity will be disbursed. If not provided, the maturity will be disbursed to the caller’s Main account.

toAccountIdentifier?

string

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.

Returns

Promise<void>

Preconditions

• The neuron exists
• The caller is authorized to perform this neuron operation (NeuronPermissionType::DisburseMaturity)
• The given percentage_to_merge is between 1 and 100 (inclusive)
• The neuron’s id is not yet in the list of neurons with ongoing operations
• The e8s equivalent of the amount of maturity to disburse is more than the transaction fee.

getLatestRewardEvent()

getLatestRewardEvent(certified): Promise<RewardEvent>

Defined in: packages/canisters/src/nns/governance.canister.ts:316

Returns the latest reward event.

If certified is true, the request is fetched as an update call, otherwise it’s fetched using a query call.

Parameters

certified

boolean = true

Returns

Promise<RewardEvent>

getMetrics()

getMetrics(__namedParameters): Promise<GovernanceCachedMetrics>

Defined in: packages/canisters/src/nns/governance.canister.ts:1105

Parameters

__namedParameters

certified

boolean = true

Returns

Promise<GovernanceCachedMetrics>

getNetworkEconomicsParameters()

getNetworkEconomicsParameters(__namedParameters): Promise<NetworkEconomics>

Defined in: packages/canisters/src/nns/governance.canister.ts:1030

Return the Network Economics.

Parameters

__namedParameters

certified

boolean = true

Returns

Promise<NetworkEconomics>

getNeuron()

getNeuron(__namedParameters): Promise<NeuronInfo | undefined>

Defined in: packages/canisters/src/nns/governance.canister.ts:1009

Return the data of the neuron provided as id.

Parameters

__namedParameters

certified

boolean = true

neuronId

bigint

Returns

Promise<NeuronInfo | undefined>

getProposal()

getProposal(__namedParameters): Promise<ProposalInfo | undefined>

Defined in: packages/canisters/src/nns/governance.canister.ts:681

Returns single proposal info

If certified is true (default), the request is fetched as an update call, otherwise it is fetched using a query call.

Parameters

__namedParameters

certified?

boolean = true

proposalId

bigint

Returns

Promise<ProposalInfo | undefined>

increaseDissolveDelay()

increaseDissolveDelay(__namedParameters): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:411

Increases dissolve delay of a neuron

Parameters

__namedParameters

additionalDissolveDelaySeconds

number

neuronId

bigint

Returns

Promise<void>

Throws

GovernanceError

joinCommunityFund()

joinCommunityFund(neuronId): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:488

Neuron joins the community fund

Parameters

neuronId

bigint

Returns

Promise<void>

Throws

GovernanceError

leaveCommunityFund()

leaveCommunityFund(neuronId): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:521

Neuron leaves the community fund

Parameters

neuronId

bigint

Returns

Promise<void>

Throws

GovernanceError

listKnownNeurons()

listKnownNeurons(certified): Promise<KnownNeuron[]>

Defined in: packages/canisters/src/nns/governance.canister.ts:289

Returns the list of neurons who have been approved by the community to appear as the default followee options.

If certified is true, the request is fetched as an update call, otherwise it is fetched using a query call.

Parameters

certified

boolean = true

Returns

Promise<KnownNeuron[]>

listNeurons()

listNeurons(__namedParameters): Promise<NeuronInfo[]>

Defined in: packages/canisters/src/nns/governance.canister.ts:156

Returns the list of neurons controlled by the caller.

If an array of neuron IDs is provided, precisely those neurons will be fetched.

If certified is true, the request is fetched as an update call, otherwise it is fetched using a query call.

The backend treats includeEmptyNeurons as false if absent.

The response from the canister might be paginated. In this case, all pages will be fetched in parallel and combined into a single return value.

Parameters

__namedParameters

certified

boolean = true

includeEmptyNeurons?

boolean

includePublicNeurons?

boolean

neuronIds?

bigint[]

neuronSubaccounts?

NeuronSubaccount[]

Returns

Promise<NeuronInfo[]>

listProposals()

listProposals(request): Promise<ListProposalsResponse>

Defined in: packages/canisters/src/nns/governance.canister.ts:331

Returns the list of proposals made for the community to vote on, paginated and filtered by the request.

If certified is true (default), the request is fetched as an update call, otherwise it is fetched using a query call.

Parameters

request

the options to list the proposals (limit number of results, topics to search for, etc.)

certified?

boolean = true

request

ListProposalsRequest

Returns

Promise<ListProposalsResponse>

makeProposal()

makeProposal(request): Promise<bigint | undefined>

Defined in: packages/canisters/src/nns/governance.canister.ts:701

Create new proposal

Parameters

request

MakeProposalRequest

Returns

Promise<bigint | undefined>

The newly created proposal ID or undefined if the success response returned by the Governance canister does not provide such information.

Throws

GovernanceError

mergeMaturity()

mergeMaturity(__namedParameters): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:817

Merge Maturity of a neuron

Parameters

__namedParameters

neuronId

bigint

percentageToMerge

number

Returns

Promise<void>

Throws

GovernanceError

Throws

InvalidPercentageError

mergeNeurons()

mergeNeurons(request): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:576

Merge two neurons

Parameters

request

sourceNeuronId

bigint

targetNeuronId

bigint

Returns

Promise<void>

Throws

GovernanceError

refreshVotingPower()

refreshVotingPower(__namedParameters): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:795

Refreshes voting power of a neuron (Resets the votingPowerRefreshedTimestampSeconds parameter of the neuron to the current time).

Parameters

__namedParameters

neuronId

bigint

Returns

Promise<void>

Throws

GovernanceError

registerVote()

registerVote(__namedParameters): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:722

Registers vote for a proposal from the neuron passed.

Parameters

__namedParameters

neuronId

bigint

proposalId

bigint

vote

Vote

Returns

Promise<void>

Throws

GovernanceError

removeHotkey()

removeHotkey(__namedParameters): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:935

Remove hotkey to neuron

Parameters

__namedParameters

neuronId

bigint

principal

Principal

Returns

Promise<void>

Throws

GovernanceError

setDissolveDelay()

setDissolveDelay(neuronId): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:437

Sets dissolve delay of a neuron. The new date is now + dissolveDelaySeconds.

Parameters

neuronId

dissolveDelaySeconds

number

neuronId

bigint

Returns

Promise<void>

Throws

GovernanceError

setFollowees()

setFollowees(followRequest): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:744

Edit neuron followees per topic

Parameters

followRequest

FollowRequest

Returns

Promise<void>

Throws

GovernanceError

setFollowing()

setFollowing(params): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:1090

Set the following topics for a neuron.

Parameters

params

neuronId

bigint

The id of the neuron for which to set the following topics

topicFollowing

FolloweesForTopic[]

The topics and the followees for each topic that the neuron should follow.

Returns

Promise<void>

setNodeProviderAccount()

setNodeProviderAccount(accountIdentifier): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:556

Sets node provider reward account. Where the reward is paid to.

Parameters

accountIdentifier

string

Returns

Promise<void>

Throws

GovernanceError

Throws

InvalidAccountIDError

setVisibility()

setVisibility(neuronId, visibility): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:536

Set visibility of a neuron

Parameters

neuronId

bigint

visibility

NeuronVisibility

Returns

Promise<void>

Throws

GovernanceError

simulateMergeNeurons()

simulateMergeNeurons(request): Promise<NeuronInfo>

Defined in: packages/canisters/src/nns/governance.canister.ts:593

Simulate merging two neurons

Parameters

request

sourceNeuronId

bigint

targetNeuronId

bigint

Returns

Promise<NeuronInfo>

Throws

GovernanceError

spawnNeuron()

spawnNeuron(__namedParameters): Promise<bigint>

Defined in: packages/canisters/src/nns/governance.canister.ts:868

Merge Maturity of a neuron

Parameters

__namedParameters

neuronId

bigint

newController?

Principal

nonce?

bigint

percentageToSpawn?

number

Returns

Promise<bigint>

Throws

GovernanceError

Throws

InvalidPercentageError

splitNeuron()

splitNeuron(__namedParameters): Promise<bigint>

Defined in: packages/canisters/src/nns/governance.canister.ts:638

Splits a neuron creating a new one

Parameters

__namedParameters

amount

bigint

memo?

bigint

neuronId

bigint

Returns

Promise<bigint>

newNeuronId

Throws

GovernanceError

stakeMaturity()

stakeMaturity(params): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:846

Stake the maturity of a neuron.

Parameters

params

neuronId

bigint

percentageToStake?

number

Returns

Promise<void>

Throws

GovernanceError

Throws

InvalidPercentageError

stakeNeuron()

stakeNeuron(__namedParameters): Promise<bigint>

Defined in: packages/canisters/src/nns/governance.canister.ts:350

Parameters

__namedParameters

createdAt?

bigint

fee?

bigint

fromSubAccount?

number[]

ledgerCanister

IcpLedgerCanister

principal

Principal

stake

bigint

Returns

Promise<bigint>

Throws

InsufficientAmountError

Throws

StakeNeuronTransferError

Throws

CouldNotClaimNeuronError

Throws

TransferError

startDissolving()

startDissolving(neuronId): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:460

Start dissolving process of a neuron

Parameters

neuronId

bigint

Returns

Promise<void>

Throws

GovernanceError

stopDissolving()

stopDissolving(neuronId): Promise<void>

Defined in: packages/canisters/src/nns/governance.canister.ts:474

Stop dissolving process of a neuron

Parameters

neuronId

bigint

Returns

Promise<void>

Throws

GovernanceError

create()

static create(options): NnsGovernanceCanister

Defined in: packages/canisters/src/nns/governance.canister.ts:110

Parameters

options

NnsGovernanceCanisterOptions = {}

Returns

NnsGovernanceCanister

---

NnsGovernanceTestCanister

Defined in: packages/canisters/src/nns/governance_test.canister.ts:19

Methods

updateNeuron()

updateNeuron(neuron): Promise<[] | [GovernanceError]>

Defined in: packages/canisters/src/nns/governance_test.canister.ts:51

Test method to update fields of a neuron.

Only available in the governance test canister.

Parameters

neuron

Neuron

Returns

Promise<[] | [GovernanceError]>

create()

static create(options): NnsGovernanceTestCanister

Defined in: packages/canisters/src/nns/governance_test.canister.ts:28

Parameters

options

CanisterOptions<_SERVICE> = {}

Returns

NnsGovernanceTestCanister

---

SnsWasmCanister

Defined in: packages/canisters/src/nns/sns_wasm.canister.ts:10

Methods

listSnses()

listSnses(__namedParameters): Promise<DeployedSns[]>

Defined in: packages/canisters/src/nns/sns_wasm.canister.ts:29

Parameters

__namedParameters

certified?

boolean = true

Returns

Promise<DeployedSns[]>

create()

static create(options): SnsWasmCanister

Defined in: packages/canisters/src/nns/sns_wasm.canister.ts:16

Parameters

options

CanisterOptions<_SERVICE> = {}

Returns

SnsWasmCanister

---

abstract StakeNeuronError

Defined in: packages/canisters/src/nns/errors/governance.errors.ts:3

Extends

• Error

Extended by

• CouldNotClaimNeuronError
• InsufficientAmountError

Constructors

Constructor

new StakeNeuronError(message?): StakeNeuronError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

StakeNeuronError

Inherited from

Error.constructor

Constructor

new StakeNeuronError(message?, options?): StakeNeuronError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

StakeNeuronError

Inherited from

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

---

UnrecognizedTypeError

Defined in: packages/canisters/src/nns/errors/governance.errors.ts:13

Extends

• Error

Constructors

Constructor

new UnrecognizedTypeError(message?): UnrecognizedTypeError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

Returns

UnrecognizedTypeError

Inherited from

Error.constructor

Constructor

new UnrecognizedTypeError(message?, options?): UnrecognizedTypeError

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters

message?

string

options?

ErrorOptions

Returns

UnrecognizedTypeError

Inherited from

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

---

UnsupportedValueError

Defined in: packages/canisters/src/nns/errors/governance.errors.ts:23

An error used to ensure at compile-time that it’s never reached.

Extends

• Error

Constructors

Constructor

new UnsupportedValueError(value): UnsupportedValueError

Defined in: packages/canisters/src/nns/errors/governance.errors.ts:24

Parameters

value

never

Returns

UnsupportedValueError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

isError()

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

Interfaces

Account

Defined in: packages/canisters/src/nns/types/governance_converters.ts:186

Properties

owner

owner: Option<Principal>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:187

subaccount

subaccount: Option<number[]>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:188

---

AddHotKey

Defined in: packages/canisters/src/nns/types/governance_converters.ts:70

Properties

newHotKey

newHotKey: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:71

---

AddHotKeyRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:605

Properties

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:606

principal

principal: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:607

---

AddOrRemoveNodeProvider

Defined in: packages/canisters/src/nns/types/governance_converters.ts:73

Properties

change

change: Option<Change>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:74

---

ApproveGenesisKyc

Defined in: packages/canisters/src/nns/types/governance_converters.ts:76

Properties

principals

principals: string[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:77

---

Ballot

Defined in: packages/canisters/src/nns/types/governance_converters.ts:82

Properties

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:83

vote

vote: Vote

Defined in: packages/canisters/src/nns/types/governance_converters.ts:84

votingPower

votingPower: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:85

---

BallotInfo

Defined in: packages/canisters/src/nns/types/governance_converters.ts:87

Properties

proposalId

proposalId: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:89

vote

vote: Vote

Defined in: packages/canisters/src/nns/types/governance_converters.ts:88

---

BlessAlternativeGuestOsVersion

Defined in: packages/canisters/src/nns/types/governance_converters.ts:337

Properties

baseGuestLaunchMeasurements

baseGuestLaunchMeasurements: Option<GuestLaunchMeasurements>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:340

chipIds

chipIds: Option<Uint8Array<ArrayBufferLike>[]>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:339

rootfsHash

rootfsHash: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:338

---

CanisterAuthzInfo

Defined in: packages/canisters/src/nns/types/governance_converters.ts:95

Properties

methodsAuthz

methodsAuthz: MethodAuthzInfo[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:96

---

CanisterSettings

Defined in: packages/canisters/src/nns/types/governance_converters.ts:304

Properties

computeAllocation

computeAllocation: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:311

controllers

controllers: Option<string[]>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:306

freezingThreshold

freezingThreshold: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:305

logVisibility

logVisibility: Option<LogVisibility>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:307

memoryAllocation

memoryAllocation: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:310

snapshotVisibility

snapshotVisibility: Option<number>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:308

wasmMemoryLimit

wasmMemoryLimit: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:309

wasmMemoryThreshold

wasmMemoryThreshold: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:312

---

ChangeAutoStakeMaturity

Defined in: packages/canisters/src/nns/types/governance_converters.ts:220

Properties

requestedSettingForAutoStakeMaturity

requestedSettingForAutoStakeMaturity: boolean

Defined in: packages/canisters/src/nns/types/governance_converters.ts:221

---

ClaimNeuronRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:575

Properties

dissolveDelayInSecs

dissolveDelayInSecs: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:578

nonce

nonce: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:577

publicKey

publicKey: DerEncodedPublicKey

Defined in: packages/canisters/src/nns/types/governance_converters.ts:576

---

ClaimOrRefresh

Defined in: packages/canisters/src/nns/types/governance_converters.ts:99

Properties

by

by: Option<By>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:100

---

ClaimOrRefreshNeuronFromAccount

Defined in: packages/canisters/src/nns/types/governance_converters.ts:102

Properties

controller

controller: Option<Principal>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:103

memo

memo: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:104

---

ClaimOrRefreshNeuronRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:106

Properties

by

by: Option<By>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:108

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:107

---

Configure

Defined in: packages/canisters/src/nns/types/governance_converters.ts:142

Properties

operation

operation: Option<Operation>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:143

---

Countries

Defined in: packages/canisters/src/nns/types/governance_converters.ts:737

Properties

isoCodes

isoCodes: string[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:738

---

CreateCanisterAndInstallCode

Defined in: packages/canisters/src/nns/types/governance_converters.ts:353

Properties

canisterSettings

canisterSettings: Option<CanisterSettings>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:355

hostSubnetId

hostSubnetId: Option<Principal>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:357

installArgHash

installArgHash: Option<Uint8Array<ArrayBufferLike>>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:356

wasmModuleHash

wasmModuleHash: Option<Uint8Array<ArrayBufferLike>>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:354

---

CreateServiceNervousSystem

Defined in: packages/canisters/src/nns/types/governance_converters.ts:823

Properties

dappCanisters

dappCanisters: string[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:831

description

description: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:830

fallbackControllerPrincipalIds

fallbackControllerPrincipalIds: string[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:826

governanceParameters

governanceParameters: Option<GovernanceParameters>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:825

initialTokenDistribution

initialTokenDistribution: Option<InitialTokenDistribution>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:833

ledgerParameters

ledgerParameters: Option<LedgerParameters>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:829

logo

logo: Option<Image>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:827

name

name: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:828

swapParameters

swapParameters: Option<SwapParameters>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:832

url

url: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:824

---

CustomProposalCriticality

Defined in: packages/canisters/src/nns/types/governance_converters.ts:776

Properties

additionalCriticalNativeActionIds

additionalCriticalNativeActionIds: Option<bigint[]>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:777

---

Decimal

Defined in: packages/canisters/src/nns/types/governance_converters.ts:452

Properties

humanReadable

humanReadable: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:453

---

DeregisterKnownNeuron

Defined in: packages/canisters/src/nns/types/governance_converters.ts:214

Properties

id

id: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:215

---

DeveloperDistribution

Defined in: packages/canisters/src/nns/types/governance_converters.ts:813

Properties

developerNeurons

developerNeurons: NeuronDistribution[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:814

---

Disburse

Defined in: packages/canisters/src/nns/types/governance_converters.ts:149

Properties

amount

amount: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:151

toAccountId

toAccountId: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:150

---

DisburseMaturity

Defined in: packages/canisters/src/nns/types/governance_converters.ts:190

Properties

percentageToDisburse

percentageToDisburse: number

Defined in: packages/canisters/src/nns/types/governance_converters.ts:193

toAccount

toAccount: Option<Account>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:191

toAccountIdentifier

toAccountIdentifier: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:192

---

DisburseRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:651

Properties

amount?

optional amount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:654

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:652

toAccountId?

optional toAccountId: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:653

---

DisburseResponse

Defined in: packages/canisters/src/nns/types/governance_converters.ts:153

Properties

transferBlockHeight

transferBlockHeight: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:154

---

DisburseToNeuron

Defined in: packages/canisters/src/nns/types/governance_converters.ts:156

Properties

amount

amount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:159

dissolveDelaySeconds

dissolveDelaySeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:157

kycVerified

kycVerified: boolean

Defined in: packages/canisters/src/nns/types/governance_converters.ts:158

newController

newController: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:160

nonce

nonce: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:161

---

DisburseToNeuronRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:657

Properties

amount

amount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:661

dissolveDelaySeconds

dissolveDelaySeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:659

kycVerified

kycVerified: boolean

Defined in: packages/canisters/src/nns/types/governance_converters.ts:660

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:658

newController

newController: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:662

nonce

nonce: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:663

---

Duration

Defined in: packages/canisters/src/nns/types/governance_converters.ts:729

Properties

seconds

seconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:730

---

ExecuteNnsFunction

Defined in: packages/canisters/src/nns/types/governance_converters.ts:173

Properties

nnsFunctionId

nnsFunctionId: number

Defined in: packages/canisters/src/nns/types/governance_converters.ts:174

payloadBytes?

optional payloadBytes: ArrayBuffer

Defined in: packages/canisters/src/nns/types/governance_converters.ts:175

---

Follow

Defined in: packages/canisters/src/nns/types/governance_converters.ts:177

Properties

followees

followees: bigint[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:179

topic

topic: Topic

Defined in: packages/canisters/src/nns/types/governance_converters.ts:178

---

Followees

Defined in: packages/canisters/src/nns/types/governance_converters.ts:181

Properties

followees

followees: bigint[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:183

topic

topic: Topic

Defined in: packages/canisters/src/nns/types/governance_converters.ts:182

---

FolloweesForTopic

Defined in: packages/canisters/src/nns/types/governance_converters.ts:163

Properties

followees

followees: bigint[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:165

topic

topic: Topic

Defined in: packages/canisters/src/nns/types/governance_converters.ts:164

---

FollowRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:628

Properties

followees

followees: bigint[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:631

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:629

topic

topic: Topic

Defined in: packages/canisters/src/nns/types/governance_converters.ts:630

---

FulfillSubnetRentalRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:318

Properties

nodeIds

nodeIds: Principal[] | undefined

Defined in: packages/canisters/src/nns/types/governance_converters.ts:321

replicaVersionId

replicaVersionId: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:320

user

user: Option<Principal>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:319

---

GlobalTimeOfDay

Defined in: packages/canisters/src/nns/types/governance_converters.ts:733

Properties

secondsAfterUtcMidnight

secondsAfterUtcMidnight: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:734

---

GovernanceCachedMetrics

Defined in: packages/canisters/src/nns/types/governance_converters.ts:853

Properties

communityFundTotalMaturityE8sEquivalent

communityFundTotalMaturityE8sEquivalent: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:865

communityFundTotalStakedE8s

communityFundTotalStakedE8s: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:893

decliningVotingPowerNeuronSubsetMetrics

decliningVotingPowerNeuronSubsetMetrics: Option<NeuronSubsetMetrics>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:877

dissolvedNeuronsCount

dissolvedNeuronsCount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:864

dissolvedNeuronsE8s

dissolvedNeuronsE8s: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:880

dissolvingNeuronsCount

dissolvingNeuronsCount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:890

dissolvingNeuronsCountBuckets

dissolvingNeuronsCountBuckets: [bigint, bigint][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:887

dissolvingNeuronsE8sBuckets

dissolvingNeuronsE8sBuckets: [bigint, number][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:891

dissolvingNeuronsE8sBucketsEct

dissolvingNeuronsE8sBucketsEct: [bigint, number][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:888

dissolvingNeuronsE8sBucketsSeed

dissolvingNeuronsE8sBucketsSeed: [bigint, number][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:882

dissolvingNeuronsStakedMaturityE8sEquivalentBuckets

dissolvingNeuronsStakedMaturityE8sEquivalentBuckets: [bigint, number][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:858

dissolvingNeuronsStakedMaturityE8sEquivalentSum

dissolvingNeuronsStakedMaturityE8sEquivalentSum: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:856

ectNeuronCount

ectNeuronCount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:861

fullyLostVotingPowerNeuronSubsetMetrics

fullyLostVotingPowerNeuronSubsetMetrics: Option<NeuronSubsetMetrics>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:869

garbageCollectableNeuronsCount

garbageCollectableNeuronsCount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:857

neuronsFundTotalActiveNeurons

neuronsFundTotalActiveNeurons: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:872

neuronsWithInvalidStakeCount

neuronsWithInvalidStakeCount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:859

neuronsWithLessThan6MonthsDissolveDelayCount

neuronsWithLessThan6MonthsDissolveDelayCount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:863

neuronsWithLessThan6MonthsDissolveDelayE8s

neuronsWithLessThan6MonthsDissolveDelayE8s: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:883

nonSelfAuthenticatingControllerNeuronSubsetMetrics

nonSelfAuthenticatingControllerNeuronSubsetMetrics: Option<NeuronSubsetMetrics>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:889

notDissolvingNeuronsCount

notDissolvingNeuronsCount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:870

notDissolvingNeuronsCountBuckets

notDissolvingNeuronsCountBuckets: [bigint, bigint][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:860

notDissolvingNeuronsE8sBuckets

notDissolvingNeuronsE8sBuckets: [bigint, number][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:855

notDissolvingNeuronsE8sBucketsEct

notDissolvingNeuronsE8sBucketsEct: [bigint, number][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:875

notDissolvingNeuronsE8sBucketsSeed

notDissolvingNeuronsE8sBucketsSeed: [bigint, number][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:894

notDissolvingNeuronsStakedMaturityE8sEquivalentBuckets

notDissolvingNeuronsStakedMaturityE8sEquivalentBuckets: [bigint, number][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:884

notDissolvingNeuronsStakedMaturityE8sEquivalentSum

notDissolvingNeuronsStakedMaturityE8sEquivalentSum: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:879

publicNeuronSubsetMetrics

publicNeuronSubsetMetrics: Option<NeuronSubsetMetrics>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:895

seedNeuronCount

seedNeuronCount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:897

spawningNeuronsCount

spawningNeuronsCount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:876

timestampSeconds

timestampSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:896

totalLockedE8s

totalLockedE8s: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:871

totalMaturityDisbursementsInProgressE8sEquivalent

totalMaturityDisbursementsInProgressE8sEquivalent: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:904

SDK DIVERGENCE: optional here even though the backend declares the underlying Candid field as required, so the SDK can decode responses from canister versions that predate the field (e.g. bundled dfx wasms, rolling-release mainnet). See the comment on governance.did.

totalMaturityE8sEquivalent

totalMaturityE8sEquivalent: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:854

totalStakedE8s

totalStakedE8s: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:868

totalStakedE8sEct

totalStakedE8sEct: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:878

totalStakedE8sNonSelfAuthenticatingController

totalStakedE8sNonSelfAuthenticatingController: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:881

totalStakedE8sSeed

totalStakedE8sSeed: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:866

totalStakedMaturityE8sEquivalent

totalStakedMaturityE8sEquivalent: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:874

totalStakedMaturityE8sEquivalentEct

totalStakedMaturityE8sEquivalentEct: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:867

totalStakedMaturityE8sEquivalentSeed

totalStakedMaturityE8sEquivalentSeed: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:892

totalSupplyIcp

totalSupplyIcp: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:862

totalVotingPowerNonSelfAuthenticatingController

totalVotingPowerNonSelfAuthenticatingController: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:873

---

GovernanceParameters

Defined in: packages/canisters/src/nns/types/governance_converters.ts:762

Properties

customProposalCriticality

customProposalCriticality: Option<CustomProposalCriticality>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:773

neuronMaximumAgeBonus

neuronMaximumAgeBonus: Option<Percentage>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:767

neuronMaximumAgeForAgeBonus

neuronMaximumAgeForAgeBonus: Option<Duration>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:764

neuronMaximumDissolveDelay

neuronMaximumDissolveDelay: Option<Duration>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:765

neuronMaximumDissolveDelayBonus

neuronMaximumDissolveDelayBonus: Option<Percentage>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:763

neuronMinimumDissolveDelayToVote

neuronMinimumDissolveDelayToVote: Option<Duration>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:766

neuronMinimumStake

neuronMinimumStake: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:768

proposalInitialVotingPeriod

proposalInitialVotingPeriod: Option<Duration>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:770

proposalRejectionFee

proposalRejectionFee: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:771

proposalWaitForQuietDeadlineIncrease

proposalWaitForQuietDeadlineIncrease: Option<Duration>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:769

votingRewardParameters

votingRewardParameters: Option<VotingRewardParameters>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:772

---

GuestLaunchMeasurement

Defined in: packages/canisters/src/nns/types/governance_converters.ts:327

Properties

measurement

measurement: Option<Uint8Array<ArrayBufferLike>>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:332

SEV-SNP measurement (48 bytes).

metadata

metadata: Option<GuestLaunchMeasurementMetadata>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:328

---

GuestLaunchMeasurementMetadata

Defined in: packages/canisters/src/nns/types/governance_converters.ts:323

Properties

kernelCmdline

kernelCmdline: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:324

vcpuType

vcpuType: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:325

---

GuestLaunchMeasurements

Defined in: packages/canisters/src/nns/types/governance_converters.ts:334

Properties

guestLaunchMeasurements

guestLaunchMeasurements: Option<GuestLaunchMeasurement[]>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:335

---

Image

Defined in: packages/canisters/src/nns/types/governance_converters.ts:745

Properties

base64Encoding

base64Encoding: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:746

---

IncreaseDissolveDelay

Defined in: packages/canisters/src/nns/types/governance_converters.ts:204

Properties

additionalDissolveDelaySeconds

additionalDissolveDelaySeconds: number

Defined in: packages/canisters/src/nns/types/governance_converters.ts:205

---

IncreaseDissolveDelayRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:623

Properties

additionalDissolveDelaySeconds

additionalDissolveDelaySeconds: number

Defined in: packages/canisters/src/nns/types/governance_converters.ts:625

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:624

---

InitialTokenDistribution

Defined in: packages/canisters/src/nns/types/governance_converters.ts:817

Properties

developerDistribution

developerDistribution: Option<DeveloperDistribution>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:819

swapDistribution

swapDistribution: Option<SwapDistribution>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:820

treasuryDistribution

treasuryDistribution: Option<SwapDistribution>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:818

---

InstallCode

Defined in: packages/canisters/src/nns/types/governance_converters.ts:286

Properties

argHash

argHash: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:287

canisterId

canisterId: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:290

installMode

installMode: Option<CanisterInstallMode>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:291

skipStoppingBeforeInstalling

skipStoppingBeforeInstalling: Option<boolean>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:289

wasmModuleHash

wasmModuleHash: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:288

---

InstallCodeRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:293

Properties

arg

arg: ArrayBuffer

Defined in: packages/canisters/src/nns/types/governance_converters.ts:294

canisterId

canisterId: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:297

installMode

installMode: Option<CanisterInstallMode>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:298

skipStoppingBeforeInstalling

skipStoppingBeforeInstalling: Option<boolean>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:296

wasmModule

wasmModule: ArrayBuffer

Defined in: packages/canisters/src/nns/types/governance_converters.ts:295

---

JoinCommunityFundRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:666

Properties

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:667

---

KnownNeuron

Defined in: packages/canisters/src/nns/types/governance_converters.ts:207

Properties

committed_topics

committed_topics: Option<([] | [TopicToFollow])[]>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:212

description

description: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:210

id

id: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:208

links

links: Option<string[]>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:211

name

name: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:209

---

LedgerParameters

Defined in: packages/canisters/src/nns/types/governance_converters.ts:749

Properties

tokenLogo

tokenLogo: Option<Image>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:752

tokenName

tokenName: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:753

tokenSymbol

tokenSymbol: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:751

transactionFee

transactionFee: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:750

---

ListNodeProvidersResponse

Defined in: packages/canisters/src/nns/types/governance_converters.ts:721

Properties

nodeProviders

nodeProviders: NodeProvider[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:722

---

ListProposalsRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:226

Properties

beforeProposal

beforeProposal: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:235

excludeTopic

excludeTopic: Topic[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:249

includeAllManageNeuronProposals

includeAllManageNeuronProposals: boolean

Defined in: packages/canisters/src/nns/types/governance_converters.ts:254

includeRewardStatus

includeRewardStatus: ProposalRewardStatus[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:243

includeStatus

includeStatus: ProposalStatus[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:259

limit

limit: number

Defined in: packages/canisters/src/nns/types/governance_converters.ts:230

omitLargeFields?

optional omitLargeFields: boolean

Defined in: packages/canisters/src/nns/types/governance_converters.ts:265

returnSelfDescribingAction?

optional returnSelfDescribingAction: boolean

Defined in: packages/canisters/src/nns/types/governance_converters.ts:268

---

ListProposalsResponse

Defined in: packages/canisters/src/nns/types/governance_converters.ts:270

Properties

proposals

proposals: ProposalInfo[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:271

---

LoadCanisterSnapshot

Defined in: packages/canisters/src/nns/types/governance_converters.ts:348

Properties

canisterId

canisterId: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:349

snapshotId

snapshotId: Option<Uint8Array<ArrayBufferLike>>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:350

---

MakeExecuteNnsFunctionProposalRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:712

Properties

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:713

nnsFunction

nnsFunction: number

Defined in: packages/canisters/src/nns/types/governance_converters.ts:717

payload

payload: ArrayBuffer

Defined in: packages/canisters/src/nns/types/governance_converters.ts:718

summary

summary: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:715

title

title: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:714

url

url: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:716

---

MakeMotionProposalRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:678

Properties

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:679

summary

summary: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:683

text

text: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:682

title

title: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:680

url

url: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:681

---

MakeNetworkEconomicsProposalRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:686

Properties

networkEconomics

networkEconomics: NetworkEconomics

Defined in: packages/canisters/src/nns/types/governance_converters.ts:691

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:687

summary

summary: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:689

title

title: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:688

url

url: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:690

---

MakeProposalRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:670

Properties

action

action: ProposalActionRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:675

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:671

summary

summary: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:674

title

title: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:672

url

url: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:673

---

MakeProposalResponse

Defined in: packages/canisters/src/nns/types/governance_converters.ts:273

Properties

proposalId

proposalId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:274

---

MakeRewardNodeProviderProposalRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:694

Properties

amount

amount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:700

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:695

nodeProvider

nodeProvider: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:699

rewardMode

rewardMode: Option<RewardMode>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:701

summary

summary: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:697

title

title: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:696

url

url: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:698

---

MakeSetDefaultFolloweesProposalRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:704

Properties

followees

followees: Followees[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:709

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:705

summary

summary: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:707

title

title: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:706

url

url: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:708

---

ManageNeuron

Defined in: packages/canisters/src/nns/types/governance_converters.ts:276

Properties

command

command: Option<Command>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:278

id

id: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:277

neuronIdOrSubaccount

neuronIdOrSubaccount: Option<NeuronIdOrSubaccount>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:279

---

ManageNeuronRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:281

Properties

command

command: Option<ManageNeuronCommandRequest>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:283

id

id: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:282

neuronIdOrSubaccount

neuronIdOrSubaccount: Option<NeuronIdOrSubaccount>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:284

---

MaturityDisbursement

Defined in: packages/canisters/src/nns/types/governance_converters.ts:196

Properties

accountIdentifierToDisburseTo

accountIdentifierToDisburseTo: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:200

accountToDisburseTo

accountToDisburseTo: Option<Account>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:199

amountE8s

amountE8s: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:198

finalizeDisbursementTimestampSeconds

finalizeDisbursementTimestampSeconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:201

timestampOfDisbursementSeconds

timestampOfDisbursementSeconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:197

---

Merge

Defined in: packages/canisters/src/nns/types/governance_converters.ts:360

Properties

sourceNeuronId

sourceNeuronId: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:361

---

MergeMaturity

Defined in: packages/canisters/src/nns/types/governance_converters.ts:370

Properties

percentageToMerge

percentageToMerge: number

Defined in: packages/canisters/src/nns/types/governance_converters.ts:371

---

MergeMaturityRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:373

Properties

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:374

percentageToMerge

percentageToMerge: number

Defined in: packages/canisters/src/nns/types/governance_converters.ts:375

---

MergeMaturityResponse

Defined in: packages/canisters/src/nns/types/governance_converters.ts:377

Properties

mergedMaturityE8s

mergedMaturityE8s: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:378

newStakeE8s

newStakeE8s: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:379

---

MergeRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:363

Properties

sourceNeuronId

sourceNeuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:364

targetNeuronId

targetNeuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:365

---

MethodAuthzChange

Defined in: packages/canisters/src/nns/types/governance_converters.ts:381

Properties

canister

canister: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:384

methodName

methodName: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:383

operation

operation: AuthzChangeOp

Defined in: packages/canisters/src/nns/types/governance_converters.ts:385

principal

principal: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:382

---

MethodAuthzInfo

Defined in: packages/canisters/src/nns/types/governance_converters.ts:387

Properties

methodName

methodName: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:388

principalIds

principalIds: ArrayBuffer[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:389

---

Motion

Defined in: packages/canisters/src/nns/types/governance_converters.ts:391

Properties

motionText

motionText: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:392

---

NetworkEconomics

Defined in: packages/canisters/src/nns/types/governance_converters.ts:424

Properties

maximumNodeProviderRewards

maximumNodeProviderRewards: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:432

maxProposalsToKeepPerTopic

maxProposalsToKeepPerTopic: number

Defined in: packages/canisters/src/nns/types/governance_converters.ts:426

minimumIcpXdrRate

minimumIcpXdrRate: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:431

neuronManagementFeePerProposal

neuronManagementFeePerProposal: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:427

neuronMinimumStake

neuronMinimumStake: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:425

neuronsFundEconomics

neuronsFundEconomics: Option<NeuronsFundEconomics>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:433

neuronSpawnDissolveDelaySeconds

neuronSpawnDissolveDelaySeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:430

rejectCost

rejectCost: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:428

transactionFee

transactionFee: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:429

votingPowerEconomics

votingPowerEconomics: Option<VotingPowerEconomics>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:434

---

Neuron

Defined in: packages/canisters/src/nns/types/governance_converters.ts:455

Properties

accountIdentifier

accountIdentifier: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:471

agingSinceTimestampSeconds

agingSinceTimestampSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:467

autoStakeMaturity

autoStakeMaturity: Option<boolean>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:465

cachedNeuronStake

cachedNeuronStake: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:463

controller

controller: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:459

createdTimestampSeconds

createdTimestampSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:464

decidingVotingPower

decidingVotingPower: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:479

dissolveState

dissolveState: Option<DissolveState>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:474

eightYearGangBonusBaseE8s

eightYearGangBonusBaseE8s: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:480

followees

followees: Followees[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:475

hotKeys

hotKeys: string[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:470

id

id: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:456

joinedCommunityFundTimestampSeconds

joinedCommunityFundTimestampSeconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:472

kycVerified

kycVerified: boolean

Defined in: packages/canisters/src/nns/types/governance_converters.ts:461

maturityDisbursementsInProgress

maturityDisbursementsInProgress: Option<MaturityDisbursement[]>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:473

maturityE8sEquivalent

maturityE8sEquivalent: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:466

neuronFees

neuronFees: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:469

neuronType

neuronType: Option<NeuronType>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:457

notForProfit

notForProfit: boolean

Defined in: packages/canisters/src/nns/types/governance_converters.ts:462

potentialVotingPower

potentialVotingPower: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:478

recentBallots

recentBallots: BallotInfo[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:460

spawnAtTimesSeconds

spawnAtTimesSeconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:468

stakedMaturityE8sEquivalent

stakedMaturityE8sEquivalent: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:458

visibility

visibility: Option<NeuronVisibility>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:476

votingPowerRefreshedTimestampSeconds

votingPowerRefreshedTimestampSeconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:477

---

NeuronBasketConstructionParameters

Defined in: packages/canisters/src/nns/types/governance_converters.ts:780

Properties

count

count: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:782

dissolveDelayInterval

dissolveDelayInterval: Option<Duration>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:781

---

NeuronDistribution

Defined in: packages/canisters/src/nns/types/governance_converters.ts:805

Properties

controller

controller: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:806

dissolveDelay

dissolveDelay: Option<Duration>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:807

memo

memo: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:808

stake

stake: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:810

vestingPeriod

vestingPeriod: Option<Duration>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:809

---

NeuronInfo

Defined in: packages/canisters/src/nns/types/governance_converters.ts:485

Properties

ageSeconds

ageSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:499

createdTimestampSeconds

createdTimestampSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:490

decidingVotingPower

decidingVotingPower: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:496

dissolveDelaySeconds

dissolveDelaySeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:487

eightYearGangBonusBaseE8s

eightYearGangBonusBaseE8s: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:498

fullNeuron

fullNeuron: Option<Neuron>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:500

joinedCommunityFundTimestampSeconds

joinedCommunityFundTimestampSeconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:492

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:486

neuronType

neuronType: Option<NeuronType>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:489

potentialVotingPower

potentialVotingPower: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:497

recentBallots

recentBallots: BallotInfo[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:488

retrievedAtTimestampSeconds

retrievedAtTimestampSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:493

state

state: NeuronState

Defined in: packages/canisters/src/nns/types/governance_converters.ts:491

visibility

visibility: Option<NeuronVisibility>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:501

votingPower

votingPower: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:494

votingPowerRefreshedTimestampSeconds

votingPowerRefreshedTimestampSeconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:495

---

NeuronsFundEconomics

Defined in: packages/canisters/src/nns/types/governance_converters.ts:441

Properties

maximumIcpXdrRate

maximumIcpXdrRate: Option<Percentage>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:442

maxTheoreticalNeuronsFundParticipationAmountXdr

maxTheoreticalNeuronsFundParticipationAmountXdr: Option<Decimal>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:444

minimumIcpXdrRate

minimumIcpXdrRate: Option<Percentage>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:445

neuronsFundMatchedFundingCurveCoefficients

neuronsFundMatchedFundingCurveCoefficients: Option<NeuronsFundMatchedFundingCurveCoefficients>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:443

---

NeuronsFundMatchedFundingCurveCoefficients

Defined in: packages/canisters/src/nns/types/governance_converters.ts:447

Properties

contributionThresholdXdr

contributionThresholdXdr: Option<Decimal>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:448

fullParticipationMilestoneXdr

fullParticipationMilestoneXdr: Option<Decimal>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:450

oneThirdParticipationMilestoneXdr

oneThirdParticipationMilestoneXdr: Option<Decimal>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:449

---

NeuronSubsetMetrics

Defined in: packages/canisters/src/nns/types/governance_converters.ts:836

Properties

count

count: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:841

countBuckets

countBuckets: [bigint, bigint][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:850

decidingVotingPowerBuckets

decidingVotingPowerBuckets: [bigint, bigint][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:842

maturityE8sEquivalentBuckets

maturityE8sEquivalentBuckets: [bigint, bigint][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:838

potentialVotingPowerBuckets

potentialVotingPowerBuckets: [bigint, bigint][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:849

stakedE8sBuckets

stakedE8sBuckets: [bigint, bigint][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:847

stakedMaturityE8sEquivalentBuckets

stakedMaturityE8sEquivalentBuckets: [bigint, bigint][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:846

totalDecidingVotingPower

totalDecidingVotingPower: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:845

totalMaturityE8sEquivalent

totalMaturityE8sEquivalent: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:837

totalPotentialVotingPower

totalPotentialVotingPower: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:844

totalStakedE8s

totalStakedE8s: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:840

totalStakedMaturityE8sEquivalent

totalStakedMaturityE8sEquivalent: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:843

totalVotingPower

totalVotingPower: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:848

votingPowerBuckets

votingPowerBuckets: [bigint, bigint][]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:839

---

NnsGovernanceCanisterOptions

Defined in: packages/canisters/src/nns/types/governance.options.ts:5

Extends

• CanisterOptions<_SERVICE>

Properties

agent?

optional agent: Agent

Defined in: packages/utils/dist/types/canister.options.d.ts:4

Inherited from

CanisterOptions.agent

canisterId?

optional canisterId: Principal

Defined in: packages/utils/dist/types/canister.options.d.ts:5

Inherited from

CanisterOptions.canisterId

certifiedServiceOverride?

optional certifiedServiceOverride: ActorSubclass<_SERVICE>

Defined in: packages/utils/dist/types/canister.options.d.ts:7

Inherited from

CanisterOptions.certifiedServiceOverride

hardwareWallet?

optional hardwareWallet: boolean

Defined in: packages/canisters/src/nns/types/governance.options.ts:8

oldListNeuronsServiceOverride?

optional oldListNeuronsServiceOverride: ActorSubclass<_SERVICE>

Defined in: packages/canisters/src/nns/types/governance.options.ts:9

serviceOverride?

optional serviceOverride: ActorSubclass<_SERVICE>

Defined in: packages/utils/dist/types/canister.options.d.ts:6

Inherited from

CanisterOptions.serviceOverride

---

NodeProvider

Defined in: packages/canisters/src/nns/types/governance_converters.ts:504

Properties

id

id: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:505

rewardAccount

rewardAccount: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:506

---

OpenSnsTokenSwap

Defined in: packages/canisters/src/nns/types/governance_converters.ts:394

Properties

communityFundInvestmentE8s

communityFundInvestmentE8s: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:395

params

params: Option<{ maxDirectParticipationIcpE8s: Option<bigint>; maxIcpE8s: bigint; maxParticipantIcpE8s: bigint; minDirectParticipationIcpE8s: Option<bigint>; minIcpE8s: bigint; minParticipantIcpE8s: bigint; minParticipants: number; neuronBasketConstructionParameters: Option<{ count: bigint; dissolve_delay_interval_seconds: bigint; }>; saleDelaySeconds: Option<bigint>; snsTokenE8s: bigint; swapDueTimestampSeconds: bigint; }>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:397

targetSwapCanisterId

targetSwapCanisterId: Option<Principal>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:396

---

Percentage

Defined in: packages/canisters/src/nns/types/governance_converters.ts:725

Properties

basisPoints

basisPoints: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:726

---

Proposal

Defined in: packages/canisters/src/nns/types/governance_converters.ts:526

Properties

action

action: Option<Action>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:529

selfDescribingAction

selfDescribingAction: Option<SelfDescribingProposalAction>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:531

summary

summary: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:530

title

title: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:527

url

url: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:528

---

ProposalInfo

Defined in: packages/canisters/src/nns/types/governance_converters.ts:535

Properties

ballots

ballots: Ballot[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:537

deadlineTimestampSeconds

deadlineTimestampSeconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:543

decidedTimestampSeconds

decidedTimestampSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:542

executedTimestampSeconds

executedTimestampSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:547

failedTimestampSeconds

failedTimestampSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:541

id

id: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:536

latestTally

latestTally: Option<Tally>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:544

proposal

proposal: Option<Proposal>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:545

proposalTimestampSeconds

proposalTimestampSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:539

proposer

proposer: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:546

rejectCost

rejectCost: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:538

rewardEventRound

rewardEventRound: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:540

rewardStatus

rewardStatus: ProposalRewardStatus

Defined in: packages/canisters/src/nns/types/governance_converters.ts:550

status

status: ProposalStatus

Defined in: packages/canisters/src/nns/types/governance_converters.ts:549

topic

topic: Topic

Defined in: packages/canisters/src/nns/types/governance_converters.ts:548

totalPotentialVotingPower

totalPotentialVotingPower: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:551

---

RefreshVotingPower

Defined in: packages/canisters/src/nns/types/governance_converters.ts:146

---

RegisterVote

Defined in: packages/canisters/src/nns/types/governance_converters.ts:554

Properties

proposal

proposal: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:556

vote

vote: Vote

Defined in: packages/canisters/src/nns/types/governance_converters.ts:555

---

RegisterVoteRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:634

Properties

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:635

proposal

proposal: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:637

vote

vote: Vote

Defined in: packages/canisters/src/nns/types/governance_converters.ts:636

---

RemoveHotKey

Defined in: packages/canisters/src/nns/types/governance_converters.ts:558

Properties

hotKeyToRemove

hotKeyToRemove: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:559

---

RemoveHotKeyRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:610

Properties

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:611

principal

principal: string

Defined in: packages/canisters/src/nns/types/governance_converters.ts:612

---

RewardNodeProvider

Defined in: packages/canisters/src/nns/types/governance_converters.ts:581

Properties

amountE8s

amountE8s: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:584

nodeProvider

nodeProvider: Option<NodeProvider>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:582

rewardMode

rewardMode: Option<RewardMode>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:583

---

RewardNodeProviders

Defined in: packages/canisters/src/nns/types/governance_converters.ts:564

Properties

rewards

rewards: RewardNodeProvider[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:566

useRegistryDerivedRewards

useRegistryDerivedRewards: boolean | undefined

Defined in: packages/canisters/src/nns/types/governance_converters.ts:565

---

RewardToAccount

Defined in: packages/canisters/src/nns/types/governance_converters.ts:568

Properties

toAccount

toAccount: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:569

---

RewardToNeuron

Defined in: packages/canisters/src/nns/types/governance_converters.ts:571

Properties

dissolveDelaySeconds

dissolveDelaySeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:572

---

SelfDescribingProposalAction

Defined in: packages/canisters/src/nns/types/governance_converters.ts:520

Properties

typeDescription

typeDescription: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:521

typeName

typeName: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:522

value

value: Option<SelfDescribingValue>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:523

---

SetDefaultFollowees

Defined in: packages/canisters/src/nns/types/governance_converters.ts:586

Properties

defaultFollowees

defaultFollowees: Followees[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:587

---

SetDissolveTimestamp

Defined in: packages/canisters/src/nns/types/governance_converters.ts:217

Properties

dissolveTimestampSeconds

dissolveTimestampSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:218

---

SetFollowing

Defined in: packages/canisters/src/nns/types/governance_converters.ts:167

Properties

topicFollowing

topicFollowing: FolloweesForTopic[]

Defined in: packages/canisters/src/nns/types/governance_converters.ts:168

---

SetSnsTokenSwapOpenTimeWindow

Defined in: packages/canisters/src/nns/types/governance_converters.ts:415

Properties

request

request: Option<{ openTimeWindow: Option<{ endTimestampSeconds: bigint; startTimestampSeconds: bigint; }>; }>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:416

swapCanisterId

swapCanisterId: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:422

---

SetVisibility

Defined in: packages/canisters/src/nns/types/governance_converters.ts:223

Properties

visibility

visibility: Option<NeuronVisibility>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:224

---

Spawn

Defined in: packages/canisters/src/nns/types/governance_converters.ts:589

Properties

newController

newController: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:590

percentageToSpawn

percentageToSpawn: number | undefined

Defined in: packages/canisters/src/nns/types/governance_converters.ts:591

---

SpawnRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:640

Properties

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:641

newController

newController: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:642

percentageToSpawn?

optional percentageToSpawn: number

Defined in: packages/canisters/src/nns/types/governance_converters.ts:643

---

Split

Defined in: packages/canisters/src/nns/types/governance_converters.ts:594

Properties

amount

amount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:595

memo

memo: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:596

---

SplitRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:646

Properties

amount

amount: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:648

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:647

---

StakeMaturity

Defined in: packages/canisters/src/nns/types/governance_converters.ts:367

Properties

percentageToStake

percentageToStake: Option<number>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:368

---

StartDissolvingRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:615

Properties

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:616

---

StopDissolvingRequest

Defined in: packages/canisters/src/nns/types/governance_converters.ts:619

Properties

neuronId

neuronId: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:620

---

StopOrStartCanister

Defined in: packages/canisters/src/nns/types/governance_converters.ts:300

Properties

action

action: Option<CanisterAction>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:302

canisterId

canisterId: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:301

---

SwapDistribution

Defined in: packages/canisters/src/nns/types/governance_converters.ts:801

Properties

total

total: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:802

---

SwapParameters

Defined in: packages/canisters/src/nns/types/governance_converters.ts:784

Properties

confirmationText

confirmationText: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:788

duration

duration: Option<Duration>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:786

maxDirectParticipationIcp

maxDirectParticipationIcp: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:796

maximumIcp

maximumIcp: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:794

maximumParticipantIcp

maximumParticipantIcp: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:789

minDirectParticipationIcp

minDirectParticipationIcp: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:797

minimumIcp

minimumIcp: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:791

minimumParticipantIcp

minimumParticipantIcp: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:792

minimumParticipants

minimumParticipants: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:785

neuronBasketConstructionParameters

neuronBasketConstructionParameters: Option<NeuronBasketConstructionParameters>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:787

neuronsFundInvestmentIcp

neuronsFundInvestmentIcp: Option<Tokens>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:790

neuronsFundParticipation

neuronsFundParticipation: Option<boolean>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:798

restrictedCountries

restrictedCountries: Option<Countries>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:795

startTime

startTime: Option<GlobalTimeOfDay>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:793

---

TakeCanisterSnapshot

Defined in: packages/canisters/src/nns/types/governance_converters.ts:343

Properties

canisterId

canisterId: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:345

replaceSnapshot

replaceSnapshot: Option<Uint8Array<ArrayBufferLike>>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:344

---

Tally

Defined in: packages/canisters/src/nns/types/governance_converters.ts:598

Properties

no

no: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:599

timestampSeconds

timestampSeconds: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:602

total

total: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:601

yes

yes: bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:600

---

Tokens

Defined in: packages/canisters/src/nns/types/governance_converters.ts:741

Properties

e8s

e8s: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:742

---

UpdateCanisterSettings

Defined in: packages/canisters/src/nns/types/governance_converters.ts:314

Properties

canisterId

canisterId: Option<string>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:315

settings

settings: Option<CanisterSettings>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:316

---

VotingPowerEconomics

Defined in: packages/canisters/src/nns/types/governance_converters.ts:436

Properties

clearFollowingAfterSeconds

clearFollowingAfterSeconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:439

neuronMinimumDissolveDelayToVoteSeconds

neuronMinimumDissolveDelayToVoteSeconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:438

startReducingVotingPowerAfterSeconds

startReducingVotingPowerAfterSeconds: Option<bigint>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:437

---

VotingRewardParameters

Defined in: packages/canisters/src/nns/types/governance_converters.ts:756

Properties

finalRewardRate

finalRewardRate: Option<Percentage>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:759

initialRewardRate

initialRewardRate: Option<Percentage>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:758

rewardRateTransitionDuration

rewardRateTransitionDuration: Option<Duration>

Defined in: packages/canisters/src/nns/types/governance_converters.ts:757

Type Aliases

Action

Action = { RegisterKnownNeuron: KnownNeuron; } | { DeregisterKnownNeuron: DeregisterKnownNeuron; } | { ExecuteNnsFunction: ExecuteNnsFunction; } | { CreateServiceNervousSystem: CreateServiceNervousSystem; } | { ManageNeuron: ManageNeuron; } | { InstallCode: InstallCode; } | { StopOrStartCanister: StopOrStartCanister; } | { UpdateCanisterSettings: UpdateCanisterSettings; } | { FulfillSubnetRentalRequest: FulfillSubnetRentalRequest; } | { BlessAlternativeGuestOsVersion: BlessAlternativeGuestOsVersion; } | { ApproveGenesisKyc: ApproveGenesisKyc; } | { ManageNetworkEconomics: NetworkEconomics; } | { RewardNodeProvider: RewardNodeProvider; } | { RewardNodeProviders: RewardNodeProviders; } | { AddOrRemoveNodeProvider: AddOrRemoveNodeProvider; } | { SetDefaultFollowees: SetDefaultFollowees; } | { Motion: Motion; } | { SetSnsTokenSwapOpenTimeWindow: SetSnsTokenSwapOpenTimeWindow; } | { OpenSnsTokenSwap: OpenSnsTokenSwap; } | { TakeCanisterSnapshot: TakeCanisterSnapshot; } | { LoadCanisterSnapshot: LoadCanisterSnapshot; } | { CreateCanisterAndInstallCode: CreateCanisterAndInstallCode; }

Defined in: packages/canisters/src/nns/types/governance_converters.ts:25

---

AuthzChangeOp

AuthzChangeOp = { Authorize: { addSelf: boolean; }; } | { Deauthorize: null; }

Defined in: packages/canisters/src/nns/types/governance_converters.ts:79

---

By

By = { NeuronIdOrSubaccount: Record<string, never>; } | { MemoAndController: ClaimOrRefreshNeuronFromAccount; } | { Memo: bigint; }

Defined in: packages/canisters/src/nns/types/governance_converters.ts:91

---

CanisterIdString

CanisterIdString = string

Defined in: packages/canisters/src/nns/types/common.ts:1

---

Change

Change = { ToRemove: NodeProvider; } | { ToAdd: NodeProvider; }

Defined in: packages/canisters/src/nns/types/governance_converters.ts:98

---

Command

Command = { Spawn: Spawn; } | { Split: Split; } | { Follow: Follow; } | { ClaimOrRefresh: ClaimOrRefresh; } | { Configure: Configure; } | { RegisterVote: RegisterVote; } | { Merge: Merge; } | { DisburseToNeuron: DisburseToNeuron; } | { SetFollowing: SetFollowing; } | { MergeMaturity: MergeMaturity; } | { StakeMaturity: StakeMaturity; } | { MakeProposal: Proposal; } | { Disburse: Disburse; } | { RefreshVotingPower: RefreshVotingPower; } | { DisburseMaturity: DisburseMaturity; }

Defined in: packages/canisters/src/nns/types/governance_converters.ts:110

---

DissolveState

DissolveState = { DissolveDelaySeconds: bigint; } | { WhenDissolvedTimestampSeconds: bigint; }

Defined in: packages/canisters/src/nns/types/governance_converters.ts:170

---

E8s

E8s = bigint

Defined in: packages/canisters/src/nns/types/common.ts:3

---

ManageNeuronCommandRequest

ManageNeuronCommandRequest = { Spawn: Spawn; } | { Split: Split; } | { Follow: Follow; } | { ClaimOrRefresh: ClaimOrRefresh; } | { Configure: Configure; } | { RegisterVote: RegisterVote; } | { Merge: Merge; } | { DisburseToNeuron: DisburseToNeuron; } | { SetFollowing: SetFollowing; } | { MergeMaturity: MergeMaturity; } | { StakeMaturity: StakeMaturity; } | { MakeProposal: MakeProposalRequest; } | { Disburse: Disburse; } | { DisburseMaturity: DisburseMaturity; }

Defined in: packages/canisters/src/nns/types/governance_converters.ts:127

---

Memo

Memo = bigint

Defined in: packages/canisters/src/nns/types/common.ts:4

---

NeuronId

NeuronId = bigint

Defined in: packages/canisters/src/nns/types/common.ts:2

---

NeuronIdOrSubaccount

NeuronIdOrSubaccount = { Subaccount: number[]; } | { NeuronId: NeuronId; }

Defined in: packages/canisters/src/nns/types/governance_converters.ts:482

---

Operation

Operation = { RemoveHotKey: RemoveHotKey; } | { AddHotKey: AddHotKey; } | { StopDissolving: Record<string, never>; } | { StartDissolving: Record<string, never>; } | { IncreaseDissolveDelay: IncreaseDissolveDelay; } | { JoinCommunityFund: Record<string, never>; } | { LeaveCommunityFund: Record<string, never>; } | { SetDissolveTimestamp: SetDissolveTimestamp; } | { ChangeAutoStakeMaturity: ChangeAutoStakeMaturity; } | { SetVisibility: SetVisibility; }

Defined in: packages/canisters/src/nns/types/governance_converters.ts:508

---

Option

Option<T> = T | undefined

Defined in: packages/canisters/src/nns/types/common.ts:7

Type Parameters

T

T

---

PrincipalString

PrincipalString = string

Defined in: packages/canisters/src/nns/types/common.ts:5

---

ProposalActionRequest

ProposalActionRequest = { RegisterKnownNeuron: KnownNeuron; } | { DeregisterKnownNeuron: DeregisterKnownNeuron; } | { ExecuteNnsFunction: ExecuteNnsFunction; } | { CreateServiceNervousSystem: CreateServiceNervousSystem; } | { ManageNeuron: ManageNeuronRequest; } | { InstallCode: InstallCodeRequest; } | { StopOrStartCanister: StopOrStartCanister; } | { UpdateCanisterSettings: UpdateCanisterSettings; } | { BlessAlternativeGuestOsVersion: BlessAlternativeGuestOsVersion; } | { ApproveGenesisKyc: ApproveGenesisKyc; } | { ManageNetworkEconomics: NetworkEconomics; } | { RewardNodeProvider: RewardNodeProvider; } | { RewardNodeProviders: RewardNodeProviders; } | { AddOrRemoveNodeProvider: AddOrRemoveNodeProvider; } | { Motion: Motion; } | { TakeCanisterSnapshot: TakeCanisterSnapshot; } | { LoadCanisterSnapshot: LoadCanisterSnapshot; }

Defined in: packages/canisters/src/nns/types/governance_converters.ts:50

---

ProposalId

ProposalId = bigint

Defined in: packages/canisters/src/nns/types/governance_converters.ts:533

---

RewardMode

RewardMode = { RewardToNeuron: RewardToNeuron; } | { RewardToAccount: RewardToAccount; }

Defined in: packages/canisters/src/nns/types/governance_converters.ts:561

---

SnsWasmCanisterOptions

SnsWasmCanisterOptions = CanisterOptions<_SERVICE>

Defined in: packages/canisters/src/nns/types/sns_wasm.options.ts:4

Functions

accountIdentifierFromBytes()

accountIdentifierFromBytes(accountIdentifier): string

Defined in: packages/canisters/src/nns/utils/account_identifier.utils.ts:19

Parameters

accountIdentifier

Uint8Array

Returns

string

---

accountIdentifierToBytes()

accountIdentifierToBytes(accountIdentifier): Uint8Array

Defined in: packages/canisters/src/nns/utils/account_identifier.utils.ts:15

Parameters

accountIdentifier

string

Returns

Uint8Array

---

ineligibleNeurons()

ineligibleNeurons(params): NeuronInfo[]

Defined in: packages/canisters/src/nns/utils/neurons.utils.ts:37

Filter the neurons that are ineligible to vote to a proposal.

This feature needs the ballots of the proposal to contains accurate data. If the proposal has settled, as the ballots of the proposal are emptied for archive purpose, the function might return a list of ineligible neurons that are actually neurons that have not voted but would have been eligible.

Long story short, check the status of the proposal before using this function.

Parameters

params

neurons

NeuronInfo[]

The neurons to filter.

proposal

ProposalInfo

The proposal to match against the selected neurons.

Returns

NeuronInfo[]

---

memoToNeuronAccountIdentifier()

memoToNeuronAccountIdentifier(__namedParameters): AccountIdentifier

Defined in: packages/canisters/src/nns/utils/neurons.utils.ts:122

Parameters

__namedParameters

controller

Principal

governanceCanisterId

Principal

memo

bigint

Returns

AccountIdentifier

---

memoToNeuronSubaccount()

memoToNeuronSubaccount(__namedParameters): SubAccount

Defined in: packages/canisters/src/nns/utils/neurons.utils.ts:101

Parameters

__namedParameters

controller

Principal

memo

bigint

Returns

SubAccount

---

principalToAccountIdentifier()

principalToAccountIdentifier(principal, subAccount?): string

Defined in: packages/canisters/src/nns/utils/account_identifier.utils.ts:24

Parameters

principal

Principal

subAccount?

Uint8Array<ArrayBufferLike>

Returns

string

---

votableNeurons()

votableNeurons(params): NeuronInfo[]

Defined in: packages/canisters/src/nns/utils/neurons.utils.ts:66

Filter the neurons that can vote for a proposal - i.e. the neurons that have not voted yet and are eligible

Parameters

params

neurons

NeuronInfo[]

The neurons to filter.

proposal

ProposalInfo

The proposal to match against the selected neurons.

Returns

NeuronInfo[]

---

votedNeurons()

votedNeurons(params): NeuronInfo[]

Defined in: packages/canisters/src/nns/utils/neurons.utils.ts:89

Filter the neurons that have voted for a proposal.

Parameters

params

neurons

NeuronInfo[]

The neurons to filter.

proposal

ProposalInfo

The proposal for which some neurons might have already voted.

Returns

NeuronInfo[]