Skip to main content
Version: v29.0.x

Type Alias: AddInstructionParams

AddInstructionParams = object & { endBlock?: BigNumber; } | { endAfterBlock?: BigNumber; } | { endAfterLock?: true; }

Defined in: src/api/procedures/types.ts:934

Type declaration

NameTypeDescriptionDefined in

legs

InstructionLeg[]

array of Asset movements

src/api/procedures/types.ts:938

mediators?

(string | Identity)[]

additional identities that must affirm the instruction

Note

mediators are mandatory if settlement is to be locked for execution (providing endAfterLock)

src/api/procedures/types.ts:956

memo?

string

identifier string to help differentiate instructions

src/api/procedures/types.ts:950

tradeDate?

Date

date at which the trade was agreed upon (optional, for off chain trades)

src/api/procedures/types.ts:942

valueDate?

Date

date at which the trade was executed (optional, for off chain trades)

src/api/procedures/types.ts:946