api_client_Settlements.Settlements

@polymeshassociation/polymesh-sdk / Modules / api/client/Settlements / Settlements

Class: Settlements

api/client/Settlements.Settlements

Handles all Settlement related functionality

Table of contents

Methods

• addInstruction

• affirmInstruction

• createVenue

• getInstruction

• getVenue

Methods

addInstruction

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

Create an Instruction to exchange Assets

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

Parameters

Name	Type
args	AddInstructionWithVenueIdParams
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<Instruction[], Instruction, unknown[][]>>

Defined in

api/client/Settlements.ts:118

---

affirmInstruction

▸ affirmInstruction(args, opts?): Promise<TransactionQueue<Instruction, Instruction, unknown[][]>>

Affirm an Instruction (authorize)

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

Parameters

Name	Type
args	AffirmInstructionParams
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<Instruction, Instruction, unknown[][]>>

Defined in

api/client/Settlements.ts:128

---

createVenue

▸ createVenue(args, opts?): Promise<TransactionQueue<Venue, Venue, unknown[][]>>

Create a Venue under the ownership of the signing Identity

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

Parameters

Name	Type
args	CreateVenueParams
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<Venue, Venue, unknown[][]>>

Defined in

api/client/Settlements.ts:108

---

getInstruction

▸ getInstruction(args): Promise<Instruction>

Retrieve an Instruction by its ID

Parameters

Name	Type	Description
args	Object	-
args.id	BigNumber	identifier number of the Instruction

Returns

Promise<Instruction>

Defined in

api/client/Settlements.ts:86

---

getVenue

▸ getVenue(args): Promise<Venue>

Retrieve a Venue by its ID

Parameters

Name	Type	Description
args	Object	-
args.id	BigNumber	identifier number of the Venue

Returns

Promise<Venue>

Defined in

api/client/Settlements.ts:65