Skip to content
ICP JS SDK Docs
Canisters
Search Canisters
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Canisters
Version
Latest (v2.0.1)
v2
Getting Started
Overview
Installation
Quick Start
Modules
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
Account
BtcAddress
BtcAddressInfo
EstimateWithdrawalFee
get_utxos_response
MinterAccount
MinterInfo
outpoint
PendingUtxo
ReimbursedDeposit
ReimbursementRequest
RetrieveBtcOk
RetrieveBtcStatusV2WithId
utxo
Utxo
type-aliases
BitcoinNetwork
block_hash
block_height
EstimateWithdrawalFeeParams
GetBalanceParams
GetBTCAddressParams
GetKnownUtxosParams
GetUtxosParams
MinterParams
RetrieveBtcParams
RetrieveBtcResponse
RetrieveBtcStatus
RetrieveBtcStatusV2
RetrieveBtcStatusV2ByAccountParams
RetrieveBtcWithApprovalResponse
satoshi
UpdateBalanceOk
UpdateBalanceParams
UpdateBalanceResponse
UtxoStatus
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
CyclesManagement
Eip1559TransactionPrice
Erc20Contract
EthTransaction
ManagedCanisters
MinterInfo
OrchestratorInfo
RetrieveErc20Request
RetrieveEthRequest
type-aliases
Eip1559TransactionPriceParams
ManagedCanisterStatus
RetrieveEthStatus
Subaccount
TxFinalizedStatus
CMC
Overview
classes
CMCCanister
CMCError
InvalidaTransactionError
ProcessingError
RefundedError
TransactionTooOldError
functions
throwNotifyError
interfaces
NotifyCreateCanisterArg
NotifyTopUpArg
SubnetTypesToSubnetsResponse
type-aliases
Cycles
IC Management
Overview
classes
ICManagementCanister
UnsupportedLogVisibility
enumerations
LogVisibility
functions
decodeSnapshotId
encodeSnapshotId
fromReadCanisterSnapshotMetadataResponse
mapSnapshotId
toCanisterSettings
toCanisterSnapshotMetadataKind
toReplaceSnapshotArgs
toSnapshotArgs
toUploadCanisterSnapshotDataKind
toUploadCanisterSnapshotMetadata
interfaces
canister_log_record
canister_status_result
CanisterSettings
CanisterStatusParams
chunk_hash
ClearChunkStoreParams
CreateCanisterParams
definite_canister_settings
environment_variable
fetch_canister_logs_result
InstallChunkedCodeParams
InstallCodeParams
OptionSnapshotParams
ProvisionalCreateCanisterWithCyclesParams
read_canister_snapshot_data_response
read_canister_snapshot_metadata_response
ReadCanisterSnapshotDataParams
ReadCanisterSnapshotMetadataParams
ReadCanisterSnapshotMetadataResponse
snapshot
StoredChunksParams
UninstallCodeParams
UpdateSettingsParams
upload_canister_snapshot_metadata_response
UploadCanisterSnapshotDataParams
UploadCanisterSnapshotMetadataParams
UploadChunkParams
type-aliases
canister_install_mode
CanisterSnapshotMetadataKind
CanisterStatusResponse
FetchCanisterLogsResponse
ICManagementCanisterOptions
list_canister_snapshots_result
log_visibility
snapshot_id
SnapshotIdText
SnapshotParams
take_canister_snapshot_result
UploadCanisterSnapshotDataKind
UploadCanisterSnapshotMetadataParam
Ledger
ICP
Overview
classes
AccountIdentifier
AllowanceChangedError
ApproveError
BadFeeError
ConsentMessageError
ConsentMessageUnavailableError
CreatedInFutureError
DuplicateError
ExpiredError
GenericError
IcrcError
IndexCanister
InsufficientFundsError
InsufficientPaymentError
InvalidAccountIDError
InvalidSenderError
LedgerCanister
SubAccount
TemporarilyUnavailableError
TooOldError
TransferError
TxCreatedInFutureError
TxDuplicateError
TxTooOldError
UnsupportedCanisterCallError
functions
checkAccountId
isIcpAccountIdentifier
mapIcrc1TransferError
mapIcrc21ConsentMessageError
mapIcrc2ApproveError
mapTransferError
toIcrc1TransferRawRequest
toIcrc21ConsentMessageRawRequest
toIcrc2ApproveRawRequest
toTransferRawRequest
interfaces
Account
GetAccountIdentifierTransactionsArgs
GetAccountIdentifierTransactionsError
GetAccountIdentifierTransactionsResponse
GetAccountTransactionsArgs
GetBlocksRequest
GetBlocksResponse
HttpRequest
HttpResponse
Icrc1Account
Icrc1TransferRequest
InitArg
_SERVICE
Status
TimeStamp
Tokens
Transaction
TransactionWithId
TransferRequest
type-aliases
AccountIdentifierHex
BlockHeight
E8s
GetAccountIdentifierTransactionsResult
Icrc1ApproveError
Icrc1BlockIndex
Icrc1SubAccount
Icrc1Timestamp
Icrc1Tokens
Icrc1TransferError
Icrc1TransferResult
Icrc2ApproveRequest
Icrc2ApproveResult
Icrc2TransferFromError
Icrc2TransferFromResult
LedgerCanisterOptions
Operation
Value
variables
idlFactory
init
ICRC
Overview
classes
ConsentMessageError
ConsentMessageUnavailableError
GenericError
IcrcIndexCanister
IcrcIndexNgCanister
IcrcLedgerCanister
IcrcTransferError
IndexError
IndexPrincipalNotSetError
InsufficientPaymentError
UnsupportedCanisterCallError
enumerations
IcrcMetadataResponseEntries
functions
decodeIcrcAccount
decodePayment
encodeIcrcAccount
fromCandidAccount
mapIcrc106GetIndexPrincipalError
mapIcrc21ConsentMessageError
mapTokenMetadata
toApproveArgs
toCandidAccount
toIcrc21ConsentMessageArgs
toTransferArg
toTransferFromArgs
interfaces
GetAccountTransactionsParams
Icrc21ConsentMessageMetadata
Icrc21ConsentMessageSpec
IcrcAccount
IcrcAllowance
IcrcCandidAccount
IcrcGetBlocksArgs
IcrcGetBlocksResult
IcrcGetTransactions
IcrcIndexNgGetTransactions
IcrcIndexNgTransaction
IcrcIndexNgTransactionWithId
IcrcNgStatus
IcrcStandardRecord
IcrcTokenMetadata
IcrcTransaction
IcrcTransactionWithId
IcrcTransferArg
TransferParams
type-aliases
AllowanceParams
ApproveParams
BalanceParams
GetBlocksParams
GetIndexNgAccountTransactionsParams
Icrc21ConsentMessageDeviceSpec
Icrc21ConsentMessageParams
Icrc3Value
IcrcApproveError
IcrcBlockIndex
IcrcNgTxId
IcrcSubaccount
IcrcTimestamp
IcrcTokenMetadataResponse
IcrcTokens
IcrcTransferFromError
IcrcTransferVariantError
IcrcTxId
IcrcValue
ListSubaccountsParams
TransferFromParams
NNS
Overview
classes
CouldNotClaimNeuronError
GenesisTokenCanister
GovernanceCanister
GovernanceError
GovernanceTestCanister
InsufficientAmountError
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
DeployedSns
DeregisterKnownNeuron
DeveloperDistribution
Disburse
DisburseMaturity
DisburseRequest
DisburseResponse
DisburseToNeuron
DisburseToNeuronRequest
Duration
ExecuteNnsFunction
Follow
Followees
FolloweesForTopic
FollowRequest
FulfillSubnetRentalRequest
GlobalTimeOfDay
GovernanceCachedMetrics
GovernanceCanisterOptions
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
NodeProvider
OpenSnsTokenSwap
Percentage
Proposal
ProposalInfo
RefreshVotingPower
RegisterVote
RegisterVoteRequest
RemoveHotKey
RemoveHotKeyRequest
RewardEvent
RewardNodeProvider
RewardNodeProviders
RewardToAccount
RewardToNeuron
SetDefaultFollowees
SetDissolveTimestamp
SetFollowing
SetSnsTokenSwapOpenTimeWindow
SetVisibility
Spawn
SpawnRequest
Split
SplitRequest
StakeMaturity
StartDissolvingRequest
StopDissolvingRequest
StopOrStartCanister
SwapDistribution
SwapParameters
Tally
Tokens
UpdateCanisterSettings
VotingPowerEconomics
VotingRewardParameters
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
CfParticipant
InitSnsCanistersOptions
InitSnsWrapper
SnsAccount
SnsBallot
SnsCanisterOptions
SnsCanisterStatus
SnsClaimNeuronParams
SnsClaimOrRefreshArgs
SnsDefaultFollowees
SnsDisburseMaturityInProgress
SnsDisburseNeuronParams
SnsFinalizeSwapResponse
SnsFollowee
SnsFolloweesForTopic
SnsGetAutoFinalizationStatusResponse
SnsGetBuyerStateRequest
SnsGetBuyerStateResponse
SnsGetDerivedStateResponse
SnsGetInitResponse
SnsGetLifecycleResponse
SnsGetMetadataResponse
SnsGetMetricsResponse
SnsGetNeuronParams
SnsGetProposalParams
SnsGetSaleParametersResponse
SnsIncreaseDissolveDelayParams
SnsIncreaseStakeNeuronParams
SnsInvalidUserAmount
SnsListNervousSystemFunctionsResponse
SnsListNeuronsParams
SnsListProposalsParams
SnsListProposalsResponse
SnsListTopicsResponse
SnsManageNeuron
SnsManageNeuronResponse
SnsNervousSystemFunction
SnsNervousSystemParameters
SnsNeuron
SnsNeuronAutoStakeMaturityParams
SnsNeuronDisburseMaturityParams
SnsNeuronId
SnsNeuronPermission
SnsNeuronPermissionList
SnsNeuronPermissionsParams
SnsNeuronRecipe
SnsNeuronsFundParticipationConstraints
SnsNeuronStakeMaturityParams
SnsParams
SnsPercentage
SnsProposalData
SnsProposalId
SnsRefreshBuyerTokensResponse
SnsRegisterVoteParams
SnsRewardEvent
SnsSetDissolveTimestampParams
SnsSetFollowingParams
SnsSetTopicFollowees
SnsSplitNeuronParams
SnsStakeNeuronParams
SnsSwap
SnsSwapBuyerState
SnsSwapDerivedState
SnsSwapInit
SnsSwapTicket
SnsTally
SnsTopicInfo
SnsTransferableAmount
SnsVotingRewardsParameters
TransferSnsTreasuryFunds
type-aliases
SnsAction
SnsFunctionType
SnsListTopicsParams
SnsTopic
variables
initSnsWrapper
Upgrading
v2
v1
Changelog
GitHub
Select theme
Dark
Light
Auto
block_hash
Copy Page
block_hash
=
Uint8Array
Defined in:
packages/ckbtc/src/candid/bitcoin.d.ts:14
