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
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<GenericPolymeshTransaction<Instruction[], Instruction>>
affirmInstruction
▸ affirmInstruction(args, opts?): Promise<GenericPolymeshTransaction<Instruction, Instruction>>
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 | InstructionIdParams |
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<Instruction, Instruction>>
createVenue
▸ createVenue(args, opts?): Promise<GenericPolymeshTransaction<Venue, Venue>>
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<GenericPolymeshTransaction<Venue, Venue>>
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>
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>