Venue

Represents a Venue through which settlements are handled

Hierarchy

  • Entity‹UniqueIdentifiers›

    Venue

Index

Properties

Methods

Properties

addInstruction

addInstruction: ProcedureMethod‹AddInstructionParams, Instruction[], Instruction

Defined in src/api/entities/Venue/index.ts:196

Creates a settlement Instruction in this Venue

param array of token movements (amount, from, to, token)

param date at which the trade was agreed upon (optional, for offchain trades)

param date at which the trade was executed (optional, for offchain trades)

param block at which the Instruction will be executed automatically (optional, the Instruction will be executed when all participants have authorized it if not supplied)

note required role:

  • Venue Owner

addInstructions

addInstructions: ProcedureMethod‹AddInstructionsParams, Instruction[]›

Defined in src/api/entities/Venue/index.ts:210

Creates a batch of settlement Instructions in this Venue

param array of Instructions

param array of token movements (amount, from, to, token)

param date at which the trade was agreed upon (optional, for offchain trades)

param date at which the trade was executed (optional, for offchain trades)

param block at which the Instruction will be executed automatically (optional, the Instruction will be executed when all participants have authorized it if not supplied)

note required role:

  • Venue Owner

Protected context

context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

id

id: BigNumber

Defined in src/api/entities/Venue/index.ts:57

Identifier number of the venue

modify

modify: ProcedureMethod‹ModifyVenueParams, void›

Defined in src/api/entities/Venue/index.ts:218

Modify description and type

note required role:

  • Venue Owner

uuid

uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

details

details(): Promise‹VenueDetails

Defined in src/api/entities/Venue/index.ts:110

Retrieve information specific to this venue

Returns: Promise‹VenueDetails

exists

exists(): Promise‹boolean›

Defined in src/api/entities/Venue/index.ts:91

Retrieve whether the Venue exists

Returns: Promise‹boolean›

getPendingInstructions

getPendingInstructions(): Promise‹Instruction[]›

Defined in src/api/entities/Venue/index.ts:144

Retrieve all pending Instructions in this Venue

Returns: Promise‹Instruction[]›

isEqual

isEqual(entity: Entity‹object›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Whether this Entity is the same as another one

Parameters:

Returns: boolean

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

Identifiers: object

Parameters:

Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

Identifiers: object

Parameters:

Returns: Identifiers

Last updated