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
| Name | 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
Defined in
affirmInstruction
▸ affirmInstruction(args, opts?): Promise<GenericPolymeshTransaction<Instruction, Instruction>>
Affirm an Instruction (authorize)
Parameters
| Name | 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
Defined in
createVenue
▸ createVenue(args, opts?): Promise<GenericPolymeshTransaction<Venue, Venue>>
Create a Venue under the ownership of the signing Identity
Parameters
| Name | 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
Defined in
getHistoricalInstructions
▸ getHistoricalInstructions(filter): Promise<HistoricInstruction[]>
Retrieve all Instructions that have been associated with this Identity's DID
Parameters
| Name | Type |
|---|---|
filter | InstructionPartiesFilters |
Returns
Promise<HistoricInstruction[]>
Note
uses the middleware V2
Note
supports pagination
Defined in
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
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>