Class: Checkpoints
api/entities/Asset/Fungible/Checkpoints.Checkpoints
Handles all Asset Checkpoints related functionality
Hierarchy
-
Namespace<FungibleAsset>↳
Checkpoints
Properties
schedules
• schedules: Schedules
Defined in
api/entities/Asset/Fungible/Checkpoints/index.ts:36
Methods
create
▸ create(opts?): Promise<GenericPolymeshTransaction<Checkpoint, Checkpoint>>
Create a snapshot of Asset Holders and their respective balances at this moment
Parameters
| Name | Type |
|---|---|
opts? | ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<Checkpoint, Checkpoint>>
Note
this method is of type NoArgsProcedureMethod, which means you can call create.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Defined in
api/entities/Asset/Fungible/Checkpoints/index.ts:58
get
▸ get(paginationOpts?): Promise<ResultSet<CheckpointWithData>>
Retrieve all Checkpoints created on this Asset, together with their corresponding creation Date and Total Supply
Parameters
| Name | Type |
|---|---|
paginationOpts? | PaginationOptions |
Returns
Promise<ResultSet<CheckpointWithData>>
Note
supports pagination
Defined in
api/entities/Asset/Fungible/Checkpoints/index.ts:92
getOne
▸ getOne(args): Promise<Checkpoint>
Retrieve a single Checkpoint for this Asset by its ID
Parameters
| Name | Type |
|---|---|
args | Object |
args.id | BigNumber |
Returns
Promise<Checkpoint>
Throws
if there is no Checkpoint with the passed ID