Overview
Namespaces
Section titled “Namespaces”Enumerations
Section titled “Enumerations”GetOpenTicketErrorType
Section titled “GetOpenTicketErrorType”Defined in: packages/canisters/src/sns/enums/swap.enums.ts:12
Enumeration Members
Section titled “Enumeration Members”TYPE_SALE_CLOSED
Section titled “TYPE_SALE_CLOSED”TYPE_SALE_CLOSED:
2
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:15
TYPE_SALE_NOT_OPEN
Section titled “TYPE_SALE_NOT_OPEN”TYPE_SALE_NOT_OPEN:
1
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:14
TYPE_UNSPECIFIED
Section titled “TYPE_UNSPECIFIED”TYPE_UNSPECIFIED:
0
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:13
NewSaleTicketResponseErrorType
Section titled “NewSaleTicketResponseErrorType”Defined in: packages/canisters/src/sns/enums/swap.enums.ts:19
Enumeration Members
Section titled “Enumeration Members”TYPE_INVALID_PRINCIPAL
Section titled “TYPE_INVALID_PRINCIPAL”TYPE_INVALID_PRINCIPAL:
6
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:36
TYPE_INVALID_SUBACCOUNT
Section titled “TYPE_INVALID_SUBACCOUNT”TYPE_INVALID_SUBACCOUNT:
5
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:34
TYPE_INVALID_USER_AMOUNT
Section titled “TYPE_INVALID_USER_AMOUNT”TYPE_INVALID_USER_AMOUNT:
4
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:32
TYPE_SALE_CLOSED
Section titled “TYPE_SALE_CLOSED”TYPE_SALE_CLOSED:
2
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:22
TYPE_SALE_NOT_OPEN
Section titled “TYPE_SALE_NOT_OPEN”TYPE_SALE_NOT_OPEN:
1
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:21
TYPE_TICKET_EXISTS
Section titled “TYPE_TICKET_EXISTS”TYPE_TICKET_EXISTS:
3
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:27
TYPE_UNSPECIFIED
Section titled “TYPE_UNSPECIFIED”TYPE_UNSPECIFIED:
0
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:20
SnsNeuronPermissionType
Section titled “SnsNeuronPermissionType”Defined in: packages/canisters/src/sns/enums/governance.enums.ts:2
Enumeration Members
Section titled “Enumeration Members”NEURON_PERMISSION_TYPE_CONFIGURE_DISSOLVE_STATE
Section titled “NEURON_PERMISSION_TYPE_CONFIGURE_DISSOLVE_STATE”NEURON_PERMISSION_TYPE_CONFIGURE_DISSOLVE_STATE:
1
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:7
NEURON_PERMISSION_TYPE_DISBURSE
Section titled “NEURON_PERMISSION_TYPE_DISBURSE”NEURON_PERMISSION_TYPE_DISBURSE:
5
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:24
NEURON_PERMISSION_TYPE_DISBURSE_MATURITY
Section titled “NEURON_PERMISSION_TYPE_DISBURSE_MATURITY”NEURON_PERMISSION_TYPE_DISBURSE_MATURITY:
8
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:38
NEURON_PERMISSION_TYPE_MANAGE_PRINCIPALS
Section titled “NEURON_PERMISSION_TYPE_MANAGE_PRINCIPALS”NEURON_PERMISSION_TYPE_MANAGE_PRINCIPALS:
2
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:13
NEURON_PERMISSION_TYPE_MANAGE_VOTING_PERMISSION
Section titled “NEURON_PERMISSION_TYPE_MANAGE_VOTING_PERMISSION”NEURON_PERMISSION_TYPE_MANAGE_VOTING_PERMISSION:
10
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:45
NEURON_PERMISSION_TYPE_MERGE_MATURITY
Section titled “NEURON_PERMISSION_TYPE_MERGE_MATURITY”NEURON_PERMISSION_TYPE_MERGE_MATURITY:
7
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:34
Deprecated
Section titled “Deprecated”NEURON_PERMISSION_TYPE_SPLIT
Section titled “NEURON_PERMISSION_TYPE_SPLIT”NEURON_PERMISSION_TYPE_SPLIT:
6
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:27
NEURON_PERMISSION_TYPE_STAKE_MATURITY
Section titled “NEURON_PERMISSION_TYPE_STAKE_MATURITY”NEURON_PERMISSION_TYPE_STAKE_MATURITY:
9
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:41
NEURON_PERMISSION_TYPE_SUBMIT_PROPOSAL
Section titled “NEURON_PERMISSION_TYPE_SUBMIT_PROPOSAL”NEURON_PERMISSION_TYPE_SUBMIT_PROPOSAL:
3
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:18
NEURON_PERMISSION_TYPE_UNSPECIFIED
Section titled “NEURON_PERMISSION_TYPE_UNSPECIFIED”NEURON_PERMISSION_TYPE_UNSPECIFIED:
0
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:3
NEURON_PERMISSION_TYPE_VOTE
Section titled “NEURON_PERMISSION_TYPE_VOTE”NEURON_PERMISSION_TYPE_VOTE:
4
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:21
SnsProposalDecisionStatus
Section titled “SnsProposalDecisionStatus”Defined in: packages/canisters/src/sns/enums/governance.enums.ts:67
Enumeration Members
Section titled “Enumeration Members”PROPOSAL_DECISION_STATUS_ADOPTED
Section titled “PROPOSAL_DECISION_STATUS_ADOPTED”PROPOSAL_DECISION_STATUS_ADOPTED:
3
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:78
PROPOSAL_DECISION_STATUS_EXECUTED
Section titled “PROPOSAL_DECISION_STATUS_EXECUTED”PROPOSAL_DECISION_STATUS_EXECUTED:
4
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:81
PROPOSAL_DECISION_STATUS_FAILED
Section titled “PROPOSAL_DECISION_STATUS_FAILED”PROPOSAL_DECISION_STATUS_FAILED:
5
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:84
PROPOSAL_DECISION_STATUS_OPEN
Section titled “PROPOSAL_DECISION_STATUS_OPEN”PROPOSAL_DECISION_STATUS_OPEN:
1
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:71
PROPOSAL_DECISION_STATUS_REJECTED
Section titled “PROPOSAL_DECISION_STATUS_REJECTED”PROPOSAL_DECISION_STATUS_REJECTED:
2
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:74
PROPOSAL_DECISION_STATUS_UNSPECIFIED
Section titled “PROPOSAL_DECISION_STATUS_UNSPECIFIED”PROPOSAL_DECISION_STATUS_UNSPECIFIED:
0
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:68
SnsProposalRewardStatus
Section titled “SnsProposalRewardStatus”Defined in: packages/canisters/src/sns/enums/governance.enums.ts:48
Enumeration Members
Section titled “Enumeration Members”PROPOSAL_REWARD_STATUS_ACCEPT_VOTES
Section titled “PROPOSAL_REWARD_STATUS_ACCEPT_VOTES”PROPOSAL_REWARD_STATUS_ACCEPT_VOTES:
1
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:56
PROPOSAL_REWARD_STATUS_READY_TO_SETTLE
Section titled “PROPOSAL_REWARD_STATUS_READY_TO_SETTLE”PROPOSAL_REWARD_STATUS_READY_TO_SETTLE:
2
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:60
PROPOSAL_REWARD_STATUS_SETTLED
Section titled “PROPOSAL_REWARD_STATUS_SETTLED”PROPOSAL_REWARD_STATUS_SETTLED:
3
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:64
PROPOSAL_REWARD_STATUS_UNSPECIFIED
Section titled “PROPOSAL_REWARD_STATUS_UNSPECIFIED”PROPOSAL_REWARD_STATUS_UNSPECIFIED:
0
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:49
SnsSwapLifecycle
Section titled “SnsSwapLifecycle”Defined in: packages/canisters/src/sns/enums/swap.enums.ts:2
Enumeration Members
Section titled “Enumeration Members”Aborted
Section titled “Aborted”Aborted:
4
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:7
Adopted
Section titled “Adopted”Adopted:
5
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:8
Committed
Section titled “Committed”Committed:
3
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:6
Open:
2
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:5
Pending
Section titled “Pending”Pending:
1
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:4
Unspecified
Section titled “Unspecified”Unspecified:
0
Defined in: packages/canisters/src/sns/enums/swap.enums.ts:3
SnsVote
Section titled “SnsVote”Defined in: packages/canisters/src/sns/enums/governance.enums.ts:87
Enumeration Members
Section titled “Enumeration Members”No:
2
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:90
Unspecified
Section titled “Unspecified”Unspecified:
0
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:88
Yes:
1
Defined in: packages/canisters/src/sns/enums/governance.enums.ts:89
Classes
Section titled “Classes”SnsGovernanceCanister
Section titled “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”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”SnsGovernanceError
Section titled “SnsGovernanceError”Defined in: packages/canisters/src/sns/errors/governance.errors.ts:1
Extends
Section titled “Extends”Error
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SnsGovernanceError(
message?):SnsGovernanceError
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082
Parameters
Section titled “Parameters”message?
Section titled “message?”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Error.constructor
Constructor
Section titled “Constructor”new SnsGovernanceError(
message?,options?):SnsGovernanceError
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1082
Parameters
Section titled “Parameters”message?
Section titled “message?”string
options?
Section titled “options?”ErrorOptions
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Error.constructor
Properties
Section titled “Properties”cause?
Section titled “cause?”
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Section titled “Inherited from”Error.cause
message
Section titled “message”message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Section titled “Inherited from”Error.message
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Section titled “Inherited from”Error.name
stack?
Section titled “stack?”
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Section titled “Inherited from”Error.stack
stackTraceLimit
Section titled “stackTraceLimit”
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:67
The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Section titled “Inherited from”Error.stackTraceLimit
Methods
Section titled “Methods”captureStackTrace()
Section titled “captureStackTrace()”
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:51
Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};Error.captureStackTrace(myObject);myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() { b();}
function b() { c();}
function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error;}
a();Parameters
Section titled “Parameters”targetObject
Section titled “targetObject”object
constructorOpt?
Section titled “constructorOpt?”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Error.captureStackTrace
isError()
Section titled “isError()”
staticisError(error):error is Error
Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23
Indicates whether the argument provided is a built-in Error instance or not.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”error is Error
Inherited from
Section titled “Inherited from”Error.isError
prepareStackTrace()
Section titled “prepareStackTrace()”
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/@types/node/globals.d.ts:55
Parameters
Section titled “Parameters”Error
stackTraces
Section titled “stackTraces”CallSite[]
Returns
Section titled “Returns”any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Section titled “Inherited from”Error.prepareStackTrace
SnsGovernanceTestCanister
Section titled “SnsGovernanceTestCanister”Defined in: packages/canisters/src/sns/governance_test.canister.ts:18
Extends
Section titled “Extends”Canister<_SERVICE>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew SnsGovernanceTestCanister(id,service,certifiedService):SnsGovernanceTestCanister
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”Inherited from
Section titled “Inherited from”Canister<SnsGovernanceTestService>.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”addMaturity()
Section titled “addMaturity()”addMaturity(
params):Promise<void>
Defined in: packages/canisters/src/sns/governance_test.canister.ts:38
Add maturity to a neuron (only for testing purposes. Testnet only.)
Parameters
Section titled “Parameters”params
Section titled “params”SnsAddMaturityParams
Returns
Section titled “Returns”Promise<void>
create()
Section titled “create()”
staticcreate(options):SnsGovernanceTestCanister
Defined in: packages/canisters/src/sns/governance_test.canister.ts:24
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”SnsRootCanister
Section titled “SnsRootCanister”Defined in: packages/canisters/src/sns/root.canister.ts:10
Extends
Section titled “Extends”Canister<_SERVICE>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew SnsRootCanister(id,service,certifiedService):SnsRootCanister
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”Inherited from
Section titled “Inherited from”Canister<SnsRootService>.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”listSnsCanisters()
Section titled “listSnsCanisters()”listSnsCanisters(
params):Promise<ListSnsCanistersResponse>
Defined in: packages/canisters/src/sns/root.canister.ts:32
List the canisters that are part of the Sns.
Source code: https://github.com/dfinity/ic/blob/master/rs/sns/root/src/lib.rs
Parameters
Section titled “Parameters”params
Section titled “params”certified?
Section titled “certified?”boolean = true
Query or update calls
Returns
Section titled “Returns”Promise<ListSnsCanistersResponse>
- A list of canisters (‘root’ | ‘governance’ | ‘ledger’ | ‘dapps’ | ‘swap’ | ‘archives’)
create()
Section titled “create()”
staticcreate(options):SnsRootCanister
Defined in: packages/canisters/src/sns/root.canister.ts:11
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”SnsSwapCanister
Section titled “SnsSwapCanister”Defined in: packages/canisters/src/sns/swap.canister.ts:24
Extends
Section titled “Extends”Canister<_SERVICE>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew SnsSwapCanister(id,service,certifiedService):SnsSwapCanister
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”Inherited from
Section titled “Inherited from”Canister<SnsSwapService>.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”getDerivedState()
Section titled “getDerivedState()”getDerivedState(
__namedParameters):Promise<GetDerivedStateResponse>
Defined in: packages/canisters/src/sns/swap.canister.ts:75
Get sale buyers state
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”QueryParams
Returns
Section titled “Returns”Promise<GetDerivedStateResponse>
getFinalizationStatus()
Section titled “getFinalizationStatus()”getFinalizationStatus(
params):Promise<GetAutoFinalizationStatusResponse>
Defined in: packages/canisters/src/sns/swap.canister.ts:145
Get sale lifecycle state
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<GetAutoFinalizationStatusResponse>
getLifecycle()
Section titled “getLifecycle()”getLifecycle(
params):Promise<GetLifecycleResponse>
Defined in: packages/canisters/src/sns/swap.canister.ts:137
Get sale lifecycle state
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<GetLifecycleResponse>
getOpenTicket()
Section titled “getOpenTicket()”getOpenTicket(
params):Promise<Ticket|undefined>
Defined in: packages/canisters/src/sns/swap.canister.ts:91
Return a sale ticket if created and not yet removed (payment flow)
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<Ticket | undefined>
getSaleParameters()
Section titled “getSaleParameters()”getSaleParameters(
__namedParameters):Promise<GetSaleParametersResponse>
Defined in: packages/canisters/src/sns/swap.canister.ts:83
Get sale parameters
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”QueryParams
Returns
Section titled “Returns”Promise<GetSaleParametersResponse>
getUserCommitment()
Section titled “getUserCommitment()”getUserCommitment(
params):Promise<BuyerState|undefined>
Defined in: packages/canisters/src/sns/swap.canister.ts:63
Get user commitment
Parameters
Section titled “Parameters”params
Section titled “params”GetBuyerStateRequest & QueryParams
Returns
Section titled “Returns”Promise<BuyerState | undefined>
newSaleTicket()
Section titled “newSaleTicket()”newSaleTicket(
params):Promise<Ticket>
Defined in: packages/canisters/src/sns/swap.canister.ts:110
Create a sale ticket (payment flow)
Parameters
Section titled “Parameters”params
Section titled “params”NewSaleTicketParams
Returns
Section titled “Returns”Promise<Ticket>
notifyParticipation()
Section titled “notifyParticipation()”notifyParticipation(
params):Promise<RefreshBuyerTokensResponse>
Defined in: packages/canisters/src/sns/swap.canister.ts:55
Notify of the user participating in the swap
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/swap.canister.ts:45
Notify of the payment failure to remove the ticket
Returns
Section titled “Returns”Promise<Ticket | undefined>
state()
Section titled “state()”state(
params):Promise<GetStateResponse>
Defined in: packages/canisters/src/sns/swap.canister.ts:39
Get the state of the swap
Parameters
Section titled “Parameters”params
Section titled “params”QueryParams
Returns
Section titled “Returns”Promise<GetStateResponse>
create()
Section titled “create()”
staticcreate(options):SnsSwapCanister
Defined in: packages/canisters/src/sns/swap.canister.ts:25
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”SnsSwapGetOpenTicketError
Section titled “SnsSwapGetOpenTicketError”Defined in: packages/canisters/src/sns/errors/swap.errors.ts:28
Extends
Section titled “Extends”Error
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SnsSwapGetOpenTicketError(
errorType):SnsSwapGetOpenTicketError
Defined in: packages/canisters/src/sns/errors/swap.errors.ts:29
Parameters
Section titled “Parameters”errorType
Section titled “errorType”Returns
Section titled “Returns”Overrides
Section titled “Overrides”Error.constructor
Properties
Section titled “Properties”cause?
Section titled “cause?”
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Section titled “Inherited from”Error.cause
errorType
Section titled “errorType”errorType:
GetOpenTicketErrorType
Defined in: packages/canisters/src/sns/errors/swap.errors.ts:29
message
Section titled “message”message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Section titled “Inherited from”Error.message
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Section titled “Inherited from”Error.name
stack?
Section titled “stack?”
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Section titled “Inherited from”Error.stack
stackTraceLimit
Section titled “stackTraceLimit”
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:67
The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Section titled “Inherited from”Error.stackTraceLimit
Methods
Section titled “Methods”captureStackTrace()
Section titled “captureStackTrace()”
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:51
Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};Error.captureStackTrace(myObject);myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() { b();}
function b() { c();}
function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error;}
a();Parameters
Section titled “Parameters”targetObject
Section titled “targetObject”object
constructorOpt?
Section titled “constructorOpt?”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Error.captureStackTrace
isError()
Section titled “isError()”
staticisError(error):error is Error
Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23
Indicates whether the argument provided is a built-in Error instance or not.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”error is Error
Inherited from
Section titled “Inherited from”Error.isError
prepareStackTrace()
Section titled “prepareStackTrace()”
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/@types/node/globals.d.ts:55
Parameters
Section titled “Parameters”Error
stackTraces
Section titled “stackTraces”CallSite[]
Returns
Section titled “Returns”any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Section titled “Inherited from”Error.prepareStackTrace
SnsSwapNewTicketError
Section titled “SnsSwapNewTicketError”Defined in: packages/canisters/src/sns/errors/swap.errors.ts:7
Extends
Section titled “Extends”Error
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SnsSwapNewTicketError(
__namedParameters):SnsSwapNewTicketError
Defined in: packages/canisters/src/sns/errors/swap.errors.ts:12
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”errorType
Section titled “errorType”NewSaleTicketResponseErrorType
existingTicket?
Section titled “existingTicket?”invalidUserAmount?
Section titled “invalidUserAmount?”Returns
Section titled “Returns”Overrides
Section titled “Overrides”Error.constructor
Properties
Section titled “Properties”cause?
Section titled “cause?”
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Section titled “Inherited from”Error.cause
errorType
Section titled “errorType”errorType:
NewSaleTicketResponseErrorType
Defined in: packages/canisters/src/sns/errors/swap.errors.ts:8
existingTicket?
Section titled “existingTicket?”
optionalexistingTicket:Ticket
Defined in: packages/canisters/src/sns/errors/swap.errors.ts:10
invalidUserAmount?
Section titled “invalidUserAmount?”
optionalinvalidUserAmount:InvalidUserAmount
Defined in: packages/canisters/src/sns/errors/swap.errors.ts:9
message
Section titled “message”message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Section titled “Inherited from”Error.message
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Section titled “Inherited from”Error.name
stack?
Section titled “stack?”
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Section titled “Inherited from”Error.stack
stackTraceLimit
Section titled “stackTraceLimit”
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:67
The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Section titled “Inherited from”Error.stackTraceLimit
Methods
Section titled “Methods”captureStackTrace()
Section titled “captureStackTrace()”
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:51
Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};Error.captureStackTrace(myObject);myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() { b();}
function b() { c();}
function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error;}
a();Parameters
Section titled “Parameters”targetObject
Section titled “targetObject”object
constructorOpt?
Section titled “constructorOpt?”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Error.captureStackTrace
isError()
Section titled “isError()”
staticisError(error):error is Error
Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23
Indicates whether the argument provided is a built-in Error instance or not.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”error is Error
Inherited from
Section titled “Inherited from”Error.isError
prepareStackTrace()
Section titled “prepareStackTrace()”
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/@types/node/globals.d.ts:55
Parameters
Section titled “Parameters”Error
stackTraces
Section titled “stackTraces”CallSite[]
Returns
Section titled “Returns”any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Section titled “Inherited from”Error.prepareStackTrace
SnsWrapper
Section titled “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”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>
UnsupportedMethodError
Section titled “UnsupportedMethodError”Defined in: packages/canisters/src/sns/errors/common.errors.ts:3
Extends
Section titled “Extends”Error
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new UnsupportedMethodError(
methodName):UnsupportedMethodError
Defined in: packages/canisters/src/sns/errors/common.errors.ts:4
Parameters
Section titled “Parameters”methodName
Section titled “methodName”string
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Error.constructor
Properties
Section titled “Properties”cause?
Section titled “cause?”
optionalcause:unknown
Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26
Inherited from
Section titled “Inherited from”Error.cause
message
Section titled “message”message:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077
Inherited from
Section titled “Inherited from”Error.message
methodName
Section titled “methodName”
readonlymethodName:string
Defined in: packages/canisters/src/sns/errors/common.errors.ts:4
name:
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076
Inherited from
Section titled “Inherited from”Error.name
stack?
Section titled “stack?”
optionalstack:string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078
Inherited from
Section titled “Inherited from”Error.stack
stackTraceLimit
Section titled “stackTraceLimit”
staticstackTraceLimit:number
Defined in: node_modules/@types/node/globals.d.ts:67
The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Section titled “Inherited from”Error.stackTraceLimit
Methods
Section titled “Methods”captureStackTrace()
Section titled “captureStackTrace()”
staticcaptureStackTrace(targetObject,constructorOpt?):void
Defined in: node_modules/@types/node/globals.d.ts:51
Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};Error.captureStackTrace(myObject);myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() { b();}
function b() { c();}
function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error;}
a();Parameters
Section titled “Parameters”targetObject
Section titled “targetObject”object
constructorOpt?
Section titled “constructorOpt?”Function
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Error.captureStackTrace
isError()
Section titled “isError()”
staticisError(error):error is Error
Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23
Indicates whether the argument provided is a built-in Error instance or not.
Parameters
Section titled “Parameters”unknown
Returns
Section titled “Returns”error is Error
Inherited from
Section titled “Inherited from”Error.isError
prepareStackTrace()
Section titled “prepareStackTrace()”
staticprepareStackTrace(err,stackTraces):any
Defined in: node_modules/@types/node/globals.d.ts:55
Parameters
Section titled “Parameters”Error
stackTraces
Section titled “stackTraces”CallSite[]
Returns
Section titled “Returns”any
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Section titled “Inherited from”Error.prepareStackTrace
Interfaces
Section titled “Interfaces”InitSnsCanistersOptions
Section titled “InitSnsCanistersOptions”Defined in: packages/canisters/src/sns/sns.ts:19
Options to discover and initialize all canisters of a Sns.
Extends
Section titled “Extends”QueryParams
Properties
Section titled “Properties”agent?
Section titled “agent?”
optionalagent:Agent
Defined in: packages/canisters/src/sns/sns.ts:21
An agent that can be used to override the default agent. Useful to target another environment that mainnet.
certified?
Section titled “certified?”
optionalcertified:boolean
Defined in: packages/utils/dist/types/query.params.d.ts:6
Perform update calls (certified) or query calls (not certified).
Inherited from
Section titled “Inherited from”QueryParams.certified
rootOptions
Section titled “rootOptions”rootOptions:
Omit<SnsCanisterOptions<_SERVICE>,"agent">
Defined in: packages/canisters/src/sns/sns.ts:23
The options that will be used to instantiate the actors of the root canister of the particular Sns.
InitSnsWrapper()
Section titled “InitSnsWrapper()”Defined in: packages/canisters/src/sns/sns.ts:26
InitSnsWrapper(
options):Promise<SnsWrapper>
Defined in: packages/canisters/src/sns/sns.ts:27
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<SnsWrapper>
SnsCanisterOptions
Section titled “SnsCanisterOptions”Defined in: packages/canisters/src/sns/types/canister.options.ts:4
Extends
Section titled “Extends”Omit<CanisterOptions<T>,"canisterId">
Type Parameters
Section titled “Type Parameters”T
Properties
Section titled “Properties”agent?
Section titled “agent?”
optionalagent:Agent
Defined in: packages/utils/dist/types/canister.options.d.ts:4
Inherited from
Section titled “Inherited from”NnsGovernanceCanisterOptions.agent
canisterId
Section titled “canisterId”canisterId:
Principal
Defined in: packages/canisters/src/sns/types/canister.options.ts:9
certifiedServiceOverride?
Section titled “certifiedServiceOverride?”
optionalcertifiedServiceOverride:ActorSubclass<T>
Defined in: packages/utils/dist/types/canister.options.d.ts:7
Inherited from
Section titled “Inherited from”Omit.certifiedServiceOverride
serviceOverride?
Section titled “serviceOverride?”
optionalserviceOverride:ActorSubclass<T>
Defined in: packages/utils/dist/types/canister.options.d.ts:6
Inherited from
Section titled “Inherited from”Omit.serviceOverride
SnsClaimNeuronParams
Section titled “SnsClaimNeuronParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:177
The parameters to claim a neuron
Properties
Section titled “Properties”controller
Section titled “controller”controller:
Principal
Defined in: packages/canisters/src/sns/types/governance.params.ts:179
memo:
bigint
Defined in: packages/canisters/src/sns/types/governance.params.ts:178
subaccount
Section titled “subaccount”subaccount:
Subaccount
Defined in: packages/canisters/src/sns/types/governance.params.ts:180
SnsClaimOrRefreshArgs
Section titled “SnsClaimOrRefreshArgs”Defined in: packages/canisters/src/sns/types/governance.params.ts:94
Extends
Section titled “Extends”Omit<QueryParams,"certified">
Properties
Section titled “Properties”controller?
Section titled “controller?”
optionalcontroller:Principal
Defined in: packages/canisters/src/sns/types/governance.params.ts:97
optionalmemo:bigint
Defined in: packages/canisters/src/sns/types/governance.params.ts:96
subaccount
Section titled “subaccount”subaccount:
Uint8Array
Defined in: packages/canisters/src/sns/types/governance.params.ts:95
SnsDisburseNeuronParams
Section titled “SnsDisburseNeuronParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:126
The parameters to disburse a neuron
Extends
Section titled “Extends”SnsNeuronManagementParams
Properties
Section titled “Properties”amount?
Section titled “amount?”
optionalamount:bigint
Defined in: packages/canisters/src/sns/types/governance.params.ts:127
neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:104
Inherited from
Section titled “Inherited from”SnsNeuronManagementParams.neuronId
toAccount?
Section titled “toAccount?”
optionaltoAccount:IcrcAccount
Defined in: packages/canisters/src/sns/types/governance.params.ts:128
SnsGetNeuronParams
Section titled “SnsGetNeuronParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:71
The parameters to get a Sns neuron
Extends
Section titled “Extends”QueryParams
Properties
Section titled “Properties”certified?
Section titled “certified?”
optionalcertified:boolean
Defined in: packages/utils/dist/types/query.params.d.ts:6
Perform update calls (certified) or query calls (not certified).
Inherited from
Section titled “Inherited from”QueryParams.certified
neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:72
SnsGetProposalParams
Section titled “SnsGetProposalParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:64
The parameters to get an sns proposal
Extends
Section titled “Extends”QueryParams
Properties
Section titled “Properties”certified?
Section titled “certified?”
optionalcertified:boolean
Defined in: packages/utils/dist/types/query.params.d.ts:6
Perform update calls (certified) or query calls (not certified).
Inherited from
Section titled “Inherited from”QueryParams.certified
proposalId
Section titled “proposalId”proposalId:
ProposalId
Defined in: packages/canisters/src/sns/types/governance.params.ts:65
SnsIncreaseDissolveDelayParams
Section titled “SnsIncreaseDissolveDelayParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:141
The parameters to increase dissolve delay
Extends
Section titled “Extends”SnsNeuronManagementParams
Properties
Section titled “Properties”additionalDissolveDelaySeconds
Section titled “additionalDissolveDelaySeconds”additionalDissolveDelaySeconds:
number
Defined in: packages/canisters/src/sns/types/governance.params.ts:142
neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:104
Inherited from
Section titled “Inherited from”SnsNeuronManagementParams.neuronId
SnsIncreaseStakeNeuronParams
Section titled “SnsIncreaseStakeNeuronParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:84
Extends
Section titled “Extends”Omit<QueryParams,"certified">
Properties
Section titled “Properties”neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:90
source
Section titled “source”source:
IcrcAccount
Defined in: packages/canisters/src/sns/types/governance.params.ts:89
stakeE8s
Section titled “stakeE8s”stakeE8s:
bigint
Defined in: packages/canisters/src/sns/types/governance.params.ts:88
SnsListNeuronsParams
Section titled “SnsListNeuronsParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:16
The parameters available to list Sns neurons
Extends
Section titled “Extends”QueryParams
Properties
Section titled “Properties”beforeNeuronId?
Section titled “beforeNeuronId?”
optionalbeforeNeuronId:NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:22
Index the search to returns a list that starts after specified neuron id
certified?
Section titled “certified?”
optionalcertified:boolean
Defined in: packages/utils/dist/types/query.params.d.ts:6
Perform update calls (certified) or query calls (not certified).
Inherited from
Section titled “Inherited from”QueryParams.certified
limit?
Section titled “limit?”
optionallimit:number
Defined in: packages/canisters/src/sns/types/governance.params.ts:20
The maximum number of neurons returned by the method list_neurons
principal?
Section titled “principal?”
optionalprincipal:Principal
Defined in: packages/canisters/src/sns/types/governance.params.ts:18
Scope the query to a particular principal
SnsListProposalsParams
Section titled “SnsListProposalsParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:28
The parameters available to list Sns proposals
Extends
Section titled “Extends”QueryParams
Properties
Section titled “Properties”beforeProposal?
Section titled “beforeProposal?”
optionalbeforeProposal:ProposalId
Defined in: packages/canisters/src/sns/types/governance.params.ts:37
certified?
Section titled “certified?”
optionalcertified:boolean
Defined in: packages/utils/dist/types/query.params.d.ts:6
Perform update calls (certified) or query calls (not certified).
Inherited from
Section titled “Inherited from”QueryParams.certified
excludeType?
Section titled “excludeType?”
optionalexcludeType:bigint[]
Defined in: packages/canisters/src/sns/types/governance.params.ts:43
includeRewardStatus?
Section titled “includeRewardStatus?”
optionalincludeRewardStatus:SnsProposalRewardStatus[]
Defined in: packages/canisters/src/sns/types/governance.params.ts:33
includeStatus?
Section titled “includeStatus?”
optionalincludeStatus:SnsProposalDecisionStatus[]
Defined in: packages/canisters/src/sns/types/governance.params.ts:48
includeTopics?
Section titled “includeTopics?”
optionalincludeTopics: (Topic|null)[]
Defined in: packages/canisters/src/sns/types/governance.params.ts:56
limit?
Section titled “limit?”
optionallimit:number
Defined in: packages/canisters/src/sns/types/governance.params.ts:40
SnsNeuronAutoStakeMaturityParams
Section titled “SnsNeuronAutoStakeMaturityParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:201
The parameters to toggle auto stake maturity of a neuron
Extends
Section titled “Extends”SnsNeuronManagementParams
Properties
Section titled “Properties”autoStake
Section titled “autoStake”autoStake:
boolean
Defined in: packages/canisters/src/sns/types/governance.params.ts:202
neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:104
Inherited from
Section titled “Inherited from”SnsNeuronManagementParams.neuronId
SnsNeuronDisburseMaturityParams
Section titled “SnsNeuronDisburseMaturityParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:193
The parameters to disburse maturity of a neuron
Extends
Section titled “Extends”SnsNeuronManagementParams
Properties
Section titled “Properties”neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:104
Inherited from
Section titled “Inherited from”SnsNeuronManagementParams.neuronId
percentageToDisburse
Section titled “percentageToDisburse”percentageToDisburse:
number
Defined in: packages/canisters/src/sns/types/governance.params.ts:195
toAccount?
Section titled “toAccount?”
optionaltoAccount:IcrcAccount
Defined in: packages/canisters/src/sns/types/governance.params.ts:194
SnsNeuronPermissionsParams
Section titled “SnsNeuronPermissionsParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:110
The parameters to add permissions to a neuron
Extends
Section titled “Extends”SnsNeuronManagementParams
Properties
Section titled “Properties”neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:104
Inherited from
Section titled “Inherited from”SnsNeuronManagementParams.neuronId
permissions
Section titled “permissions”permissions:
SnsNeuronPermissionType[]
Defined in: packages/canisters/src/sns/types/governance.params.ts:112
principal
Section titled “principal”principal:
Principal
Defined in: packages/canisters/src/sns/types/governance.params.ts:111
SnsNeuronStakeMaturityParams
Section titled “SnsNeuronStakeMaturityParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:186
The parameters to stake maturity of a neuron
Extends
Section titled “Extends”SnsNeuronManagementParams
Properties
Section titled “Properties”neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:104
Inherited from
Section titled “Inherited from”SnsNeuronManagementParams.neuronId
percentageToStake?
Section titled “percentageToStake?”
optionalpercentageToStake:number
Defined in: packages/canisters/src/sns/types/governance.params.ts:187
SnsRegisterVoteParams
Section titled “SnsRegisterVoteParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:169
The parameters to register vote
Extends
Section titled “Extends”SnsNeuronManagementParams
Properties
Section titled “Properties”neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:104
Inherited from
Section titled “Inherited from”SnsNeuronManagementParams.neuronId
proposalId
Section titled “proposalId”proposalId:
ProposalId
Defined in: packages/canisters/src/sns/types/governance.params.ts:171
vote:
SnsVote
Defined in: packages/canisters/src/sns/types/governance.params.ts:170
SnsSetDissolveTimestampParams
Section titled “SnsSetDissolveTimestampParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:134
The parameters to set dissolve timestamp
Extends
Section titled “Extends”SnsNeuronManagementParams
Properties
Section titled “Properties”dissolveTimestampSeconds
Section titled “dissolveTimestampSeconds”dissolveTimestampSeconds:
bigint
Defined in: packages/canisters/src/sns/types/governance.params.ts:135
neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:104
Inherited from
Section titled “Inherited from”SnsNeuronManagementParams.neuronId
SnsSetFollowingParams
Section titled “SnsSetFollowingParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:156
The parameters to follow by topic
Extends
Section titled “Extends”SnsNeuronManagementParams
Properties
Section titled “Properties”neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:104
Inherited from
Section titled “Inherited from”SnsNeuronManagementParams.neuronId
topicFollowing
Section titled “topicFollowing”topicFollowing:
object[]
Defined in: packages/canisters/src/sns/types/governance.params.ts:157
followees
Section titled “followees”followees:
object[]
topic:
Topic
SnsSetTopicFollowees
Section titled “SnsSetTopicFollowees”Defined in: packages/canisters/src/sns/types/governance.params.ts:148
The parameters to follow by ns-function
Extends
Section titled “Extends”SnsNeuronManagementParams
Properties
Section titled “Properties”followees
Section titled “followees”followees:
NeuronId[]
Defined in: packages/canisters/src/sns/types/governance.params.ts:150
functionId
Section titled “functionId”functionId:
bigint
Defined in: packages/canisters/src/sns/types/governance.params.ts:149
neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:104
Inherited from
Section titled “Inherited from”SnsNeuronManagementParams.neuronId
SnsSplitNeuronParams
Section titled “SnsSplitNeuronParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:118
The parameters to split a neuron
Extends
Section titled “Extends”SnsNeuronManagementParams
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/sns/types/governance.params.ts:119
memo:
bigint
Defined in: packages/canisters/src/sns/types/governance.params.ts:120
neuronId
Section titled “neuronId”neuronId:
NeuronId
Defined in: packages/canisters/src/sns/types/governance.params.ts:104
Inherited from
Section titled “Inherited from”SnsNeuronManagementParams.neuronId
SnsStakeNeuronParams
Section titled “SnsStakeNeuronParams”Defined in: packages/canisters/src/sns/types/governance.params.ts:75
Extends
Section titled “Extends”Omit<QueryParams,"certified">
Properties
Section titled “Properties”controller
Section titled “controller”controller:
Principal
Defined in: packages/canisters/src/sns/types/governance.params.ts:78
createdAt?
Section titled “createdAt?”
optionalcreatedAt:bigint
Defined in: packages/canisters/src/sns/types/governance.params.ts:80
optionalfee:bigint
Defined in: packages/canisters/src/sns/types/governance.params.ts:81
source
Section titled “source”source:
IcrcAccount
Defined in: packages/canisters/src/sns/types/governance.params.ts:77
stakeE8s
Section titled “stakeE8s”stakeE8s:
bigint
Defined in: packages/canisters/src/sns/types/governance.params.ts:76
Type Aliases
Section titled “Type Aliases”SnsListTopicsParams
Section titled “SnsListTopicsParams”SnsListTopicsParams =
QueryParams
Defined in: packages/canisters/src/sns/types/governance.params.ts:59
Variables
Section titled “Variables”initSnsWrapper
Section titled “initSnsWrapper”
constinitSnsWrapper:InitSnsWrapper
Defined in: packages/canisters/src/sns/sns.ts:33
Lookup for the canister ids of a Sns and initialize the wrapper to access its features.
Functions
Section titled “Functions”fromCandidAction()
Section titled “fromCandidAction()”fromCandidAction(
action):Action
Defined in: packages/canisters/src/sns/converters/governance.converters.ts:335
Parameters
Section titled “Parameters”action
Section titled “action”Returns
Section titled “Returns”Action
neuronSubaccount()
Section titled “neuronSubaccount()”neuronSubaccount(
params):Subaccount
Defined in: packages/canisters/src/sns/utils/governance.utils.ts:18
Neuron subaccount is calculated as “sha256(0x0c . “neuron-stake” . controller . i)“
Parameters
Section titled “Parameters”params
Section titled “params”controller
Section titled “controller”Principal
number
Returns
Section titled “Returns”References
Section titled “References”SnsWasmDid
Section titled “SnsWasmDid”Re-exports SnsWasmDid