Checkpoints

Handles all Security Token Checkpoints related functionality

Hierarchy

• Namespace‹SecurityToken›

  ↳ Checkpoints

Index

Properties

• context

• create

• parent

• schedules

Methods

• get

Properties

Protected context

• context: Context

Inherited from void

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

create

• create: ProcedureMethod‹void, Checkpoint›

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

Create a snapshot of Security Token holders and their respective balances at this moment

note required role:

• Security Token Owner

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:22

Methods

get

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

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

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››