CyclesLedgerDid
Interfaces
Section titled “Interfaces”_SERVICE
Section titled “_SERVICE”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:376
Properties
Section titled “Properties”create_canister
Section titled “create_canister”create_canister:
ActorMethod<[CreateCanisterArgs], {Ok:CreateCanisterSuccess; } | {Err:CreateCanisterError; }>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:377
create_canister_from
Section titled “create_canister_from”create_canister_from:
ActorMethod<[CreateCanisterFromArgs], {Ok:CreateCanisterSuccess; } | {Err:CreateCanisterFromError; }>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:381
deposit
Section titled “deposit”deposit:
ActorMethod<[DepositArgs],DepositResult>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:385
http_request
Section titled “http_request”http_request:
ActorMethod<[HttpRequest],HttpResponse>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:386
icrc1_balance_of
Section titled “icrc1_balance_of”icrc1_balance_of:
ActorMethod<[Account],bigint>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:392
icrc1_decimals
Section titled “icrc1_decimals”icrc1_decimals:
ActorMethod<[],number>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:393
icrc1_fee
Section titled “icrc1_fee”icrc1_fee:
ActorMethod<[],bigint>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:394
icrc1_metadata
Section titled “icrc1_metadata”icrc1_metadata:
ActorMethod<[], [string,MetadataValue][]>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:395
icrc1_minting_account
Section titled “icrc1_minting_account”icrc1_minting_account:
ActorMethod<[], [] | [Account]>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:396
icrc1_name
Section titled “icrc1_name”icrc1_name:
ActorMethod<[],string>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:397
icrc1_supported_standards
Section titled “icrc1_supported_standards”icrc1_supported_standards:
ActorMethod<[],SupportedStandard[]>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:398
icrc1_symbol
Section titled “icrc1_symbol”icrc1_symbol:
ActorMethod<[],string>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:399
icrc1_total_supply
Section titled “icrc1_total_supply”icrc1_total_supply:
ActorMethod<[],bigint>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:400
icrc1_transfer
Section titled “icrc1_transfer”icrc1_transfer:
ActorMethod<[TransferArgs], {Ok:bigint; } | {Err:TransferError; }>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:401
icrc103_get_allowances
Section titled “icrc103_get_allowances”icrc103_get_allowances:
ActorMethod<[GetAllowancesArgs],ICRC103GetAllowancesResponse>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:387
icrc106_get_index_principal
Section titled “icrc106_get_index_principal”icrc106_get_index_principal:
ActorMethod<[],GetIndexPrincipalResult>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:391
icrc2_allowance
Section titled “icrc2_allowance”icrc2_allowance:
ActorMethod<[AllowanceArgs],Allowance>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:405
icrc2_approve
Section titled “icrc2_approve”icrc2_approve:
ActorMethod<[ApproveArgs], {Ok:bigint; } | {Err:ApproveError; }>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:406
icrc2_transfer_from
Section titled “icrc2_transfer_from”icrc2_transfer_from:
ActorMethod<[TransferFromArgs], {Ok:bigint; } | {Err:TransferFromError; }>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:410
icrc3_get_archives
Section titled “icrc3_get_archives”icrc3_get_archives:
ActorMethod<[GetArchivesArgs],GetArchivesResult>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:414
icrc3_get_blocks
Section titled “icrc3_get_blocks”icrc3_get_blocks:
ActorMethod<[GetBlocksArgs],GetBlocksResult>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:415
icrc3_get_tip_certificate
Section titled “icrc3_get_tip_certificate”icrc3_get_tip_certificate:
ActorMethod<[], [] | [DataCertificate]>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:416
icrc3_supported_block_types
Section titled “icrc3_supported_block_types”icrc3_supported_block_types:
ActorMethod<[],SupportedBlockType[]>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:417
withdraw
Section titled “withdraw”withdraw:
ActorMethod<[WithdrawArgs], {Ok:bigint; } | {Err:WithdrawError; }>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:418
withdraw_from
Section titled “withdraw_from”withdraw_from:
ActorMethod<[WithdrawFromArgs], {Ok:bigint; } | {Err:WithdrawFromError; }>
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:422
Account
Section titled “Account”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:13
Properties
Section titled “Properties”owner:
Principal
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:14
subaccount
Section titled “subaccount”subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:15
Allowance
Section titled “Allowance”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:17
Properties
Section titled “Properties”allowance
Section titled “allowance”allowance:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:18
expires_at
Section titled “expires_at”expires_at: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:19
AllowanceArgs
Section titled “AllowanceArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:21
Properties
Section titled “Properties”account
Section titled “account”account:
Account
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:22
spender
Section titled “spender”spender:
Account
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:23
ApproveArgs
Section titled “ApproveArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:31
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:36
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:35
expected_allowance
Section titled “expected_allowance”expected_allowance: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:37
expires_at
Section titled “expires_at”expires_at: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:38
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:32
from_subaccount
Section titled “from_subaccount”from_subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:34
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:33
spender
Section titled “spender”spender:
Account
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:39
CanisterSettings
Section titled “CanisterSettings”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:54
Properties
Section titled “Properties”compute_allocation
Section titled “compute_allocation”compute_allocation: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:59
controllers
Section titled “controllers”controllers: [] | [
Principal[]]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:56
freezing_threshold
Section titled “freezing_threshold”freezing_threshold: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:55
memory_allocation
Section titled “memory_allocation”memory_allocation: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:58
reserved_cycles_limit
Section titled “reserved_cycles_limit”reserved_cycles_limit: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:57
CmcCreateCanisterArgs
Section titled “CmcCreateCanisterArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:62
Properties
Section titled “Properties”settings
Section titled “settings”settings: [] | [
CanisterSettings]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:71
Optional canister settings that, if set, are applied to the newly created canister. If not specified, the caller is the controller of the canister and the other settings are set to default values.
subnet_selection
Section titled “subnet_selection”subnet_selection: [] | [
SubnetSelection]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:66
Optional instructions to select on which subnet the new canister will be created on.
CreateCanisterArgs
Section titled “CreateCanisterArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:73
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:76
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:75
creation_args
Section titled “creation_args”creation_args: [] | [
CmcCreateCanisterArgs]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:77
from_subaccount
Section titled “from_subaccount”from_subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:74
CreateCanisterFromArgs
Section titled “CreateCanisterFromArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:103
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:107
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:106
creation_args
Section titled “creation_args”creation_args: [] | [
CmcCreateCanisterArgs]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:108
from:
Account
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:105
spender_subaccount
Section titled “spender_subaccount”spender_subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:104
CreateCanisterSuccess
Section titled “CreateCanisterSuccess”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:135
Properties
Section titled “Properties”block_id
Section titled “block_id”block_id:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:136
canister_id
Section titled “canister_id”canister_id:
Principal
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:137
DataCertificate
Section titled “DataCertificate”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:139
Properties
Section titled “Properties”certificate
Section titled “certificate”certificate:
Uint8Array
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:143
See https://internetcomputer.org/docs/current/references/ic-interface-spec#certification
hash_tree
Section titled “hash_tree”hash_tree:
Uint8Array
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:147
CBOR encoded hash_tree
DepositArgs
Section titled “DepositArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:149
Properties
Section titled “Properties”memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:151
to:
Account
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:150
DepositResult
Section titled “DepositResult”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:153
Properties
Section titled “Properties”balance
Section titled “balance”balance:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:154
block_index
Section titled “block_index”block_index:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:155
GetAllowancesArgs
Section titled “GetAllowancesArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:157
Properties
Section titled “Properties”from_account
Section titled “from_account”from_account: [] | [
Account]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:160
prev_spender
Section titled “prev_spender”prev_spender: [] | [
Account]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:159
take: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:158
GetArchivesArgs
Section titled “GetArchivesArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:167
Properties
Section titled “Properties”from: [] | [
Principal]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:174
The last archive seen by the client. The ledger will return archives coming after this one if set, otherwise it will return the first archives.
GetBlocksResult
Section titled “GetBlocksResult”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:191
Properties
Section titled “Properties”archived_blocks
Section titled “archived_blocks”archived_blocks:
object[]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:202
The archived_blocks vector is always going to be empty for this ledger because there is no archive node.
args:
GetBlocksArgs
callback
Section titled “callback”callback: [
Principal,string]
blocks
Section titled “blocks”blocks:
object[]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:197
block:
Value
id:
bigint
log_length
Section titled “log_length”log_length:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:196
Total number of blocks in the block log.
HttpRequest
Section titled “HttpRequest”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:218
Properties
Section titled “Properties”body:
Uint8Array
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:221
headers
Section titled “headers”headers: [
string,string][]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:222
method
Section titled “method”method:
string
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:220
url:
string
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:219
HttpResponse
Section titled “HttpResponse”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:224
Properties
Section titled “Properties”body:
Uint8Array
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:225
headers
Section titled “headers”headers: [
string,string][]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:226
status_code
Section titled “status_code”status_code:
number
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:227
InitArgs
Section titled “InitArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:232
Properties
Section titled “Properties”index_id
Section titled “index_id”index_id: [] | [
Principal]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:234
initial_balances
Section titled “initial_balances”initial_balances: [] | [[
Account,bigint][]]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:233
max_blocks_per_request
Section titled “max_blocks_per_request”max_blocks_per_request:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:235
SubnetFilter
Section titled “SubnetFilter”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:251
Properties
Section titled “Properties”subnet_type
Section titled “subnet_type”subnet_type: [] | [
string]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:252
SupportedBlockType
Section titled “SupportedBlockType”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:267
Properties
Section titled “Properties”block_type
Section titled “block_type”block_type:
string
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:269
url:
string
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:268
SupportedStandard
Section titled “SupportedStandard”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:271
Properties
Section titled “Properties”name:
string
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:273
url:
string
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:272
TransferArgs
Section titled “TransferArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:275
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:281
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:280
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:277
from_subaccount
Section titled “from_subaccount”from_subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:279
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:278
to:
Account
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:276
TransferFromArgs
Section titled “TransferFromArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:294
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:301
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:300
fee: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:296
from:
Account
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:298
memo: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:299
spender_subaccount
Section titled “spender_subaccount”spender_subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:297
to:
Account
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:295
UpgradeArgs
Section titled “UpgradeArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:315
Properties
Section titled “Properties”change_index_id
Section titled “change_index_id”change_index_id: [] | [
ChangeIndexId]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:316
max_blocks_per_request
Section titled “max_blocks_per_request”max_blocks_per_request: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:317
WithdrawArgs
Section titled “WithdrawArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:327
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:331
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:330
from_subaccount
Section titled “from_subaccount”from_subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:329
to:
Principal
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:328
WithdrawFromArgs
Section titled “WithdrawFromArgs”Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:349
Properties
Section titled “Properties”amount
Section titled “amount”amount:
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:354
created_at_time
Section titled “created_at_time”created_at_time: [] | [
bigint]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:353
from:
Account
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:352
spender_subaccount
Section titled “spender_subaccount”spender_subaccount: [] | [
Uint8Array<ArrayBufferLike>]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:351
to:
Principal
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:350
Type Aliases
Section titled “Type Aliases”Allowances
Section titled “Allowances”Allowances =
object[]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:25
Type Declaration
Section titled “Type Declaration”allowance
Section titled “allowance”allowance:
bigint
expires_at
Section titled “expires_at”expires_at: [] | [
bigint]
from_account
Section titled “from_account”from_account:
Account
to_spender
Section titled “to_spender”to_spender:
Account
ApproveError
Section titled “ApproveError”ApproveError = {
GenericError: {error_code:bigint;message:string; }; } | {TemporarilyUnavailable:null; } | {Duplicate: {duplicate_of:bigint; }; } | {BadFee: {expected_fee:bigint; }; } | {AllowanceChanged: {current_allowance:bigint; }; } | {CreatedInFuture: {ledger_time:bigint; }; } | {TooOld:null; } | {Expired: {ledger_time:bigint; }; } | {InsufficientFunds: {balance:bigint; }; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:41
BlockIndex
Section titled “BlockIndex”BlockIndex =
bigint
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:53
ChangeIndexId
Section titled “ChangeIndexId”ChangeIndexId = {
SetTo:Principal; } | {Unset:null; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:61
CreateCanisterError
Section titled “CreateCanisterError”CreateCanisterError = {
GenericError: {error_code:bigint;message:string; }; } | {TemporarilyUnavailable:null; } | {Duplicate: {canister_id: [] | [Principal];duplicate_of:bigint; }; } | {CreatedInFuture: {ledger_time:bigint; }; } | {FailedToCreate: {error:string;fee_block: [] | [BlockIndex];refund_block: [] | [BlockIndex]; }; } | {TooOld:null; } | {InsufficientFunds: {balance:bigint; }; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:79
CreateCanisterFromError
Section titled “CreateCanisterFromError”CreateCanisterFromError = {
FailedToCreateFrom: {approval_refund_block: [] | [BlockIndex];create_from_block: [] | [BlockIndex];refund_block: [] | [BlockIndex];rejection_code:RejectionCode;rejection_reason:string; }; } | {GenericError: {error_code:bigint;message:string; }; } | {TemporarilyUnavailable:null; } | {InsufficientAllowance: {allowance:bigint; }; } | {Duplicate: {canister_id: [] | [Principal];duplicate_of:bigint; }; } | {CreatedInFuture: {ledger_time:bigint; }; } | {TooOld:null; } | {InsufficientFunds: {balance:bigint; }; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:110
GetAllowancesError
Section titled “GetAllowancesError”GetAllowancesError = {
GenericError: {error_code:bigint;message:string; }; } | {AccessDenied: {reason:string; }; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:162
GetArchivesResult
Section titled “GetArchivesResult”GetArchivesResult =
object[]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:176
Type Declaration
Section titled “Type Declaration”canister_id
Section titled “canister_id”canister_id:
Principal
The id of the archive
end:
bigint
The last block in the archive
start:
bigint
The first block in the archive
GetBlocksArgs
Section titled “GetBlocksArgs”GetBlocksArgs =
object[]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:190
Type Declaration
Section titled “Type Declaration”length
Section titled “length”length:
bigint
start:
bigint
GetIndexPrincipalError
Section titled “GetIndexPrincipalError”GetIndexPrincipalError = {
GenericError: {description:string;error_code:bigint; }; } | {IndexPrincipalNotSet:null; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:207
Type Declaration
Section titled “Type Declaration”{ GenericError: { description: string; error_code: bigint; }; }
GenericError
Section titled “GenericError”GenericError:
object
Any error not covered by the above variants.
GenericError.description
Section titled “GenericError.description”description:
string
GenericError.error_code
Section titled “GenericError.error_code”error_code:
bigint
{ IndexPrincipalNotSet: null; }
IndexPrincipalNotSet
Section titled “IndexPrincipalNotSet”IndexPrincipalNotSet:
null
GetIndexPrincipalResult
Section titled “GetIndexPrincipalResult”GetIndexPrincipalResult = {
Ok:Principal; } | {Err:GetIndexPrincipalError; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:215
ICRC103GetAllowancesResponse
Section titled “ICRC103GetAllowancesResponse”ICRC103GetAllowancesResponse = {
Ok:Allowances; } | {Err:GetAllowancesError; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:229
LedgerArgs
Section titled “LedgerArgs”LedgerArgs = {
Upgrade: [] | [UpgradeArgs]; } | {Init:InitArgs; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:237
MetadataValue
Section titled “MetadataValue”MetadataValue = {
Int:bigint; } | {Nat:bigint; } | {Blob:Uint8Array; } | {Text:string; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:238
RejectionCode
Section titled “RejectionCode”RejectionCode = {
NoError:null; } | {CanisterError:null; } | {SysTransient:null; } | {DestinationInvalid:null; } | {Unknown:null; } | {SysFatal:null; } | {CanisterReject:null; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:243
SubnetSelection
Section titled “SubnetSelection”SubnetSelection = {
Filter:SubnetFilter; } | {Subnet: {subnet:Principal; }; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:254
Type Declaration
Section titled “Type Declaration”{ Filter: SubnetFilter; }
Filter
Section titled “Filter”Filter:
SubnetFilter
Choose a random subnet that satisfies the specified properties.
{ Subnet: { subnet: Principal; }; }
Subnet
Section titled “Subnet”Subnet:
object
/ Choose a specific subnet
Subnet.subnet
Section titled “Subnet.subnet”subnet:
Principal
TransferError
Section titled “TransferError”TransferError = {
GenericError: {error_code:bigint;message:string; }; } | {TemporarilyUnavailable:null; } | {BadBurn: {min_burn_amount:bigint; }; } | {Duplicate: {duplicate_of:bigint; }; } | {BadFee: {expected_fee:bigint; }; } | {CreatedInFuture: {ledger_time:bigint; }; } | {TooOld:null; } | {InsufficientFunds: {balance:bigint; }; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:283
TransferFromError
Section titled “TransferFromError”TransferFromError = {
GenericError: {error_code:bigint;message:string; }; } | {TemporarilyUnavailable:null; } | {InsufficientAllowance: {allowance:bigint; }; } | {BadBurn: {min_burn_amount:bigint; }; } | {Duplicate: {duplicate_of:bigint; }; } | {BadFee: {expected_fee:bigint; }; } | {CreatedInFuture: {ledger_time:bigint; }; } | {TooOld:null; } | {InsufficientFunds: {balance:bigint; }; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:303
Value = {
Int:bigint; } | {Map: [string,Value][]; } | {Nat:bigint; } | {Nat64:bigint; } | {Blob:Uint8Array; } | {Text:string; } | {Array:Value[]; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:319
WithdrawError
Section titled “WithdrawError”WithdrawError = {
FailedToWithdraw: {fee_block: [] | [bigint];rejection_code:RejectionCode;rejection_reason:string; }; } | {GenericError: {error_code:bigint;message:string; }; } | {TemporarilyUnavailable:null; } | {Duplicate: {duplicate_of:bigint; }; } | {BadFee: {expected_fee:bigint; }; } | {InvalidReceiver: {receiver:Principal; }; } | {CreatedInFuture: {ledger_time:bigint; }; } | {TooOld:null; } | {InsufficientFunds: {balance:bigint; }; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:333
WithdrawFromError
Section titled “WithdrawFromError”WithdrawFromError = {
GenericError: {error_code:bigint;message:string; }; } | {TemporarilyUnavailable:null; } | {InsufficientAllowance: {allowance:bigint; }; } | {Duplicate: {duplicate_of:BlockIndex; }; } | {InvalidReceiver: {receiver:Principal; }; } | {CreatedInFuture: {ledger_time:bigint; }; } | {TooOld:null; } | {FailedToWithdrawFrom: {approval_refund_block: [] | [bigint];refund_block: [] | [bigint];rejection_code:RejectionCode;rejection_reason:string;withdraw_from_block: [] | [bigint]; }; } | {InsufficientFunds: {balance:bigint; }; }
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:356
Variables
Section titled “Variables”idlFactory
Section titled “idlFactory”
constidlFactory:IDL.InterfaceFactory
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:427
init()
Section titled “init()”
constinit: (args) =>IDL.Type[]
Defined in: packages/canisters/src/declarations/cycles-ledger/cycles-ledger.d.ts:428
Parameters
Section titled “Parameters”typeof IDL
Returns
Section titled “Returns”IDL.Type[]