Venue

Represents a Venue through which settlements are handled

Hierarchy

  • Entity‹UniqueIdentifiers›

    Venue

Index

Properties

Methods

Properties

addInstruction

addInstruction: ProcedureMethod‹AddInstructionParams, Instruction

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

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

Protected context

context: Context

Inherited from Entity.context

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

id

id: BigNumber

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

Identifier number of the venue

uuid

uuid: string

Inherited from Entity.uuid

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

Methods

details

details(): Promise‹VenueDetails

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

Retrieve information specific to this venue

Returns: Promise‹VenueDetails

exists

exists(): Promise‹boolean›

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

Retrieve whether the Venue exists

Returns: Promise‹boolean›

getPendingInstructions

getPendingInstructions(): Promise‹Instruction[]›

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

Retrieve all pending Instructions in this Venue

Returns: Promise‹Instruction[]›

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from Entity.generateUuid

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

Generate the Entity's UUID from its identifying properties

Type parameters:

Identifiers: object

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers

Inherited from Entity.unserialize

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

Unserialize a UUID into its Unique Identifiers

Type parameters:

Identifiers: object

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

Last updated