Overview
Namespaces
Section titled “Namespaces”Classes
Section titled “Classes”CyclesLedgerCanister
Section titled “CyclesLedgerCanister”Defined in: packages/canisters/src/ledger/cycles/cycles-ledger.canister.ts:16
Extends
Section titled “Extends”Canister<_SERVICE>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”
protectednew CyclesLedgerCanister(id,service,certifiedService):CyclesLedgerCanister
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<CyclesLedgerService>.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”withdraw()
Section titled “withdraw()”withdraw(
params):Promise<WithdrawResult>
Defined in: packages/canisters/src/ledger/cycles/cycles-ledger.canister.ts:47
Withdraws cycles from the ledger to a target canister.
Parameters
Section titled “Parameters”params
Section titled “params”The withdrawal parameters.
Returns
Section titled “Returns”Promise<WithdrawResult>
The result of the withdrawal operation.
https://github.com/dfinity/cycles-ledger#withdrawing-cycles
create()
Section titled “create()”
staticcreate(__namedParameters):CyclesLedgerCanister
Defined in: packages/canisters/src/ledger/cycles/cycles-ledger.canister.ts:17
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”CanisterOptions<_SERVICE>
Returns
Section titled “Returns”Type Aliases
Section titled “Type Aliases”WithdrawParams
Section titled “WithdrawParams”WithdrawParams =
object&Omit<WithdrawArgs,"from_subaccount"|"created_at_time">
Defined in: packages/canisters/src/ledger/cycles/types/cycles-ledger.params.ts:3
Type Declaration
Section titled “Type Declaration”createdAtTime?
Section titled “createdAtTime?”
optionalcreatedAtTime:bigint
fromSubaccount?
Section titled “fromSubaccount?”
optionalfromSubaccount:Uint8Array
WithdrawResult
Section titled “WithdrawResult”WithdrawResult = {
Ok:BlockIndex; } | {Err:WithdrawError; }
Defined in: packages/canisters/src/ledger/cycles/types/cycles-ledger.responses.ts:3