api/entities/Venue.Venue

Represents a Venue through which settlements are handled

• Entity<UniqueIdentifiers, string>

  ↳ Venue

• id
• uuid

• addInstruction
• addInstructions
• addSigners
• details
• exists
• getAllowedSigners
• getHistoricalInstructions
• getInstructions
• isEqual
• modify
• removeSigners
• toHuman
• generateUuid
• unserialize

• id: BigNumber

identifier number of the Venue

api/entities/Venue/index.ts:82

---

• uuid: string

Entity.uuid

api/entities/Entity.ts:46

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

Creates a settlement Instruction in this Venue

Name	Type
args	AddInstructionParams
opts?	ProcedureOpts

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

api/entities/Venue/index.ts:343

---

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

Creates a batch of settlement Instructions in this Venue

Name	Type
args	AddInstructionsParams
opts?	ProcedureOpts

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

api/entities/Venue/index.ts:356

---

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

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

Name	Type
args	UpdateVenueSignersParams
opts?	ProcedureOpts

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

api/entities/Venue/index.ts:384

---

▸ details(): Promise<VenueDetails>

Retrieve information specific to this Venue

Promise<VenueDetails>

api/entities/Venue/index.ts:155

---

▸ exists(): Promise<boolean>

Determine whether this Venue exists on chain

Promise<boolean>

Entity.exists

api/entities/Venue/index.ts:136

---

▸ getAllowedSigners(): Promise<Account[]>

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

Promise<Account[]>

api/entities/Venue/index.ts:312

---

▸ getHistoricalInstructions(opts?): Promise<ResultSet<HistoricInstruction>>

Retrieve all Instructions that have been associated with this Venue instance

Name	Type	Description
opts	Object	-
opts.size?	BigNumber	page size
opts.start?	BigNumber	page offset

Promise<ResultSet<HistoricInstruction>>

Note

uses the middleware V2

Note

supports pagination

api/entities/Venue/index.ts:244

---

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

Retrieve all pending and failed Instructions in this Venue

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

api/entities/Venue/index.ts:184

---

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Name	Type
entity	Entity<unknown, unknown>

boolean

Entity.isEqual

api/entities/Entity.ts:61

---

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

Modify description and type

Name	Type
args	ModifyVenueParams
opts?	ProcedureOpts

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

api/entities/Venue/index.ts:369

---

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

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

Name	Type
args	UpdateVenueSignersParams
opts?	ProcedureOpts

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

api/entities/Venue/index.ts:399

---

▸ toHuman(): string

Return the Venue's ID

string

Entity.toHuman

api/entities/Venue/index.ts:406

---

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Name
Identifiers

Name	Type
identifiers	Identifiers

string

Entity.generateUuid

api/entities/Entity.ts:14

---

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Name
Identifiers

Name	Type	Description
serialized	string	UUID to unserialize

Identifiers

Entity.unserialize

api/entities/Entity.ts:23