Checkpoints
Handles all Asset Checkpoints related functionality
Hierarchy
Namespace‹Asset›
↳ Checkpoints
Index
Properties
Methods
Properties
Protected context
Protected context• context: Context
Inherited from void
Defined in src/api/entities/Namespace.ts:11
Protected parent
Protected parent• parent: Asset
Inherited from void
Defined in src/api/entities/Namespace.ts:9
schedules
• schedules: Schedules
Defined in src/api/entities/Asset/Checkpoints/index.ts:29
Methods
create
▸ create(opts?: ProcedureOpts): Promise‹TransactionQueue‹Checkpoint››
Defined in src/api/entities/Asset/Checkpoints/index.ts:53
Create a snapshot of Asset Holders and their respective balances at this moment
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
Parameters:
opts?
Returns: Promise‹TransactionQueue‹Checkpoint››
get
▸ get(paginationOpts?: PaginationOptions): Promise‹ResultSet‹CheckpointWithData››
Defined in src/api/entities/Asset/Checkpoints/index.ts:87
Retrieve all Checkpoints created on this Asset, together with their corresponding creation Date and Total Supply
note supports pagination
Parameters:
paginationOpts?
Returns: Promise‹ResultSet‹CheckpointWithData››
getOne
▸ getOne(args: object): Promise‹Checkpoint›
Defined in src/api/entities/Asset/Checkpoints/index.ts:62
Retrieve a single Checkpoint for this Asset by its ID
throws if there is no Checkpoint with the passed ID
Parameters:
▪ args: object
id
BigNumber
Returns: Promise‹Checkpoint›
Last updated