@proto-kit/library • Docs

Documentation / @proto-kit/library / Withdrawals

Class: Withdrawals

Base class for runtime modules providing the necessary utilities.

Extends

• RuntimeModule

Constructors

new Withdrawals()

new Withdrawals(balances): Withdrawals

Parameters

• balances: Balances<NoConfig>

Returns

Withdrawals

Overrides

RuntimeModule.constructor

Defined in

packages/library/src/runtime/Withdrawals.ts:37

Properties

currentConfig

protected currentConfig: undefined | NoConfig

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

RuntimeModule.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17

events?

optional events: RuntimeEvents<any>

Inherited from

RuntimeModule.events

Defined in

packages/module/dist/runtime/RuntimeModule.d.ts:31

isRuntimeModule

isRuntimeModule: boolean

This property exists only to typecheck that the RuntimeModule was extended correctly in e.g. a decorator. We need at least one non-optional property in this class to make the typechecking work.

Inherited from

RuntimeModule.isRuntimeModule

Defined in

packages/module/dist/runtime/RuntimeModule.d.ts:28

messages

messages: OutgoingMessages<object>

Type declaration

withdrawal

withdrawal: typeof Withdrawal = Withdrawal

Overrides

RuntimeModule.messages

Defined in

packages/library/src/runtime/Withdrawals.ts:33

name?

optional name: string

Inherited from

RuntimeModule.name

Defined in

packages/module/dist/runtime/RuntimeModule.d.ts:29

parent?

optional parent: RuntimeEnvironment

Inherited from

RuntimeModule.parent

Defined in

packages/module/dist/runtime/RuntimeModule.d.ts:30

runtimeMethodNames

readonly runtimeMethodNames: string[]

Holds all method names that are callable throw transactions

Inherited from

RuntimeModule.runtimeMethodNames

Defined in

packages/module/dist/runtime/RuntimeModule.d.ts:22

presets

static presets: Presets<unknown>

Inherited from

RuntimeModule.presets

Defined in

packages/module/dist/runtime/RuntimeModule.d.ts:18

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

RuntimeModule.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18

network

Get Signature

get network(): NetworkState

Returns

NetworkState

Inherited from

RuntimeModule.network

Defined in

packages/module/dist/runtime/RuntimeModule.d.ts:36

transaction

Get Signature

get transaction(): RuntimeTransaction

Returns

RuntimeTransaction

Inherited from

RuntimeModule.transaction

Defined in

packages/module/dist/runtime/RuntimeModule.d.ts:35

Methods

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

RuntimeModule.create

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:20

getInputs()

getInputs(): RuntimeMethodExecutionData

Returns

RuntimeMethodExecutionData

Inherited from

RuntimeModule.getInputs

Defined in

packages/module/dist/runtime/RuntimeModule.d.ts:34

withdraw()

withdraw(address, amount, tokenId): Promise<void>

Parameters

• address: PublicKey

• amount: UInt64

• tokenId: Field

Returns

Promise<void>

Defined in

packages/library/src/runtime/Withdrawals.ts:41