SnsGovernanceCanister
Defined in: packages/sns/src/governance.canister.ts:66
Extends
Section titled “Extends”Canister<SnsGovernanceService>
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”_SERVICE
certifiedService
Section titled “certifiedService”_SERVICE
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”_SERVICE
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/sns/src/governance.canister.ts:218
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/sns/src/governance.canister.ts:334
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<SnsNeuronId>
Defined in: packages/sns/src/governance.canister.ts:399
Claim neuron
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”Promise<SnsNeuronId>
disburse()
Section titled “disburse()”disburse(
params):Promise<void>
Defined in: packages/sns/src/governance.canister.ts:269
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/sns/src/governance.canister.ts:318
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<SnsNeuron>
Defined in: packages/sns/src/governance.canister.ts:167
Get the neuron of the Sns
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<SnsNeuron>
getProposal()
Section titled “getProposal()”getProposal(
params):Promise<SnsProposalData>
Defined in: packages/sns/src/governance.canister.ts:126
Get the proposal of the Sns
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<SnsProposalData>
increaseDissolveDelay()
Section titled “increaseDissolveDelay()”increaseDissolveDelay(
params):Promise<void>
Defined in: packages/sns/src/governance.canister.ts:354
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<SnsListNervousSystemFunctionsResponse>
Defined in: packages/sns/src/governance.canister.ts:145
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<SnsListNervousSystemFunctionsResponse>
listNeurons()
Section titled “listNeurons()”listNeurons(
params):Promise<SnsNeuron[]>
Defined in: packages/sns/src/governance.canister.ts:86
List the neurons of the Sns
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<SnsNeuron[]>
listProposals()
Section titled “listProposals()”listProposals(
params):Promise<SnsListProposalsResponse>
Defined in: packages/sns/src/governance.canister.ts:100
List the proposals of the Sns
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<SnsListProposalsResponse>
listTopics()
Section titled “listTopics()”listTopics(
params):Promise<SnsListTopicsResponse>
Defined in: packages/sns/src/governance.canister.ts:115
List the topics of the Sns
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<SnsListTopicsResponse>
manageNeuron()
Section titled “manageNeuron()”manageNeuron(
request):Promise<SnsManageNeuronResponse>
Defined in: packages/sns/src/governance.canister.ts:205
Manage neuron. For advanced users.
Parameters
Section titled “Parameters”request
Section titled “request”Returns
Section titled “Returns”Promise<SnsManageNeuronResponse>
metadata()
Section titled “metadata()”metadata(
params):Promise<SnsGetMetadataResponse>
Defined in: packages/sns/src/governance.canister.ts:153
Get the Sns metadata (title, description, etc.)
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<SnsGetMetadataResponse>
nervousSystemParameters()
Section titled “nervousSystemParameters()”nervousSystemParameters(
params):Promise<SnsNervousSystemParameters>
Defined in: packages/sns/src/governance.canister.ts:159
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<SnsNervousSystemParameters>
queryNeuron()
Section titled “queryNeuron()”queryNeuron(
params):Promise<SnsNeuron|undefined>
Defined in: packages/sns/src/governance.canister.ts:185
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<SnsNeuron | undefined>
refreshNeuron()
Section titled “refreshNeuron()”refreshNeuron(
neuronId):Promise<void>
Defined in: packages/sns/src/governance.canister.ts:389
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/sns/src/governance.canister.ts:381
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/sns/src/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/sns/src/governance.canister.ts:344
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/sns/src/governance.canister.ts:373
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/sns/src/governance.canister.ts:365
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<SnsNeuronId|undefined>
Defined in: packages/sns/src/governance.canister.ts:238
Split neuron
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<SnsNeuronId | undefined>
stakeMaturity()
Section titled “stakeMaturity()”stakeMaturity(
params):Promise<void>
Defined in: packages/sns/src/governance.canister.ts:297
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/sns/src/governance.canister.ts:277
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/sns/src/governance.canister.ts:285
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/sns/src/governance.canister.ts:72
Instantiate a canister to interact with the governance of a Sns project.
Parameters
Section titled “Parameters”options
Section titled “options”SnsCanisterOptions<_SERVICE>
Miscellaneous options to initialize the canister. Its ID being the only mandatory parammeter.
Returns
Section titled “Returns”SnsGovernanceCanister