Checkpoint
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents a snapshot of the Security Token's holders and their respective balances at a certain point in time
‹UniqueIdentifiers›
↳ Checkpoint
Protected context• id: BigNumber
checkpoint identifier number
• ticker: string
ticker of the Security Token whose balances are being recorded
• uuid: string
Retrieve all Tokenholder balances at this Checkpoint
note supports pagination
Parameters:
Name
Type
paginationOpts?
▸ 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(): Promise‹Date›
Retrieve this Checkpoint's creation date
Returns: Promise‹Date›
▸ exists(): Promise‹boolean›
Retrieve whether the Checkpoint still exists on chain
Returns: Promise‹boolean›
Whether this Entity is the same as another one
Parameters:
Name
Type
entity
Returns: boolean
▸ totalSupply(): Promise‹BigNumber›
Retrieve the Security Token's total supply at this checkpoint
Returns: Promise‹BigNumber›
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
▪ Identifiers: object
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
▪ Identifiers: object
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
• context:
Inherited from .
Defined in
Defined in
Defined in
Inherited from .
Defined in
▸ allBalances(paginationOpts?: ): Promise‹‹››
Defined in
Returns: Promise‹‹››
Defined in
Defined in
Defined in
▸ isEqual(entity: ‹object›): boolean
Inherited from .
Defined in
‹object›
Defined in
Inherited from .
Defined in
Inherited from .
Defined in