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

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from Entity.context

id

id: BigNumber
checkpoint identifier number

ticker

ticker: string
ticker of the Security Token whose balances are being recorded

uuid

uuid: string
Inherited from Entity.uuid

Methods

allBalances

allBalances(paginationOpts?: PaginationOptions): Promise‹ResultSetIdentityBalance››
Retrieve all Tokenholder balances at this Checkpoint
note supports pagination
Parameters:
Name
Type
paginationOpts?
Returns: Promise‹ResultSetIdentityBalance››

balance

balance(args?: undefined | object): Promise‹BigNumber›
Retrieve the balance of a specific Tokenholder Identity at this Checkpoint
Parameters:
Name
Type
args?
undefined | object
Returns: Promise‹BigNumber›

createdAt

createdAt(): Promise‹Date›
Retrieve this Checkpoint's creation date
Returns: Promise‹Date›

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this Checkpoint exists on chain
Returns: Promise‹boolean›

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from Entity.isEqual
Determine whether this Entity is the same as another one
Parameters:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean

toJson

toJson(): HumanReadable
Overrides Entity.toJson
Return the Checkpoint's ticker and identifier
Returns: HumanReadable

totalSupply

totalSupply(): Promise‹BigNumber›
Retrieve the Security Token's total supply at this checkpoint
Returns: Promise‹BigNumber›

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
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 Entity.unserialize
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago