SnsWrapper
Defined in: packages/canisters/src/sns/sns.wrapper.ts:68
Sns wrapper - notably used by NNS-dapp - ease the access to a particular Sns. It knows all the Sns’ canisters, wrap and enhance their available features. A wrapper either performs query or update calls.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SnsWrapper(
__namedParameters):SnsWrapper
Defined in: packages/canisters/src/sns/sns.wrapper.ts:79
Constructor to instantiate a Sns
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”SnsWrapperOptions
Returns
Section titled “Returns”SnsWrapper
Accessors
Section titled “Accessors”canisterIds
Section titled “canisterIds”Get Signature
Section titled “Get Signature”get canisterIds():
object
Defined in: packages/canisters/src/sns/sns.wrapper.ts:98
Binds the list of canister ids of the Sns.
Returns
Section titled “Returns”object
governanceCanisterId
Section titled “governanceCanisterId”governanceCanisterId:
Principal
indexCanisterId
Section titled “indexCanisterId”indexCanisterId:
Principal
ledgerCanisterId
Section titled “ledgerCanisterId”ledgerCanisterId:
Principal
rootCanisterId
Section titled “rootCanisterId”rootCanisterId:
Principal
swapCanisterId
Section titled “swapCanisterId”swapCanisterId:
Principal
Methods
Section titled “Methods”addNeuronPermissions()
Section titled “addNeuronPermissions()”addNeuronPermissions(
params):Promise<void>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:323
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/sns.wrapper.ts:451
Parameters
Section titled “Parameters”params
Section titled “params”SnsNeuronAutoStakeMaturityParams
Returns
Section titled “Returns”Promise<void>
balance()
Section titled “balance()”balance(
params):Promise<bigint>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:164
Parameters
Section titled “Parameters”params
Section titled “params”Omit<BalanceParams, "certified">
Returns
Section titled “Returns”Promise<bigint>
claimNeuron()
Section titled “claimNeuron()”claimNeuron(
params):Promise<NeuronId>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:331
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<NeuronId>
disburse()
Section titled “disburse()”disburse(
params):Promise<void>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:347
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/sns.wrapper.ts:447
Parameters
Section titled “Parameters”params
Section titled “params”SnsNeuronDisburseMaturityParams
Returns
Section titled “Returns”Promise<void>
getDerivedState()
Section titled “getDerivedState()”getDerivedState(
params):Promise<GetDerivedStateResponse|undefined>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:432
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<GetDerivedStateResponse | undefined>
getFinalizationStatus()
Section titled “getFinalizationStatus()”getFinalizationStatus(
params):Promise<GetAutoFinalizationStatusResponse|undefined>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:422
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<GetAutoFinalizationStatusResponse | undefined>
getLifecycle()
Section titled “getLifecycle()”getLifecycle(
params):Promise<GetLifecycleResponse|undefined>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:417
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<GetLifecycleResponse | undefined>
getNeuron()
Section titled “getNeuron()”getNeuron(
params):Promise<Neuron>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:173
Parameters
Section titled “Parameters”params
Section titled “params”Omit<SnsGetNeuronParams, "certified">
Returns
Section titled “Returns”Promise<Neuron>
getNeuronBalance()
Section titled “getNeuronBalance()”getNeuronBalance(
neuronId):Promise<bigint>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:312
Parameters
Section titled “Parameters”neuronId
Section titled “neuronId”Returns
Section titled “Returns”Promise<bigint>
getOpenTicket()
Section titled “getOpenTicket()”getOpenTicket(
params):Promise<Ticket|undefined>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:408
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<Ticket | undefined>
getProposal()
Section titled “getProposal()”getProposal(
params):Promise<ProposalData>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:124
Parameters
Section titled “Parameters”params
Section titled “params”Omit<SnsGetProposalParams, "certified">
Returns
Section titled “Returns”Promise<ProposalData>
getSaleParameters()
Section titled “getSaleParameters()”getSaleParameters(
params):Promise<GetSaleParametersResponse|undefined>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:427
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<GetSaleParametersResponse | undefined>
getTransactions()
Section titled “getTransactions()”getTransactions(
params):Promise<GetTransactions>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:437
Parameters
Section titled “Parameters”params
Section titled “params”GetIndexAccountTransactionsParams
Returns
Section titled “Returns”Promise<GetTransactions>
getUserCommitment()
Section titled “getUserCommitment()”getUserCommitment(
params):Promise<BuyerState|undefined>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:403
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<BuyerState | undefined>
increaseDissolveDelay()
Section titled “increaseDissolveDelay()”increaseDissolveDelay(
params):Promise<void>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:364
Parameters
Section titled “Parameters”params
Section titled “params”SnsIncreaseDissolveDelayParams
Returns
Section titled “Returns”Promise<void>
increaseStakeNeuron()
Section titled “increaseStakeNeuron()”increaseStakeNeuron(
params):Promise<void>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:293
Increase the stake of a neuron.
This is a convenient method that transfers the stake to the neuron subaccount and then refresh the neuron.
⚠️ This feature is provided as it without warranty. It does not implement any additional checks of the validity of the payment flow - e.g. it does not handle refund nor calls refresh again in case of errors.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
ledgerMetadata()
Section titled “ledgerMetadata()”ledgerMetadata(
params):Promise<IcrcTokenMetadataResponse>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:149
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<IcrcTokenMetadataResponse>
listNervousSystemFunctions()
Section titled “listNervousSystemFunctions()”listNervousSystemFunctions(
params):Promise<ListNervousSystemFunctionsResponse>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:129
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<ListNervousSystemFunctionsResponse>
listNeurons()
Section titled “listNeurons()”listNeurons(
params):Promise<Neuron[]>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:114
Parameters
Section titled “Parameters”params
Section titled “params”Omit<SnsListNeuronsParams, "certified">
Returns
Section titled “Returns”Promise<Neuron[]>
listProposals()
Section titled “listProposals()”listProposals(
params):Promise<ListProposalsResponse>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:119
Parameters
Section titled “Parameters”params
Section titled “params”Omit<SnsListProposalsParams, "certified">
Returns
Section titled “Returns”Promise<ListProposalsResponse>
metadata()
Section titled “metadata()”metadata(
params):Promise<[GetMetadataResponse,IcrcTokenMetadataResponse]>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:134
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<[GetMetadataResponse, IcrcTokenMetadataResponse]>
nervousSystemParameters()
Section titled “nervousSystemParameters()”nervousSystemParameters(
params):Promise<NervousSystemParameters>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:144
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<NervousSystemParameters>
newSaleTicket()
Section titled “newSaleTicket()”newSaleTicket(
params):Promise<Ticket>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:414
Parameters
Section titled “Parameters”params
Section titled “params”NewSaleTicketParams
Returns
Section titled “Returns”Promise<Ticket>
nextNeuronAccount()
Section titled “nextNeuronAccount()”nextNeuronAccount(
controller):Promise<{account:IcrcAccount;index:bigint; }>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:199
Returns the subaccount of the next neuron to be created.
The neuron account is a subaccount of the governance canister. The subaccount is derived from the controller and an ascending index.
‼️ The id of the neuron is the subaccount (neuron ID = subaccount) ‼️.
If the neuron does not exist for that subaccount, then we use it for the next neuron.
The index is used in the memo of the transfer and when claiming the neuron. This is how the backend can identify which neuron is being claimed.
Parameters
Section titled “Parameters”controller
Section titled “controller”Principal
Returns
Section titled “Returns”Promise<{ account: IcrcAccount; index: bigint; }>
notifyParticipation()
Section titled “notifyParticipation()”notifyParticipation(
params):Promise<RefreshBuyerTokensResponse>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:398
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<RefreshBuyerTokensResponse>
notifyPaymentFailure()
Section titled “notifyPaymentFailure()”notifyPaymentFailure():
Promise<Ticket|undefined>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:394
Returns the ticket if a ticket was found for the caller and the ticket was removed successfully. Returns None if no ticket was found for the caller. Only the owner of a ticket can remove it.
Always certified
Returns
Section titled “Returns”Promise<Ticket | undefined>
queryNeuron()
Section titled “queryNeuron()”queryNeuron(
params):Promise<Neuron|undefined>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:178
Parameters
Section titled “Parameters”params
Section titled “params”Omit<SnsGetNeuronParams, "certified">
Returns
Section titled “Returns”Promise<Neuron | undefined>
refreshNeuron()
Section titled “refreshNeuron()”refreshNeuron(
neuronId):Promise<void>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:327
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/sns.wrapper.ts:377
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/sns.wrapper.ts:336
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/sns.wrapper.ts:359
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/sns.wrapper.ts:373
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/sns.wrapper.ts:369
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
splitNeuron()
Section titled “splitNeuron()”splitNeuron(
params):Promise<NeuronId|undefined>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:341
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/sns.wrapper.ts:443
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
stakeNeuron()
Section titled “stakeNeuron()”stakeNeuron(
params):Promise<NeuronId>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:246
Stakes a neuron.
This is a convenient method that transfers the stake to the neuron subaccount and then claims the neuron.
⚠️ This feature is provided as it without warranty. It does not implement any additional checks of the validity of the payment flow - e.g. it does not handle refund nor retries claiming the neuron in case of errors.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<NeuronId>
startDissolving()
Section titled “startDissolving()”startDissolving(
neuronId):Promise<void>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:351
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/sns.wrapper.ts:355
Parameters
Section titled “Parameters”neuronId
Section titled “neuronId”Returns
Section titled “Returns”Promise<void>
swapState()
Section titled “swapState()”swapState(
params):Promise<GetStateResponse>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:380
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<GetStateResponse>
totalTokensSupply()
Section titled “totalTokensSupply()”totalTokensSupply(
params):Promise<bigint>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:159
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<bigint>
transactionFee()
Section titled “transactionFee()”transactionFee(
params):Promise<bigint>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:154
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<bigint>
transfer()
Section titled “transfer()”transfer(
params):Promise<bigint>
Defined in: packages/canisters/src/sns/sns.wrapper.ts:170
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<bigint>