Checkpoints
Handles all Security Token Checkpoints related functionality

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from void

Protected parent

parent: SecurityToken
Inherited from void

schedules

schedules: Schedules

Methods

create

create(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueCheckpoint››
Create a snapshot of Security Token holders and their respective balances at this moment
note this method is of type ProcedureMethod, which means you can call create.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueueCheckpoint››

get

get(paginationOpts?: PaginationOptions): Promise‹ResultSetCheckpointWithData››
Retrieve all Checkpoints created on this Security Token, together with their corresponding creation Date and Total Supply
note supports pagination
Parameters:
Name
Type
paginationOpts?
Returns: Promise‹ResultSetCheckpointWithData››

getOne

getOne(args: object): Promise‹Checkpoint
Retrieve a single Checkpoint for this Security Token by its ID
throws if there is no Checkpoint with the passed ID
Parameters:
args: object
Name
Type
id
BigNumber
Returns: Promise‹Checkpoint
Last modified 26d ago