Skip to content
ICP JS SDK Docs
Canisters
Search Canisters
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Canisters
Version
Latest (v3.3.0)
v3
v2
Getting Started
Overview
Installation
Quick Start
Modules
Assets
Overview
classes
AssetManager
interfaces
AssetManagerConfig
CommitBatchArgs
Progress
StoreConfig
type-aliases
ContentEncoding
StoreArgs
StoreBlobArgs
StoreBytesArgs
StoreFileArgs
StorePathArgs
StoreReadableArgs
ckBTC
Overview
classes
BitcoinCanister
CkBtcMinterCanister
MinterAlreadyProcessingError
MinterAmountTooLowError
MinterGenericError
MinterInsufficientAllowanceError
MinterInsufficientFundsError
MinterMalformedAddressError
MinterNoNewUtxosError
MinterRetrieveBtcError
MinterTemporaryUnavailableError
MinterUpdateBalanceError
ParseBtcAddressBadWitnessLengthError
ParseBtcAddressError
ParseBtcAddressInvalidError
ParseBtcAddressMalformedAddressError
ParseBtcAddressNoDataError
ParseBtcAddressUnexpectedHumanReadablePartError
ParseBtcAddressUnsupportedAddressTypeError
ParseBtcAddressUnsupportedWitnessVersionError
ParseBtcAddressWrongNetworkError
enumerations
BtcAddressType
BtcNetwork
functions
createRetrieveBtcError
createRetrieveBtcWithApprovalError
createUpdateBalanceError
parseBtcAddress
toGetBalanceParams
toGetUtxosParams
interfaces
BtcAddress
BtcAddressInfo
CkBtcCanisterOptions
EstimateWithdrawalFee
MinterAccount
RetrieveBtcStatusV2WithId
namespaces
BitcoinDid
BitcoinDid
interfaces
config
fees
get_balance_request
get_block_headers_request
get_block_headers_response
get_current_fee_percentiles_request
get_utxos_request
get_utxos_response
init_config
outpoint
send_transaction_request
_SERVICE
set_config_request
utxo
type-aliases
address
block_hash
block_header
block_height
canister_arg
flag
millisatoshi_per_byte
network
satoshi
variables
idlFactory
init
CkBtcMinterDid
CkBtcMinterDid
interfaces
Account
CanisterStatusResponse
DefiniteCanisterSettings
environment_variable
Event
InitArgs
MemoryMetrics
MinterInfo
PendingUtxo
QueryStats
ReimbursedDeposit
ReimbursementRequest
RetrieveBtcArgs
RetrieveBtcOk
RetrieveBtcWithApprovalArgs
_SERVICE
SuspendedUtxo
UpgradeArgs
Utxo
WithdrawalFee
type-aliases
BitcoinAddress
BtcNetwork
CanisterStatusType
EventType
InvalidTransactionError
LogVisibility
MinterArg
Mode
ReimbursementReason
ReplacedReason
RetrieveBtcError
RetrieveBtcStatus
RetrieveBtcStatusV2
RetrieveBtcWithApprovalError
SuspendedReason
Timestamp
UpdateBalanceError
UtxoStatus
WithdrawalReimbursementReason
variables
idlFactory
init
type-aliases
BitcoinNetwork
EstimateWithdrawalFeeParams
GetBalanceParams
GetBTCAddressParams
GetKnownUtxosParams
GetUtxosParams
MinterParams
RetrieveBtcParams
RetrieveBtcResponse
RetrieveBtcStatusV2ByAccountParams
RetrieveBtcWithApprovalResponse
UpdateBalanceOk
UpdateBalanceParams
UpdateBalanceResponse
ckETH
Overview
classes
CkEthMinterCanister
CkEthOrchestratorCanister
DetailedError
LedgerAmountTooLowError
LedgerError
LedgerGenericError
LedgerInsufficientAllowanceError
LedgerInsufficientFundsError
LedgerTemporaryUnavailableError
LedgerWithdrawalError
MinterAmountTooLowError
MinterError
MinterGenericError
MinterInsufficientAllowanceError
MinterInsufficientFundsError
MinterRecipientAddressBlockedError
MinterTemporaryUnavailableError
MinterTokenNotSupported
functions
createWithdrawErc20Error
createWithdrawEthError
encodePrincipalToEthAddress
interfaces
CkEthMinterCanisterOptions
namespaces
CkEthMinterDid
CkEthMinterDid
interfaces
Account
AddCkErc20Token
CanisterStatusResponse
CkErc20Token
DefiniteCanisterSettings
Eip1559TransactionPrice
Eip1559TransactionPriceArg
EthTransaction
Event
EventSource
GasFeeEstimate
InitArg
MinterInfo
QueryStats
RetrieveErc20Request
RetrieveEthRequest
_SERVICE
TransactionReceipt
UnsignedTransaction
UpgradeArg
WithdrawalArg
WithdrawalDetail
WithdrawErc20Arg
type-aliases
BlockTag
CanisterStatusType
EthereumNetwork
LedgerError
LogVisibility
MinterArg
ReimbursementIndex
RetrieveEthStatus
Subaccount
TxFinalizedStatus
WithdrawalError
WithdrawalSearchParameter
WithdrawalStatus
WithdrawErc20Error
variables
idlFactory
init
CkEthOrchestratorDid
CkEthOrchestratorDid
interfaces
AddErc20Arg
CanisterStatusResponse
CyclesManagement
DefiniteCanisterSettings
Erc20Contract
InitArg
InstalledCanister
InstalledLedgerSuite
LedgerInitArg
LedgerSuiteVersion
ManagedCanisterIds
ManagedCanisters
ManagedLedgerSuite
OrchestratorInfo
QueryStats
_SERVICE
UpdateCyclesManagement
UpgradeArg
type-aliases
CanisterStatusType
LogVisibility
ManagedCanisterStatus
OrchestratorArg
variables
idlFactory
init
type-aliases
CkEthOrchestratorCanisterOptions
Eip1559TransactionPriceParams
CMC
Overview
classes
CmcCanister
CmcError
InvalidaTransactionError
ProcessingError
RefundedError
TransactionTooOldError
functions
throwNotifyError
interfaces
CmcCanisterOptions
namespaces
CmcDid
CmcDid
interfaces
CanisterSettings
CreateCanisterArg
CyclesCanisterInitPayload
environment_variable
IcpXdrConversionRate
IcpXdrConversionRateResponse
NotifyCreateCanisterArg
NotifyMintCyclesArg
NotifyMintCyclesSuccess
NotifyTopUpArg
PrincipalsAuthorizedToCreateCanistersToSubnetsResponse
_SERVICE
SetAuthorizedSubnetworkListArgs
SubnetFilter
SubnetListWithType
SubnetTypesToSubnetsResponse
type-aliases
AccountIdentifier
BlockIndex
ChangeSubnetTypeAssignmentArgs
CreateCanisterError
CreateCanisterResult
Cycles
ExchangeRateCanister
log_visibility
Memo
NotifyCreateCanisterResult
NotifyError
NotifyMintCyclesResult
NotifyTopUpResult
Subaccount
SubnetSelection
UpdateSubnetTypeArgs
variables
idlFactory
init
IC Management
Overview
classes
IcManagementCanister
UnsupportedLogVisibility
enumerations
LogVisibility
functions
decodeSnapshotId
encodeSnapshotId
fromReadCanisterSnapshotMetadataResponse
mapSnapshotId
toCanisterSettings
toCanisterSnapshotMetadataKind
toReplaceSnapshotArgs
toSnapshotArgs
toUploadCanisterSnapshotDataKind
toUploadCanisterSnapshotMetadata
interfaces
CanisterSettings
CanisterStatusParams
ClearChunkStoreParams
CreateCanisterParams
InstallChunkedCodeParams
InstallCodeParams
OptionSnapshotParams
ProvisionalCreateCanisterWithCyclesParams
ReadCanisterSnapshotDataParams
ReadCanisterSnapshotMetadataParams
ReadCanisterSnapshotMetadataResponse
StoredChunksParams
UninstallCodeParams
UpdateSettingsParams
UploadCanisterSnapshotDataParams
UploadCanisterSnapshotMetadataParams
UploadChunkParams
namespaces
IcManagementDid
IcManagementDid
interfaces
bitcoin_get_balance_args
bitcoin_get_block_headers_args
bitcoin_get_block_headers_result
bitcoin_get_current_fee_percentiles_args
bitcoin_get_utxos_args
bitcoin_get_utxos_result
bitcoin_send_transaction_args
canister_info_args
canister_info_result
canister_log_record
canister_metadata_args
canister_metadata_result
canister_settings
canister_status_args
canister_status_result
change
chunk_hash
clear_chunk_store_args
create_canister_args
create_canister_result
definite_canister_settings
delete_canister_args
delete_canister_snapshot_args
deposit_cycles_args
ecdsa_public_key_args
ecdsa_public_key_result
environment_variable
fetch_canister_logs_args
fetch_canister_logs_result
http_header
http_request_args
http_request_result
install_chunked_code_args
install_code_args
list_canister_snapshots_args
load_canister_snapshot_args
node_metrics
node_metrics_history_args
outpoint
provisional_create_canister_with_cycles_args
provisional_create_canister_with_cycles_result
provisional_top_up_canister_args
read_canister_snapshot_data_args
read_canister_snapshot_data_response
read_canister_snapshot_metadata_args
read_canister_snapshot_metadata_response
schnorr_public_key_args
schnorr_public_key_result
_SERVICE
sign_with_ecdsa_args
sign_with_ecdsa_result
sign_with_schnorr_args
sign_with_schnorr_result
snapshot
start_canister_args
stop_canister_args
stored_chunks_args
subnet_info_args
subnet_info_result
take_canister_snapshot_args
uninstall_code_args
update_settings_args
upload_canister_snapshot_data_args
upload_canister_snapshot_metadata_args
upload_canister_snapshot_metadata_response
upload_chunk_args
utxo
vetkd_derive_key_args
vetkd_derive_key_result
vetkd_public_key_args
vetkd_public_key_result
type-aliases
bitcoin_address
bitcoin_block_hash
bitcoin_block_header
bitcoin_block_height
bitcoin_get_balance_result
bitcoin_get_current_fee_percentiles_result
bitcoin_network
canister_id
canister_install_mode
change_details
change_origin
ecdsa_curve
list_canister_snapshots_result
log_visibility
millisatoshi_per_byte
node_metrics_history_result
raw_rand_result
satoshi
schnorr_algorithm
schnorr_aux
snapshot_id
stored_chunks_result
take_canister_snapshot_result
upload_chunk_result
vetkd_curve
wasm_module
variables
idlFactory
init
type-aliases
CanisterSnapshotMetadataKind
CanisterStatusResponse
FetchCanisterLogsResponse
IcManagementCanisterOptions
SnapshotIdText
SnapshotParams
UploadCanisterSnapshotDataKind
UploadCanisterSnapshotMetadataParam
Ledger
ICP
Overview
classes
AccountIdentifier
AllowanceChangedError
ApproveError
BadFeeError
ConsentMessageError
ConsentMessageUnavailableError
CreatedInFutureError
DuplicateError
ExpiredError
GenericError
IcpIndexCanister
IcpLedgerCanister
IcrcError
InsufficientFundsError
InsufficientPaymentError
InvalidAccountIDError
InvalidSenderError
SubAccount
TemporarilyUnavailableError
TooOldError
TransferError
TxCreatedInFutureError
TxDuplicateError
TxTooOldError
UnsupportedCanisterCallError
functions
checkAccountId
isIcpAccountIdentifier
mapIcrc1TransferError
mapIcrc21ConsentMessageError
mapIcrc2ApproveError
mapTransferError
toIcrc1TransferRawRequest
toIcrc21ConsentMessageRawRequest
toIcrc2ApproveRawRequest
toTransferRawRequest
interfaces
Icrc1TransferRequest
TransferRequest
namespaces
IcpIndexDid
IcpIndexDid
interfaces
Account
GetAccountIdentifierTransactionsArgs
GetAccountIdentifierTransactionsError
GetAccountIdentifierTransactionsResponse
GetAccountTransactionsArgs
GetBlocksRequest
GetBlocksResponse
HttpRequest
HttpResponse
InitArg
_SERVICE
Status
TimeStamp
Tokens
Transaction
TransactionWithId
type-aliases
GetAccountIdentifierTransactionsResult
Operation
variables
idlFactory
init
IcpLedgerDid
IcpLedgerDid
interfaces
Account
AccountBalanceArgs
AccountBalanceArgsDfx
Allowance
AllowanceArgs
ApproveArgs
Archive
ArchivedBlocksRange
ArchivedEncodedBlocksRange
ArchiveOptions
Archives
Block
BlockRange
Duration
FeatureFlags
FieldsDisplay
GetAllowancesArgs
GetBlocksArgs
icrc21_consent_info
icrc21_consent_message_metadata
icrc21_consent_message_request
icrc21_consent_message_spec
icrc21_error_info
InitArgs
QueryBlocksResponse
QueryEncodedBlocksResponse
RemoveApprovalArgs
SendArgs
_SERVICE
TimeStamp
TipOfChainRes
Tokens
Transaction
TransferArg
TransferArgs
TransferFee
TransferFromArgs
UpgradeArgs
type-aliases
AccountIdentifier
Allowances
ApproveError
ApproveResult
BlockIndex
Icrc1BlockIndex
Icrc1Timestamp
Icrc1Tokens
Icrc1TransferError
Icrc1TransferResult
icrc21_consent_message
icrc21_consent_message_response
icrc21_error
Icrc21Value
LedgerCanisterPayload
Memo
Operation
QueryArchiveError
QueryArchiveFn
QueryArchiveResult
SubAccount
TextAccountIdentifier
TransferError
TransferFeeArg
TransferFromError
TransferFromResult
TransferResult
Value
variables
idlFactory
init
type-aliases
AccountIdentifierHex
BlockHeight
E8s
IcpLedgerCanisterOptions
Icrc2ApproveRequest
ICRC
Overview
classes
ConsentMessageError
ConsentMessageUnavailableError
GenericError
IcrcIndexCanister
IcrcLedgerCanister
IcrcNftLedgerCanister
IcrcTransferError
IndexError
IndexPrincipalNotSetError
InsufficientPaymentError
UnsupportedCanisterCallError
enumerations
IcrcMetadataResponseEntries
functions
decodeIcrcAccount
decodePayment
encodeIcrcAccount
fromCandidAccount
mapIcrc106GetIndexPrincipalError
mapIcrc21ConsentMessageError
mapTokenMetadata
toApproveArgs
toCandidAccount
toIcrc21ConsentMessageArgs
toTransferArg
toTransferFromArgs
interfaces
Icrc21ConsentMessageMetadata
Icrc21ConsentMessageSpec
IcrcAccount
IcrcLedgerCanisterOptions
IcrcTokenMetadata
TransferParams
namespaces
IcrcIndexDid
IcrcIndexDid
interfaces
Account
Approve
Burn
FeeCollector
FeeCollectorRanges
GetAccountTransactionsArgs
GetBlocksRequest
GetBlocksResponse
GetTransactions
GetTransactionsErr
InitArg
ListSubaccountsArgs
Mint
_SERVICE
Status
Transaction
TransactionWithId
Transfer
UpgradeArg
type-aliases
Block
BlockIndex
GetTransactionsResult
IndexArg
Map
SubAccount
Tokens
Value
variables
idlFactory
init
IcrcLedgerDid
IcrcLedgerDid
interfaces
Account
Allowance
Allowance103
AllowanceArgs
Approve
ApproveArgs
ArchiveInfo
BlockRange
Burn
ChangeArchiveOptions
DataCertificate
FeatureFlags
FeeCollector
FieldsDisplay
GetAllowancesArgs
GetArchivesArgs
GetBlocksArgs
GetBlocksResponse
GetBlocksResult
GetTransactionsRequest
GetTransactionsResponse
HttpRequest
HttpResponse
icrc21_consent_info
icrc21_consent_message_metadata
icrc21_consent_message_request
icrc21_consent_message_spec
icrc21_error_info
ICRC3DataCertificate
InitArgs
Mint
_SERVICE
StandardRecord
Transaction
TransactionRange
Transfer
TransferArg
TransferFromArgs
UpgradeArgs
type-aliases
ApproveError
ApproveResult
Block
BlockIndex
ChangeFeeCollector
Duration
GetAllowancesError
GetArchivesResult
GetIndexPrincipalError
GetIndexPrincipalResult
icrc103_get_allowances_response
icrc21_consent_message
icrc21_consent_message_response
icrc21_error
Icrc21Value
ICRC3Value
LedgerArg
Map
MetadataValue
QueryArchiveFn
QueryBlockArchiveFn
Subaccount
Timestamp
Tokens
TransferError
TransferFromError
TransferFromResult
TransferResult
TxIndex
Value
variables
idlFactory
init
IcrcNftLedgerDid
IcrcNftLedgerDid
interfaces
Account
_SERVICE
TransferArg
type-aliases
Subaccount
TransferError
TransferResult
Value
variables
idlFactory
init
type-aliases
AllowanceParams
ApproveParams
BalanceParams
GetBlocksParams
GetIndexAccountTransactionsParams
Icrc21ConsentMessageDeviceSpec
Icrc21ConsentMessageParams
IcrcTokenMetadataResponse
ListSubaccountsParams
TransferFromParams
Cycles
Overview
classes
CyclesLedgerCanister
namespaces
CyclesLedgerDid
CyclesLedgerDid
interfaces
Account
Allowance
AllowanceArgs
ApproveArgs
CanisterSettings
CmcCreateCanisterArgs
CreateCanisterArgs
CreateCanisterFromArgs
CreateCanisterSuccess
DataCertificate
DepositArgs
DepositResult
GetAllowancesArgs
GetArchivesArgs
GetBlocksResult
HttpRequest
HttpResponse
InitArgs
_SERVICE
SubnetFilter
SupportedBlockType
SupportedStandard
TransferArgs
TransferFromArgs
UpgradeArgs
WithdrawArgs
WithdrawFromArgs
type-aliases
Allowances
ApproveError
BlockIndex
ChangeIndexId
CreateCanisterError
CreateCanisterFromError
GetAllowancesError
GetArchivesResult
GetBlocksArgs
GetIndexPrincipalError
GetIndexPrincipalResult
ICRC103GetAllowancesResponse
LedgerArgs
MetadataValue
RejectionCode
SubnetSelection
TransferError
TransferFromError
Value
WithdrawError
WithdrawFromError
variables
idlFactory
init
type-aliases
WithdrawParams
WithdrawResult
NNS
Overview
classes
CouldNotClaimNeuronError
GovernanceError
InsufficientAmountError
NnsGenesisTokenCanister
NnsGovernanceCanister
NnsGovernanceTestCanister
SnsWasmCanister
StakeNeuronError
UnrecognizedTypeError
UnsupportedValueError
enumerations
CanisterAction
CanisterInstallMode
LogVisibility
NeuronState
NeuronType
NeuronVisibility
NnsFunction
ProposalRewardStatus
ProposalStatus
Topic
Vote
functions
accountIdentifierFromBytes
accountIdentifierToBytes
ineligibleNeurons
memoToNeuronAccountIdentifier
memoToNeuronSubaccount
principalToAccountIdentifier
votableNeurons
votedNeurons
interfaces
Account
AddHotKey
AddHotKeyRequest
AddOrRemoveNodeProvider
ApproveGenesisKyc
Ballot
BallotInfo
CanisterAuthzInfo
CanisterSettings
ChangeAutoStakeMaturity
ClaimNeuronRequest
ClaimOrRefresh
ClaimOrRefreshNeuronFromAccount
ClaimOrRefreshNeuronRequest
Configure
Countries
CreateServiceNervousSystem
Decimal
DeregisterKnownNeuron
DeveloperDistribution
Disburse
DisburseMaturity
DisburseRequest
DisburseResponse
DisburseToNeuron
DisburseToNeuronRequest
Duration
ExecuteNnsFunction
Follow
Followees
FolloweesForTopic
FollowRequest
FulfillSubnetRentalRequest
GlobalTimeOfDay
GovernanceCachedMetrics
GovernanceParameters
Image
IncreaseDissolveDelay
IncreaseDissolveDelayRequest
InitialTokenDistribution
InstallCode
InstallCodeRequest
JoinCommunityFundRequest
KnownNeuron
LedgerParameters
ListNodeProvidersResponse
ListProposalsRequest
ListProposalsResponse
MakeExecuteNnsFunctionProposalRequest
MakeMotionProposalRequest
MakeNetworkEconomicsProposalRequest
MakeProposalRequest
MakeProposalResponse
MakeRewardNodeProviderProposalRequest
MakeSetDefaultFolloweesProposalRequest
ManageNeuron
ManageNeuronRequest
MaturityDisbursement
Merge
MergeMaturity
MergeMaturityRequest
MergeMaturityResponse
MergeRequest
MethodAuthzChange
MethodAuthzInfo
Motion
NetworkEconomics
Neuron
NeuronBasketConstructionParameters
NeuronDistribution
NeuronInfo
NeuronsFundEconomics
NeuronsFundMatchedFundingCurveCoefficients
NeuronSubsetMetrics
NnsGovernanceCanisterOptions
NodeProvider
OpenSnsTokenSwap
Percentage
Proposal
ProposalInfo
RefreshVotingPower
RegisterVote
RegisterVoteRequest
RemoveHotKey
RemoveHotKeyRequest
RewardNodeProvider
RewardNodeProviders
RewardToAccount
RewardToNeuron
SetDefaultFollowees
SetDissolveTimestamp
SetFollowing
SetSnsTokenSwapOpenTimeWindow
SetVisibility
Spawn
SpawnRequest
Split
SplitRequest
StakeMaturity
StartDissolvingRequest
StopDissolvingRequest
StopOrStartCanister
SwapDistribution
SwapParameters
Tally
Tokens
UpdateCanisterSettings
VotingPowerEconomics
VotingRewardParameters
namespaces
NnsGenesisTokenDid
NnsGenesisTokenDid
interfaces
AccountState
NeuronId
_SERVICE
TransferredNeuron
type-aliases
Result
Result_1
Result_2
variables
idlFactory
init
NnsGovernanceDid
NnsGovernanceDid
interfaces
Account
AccountIdentifier
AddHotKey
AddOrRemoveNodeProvider
Amount
ApproveGenesisKyc
Ballot
BallotInfo
Canister
CanisterSettings
CanisterStatusResultV2
CanisterSummary
ChangeAutoStakeMaturity
ClaimOrRefresh
ClaimOrRefreshNeuronFromAccount
ClaimOrRefreshNeuronFromAccountResponse
ClaimOrRefreshResponse
Committed
Committed_1
Configure
Controllers
Countries
CreateServiceNervousSystem
DateRangeFilter
DateUtc
Decimal
DeregisterKnownNeuron
DerivedProposalInformation
DeveloperDistribution
Disburse
DisburseMaturity
DisburseMaturityResponse
DisburseResponse
DisburseToNeuron
Duration
ExecuteNnsFunction
Follow
Followees
FolloweesForTopic
FulfillSubnetRentalRequest
GetNeuronIndexRequest
GetNeuronsFundAuditInfoRequest
GetNeuronsFundAuditInfoResponse
GetPendingProposalsRequest
GlobalTimeOfDay
Governance
GovernanceCachedMetrics
GovernanceError
GovernanceParameters
IdealMatchedParticipationFunction
Image
IncreaseDissolveDelay
InitialTokenDistribution
InstallCode
InstallCodeRequest
KnownNeuron
KnownNeuronData
LedgerParameters
ListKnownNeuronsResponse
ListNeurons
ListNeuronsResponse
ListNeuronVotesRequest
ListNodeProviderRewardsRequest
ListNodeProviderRewardsResponse
ListNodeProvidersResponse
ListProposalInfoRequest
ListProposalInfoResponse
MakeProposalRequest
MakeProposalResponse
ManageNeuronProposal
ManageNeuronRequest
ManageNeuronResponse
MaturityDisbursement
Merge
MergeMaturity
MergeMaturityResponse
MergeResponse
MonthlyNodeProviderRewards
Motion
NetworkEconomics
Neuron
NeuronBasketConstructionParameters
NeuronBasketConstructionParameters_1
NeuronDistribution
NeuronId
NeuronIndexData
NeuronInFlightCommand
NeuronInfo
NeuronsFundAuditInfo
NeuronsFundData
NeuronsFundEconomics
NeuronsFundMatchedFundingCurveCoefficients
NeuronsFundNeuron
NeuronsFundNeuronPortion
NeuronsFundParticipation
NeuronsFundSnapshot
NeuronStakeTransfer
NeuronSubaccount
NeuronSubsetMetrics
NeuronVote
NodeProvider
Ok
Ok_1
OpenSnsTokenSwap
Params
Percentage
Principals
Proposal
ProposalData
ProposalId
ProposalInfo
RegisterVote
RemoveHotKey
RestoreAgingNeuronGroup
RestoreAgingSummary
RewardEvent
RewardNodeProvider
RewardNodeProviders
RewardToAccount
RewardToNeuron
SelfDescribingProposalAction
_SERVICE
SetDefaultFollowees
SetDissolveTimestamp
SetFollowing
SetOpenTimeWindowRequest
SetSnsTokenSwapOpenTimeWindow
SettleCommunityFundParticipation
SettleNeuronsFundParticipationRequest
SettleNeuronsFundParticipationResponse
SetVisibility
Spawn
SpawnResponse
Split
StakeMaturity
StakeMaturityResponse
StopOrStartCanister
SwapBackgroundInformation
SwapDistribution
SwapParameters
SwapParticipationLimits
Tally
TimeWindow
Tokens
UpdateCanisterSettings
UpdateNodeProvider
VotingPowerEconomics
VotingRewardParameters
WaitForQuietState
XdrConversionRate
type-aliases
Action
By
Change
Command_1
Command_2
DissolveState
GetNeuronIndexResult
ListNeuronVotesResponse
ManageNeuronCommandRequest
ManageNeuronProposalCommand
NeuronIdOrSubaccount
Operation
ProposalActionRequest
RefreshVotingPower
RefreshVotingPowerResponse
Result
Result_1
Result_10
Result_2
Result_3
Result_4
Result_5
Result_6
Result_7
Result_8
Result_9
RewardMode
SelfDescribingValue
SetFollowingResponse
TopicToFollow
Vote
variables
idlFactory
init
NnsGovernanceTestDid
NnsGovernanceTestDid
interfaces
Account
AccountIdentifier
AddHotKey
AddOrRemoveNodeProvider
Amount
ApproveGenesisKyc
Ballot
BallotInfo
Canister
CanisterSettings
CanisterStatusResultV2
CanisterSummary
ChangeAutoStakeMaturity
ClaimOrRefresh
ClaimOrRefreshNeuronFromAccount
ClaimOrRefreshNeuronFromAccountResponse
ClaimOrRefreshResponse
Committed
Committed_1
Configure
Controllers
Countries
CreateServiceNervousSystem
DateRangeFilter
DateUtc
Decimal
DeregisterKnownNeuron
DerivedProposalInformation
DeveloperDistribution
Disburse
DisburseMaturity
DisburseMaturityResponse
DisburseResponse
DisburseToNeuron
Duration
ExecuteNnsFunction
Follow
Followees
FolloweesForTopic
FulfillSubnetRentalRequest
GetNeuronIndexRequest
GetNeuronsFundAuditInfoRequest
GetNeuronsFundAuditInfoResponse
GetPendingProposalsRequest
GlobalTimeOfDay
Governance
GovernanceCachedMetrics
GovernanceError
GovernanceParameters
IdealMatchedParticipationFunction
Image
IncreaseDissolveDelay
InitialTokenDistribution
InstallCode
InstallCodeRequest
KnownNeuron
KnownNeuronData
LedgerParameters
ListKnownNeuronsResponse
ListNeurons
ListNeuronsResponse
ListNeuronVotesRequest
ListNodeProviderRewardsRequest
ListNodeProviderRewardsResponse
ListNodeProvidersResponse
ListProposalInfoRequest
ListProposalInfoResponse
MakeProposalRequest
MakeProposalResponse
ManageNeuronProposal
ManageNeuronRequest
ManageNeuronResponse
MaturityDisbursement
Merge
MergeMaturity
MergeMaturityResponse
MergeResponse
MonthlyNodeProviderRewards
Motion
NetworkEconomics
Neuron
NeuronBasketConstructionParameters
NeuronBasketConstructionParameters_1
NeuronDistribution
NeuronId
NeuronIndexData
NeuronInFlightCommand
NeuronInfo
NeuronsFundAuditInfo
NeuronsFundData
NeuronsFundEconomics
NeuronsFundMatchedFundingCurveCoefficients
NeuronsFundNeuron
NeuronsFundNeuronPortion
NeuronsFundParticipation
NeuronsFundSnapshot
NeuronStakeTransfer
NeuronSubaccount
NeuronSubsetMetrics
NeuronVote
NodeProvider
Ok
Ok_1
OpenSnsTokenSwap
Params
Percentage
Principals
Proposal
ProposalData
ProposalId
ProposalInfo
RegisterVote
RemoveHotKey
RestoreAgingNeuronGroup
RestoreAgingSummary
RewardEvent
RewardNodeProvider
RewardNodeProviders
RewardToAccount
RewardToNeuron
SelfDescribingProposalAction
_SERVICE
SetDefaultFollowees
SetDissolveTimestamp
SetFollowing
SetOpenTimeWindowRequest
SetSnsTokenSwapOpenTimeWindow
SettleCommunityFundParticipation
SettleNeuronsFundParticipationRequest
SettleNeuronsFundParticipationResponse
SetVisibility
Spawn
SpawnResponse
Split
StakeMaturity
StakeMaturityResponse
StopOrStartCanister
SwapBackgroundInformation
SwapDistribution
SwapParameters
SwapParticipationLimits
Tally
TimeWindow
Tokens
UpdateCanisterSettings
UpdateNodeProvider
VotingPowerEconomics
VotingRewardParameters
WaitForQuietState
XdrConversionRate
type-aliases
Action
By
Change
Command_1
Command_2
DissolveState
GetNeuronIndexResult
ListNeuronVotesResponse
ManageNeuronCommandRequest
ManageNeuronProposalCommand
NeuronIdOrSubaccount
Operation
ProposalActionRequest
RefreshVotingPower
RefreshVotingPowerResponse
Result
Result_1
Result_10
Result_2
Result_3
Result_4
Result_5
Result_6
Result_7
Result_8
Result_9
RewardMode
SelfDescribingValue
SetFollowingResponse
TopicToFollow
Vote
variables
idlFactory
init
SnsWasmDid
SnsWasmDid
interfaces
AddWasmRequest
AddWasmResponse
Canister
Countries
DappCanisters
DappCanistersTransferResult
DeployedSns
DeployNewSnsRequest
DeployNewSnsResponse
DeveloperDistribution
FractionalDeveloperVotingPower
GetAllowedPrincipalsResponse
GetDeployedSnsByProposalIdRequest
GetDeployedSnsByProposalIdResponse
GetNextSnsVersionRequest
GetNextSnsVersionResponse
GetProposalIdThatAddedWasmRequest
GetProposalIdThatAddedWasmResponse
GetSnsSubnetIdsResponse
GetWasmMetadataRequest
GetWasmMetadataResponse
GetWasmRequest
GetWasmResponse
IdealMatchedParticipationFunction
InsertUpgradePathEntriesRequest
InsertUpgradePathEntriesResponse
LinearScalingCoefficient
ListDeployedSnsesResponse
ListUpgradeStep
ListUpgradeStepsRequest
ListUpgradeStepsResponse
MetadataSection
NeuronBasketConstructionParameters
NeuronDistribution
NeuronsFundParticipationConstraints
Ok
PrettySnsVersion
_SERVICE
SnsCanisterIds
SnsInitPayload
SnsUpgrade
SnsVersion
SnsWasm
SnsWasmCanisterInitPayload
SnsWasmError
SwapDistribution
TreasuryDistribution
UpdateAllowedPrincipalsRequest
UpdateAllowedPrincipalsResponse
UpdateSnsSubnetListRequest
UpdateSnsSubnetListResponse
type-aliases
GetDeployedSnsByProposalIdResult
InitialTokenDistribution
Result
Result_1
UpdateAllowedPrincipalsResult
variables
idlFactory
init
type-aliases
Action
AuthzChangeOp
By
CanisterIdString
Change
Command
DissolveState
E8s
ManageNeuronCommandRequest
Memo
NeuronId
NeuronIdOrSubaccount
Operation
Option
PrincipalString
ProposalActionRequest
ProposalId
RewardMode
SnsWasmCanisterOptions
SNS
Overview
classes
SnsGovernanceCanister
SnsGovernanceError
SnsGovernanceTestCanister
SnsRootCanister
SnsSwapCanister
SnsSwapGetOpenTicketError
SnsSwapNewTicketError
SnsWrapper
UnsupportedMethodError
enumerations
GetOpenTicketErrorType
NewSaleTicketResponseErrorType
SnsNeuronPermissionType
SnsProposalDecisionStatus
SnsProposalRewardStatus
SnsSwapLifecycle
SnsVote
functions
fromCandidAction
neuronSubaccount
interfaces
InitSnsCanistersOptions
InitSnsWrapper
SnsCanisterOptions
SnsClaimNeuronParams
SnsClaimOrRefreshArgs
SnsDisburseNeuronParams
SnsGetNeuronParams
SnsGetProposalParams
SnsIncreaseDissolveDelayParams
SnsIncreaseStakeNeuronParams
SnsListNeuronsParams
SnsListProposalsParams
SnsNeuronAutoStakeMaturityParams
SnsNeuronDisburseMaturityParams
SnsNeuronPermissionsParams
SnsNeuronStakeMaturityParams
SnsRegisterVoteParams
SnsSetDissolveTimestampParams
SnsSetFollowingParams
SnsSetTopicFollowees
SnsSplitNeuronParams
SnsStakeNeuronParams
namespaces
SnsGovernanceDid
SnsGovernanceDid
interfaces
Account
AddNeuronPermissions
AdvanceSnsTargetVersion
AdvanceSnsTargetVersionActionAuxiliary
Amount
Ballot
CachedUpgradeSteps
CanisterStatusResultV2
ChangeAutoStakeMaturity
ChunkedCanisterWasm
ClaimedSwapNeurons
ClaimOrRefresh
ClaimOrRefreshResponse
ClaimSwapNeuronsRequest
ClaimSwapNeuronsResponse
Configure
Decimal
DefaultFollowees
DefiniteCanisterSettingsArgs
DeregisterDappCanisters
Disburse
DisburseMaturity
DisburseMaturityInProgress
DisburseMaturityResponse
DisburseResponse
ExecuteExtensionOperation
ExecuteGenericNervousSystemFunction
ExtensionInit
ExtensionOperationArg
ExtensionOperationSpec
ExtensionUpgradeArg
FinalizeDisburseMaturity
Follow
Followee
Followees
FolloweesForTopic
GenericNervousSystemFunction
GetMaturityModulationResponse
GetMetadataResponse
GetMetricsRequest
GetMetricsResponse
GetModeResponse
GetNeuron
GetNeuronResponse
GetProposal
GetProposalResponse
GetRunningSnsVersionResponse
GetSnsInitializationParametersResponse
GetTimersResponse
GetUpgradeJournalRequest
GetUpgradeJournalResponse
Governance
GovernanceCachedMetrics
GovernanceError
IncreaseDissolveDelay
ListNervousSystemFunctionsResponse
ListNeurons
ListNeuronsResponse
ListProposals
ListProposalsResponse
ListTopicsResponse
ManageDappCanisterSettings
ManageLedgerParameters
ManageNeuron
ManageNeuronResponse
ManageSnsMetadata
MaturityModulation
MemoAndController
MemoryMetrics
MergeMaturity
MergeMaturityResponse
Metrics
MintSnsTokens
MintSnsTokensActionAuxiliary
Motion
NervousSystemFunction
NervousSystemParameters
Neuron
NeuronId
NeuronIds
NeuronInFlightCommand
NeuronPermission
NeuronPermissionList
NeuronRecipe
NeuronRecipes
NeuronsFund
PendingVersion
Percentage
Principals
Proposal
ProposalData
ProposalId
QueryStats
RegisterDappCanisters
RegisteredExtensionOperationSpec
RegisterExtension
RegisterVote
RemoveNeuronPermissions
RewardEvent
_SERVICE
SetDissolveTimestamp
SetFollowing
SetMode
SetTopicsForCustomProposals
SnsVersion
Split
SplitResponse
StakeMaturity
StakeMaturityResponse
Subaccount
SwapNeuron
Tally
TargetVersionReset
TargetVersionSet
Timers
Tokens
TopicInfo
TopicSelector
TransferSnsTreasuryFunds
TreasuryMetrics
UpgradeExtension
UpgradeInProgress
UpgradeJournal
UpgradeJournalEntry
UpgradeOutcome
UpgradeSnsControlledCanister
UpgradeStarted
UpgradeStepsRefreshed
UpgradeStepsReset
Valuation
ValuationFactors
Version
Versions
VotingPowerMetrics
VotingRewardsParameters
WaitForQuietState
type-aliases
Action
ActionAuxiliary
By
CanisterStatusType
ClaimSwapNeuronsResult
Command
Command_1
Command_2
DissolveState
ExtensionOperationType
ExtensionType
FunctionType
GetMetricsResult
ListTopicsRequest
Operation
Participant
PreciseValue
Result
Result_1
Topic
Wasm
variables
idlFactory
init
SnsGovernanceTestDid
SnsGovernanceTestDid
interfaces
Account
AddMaturityRequest
AddMaturityResponse
AddNeuronPermissions
AdvanceSnsTargetVersion
AdvanceSnsTargetVersionActionAuxiliary
AdvanceTargetVersionRequest
Amount
Ballot
CachedUpgradeSteps
CanisterStatusResultV2
ChangeAutoStakeMaturity
ChunkedCanisterWasm
ClaimedSwapNeurons
ClaimOrRefresh
ClaimOrRefreshResponse
ClaimSwapNeuronsRequest
ClaimSwapNeuronsResponse
Configure
Decimal
DefaultFollowees
DefiniteCanisterSettingsArgs
DeregisterDappCanisters
Disburse
DisburseMaturity
DisburseMaturityInProgress
DisburseMaturityResponse
DisburseResponse
ExecuteExtensionOperation
ExecuteGenericNervousSystemFunction
ExtensionInit
ExtensionOperationArg
ExtensionOperationSpec
ExtensionUpgradeArg
FinalizeDisburseMaturity
Follow
Followee
Followees
FolloweesForTopic
GenericNervousSystemFunction
GetMaturityModulationResponse
GetMetadataResponse
GetMetricsRequest
GetMetricsResponse
GetModeResponse
GetNeuron
GetNeuronResponse
GetProposal
GetProposalResponse
GetRunningSnsVersionResponse
GetSnsInitializationParametersResponse
GetTimersResponse
GetUpgradeJournalRequest
GetUpgradeJournalResponse
Governance
GovernanceCachedMetrics
GovernanceError
IncreaseDissolveDelay
ListNervousSystemFunctionsResponse
ListNeurons
ListNeuronsResponse
ListProposals
ListProposalsResponse
ListTopicsResponse
ManageDappCanisterSettings
ManageLedgerParameters
ManageNeuron
ManageNeuronResponse
ManageSnsMetadata
MaturityModulation
MemoAndController
MemoryMetrics
MergeMaturity
MergeMaturityResponse
Metrics
MintSnsTokens
MintSnsTokensActionAuxiliary
MintTokensRequest
Motion
NervousSystemFunction
NervousSystemParameters
Neuron
NeuronId
NeuronIds
NeuronInFlightCommand
NeuronPermission
NeuronPermissionList
NeuronRecipe
NeuronRecipes
NeuronsFund
PendingVersion
Percentage
Principals
Proposal
ProposalData
ProposalId
QueryStats
RegisterDappCanisters
RegisteredExtensionOperationSpec
RegisterExtension
RegisterVote
RemoveNeuronPermissions
RewardEvent
_SERVICE
SetDissolveTimestamp
SetFollowing
SetMode
SetTopicsForCustomProposals
SnsVersion
Split
SplitResponse
StakeMaturity
StakeMaturityResponse
Subaccount
SwapNeuron
Tally
TargetVersionReset
TargetVersionSet
Timers
Tokens
TopicInfo
TopicSelector
TransferSnsTreasuryFunds
TreasuryMetrics
UpgradeExtension
UpgradeInProgress
UpgradeJournal
UpgradeJournalEntry
UpgradeOutcome
UpgradeSnsControlledCanister
UpgradeStarted
UpgradeStepsRefreshed
UpgradeStepsReset
Valuation
ValuationFactors
Version
Versions
VotingPowerMetrics
VotingRewardsParameters
WaitForQuietState
type-aliases
Action
ActionAuxiliary
AdvanceTargetVersionResponse
By
CanisterStatusType
ClaimSwapNeuronsResult
Command
Command_1
Command_2
DissolveState
ExtensionOperationType
ExtensionType
FunctionType
GetMetricsResult
ListTopicsRequest
Operation
Participant
PreciseValue
Result
Result_1
Topic
Wasm
variables
idlFactory
init
SnsRootDid
SnsRootDid
interfaces
CanisterCallError
CanisterIdRecord
CanisterStatusResult
CanisterStatusResultV2
CanisterSummary
ChangeCanisterRequest
ChunkedCanisterWasm
CleanUpFailedRegisterExtensionRequest
CleanUpFailedRegisterExtensionResponse
DefiniteCanisterSettings
DefiniteCanisterSettingsArgs
Extensions
FailedUpdate
GetSnsCanistersSummaryRequest
GetSnsCanistersSummaryResponse
GetTimersResponse
ListSnsCanistersResponse
ManageDappCanisterSettingsRequest
ManageDappCanisterSettingsResponse
MemoryMetrics
QueryStats
RegisterDappCanisterRequest
RegisterDappCanistersRequest
RegisterExtensionRequest
RegisterExtensionResponse
_SERVICE
SetDappControllersRequest
SetDappControllersResponse
SnsRootCanister
Timers
type-aliases
CanisterInstallMode
CanisterStatusType
CleanUpFailedRegisterExtensionResult
LogVisibility
RegisterExtensionResult
variables
idlFactory
init
SnsSwapDid
SnsSwapDid
interfaces
BuyerState
CanisterCallError
CanisterStatusResultV2
CfInvestment
CfNeuron
CfParticipant
Countries
DefiniteCanisterSettingsArgs
DerivedState
DirectInvestment
Err
Err_1
Err_2
Error
ErrorRefundIcpRequest
ErrorRefundIcpResponse
FailedUpdate
FinalizeSwapResponse
GetAutoFinalizationStatusResponse
GetBuyerStateRequest
GetBuyerStateResponse
GetBuyersTotalResponse
GetDerivedStateResponse
GetInitResponse
GetLifecycleResponse
GetOpenTicketResponse
GetSaleParametersResponse
GetStateResponse
GetTimersResponse
GovernanceError
Icrc1Account
IdealMatchedParticipationFunction
Init
InvalidUserAmount
LinearScalingCoefficient
ListCommunityFundParticipantsRequest
ListCommunityFundParticipantsResponse
ListDirectParticipantsRequest
ListDirectParticipantsResponse
ListSnsNeuronRecipesRequest
ListSnsNeuronRecipesResponse
MemoryMetrics
NeuronAttributes
NeuronBasketConstructionParameters
NeuronId
NeuronsFundParticipationConstraints
NewSaleTicketRequest
NewSaleTicketResponse
Ok
Ok_1
Ok_2
Params
Participant
Principals
QueryStats
RefreshBuyerTokensRequest
RefreshBuyerTokensResponse
Response
_SERVICE
SetDappControllersCallResult
SetDappControllersResponse
SetModeCallResult
SettleCommunityFundParticipationResult
SettleNeuronsFundParticipationResult
SnsNeuronRecipe
Swap
SweepResult
Ticket
Timers
TransferableAmount
type-aliases
CanisterStatusType
Investor
Possibility
Possibility_1
Possibility_2
Possibility_3
Result
Result_1
Result_2
variables
idlFactory
init
type-aliases
SnsListTopicsParams
variables
initSnsWrapper
Upgrading
v3
v2
v1
Changelog
GitHub
Select theme
Dark
Light
Auto
Cycles
Copy Page
Cycles
=
bigint
Defined in:
packages/canisters/src/declarations/cmc/cmc.d.ts:74