Checkpoint

Represents a snapshot of the Security Token's holders and their respective balances at a certain point in time

Hierarchy

  • Entity‹UniqueIdentifiers›

    Checkpoint

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

id

id: BigNumber

Defined in src/api/entities/Checkpoint.ts:43

checkpoint identifier number

ticker

ticker: string

Defined in src/api/entities/Checkpoint.ts:48

ticker of the Security Token whose balances are being recorded

uuid

uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

allBalances

allBalances(paginationOpts?: PaginationOptions): Promise‹ResultSetIdentityBalance››

Defined in src/api/entities/Checkpoint.ts:95

Retrieve all Tokenholder balances at this Checkpoint

note supports pagination

Parameters:

Name

Type

paginationOpts?

Returns: Promise‹ResultSetIdentityBalance››

balance

balance(args?: undefined | object): Promise‹BigNumber›

Defined in src/api/entities/Checkpoint.ts:177

Retrieve the balance of a specific Tokenholder Identity at this Checkpoint

Parameters:

Name

Type

args?

undefined | object

Returns: Promise‹BigNumber›

createdAt

createdAt(): Promise‹Date›

Defined in src/api/entities/Checkpoint.ts:79

Retrieve this Checkpoint's creation date

Returns: Promise‹Date›

exists

exists(): Promise‹boolean›

Defined in src/api/entities/Checkpoint.ts:217

Retrieve whether the Checkpoint still exists on chain

Returns: Promise‹boolean›

isEqual

isEqual(entity: Entity‹unknown›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Entity‹unknown›

Returns: boolean

totalSupply

totalSupply(): Promise‹BigNumber›

Defined in src/api/entities/Checkpoint.ts:65

Retrieve the Security Token's total supply at this checkpoint

Returns: Promise‹BigNumber›

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

Identifiers

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

Identifiers

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

Last updated