api.entities.Instruction.types

Module: api/entities/Instruction/types

Table of contents

Enumerations

• AffirmationStatus
• InstructionStatus
• InstructionType

Interfaces

• FungibleLeg
• GroupedInstructions
• GroupedInvolvedInstructions
• InstructionAffirmation
• NftLeg
• OffChainAffirmation
• OffChainLeg

Type Aliases

• InstructionDetails
• InstructionEndCondition
• InstructionStatusResult
• InstructionsByStatus
• Leg
• MediatorAffirmation

Type Aliases

InstructionDetails

Ƭ InstructionDetails: { createdAt: Date | null ; memo: string | null ; status: InstructionStatus ; tradeDate: Date | null ; valueDate: Date | null ; venue: Venue | null } & InstructionEndCondition

Defined in

api/entities/Instruction/types.ts:40

---

InstructionEndCondition

Ƭ InstructionEndCondition: { type: SettleOnAffirmation } | { endBlock: BigNumber ; type: SettleOnBlock } | { endAfterBlock: BigNumber ; type: SettleManual }

Defined in

api/entities/Instruction/types.ts:27

---

InstructionStatusResult

Ƭ InstructionStatusResult: { status: Pending } | { eventIdentifier: EventIdentifier ; status: Exclude<InstructionStatus, Pending> }

Defined in

api/entities/Instruction/types.ts:106

---

InstructionsByStatus

Ƭ InstructionsByStatus: GroupedInstructions & { partiallyAffirmed: Instruction[] }

Defined in

api/entities/Instruction/types.ts:141

---

Leg

Ƭ Leg: FungibleLeg | NftLeg | OffChainLeg

Defined in

api/entities/Instruction/types.ts:87

---

MediatorAffirmation

Ƭ MediatorAffirmation: Object

Type declaration

Name	Type	Description
expiry?	Date	Affirmations may have an expiration time
identity	Identity	-
status	AffirmationStatus	-

Defined in

api/entities/Instruction/types.ts:115