Polymesh SDK API Reference
v11.0.2
v11.0.2
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • Protected parent
  • schedules
  • Methods
  • create
  • get
  • getOne

Was this helpful?

  1. Classes

Checkpoints

PreviousCheckpointScheduleNextClaims

Last updated 3 years ago

Was this helpful?

Handles all Security Token Checkpoints related functionality

Hierarchy

  • Namespace‹›

    ↳ Checkpoints

Index

Properties

Methods

Properties

Protected context

Inherited from void


Protected parent

Inherited from void


schedules

Methods

create

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

Parameters:

Name
Type

args

void

opts?


get

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

note supports pagination

Parameters:

Name
Type

paginationOpts?


getOne

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

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

Context
src/api/entities/Namespace.ts:11
SecurityToken
src/api/entities/Namespace.ts:9
Schedules
src/api/entities/SecurityToken/Checkpoints/index.ts:36
ProcedureOpts
TransactionQueue
Checkpoint
src/api/entities/SecurityToken/Checkpoints/index.ts:60
ProcedureMethod
TransactionQueue
Checkpoint
PaginationOptions
ResultSet
CheckpointWithData
src/api/entities/SecurityToken/Checkpoints/index.ts:94
ResultSet
CheckpointWithData
Checkpoint
src/api/entities/SecurityToken/Checkpoints/index.ts:69
Checkpoint
SecurityToken
context
parent
schedules
create
get
getOne
ProcedureOpts
PaginationOptions