Checkpoints
Last updated
Was this helpful?
Last updated
Was this helpful?
Handles all Security Token Checkpoints related functionality
Namespace‹›
↳ Checkpoints
Protected
contextInherited from void
Protected
parentInherited from void
Create a snapshot of Security Token holders and their respective balances at this moment
Parameters:
args
void
opts?
Retrieve all Checkpoints created on this Security Token, together with their corresponding creation Date and Total Supply
note
supports pagination
Parameters:
paginationOpts?
Retrieve a single Checkpoint for this Security Token by its ID
throws
if there is no Checkpoint with the passed ID
Parameters:
▪ args: object
id
BigNumber
• context:
Defined in
• parent:
Defined in
• schedules:
Defined in
▸ create(args
: void, opts?
: ): Promise‹‹››
Defined in
note
this method is of type , which means you can call create.checkAuthorization
on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ get(paginationOpts?
: ): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ getOne(args
: object): Promise‹›
Defined in
Returns: Promise‹›