Checkpoints

Handles all Security Token Checkpoints related functionality

Hierarchy

• Namespace‹SecurityToken›

  ↳ Checkpoints

Index

Properties

• context

• parent

• schedules

Methods

• create

• get

• getOne

Properties

Protected context

• context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

Protected parent

• parent: SecurityToken

Inherited from void

Defined in src/api/entities/Namespace.ts:9

schedules

• schedules: Schedules

Defined in src/api/entities/SecurityToken/Checkpoints/index.ts:36

Methods

create

▸ create(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹Checkpoint››

Defined in src/api/entities/SecurityToken/Checkpoints/index.ts:60

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?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Checkpoint››

get

▸ get(paginationOpts?: PaginationOptions): Promise‹ResultSet‹CheckpointWithData››

Defined in src/api/entities/SecurityToken/Checkpoints/index.ts:94

Retrieve all Checkpoints created on this Security Token, together with their corresponding creation Date and Total Supply

note supports pagination

Parameters:

Name	Type
paginationOpts?	PaginationOptions

Returns: Promise‹ResultSet‹CheckpointWithData››

getOne

▸ getOne(args: object): Promise‹Checkpoint›

Defined in src/api/entities/SecurityToken/Checkpoints/index.ts:69

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›