NnsGovernanceCanister
Defined in: packages/canisters/src/nns/governance.canister.ts:95
Methods
Section titled “Methods”addHotkey()
Section titled “addHotkey()”addHotkey(
__namedParameters):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:915
Add hotkey to neuron
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”neuronId
Section titled “neuronId”bigint
principal
Section titled “principal”Principal
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”autoStakeMaturity()
Section titled “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
Section titled “Parameters”params
Section titled “params”autoStake
Section titled “autoStake”boolean
neuronId
Section titled “neuronId”bigint
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”claimOrRefreshNeuron()
Section titled “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
Section titled “Parameters”request
Section titled “request”Returns
Section titled “Returns”Promise<bigint | undefined>
Throws
Section titled “Throws”claimOrRefreshNeuronFromAccount()
Section titled “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
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”controller?
Section titled “controller?”Principal
bigint
Returns
Section titled “Returns”Promise<bigint | undefined>
disburse()
Section titled “disburse()”disburse(
__namedParameters):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:759
Disburse neuron on Account
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”amount?
Section titled “amount?”bigint
neuronId
Section titled “neuronId”bigint
toAccountId?
Section titled “toAccountId?”string
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”Throws
Section titled “Throws”InvalidAccountIDError
disburseMaturity()
Section titled “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
Section titled “Parameters”params
Section titled “params”neuronId
Section titled “neuronId”bigint
The id of the neuron for which to disburse maturity
percentageToDisburse
Section titled “percentageToDisburse”number
The percentage of the neuron’s maturity to disburse, between 1 and 100 (inclusive).
toAccount?
Section titled “toAccount?”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?
Section titled “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
Section titled “Returns”Promise<void>
Preconditions
Section titled “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()
Section titled “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
Section titled “Parameters”certified
Section titled “certified”boolean = true
Returns
Section titled “Returns”Promise<RewardEvent>
getMetrics()
Section titled “getMetrics()”getMetrics(
__namedParameters):Promise<GovernanceCachedMetrics>
Defined in: packages/canisters/src/nns/governance.canister.ts:1105
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”certified
Section titled “certified”boolean = true
Returns
Section titled “Returns”Promise<GovernanceCachedMetrics>
getNetworkEconomicsParameters()
Section titled “getNetworkEconomicsParameters()”getNetworkEconomicsParameters(
__namedParameters):Promise<NetworkEconomics>
Defined in: packages/canisters/src/nns/governance.canister.ts:1030
Return the Network Economics.
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”certified
Section titled “certified”boolean = true
Returns
Section titled “Returns”Promise<NetworkEconomics>
getNeuron()
Section titled “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
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”certified
Section titled “certified”boolean = true
neuronId
Section titled “neuronId”bigint
Returns
Section titled “Returns”Promise<NeuronInfo | undefined>
getProposal()
Section titled “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
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”certified?
Section titled “certified?”boolean = true
proposalId
Section titled “proposalId”bigint
Returns
Section titled “Returns”Promise<ProposalInfo | undefined>
increaseDissolveDelay()
Section titled “increaseDissolveDelay()”increaseDissolveDelay(
__namedParameters):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:411
Increases dissolve delay of a neuron
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”additionalDissolveDelaySeconds
Section titled “additionalDissolveDelaySeconds”number
neuronId
Section titled “neuronId”bigint
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”joinCommunityFund()
Section titled “joinCommunityFund()”joinCommunityFund(
neuronId):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:488
Neuron joins the community fund
Parameters
Section titled “Parameters”neuronId
Section titled “neuronId”bigint
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”leaveCommunityFund()
Section titled “leaveCommunityFund()”leaveCommunityFund(
neuronId):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:521
Neuron leaves the community fund
Parameters
Section titled “Parameters”neuronId
Section titled “neuronId”bigint
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”listKnownNeurons()
Section titled “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
Section titled “Parameters”certified
Section titled “certified”boolean = true
Returns
Section titled “Returns”Promise<KnownNeuron[]>
listNeurons()
Section titled “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
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”certified
Section titled “certified”boolean = true
includeEmptyNeurons?
Section titled “includeEmptyNeurons?”boolean
includePublicNeurons?
Section titled “includePublicNeurons?”boolean
neuronIds?
Section titled “neuronIds?”bigint[]
neuronSubaccounts?
Section titled “neuronSubaccounts?”Returns
Section titled “Returns”Promise<NeuronInfo[]>
listProposals()
Section titled “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
Section titled “Parameters”request
Section titled “request”the options to list the proposals (limit number of results, topics to search for, etc.)
certified?
Section titled “certified?”boolean = true
request
Section titled “request”Returns
Section titled “Returns”Promise<ListProposalsResponse>
makeProposal()
Section titled “makeProposal()”makeProposal(
request):Promise<bigint|undefined>
Defined in: packages/canisters/src/nns/governance.canister.ts:701
Create new proposal
Parameters
Section titled “Parameters”request
Section titled “request”Returns
Section titled “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
Section titled “Throws”mergeMaturity()
Section titled “mergeMaturity()”mergeMaturity(
__namedParameters):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:817
Merge Maturity of a neuron
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”neuronId
Section titled “neuronId”bigint
percentageToMerge
Section titled “percentageToMerge”number
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”Throws
Section titled “Throws”InvalidPercentageError
mergeNeurons()
Section titled “mergeNeurons()”mergeNeurons(
request):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:576
Merge two neurons
Parameters
Section titled “Parameters”request
Section titled “request”sourceNeuronId
Section titled “sourceNeuronId”bigint
targetNeuronId
Section titled “targetNeuronId”bigint
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”refreshVotingPower()
Section titled “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
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”neuronId
Section titled “neuronId”bigint
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”registerVote()
Section titled “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
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”neuronId
Section titled “neuronId”bigint
proposalId
Section titled “proposalId”bigint
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”removeHotkey()
Section titled “removeHotkey()”removeHotkey(
__namedParameters):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:935
Remove hotkey to neuron
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”neuronId
Section titled “neuronId”bigint
principal
Section titled “principal”Principal
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”setDissolveDelay()
Section titled “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
Section titled “Parameters”neuronId
Section titled “neuronId”dissolveDelaySeconds
Section titled “dissolveDelaySeconds”number
neuronId
Section titled “neuronId”bigint
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”setFollowees()
Section titled “setFollowees()”setFollowees(
followRequest):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:744
Edit neuron followees per topic
Parameters
Section titled “Parameters”followRequest
Section titled “followRequest”Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”setFollowing()
Section titled “setFollowing()”setFollowing(
params):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:1090
Set the following topics for a neuron.
Parameters
Section titled “Parameters”params
Section titled “params”neuronId
Section titled “neuronId”bigint
The id of the neuron for which to set the following topics
topicFollowing
Section titled “topicFollowing”The topics and the followees for each topic that the neuron should follow.
Returns
Section titled “Returns”Promise<void>
setNodeProviderAccount()
Section titled “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
Section titled “Parameters”accountIdentifier
Section titled “accountIdentifier”string
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”Throws
Section titled “Throws”InvalidAccountIDError
setVisibility()
Section titled “setVisibility()”setVisibility(
neuronId,visibility):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:536
Set visibility of a neuron
Parameters
Section titled “Parameters”neuronId
Section titled “neuronId”bigint
visibility
Section titled “visibility”Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”simulateMergeNeurons()
Section titled “simulateMergeNeurons()”simulateMergeNeurons(
request):Promise<NeuronInfo>
Defined in: packages/canisters/src/nns/governance.canister.ts:593
Simulate merging two neurons
Parameters
Section titled “Parameters”request
Section titled “request”sourceNeuronId
Section titled “sourceNeuronId”bigint
targetNeuronId
Section titled “targetNeuronId”bigint
Returns
Section titled “Returns”Promise<NeuronInfo>
Throws
Section titled “Throws”spawnNeuron()
Section titled “spawnNeuron()”spawnNeuron(
__namedParameters):Promise<bigint>
Defined in: packages/canisters/src/nns/governance.canister.ts:868
Merge Maturity of a neuron
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”neuronId
Section titled “neuronId”bigint
newController?
Section titled “newController?”Principal
nonce?
Section titled “nonce?”bigint
percentageToSpawn?
Section titled “percentageToSpawn?”number
Returns
Section titled “Returns”Promise<bigint>
Throws
Section titled “Throws”Throws
Section titled “Throws”InvalidPercentageError
splitNeuron()
Section titled “splitNeuron()”splitNeuron(
__namedParameters):Promise<bigint>
Defined in: packages/canisters/src/nns/governance.canister.ts:638
Splits a neuron creating a new one
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”amount
Section titled “amount”bigint
bigint
neuronId
Section titled “neuronId”bigint
Returns
Section titled “Returns”Promise<bigint>
newNeuronId
Throws
Section titled “Throws”stakeMaturity()
Section titled “stakeMaturity()”stakeMaturity(
params):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:846
Stake the maturity of a neuron.
Parameters
Section titled “Parameters”params
Section titled “params”neuronId
Section titled “neuronId”bigint
percentageToStake?
Section titled “percentageToStake?”number
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”Throws
Section titled “Throws”InvalidPercentageError
stakeNeuron()
Section titled “stakeNeuron()”stakeNeuron(
__namedParameters):Promise<bigint>
Defined in: packages/canisters/src/nns/governance.canister.ts:350
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”createdAt?
Section titled “createdAt?”bigint
bigint
fromSubAccount?
Section titled “fromSubAccount?”number[]
ledgerCanister
Section titled “ledgerCanister”principal
Section titled “principal”Principal
bigint
Returns
Section titled “Returns”Promise<bigint>
Throws
Section titled “Throws”Throws
Section titled “Throws”StakeNeuronTransferError
Throws
Section titled “Throws”Throws
Section titled “Throws”TransferError
startDissolving()
Section titled “startDissolving()”startDissolving(
neuronId):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:460
Start dissolving process of a neuron
Parameters
Section titled “Parameters”neuronId
Section titled “neuronId”bigint
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”stopDissolving()
Section titled “stopDissolving()”stopDissolving(
neuronId):Promise<void>
Defined in: packages/canisters/src/nns/governance.canister.ts:474
Stop dissolving process of a neuron
Parameters
Section titled “Parameters”neuronId
Section titled “neuronId”bigint
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”create()
Section titled “create()”
staticcreate(options):NnsGovernanceCanister
Defined in: packages/canisters/src/nns/governance.canister.ts:110
Parameters
Section titled “Parameters”options
Section titled “options”NnsGovernanceCanisterOptions = {}
Returns
Section titled “Returns”NnsGovernanceCanister