-
Notifications
You must be signed in to change notification settings - Fork 11
api.entities.Venue.Venue
api/entities/Venue.Venue
Represents a Venue through which settlements are handled
-
Entity<UniqueIdentifiers,string>↳
Venue
- 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:77
• uuid: string
▸ 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:314
▸ 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:327
▸ 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:355
▸ details(): Promise<VenueDetails>
Retrieve information specific to this Venue
Promise<VenueDetails>
api/entities/Venue/index.ts:150
▸ exists(): Promise<boolean>
Determine whether this Venue exists on chain
Promise<boolean>
api/entities/Venue/index.ts:131
▸ 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:283
▸ 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:239
▸ 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:179
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
| Name | Type |
|---|---|
entity |
Entity<unknown, unknown> |
boolean
▸ 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:340
▸ 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:370
▸ toHuman(): string
Return the Venue's ID
string
api/entities/Venue/index.ts:377
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
| Name |
|---|
Identifiers |
| Name | Type |
|---|---|
identifiers |
Identifiers |
string
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
| Name |
|---|
Identifiers |
| Name | Type | Description |
|---|---|---|
serialized |
string |
UUID to unserialize |
Identifiers
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations
- Types