Skip to main content
Version: 24.7.x

Class: Settlements

api/client/Settlements.Settlements

Handles all Settlement related functionality

Methods

addInstruction

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

Create an Instruction to exchange Assets

Parameters

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

Defined in

api/client/Settlements.ts:121


affirmInstruction

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

Affirm an Instruction (authorize)

Parameters

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

Defined in

api/client/Settlements.ts:131


createVenue

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

Create a Venue under the ownership of the signing Identity

Parameters

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

Defined in

api/client/Settlements.ts:111


getInstruction

getInstruction(args): Promise<Instruction>

Retrieve an Instruction by its ID

Parameters

NameTypeDescription
argsObject-
args.idBigNumberidentifier number of the Instruction

Returns

Promise<Instruction>

Defined in

api/client/Settlements.ts:89


getVenue

getVenue(args): Promise<Venue>

Retrieve a Venue by its ID

Parameters

NameTypeDescription
argsObject-
args.idBigNumberidentifier number of the Venue

Returns

Promise<Venue>

Defined in

api/client/Settlements.ts:68