Class: Settlements

Defined in: src/api/client/Settlements.ts:33

Handles all Settlement related functionality

Methods

addInstruction()

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

Defined in: src/api/client/Settlements.ts:119

Create an Instruction to exchange Assets

Parameters

Parameter	Type
args	AddInstructionWithVenueIdParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<Instruction[], Instruction>>

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

---

affirmInstruction()

affirmInstruction(args: InstructionIdParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<Instruction, Instruction>>

Defined in: src/api/client/Settlements.ts:128

Affirm an Instruction (authorize)

Parameters

Parameter	Type
args	InstructionIdParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<Instruction, Instruction>>

Note

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

---

createVenue()

createVenue(args: CreateVenueParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<Venue, Venue>>

Defined in: src/api/client/Settlements.ts:114

Create a Venue under the ownership of the signing Identity

Parameters

Parameter	Type
args	CreateVenueParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<Venue, Venue>>

Note

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

---

getHistoricalInstructions()

getHistoricalInstructions(filter: HistoricalInstructionFilters): Promise<ResultSet<HistoricInstruction>>

Defined in: src/api/client/Settlements.ts:137

Retrieve all Instructions that have been associated with this Identity's DID

Parameters

Parameter	Type
filter	HistoricalInstructionFilters

Returns

Promise<ResultSet<HistoricInstruction>>

Note

uses the middleware V2

Note

supports pagination

---

getInstruction()

getInstruction(args: object): Promise<Instruction>

Defined in: src/api/client/Settlements.ts:95

Retrieve an Instruction by its ID

Parameters

Parameter	Type	Description
args	{ id: BigNumber; }	‐
args.id	BigNumber	identifier number of the Instruction

Returns

Promise<Instruction>

---

getVenue()

getVenue(args: object): Promise<Venue>

Defined in: src/api/client/Settlements.ts:74

Retrieve a Venue by its ID

Parameters

Parameter	Type	Description
args	{ id: BigNumber; }	‐
args.id	BigNumber	identifier number of the Venue

Returns

Promise<Venue>