Class: Venue

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

Represents a Venue through which settlements are handled

Extends

• Entity<UniqueIdentifiers, string>

Properties

id

id: BigNumber

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

identifier number of the Venue

---

uuid

uuid: string

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

Inherited from

Entity.uuid

Methods

addInstruction()

addInstruction(args: AddInstructionParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<Instruction[], Instruction>>

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

Creates a settlement Instruction in this Venue

Parameters

Parameter	Type
args	AddInstructionParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<Instruction[], Instruction>>

Note

required role:

• Venue Owner

Note

this method is of type ProcedureMethod, which means you can call addInstruction.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

addInstructions()

addInstructions(args: AddInstructionsParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<Instruction[], Instruction[]>>

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

Creates a batch of settlement Instructions in this Venue

Parameters

Parameter	Type
args	AddInstructionsParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<Instruction[], Instruction[]>>

Note

required role:

• Venue Owner

Note

this method is of type ProcedureMethod, which means you can call addInstructions.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

addSigners()

addSigners(args: UpdateVenueSignersParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

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

Adds a list of signers allowed to sign receipts for this Venue

Parameters

Parameter	Type
args	UpdateVenueSignersParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

required role:

• Venue Owner

Throws

if one or more specified signers are already added to the Venue

Note

this method is of type ProcedureMethod, which means you can call addSigners.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

details()

details(): Promise<VenueDetails>

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

Retrieve information specific to this Venue

Returns

Promise<VenueDetails>

---

exists()

exists(): Promise<boolean>

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

Determine whether this Venue exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

---

getAllowedSigners()

getAllowedSigners(): Promise<Account[]>

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

Get all signers allowed by this Venue. Only these signers are allowed to affirm off-chain instructions

Returns

Promise<Account[]>

---

getHistoricalInstructions()

getHistoricalInstructions(opts: object): Promise<ResultSet<HistoricInstruction>>

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

Retrieve all Instructions that have been associated with this Venue instance

Parameters

Parameter	Type	Description
opts	{ size?: BigNumber; start?: BigNumber; }	‐
opts.size?	BigNumber	page size
opts.start?	BigNumber	page offset

Returns

Promise<ResultSet<HistoricInstruction>>

Note

uses the middleware V2

Note

supports pagination

---

getInstructions()

getInstructions(): Promise<Pick<GroupedInstructions, "failed" | "pending">>

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

Retrieve all pending and failed Instructions in this Venue

Returns

Promise<Pick<GroupedInstructions, "failed" | "pending">>

---

isEqual()

isEqual(entity: Entity<unknown, unknown>): boolean

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

Determine whether this Entity is the same as another one

Parameters

Parameter	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

---

modify()

modify(args: ModifyVenueParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

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

Modify description and type

Parameters

Parameter	Type
args	ModifyVenueParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

required role:

• Venue Owner

Note

this method is of type ProcedureMethod, which means you can call modify.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

removeSigners()

removeSigners(args: UpdateVenueSignersParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

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

Adds a list of signers allowed to sign receipts for this Venue

Parameters

Parameter	Type
args	UpdateVenueSignersParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

required role:

• Venue Owner

Throws

if one or more specified signers are already added to the Venue

Note

this method is of type ProcedureMethod, which means you can call removeSigners.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

toHuman()

toHuman(): string

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

Return the Venue's ID

Returns

string

Overrides

Entity.toHuman

---

generateUuid()

static generateUuid<Identifiers>(identifiers: Identifiers): string

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

Generate the Entity's UUID from its identifying properties

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
identifiers	Identifiers

Returns

string

Inherited from

Entity.generateUuid

---

unserialize()

static unserialize<Identifiers>(serialized: string): Identifiers

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

Unserialize a UUID into its Unique Identifiers

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize