@proto-kit/library • Docs

Documentation / @proto-kit/library / WithdrawalMessageProcessor

Class: WithdrawalMessageProcessor

Used by various module sub-types that may need to be configured

Extends

• OutgoingMessageProcessor<Withdrawal>

Constructors

new WithdrawalMessageProcessor()

new WithdrawalMessageProcessor(): WithdrawalMessageProcessor

Returns

WithdrawalMessageProcessor

Inherited from

OutgoingMessageProcessor.constructor

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

OutgoingMessageProcessor.currentConfig

Defined in

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

messageType

messageType: string = "withdrawal"

Overrides

OutgoingMessageProcessor.messageType

Defined in

packages/library/src/protocol/WithdrawalMessageProcessor.ts:14

parent?

optional parent: ProtocolEnvironment

Inherited from

OutgoingMessageProcessor.parent

Defined in

packages/protocol/dist/protocol/ProtocolModule.d.ts:4

type

type: typeof Withdrawal = Withdrawal

Overrides

OutgoingMessageProcessor.type

Defined in

packages/library/src/protocol/WithdrawalMessageProcessor.ts:12

Accessors

areProofsEnabled

Get Signature

get areProofsEnabled(): undefined | AreProofsEnabled

Returns

undefined | AreProofsEnabled

Inherited from

OutgoingMessageProcessor.areProofsEnabled

Defined in

packages/protocol/dist/protocol/ProtocolModule.d.ts:5

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

OutgoingMessageProcessor.config

Defined in

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

Methods

assertTrue()

assertTrue(b, msg?): void

Parameters

• b: Bool

• msg?: string

Returns

void

Inherited from

OutgoingMessageProcessor.assertTrue

Defined in

packages/protocol/dist/settlement/modularity/OutgoingMessageProcessor.d.ts:14

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

OutgoingMessageProcessor.create

Defined in

packages/protocol/dist/protocol/ProtocolModule.d.ts:6

dummy()

dummy(): Withdrawal

Returns

Withdrawal

Overrides

OutgoingMessageProcessor.dummy

Defined in

packages/library/src/protocol/WithdrawalMessageProcessor.ts:16

getMessageType()

getMessageType(): Field

Returns

Field

Inherited from

OutgoingMessageProcessor.getMessageType

Defined in

packages/protocol/dist/settlement/modularity/OutgoingMessageProcessor.d.ts:20

process()

process(message, __namedParameters): AccountUpdate[]

Parameters

• message: Withdrawal

• __namedParameters: MessageProcessorArgs

Returns

AccountUpdate[]

Overrides

OutgoingMessageProcessor.process

Defined in

packages/library/src/protocol/WithdrawalMessageProcessor.ts:20

processMessage()

processMessage(message, args): object

Parameters

• message: Withdrawal

• args: MessageProcessorArgs

Returns

object

accountUpdates

accountUpdates: AccountUpdate[]

status

status: Bool

statusMessage?

optional statusMessage: string

Inherited from

OutgoingMessageProcessor.processMessage

Defined in

packages/protocol/dist/settlement/modularity/OutgoingMessageProcessor.d.ts:15

start()

start(): Promise<void>

Returns

Promise<void>

Inherited from

OutgoingMessageProcessor.start

Defined in

packages/protocol/dist/protocol/ProtocolModule.d.ts:7