Skip to main content
Version: 26.0.0-beta.2

Class: Venue

api/entities/Venue.Venue

Represents a Venue through which settlements are handled

Hierarchy

Properties

id

id: BigNumber

identifier number of the Venue

Defined in

api/entities/Venue/index.ts:77


uuid

uuid: string

Inherited from

Entity.uuid

Defined in

api/entities/Entity.ts:46

Methods

addInstruction

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

Creates a settlement Instruction in this Venue

Parameters

NameType
argsAddInstructionParams
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

Defined in

api/entities/Venue/index.ts:313


addInstructions

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

Creates a batch of settlement Instructions in this Venue

Parameters

NameType
argsAddInstructionsParams
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

Defined in

api/entities/Venue/index.ts:326


addSigners

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

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

Parameters

NameType
argsUpdateVenueSignersParams
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

Defined in

api/entities/Venue/index.ts:354


details

details(): Promise<VenueDetails>

Retrieve information specific to this Venue

Returns

Promise<VenueDetails>

Defined in

api/entities/Venue/index.ts:150


exists

exists(): Promise<boolean>

Determine whether this Venue exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

Defined in

api/entities/Venue/index.ts:131


getAllowedSigners

getAllowedSigners(): Promise<Account[]>

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

Returns

Promise<Account[]>

Defined in

api/entities/Venue/index.ts:282


getHistoricalInstructions

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

Retrieve all Instructions that have been associated with this Venue instance

Parameters

NameTypeDescription
optsObject-
opts.size?BigNumberpage size
opts.start?BigNumberpage offset

Returns

Promise<ResultSet<HistoricInstruction>>

Note

uses the middleware V2

Note

supports pagination

Defined in

api/entities/Venue/index.ts:239


getInstructions

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

Retrieve all pending and failed Instructions in this Venue

Returns

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

Defined in

api/entities/Venue/index.ts:179


isEqual

isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

NameType
entityEntity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

Defined in

api/entities/Entity.ts:61


modify

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

Modify description and type

Parameters

NameType
argsModifyVenueParams
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

Defined in

api/entities/Venue/index.ts:339


removeSigners

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

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

Parameters

NameType
argsUpdateVenueSignersParams
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

Defined in

api/entities/Venue/index.ts:369


toHuman

toHuman(): string

Return the Venue's ID

Returns

string

Overrides

Entity.toHuman

Defined in

api/entities/Venue/index.ts:376


generateUuid

Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

NameType
identifiersIdentifiers

Returns

string

Inherited from

Entity.generateUuid

Defined in

api/entities/Entity.ts:14


unserialize

Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

NameTypeDescription
serializedstringUUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize

Defined in

api/entities/Entity.ts:23