SnsWrapper
Defined in: packages/sns/src/sns.wrapper.ts:89
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/sns/src/sns.wrapper.ts:100
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/sns/src/sns.wrapper.ts:119
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/sns/src/sns.wrapper.ts:336
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/sns.wrapper.ts:460
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/sns/src/sns.wrapper.ts:182
Parameters
Section titled “Parameters”params
Section titled “params”Omit<BalanceParams, "certified">
Returns
Section titled “Returns”Promise<bigint>
claimNeuron()
Section titled “claimNeuron()”claimNeuron(
params):Promise<SnsNeuronId>
Defined in: packages/sns/src/sns.wrapper.ts:344
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<SnsNeuronId>
disburse()
Section titled “disburse()”disburse(
params):Promise<void>
Defined in: packages/sns/src/sns.wrapper.ts:357
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/sns.wrapper.ts:456
Parameters
Section titled “Parameters”params
Section titled “params”SnsNeuronDisburseMaturityParams
Returns
Section titled “Returns”Promise<void>
getDerivedState()
Section titled “getDerivedState()”getDerivedState(
params):Promise<SnsGetDerivedStateResponse|undefined>
Defined in: packages/sns/src/sns.wrapper.ts:441
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<SnsGetDerivedStateResponse | undefined>
getFinalizationStatus()
Section titled “getFinalizationStatus()”getFinalizationStatus(
params):Promise<SnsGetAutoFinalizationStatusResponse|undefined>
Defined in: packages/sns/src/sns.wrapper.ts:431
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<SnsGetAutoFinalizationStatusResponse | undefined>
getLifecycle()
Section titled “getLifecycle()”getLifecycle(
params):Promise<SnsGetLifecycleResponse|undefined>
Defined in: packages/sns/src/sns.wrapper.ts:426
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<SnsGetLifecycleResponse | undefined>
getNeuron()
Section titled “getNeuron()”getNeuron(
params):Promise<SnsNeuron>
Defined in: packages/sns/src/sns.wrapper.ts:189
Parameters
Section titled “Parameters”params
Section titled “params”Omit<SnsGetNeuronParams, "certified">
Returns
Section titled “Returns”Promise<SnsNeuron>
getNeuronBalance()
Section titled “getNeuronBalance()”getNeuronBalance(
neuronId):Promise<bigint>
Defined in: packages/sns/src/sns.wrapper.ts:327
Parameters
Section titled “Parameters”neuronId
Section titled “neuronId”Returns
Section titled “Returns”Promise<bigint>
getOpenTicket()
Section titled “getOpenTicket()”getOpenTicket(
params):Promise<SnsSwapTicket|undefined>
Defined in: packages/sns/src/sns.wrapper.ts:417
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<SnsSwapTicket | undefined>
getProposal()
Section titled “getProposal()”getProposal(
params):Promise<SnsProposalData>
Defined in: packages/sns/src/sns.wrapper.ts:144
Parameters
Section titled “Parameters”params
Section titled “params”Omit<SnsGetProposalParams, "certified">
Returns
Section titled “Returns”Promise<SnsProposalData>
getSaleParameters()
Section titled “getSaleParameters()”getSaleParameters(
params):Promise<SnsGetSaleParametersResponse|undefined>
Defined in: packages/sns/src/sns.wrapper.ts:436
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<SnsGetSaleParametersResponse | undefined>
getTransactions()
Section titled “getTransactions()”getTransactions(
params):Promise<GetTransactions>
Defined in: packages/sns/src/sns.wrapper.ts:447
Parameters
Section titled “Parameters”params
Section titled “params”GetAccountTransactionsParams
Returns
Section titled “Returns”Promise<GetTransactions>
getUserCommitment()
Section titled “getUserCommitment()”getUserCommitment(
params):Promise<SnsSwapBuyerState|undefined>
Defined in: packages/sns/src/sns.wrapper.ts:412
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<SnsSwapBuyerState | undefined>
increaseDissolveDelay()
Section titled “increaseDissolveDelay()”increaseDissolveDelay(
params):Promise<void>
Defined in: packages/sns/src/sns.wrapper.ts:374
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/sns/src/sns.wrapper.ts:308
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/sns/src/sns.wrapper.ts:167
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<IcrcTokenMetadataResponse>
listNervousSystemFunctions()
Section titled “listNervousSystemFunctions()”listNervousSystemFunctions(
params):Promise<SnsListNervousSystemFunctionsResponse>
Defined in: packages/sns/src/sns.wrapper.ts:149
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<SnsListNervousSystemFunctionsResponse>
listNeurons()
Section titled “listNeurons()”listNeurons(
params):Promise<SnsNeuron[]>
Defined in: packages/sns/src/sns.wrapper.ts:135
Parameters
Section titled “Parameters”params
Section titled “params”Omit<SnsListNeuronsParams, "certified">
Returns
Section titled “Returns”Promise<SnsNeuron[]>
listProposals()
Section titled “listProposals()”listProposals(
params):Promise<SnsListProposalsResponse>
Defined in: packages/sns/src/sns.wrapper.ts:139
Parameters
Section titled “Parameters”params
Section titled “params”Omit<SnsListProposalsParams, "certified">
Returns
Section titled “Returns”Promise<SnsListProposalsResponse>
metadata()
Section titled “metadata()”metadata(
params):Promise<[SnsGetMetadataResponse,IcrcTokenMetadataResponse]>
Defined in: packages/sns/src/sns.wrapper.ts:154
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<[SnsGetMetadataResponse, IcrcTokenMetadataResponse]>
nervousSystemParameters()
Section titled “nervousSystemParameters()”nervousSystemParameters(
params):Promise<SnsNervousSystemParameters>
Defined in: packages/sns/src/sns.wrapper.ts:162
Parameters
Section titled “Parameters”params
Section titled “params”Omit<QueryParams, "certified">
Returns
Section titled “Returns”Promise<SnsNervousSystemParameters>
newSaleTicket()
Section titled “newSaleTicket()”newSaleTicket(
params):Promise<SnsSwapTicket>
Defined in: packages/sns/src/sns.wrapper.ts:423
Parameters
Section titled “Parameters”params
Section titled “params”NewSaleTicketParams
Returns
Section titled “Returns”Promise<SnsSwapTicket>
nextNeuronAccount()
Section titled “nextNeuronAccount()”nextNeuronAccount(
controller):Promise<{account:IcrcAccount;index:bigint; }>
Defined in: packages/sns/src/sns.wrapper.ts:214
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<SnsRefreshBuyerTokensResponse>
Defined in: packages/sns/src/sns.wrapper.ts:407
Parameters
Section titled “Parameters”params
Section titled “params”RefreshBuyerTokensRequest
Returns
Section titled “Returns”Promise<SnsRefreshBuyerTokensResponse>
notifyPaymentFailure()
Section titled “notifyPaymentFailure()”notifyPaymentFailure():
Promise<SnsSwapTicket|undefined>
Defined in: packages/sns/src/sns.wrapper.ts:403
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<SnsSwapTicket | undefined>
queryNeuron()
Section titled “queryNeuron()”queryNeuron(
params):Promise<SnsNeuron|undefined>
Defined in: packages/sns/src/sns.wrapper.ts:193
Parameters
Section titled “Parameters”params
Section titled “params”Omit<SnsGetNeuronParams, "certified">
Returns
Section titled “Returns”Promise<SnsNeuron | undefined>
refreshNeuron()
Section titled “refreshNeuron()”refreshNeuron(
neuronId):Promise<void>
Defined in: packages/sns/src/sns.wrapper.ts:340
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/sns.wrapper.ts:387
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/sns.wrapper.ts:348
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/sns.wrapper.ts:369
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/sns.wrapper.ts:383
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/sns.wrapper.ts:379
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
splitNeuron()
Section titled “splitNeuron()”splitNeuron(
params):Promise<SnsNeuronId|undefined>
Defined in: packages/sns/src/sns.wrapper.ts:353
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/sns.wrapper.ts:452
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<void>
stakeNeuron()
Section titled “stakeNeuron()”stakeNeuron(
params):Promise<SnsNeuronId>
Defined in: packages/sns/src/sns.wrapper.ts:261
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<SnsNeuronId>
startDissolving()
Section titled “startDissolving()”startDissolving(
neuronId):Promise<void>
Defined in: packages/sns/src/sns.wrapper.ts:361
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/sns.wrapper.ts:365
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/sns/src/sns.wrapper.ts:390
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/sns/src/sns.wrapper.ts:177
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/sns/src/sns.wrapper.ts:172
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/sns/src/sns.wrapper.ts:186
Parameters
Section titled “Parameters”params
Section titled “params”TransferParams
Returns
Section titled “Returns”Promise<bigint>