SnsGovernanceCanister
Defined in: packages/canisters/src/sns/governance.canister.ts:57
Extends
Section titled “Extends”Canister<_SERVICE>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew SnsGovernanceCanister(id,service,certifiedService):SnsGovernanceCanister
Defined in: packages/utils/dist/services/canister.d.ts:7
Parameters
Section titled “Parameters”Principal
service
Section titled “service”certifiedService
Section titled “certifiedService”Returns
Section titled “Returns”SnsGovernanceCanister
Inherited from
Section titled “Inherited from”Canister<SnsGovernanceService>.constructor
Properties
Section titled “Properties”caller()
Section titled “caller()”
protectedcaller: (__namedParameters) =>_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:9
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”QueryParams
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Canister.caller
certifiedService
Section titled “certifiedService”
protectedreadonlycertifiedService:_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:6
Inherited from
Section titled “Inherited from”Canister.certifiedService
service
Section titled “service”
protectedreadonlyservice:_SERVICE
Defined in: packages/utils/dist/services/canister.d.ts:5
Inherited from
Section titled “Inherited from”Canister.service
Accessors
Section titled “Accessors”canisterId
Section titled “canisterId”Get Signature
Section titled “Get Signature”get canisterId():
Principal
Defined in: packages/utils/dist/services/canister.d.ts:8
Returns
Section titled “Returns”Principal
Inherited from
Section titled “Inherited from”Canister.canisterId
Methods
Section titled “Methods”addNeuronPermissions()
Section titled “addNeuronPermissions()”addNeuronPermissions(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:217
Add permissions to a neuron for a specific principal
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
autoStakeMaturity()
Section titled “autoStakeMaturity()”autoStakeMaturity(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:345
Changes auto-stake maturity for a Neuron.
Parameters
Section titled “Parameters”params
Section titled “params”SnsNeuronAutoStakeMaturityParams
Returns
Section titled “Returns”Promise<void>
claimNeuron()
Section titled “claimNeuron()”claimNeuron(
__namedParameters):Promise<NeuronId>
Defined in: packages/canisters/src/sns/governance.canister.ts:417
Claim neuron
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise<NeuronId>
disburse()
Section titled “disburse()”disburse(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:272
Disburse neuron on Account
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
disburseMaturity()
Section titled “disburseMaturity()”disburseMaturity(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:328
Disburse the maturity of a neuron.
Parameters
Section titled “Parameters”params
Section titled “params”SnsNeuronDisburseMaturityParams
Returns
Section titled “Returns”Promise<void>
getNeuron()
Section titled “getNeuron()”getNeuron(
params):Promise<Neuron>
Defined in: packages/canisters/src/sns/governance.canister.ts:164
Get the neuron of the Sns
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Neuron>
getProposal()
Section titled “getProposal()”getProposal(
params):Promise<ProposalData>
Defined in: packages/canisters/src/sns/governance.canister.ts:119
Get the proposal of the Sns
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<ProposalData>
increaseDissolveDelay()
Section titled “increaseDissolveDelay()”increaseDissolveDelay(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:367
Increase dissolve delay of a neuron
Parameters
Section titled “Parameters”params
Section titled “params”SnsIncreaseDissolveDelayParams
Returns
Section titled “Returns”Promise<void>
listNervousSystemFunctions()
Section titled “listNervousSystemFunctions()”listNervousSystemFunctions(
params):Promise<ListNervousSystemFunctionsResponse>
Defined in: packages/canisters/src/sns/governance.canister.ts:140
List Nervous System Functions Neurons can follow other neurons in specific Nervous System Functions.
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<ListNervousSystemFunctionsResponse>
listNeurons()
Section titled “listNeurons()”listNeurons(
params):Promise<Neuron[]>
Defined in: packages/canisters/src/sns/governance.canister.ts:77
List the neurons of the Sns
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Neuron[]>
listProposals()
Section titled “listProposals()”listProposals(
params):Promise<ListProposalsResponse>
Defined in: packages/canisters/src/sns/governance.canister.ts:93
List the proposals of the Sns
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<ListProposalsResponse>
listTopics()
Section titled “listTopics()”listTopics(
params):Promise<ListTopicsResponse>
Defined in: packages/canisters/src/sns/governance.canister.ts:108
List the topics of the Sns
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<ListTopicsResponse>
manageNeuron()
Section titled “manageNeuron()”manageNeuron(
request):Promise<ManageNeuronResponse>
Defined in: packages/canisters/src/sns/governance.canister.ts:204
Manage neuron. For advanced users.
Parameters
Section titled “Parameters”request
Section titled “request”Returns
Section titled “Returns”Promise<ManageNeuronResponse>
metadata()
Section titled “metadata()”metadata(
params):Promise<GetMetadataResponse>
Defined in: packages/canisters/src/sns/governance.canister.ts:148
Get the Sns metadata (title, description, etc.)
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<GetMetadataResponse>
nervousSystemParameters()
Section titled “nervousSystemParameters()”nervousSystemParameters(
params):Promise<NervousSystemParameters>
Defined in: packages/canisters/src/sns/governance.canister.ts:156
Get the Sns nervous system parameters (default followees, max dissolve delay, max number of neurons, etc.)
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<NervousSystemParameters>
queryNeuron()
Section titled “queryNeuron()”queryNeuron(
params):Promise<Neuron|undefined>
Defined in: packages/canisters/src/sns/governance.canister.ts:184
Same as getNeuron but returns undefined instead of raising error when not found.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<Neuron | undefined>
refreshNeuron()
Section titled “refreshNeuron()”refreshNeuron(
neuronId):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:405
Refresh neuron
Parameters
Section titled “Parameters”neuronId
Section titled “neuronId”Returns
Section titled “Returns”Promise<void>
registerVote()
Section titled “registerVote()”registerVote(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:396
Registers vote for a proposal from the neuron passed.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
removeNeuronPermissions()
Section titled “removeNeuronPermissions()”removeNeuronPermissions(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:228
Remove permissions to a neuron for a specific principal
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
setDissolveTimestamp()
Section titled “setDissolveTimestamp()”setDissolveTimestamp(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:356
Increase dissolve delay of a neuron
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
setFollowing()
Section titled “setFollowing()”setFollowing(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:387
Sets followees of a neuron for topics
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
setTopicFollowees()
Section titled “setTopicFollowees()”setTopicFollowees(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:379
Sets followees of a neuron for a specific Nervous System Function
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
Deprecated
Section titled “Deprecated”will be replaced by setFollowing in the future.
splitNeuron()
Section titled “splitNeuron()”splitNeuron(
params):Promise<NeuronId|undefined>
Defined in: packages/canisters/src/sns/governance.canister.ts:239
Split neuron
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<NeuronId | undefined>
stakeMaturity()
Section titled “stakeMaturity()”stakeMaturity(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:307
Stake the maturity of a neuron.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
startDissolving()
Section titled “startDissolving()”startDissolving(
neuronId):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:281
Start dissolving process of a neuron
Parameters
Section titled “Parameters”neuronId
Section titled “neuronId”Returns
Section titled “Returns”Promise<void>
stopDissolving()
Section titled “stopDissolving()”stopDissolving(
neuronId):Promise<void>
Defined in: packages/canisters/src/sns/governance.canister.ts:292
Stop dissolving process of a neuron
Parameters
Section titled “Parameters”neuronId
Section titled “neuronId”Returns
Section titled “Returns”Promise<void>
create()
Section titled “create()”
staticcreate(options):SnsGovernanceCanister
Defined in: packages/canisters/src/sns/governance.canister.ts:63
Instantiate a canister to interact with the governance of a Sns project.
Parameters
Section titled “Parameters”options
Section titled “options”Miscellaneous options to initialize the canister. Its ID being the only mandatory parammeter.
Returns
Section titled “Returns”SnsGovernanceCanister