Checkpoint
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents a snapshot of the Asset's holders and their respective balances at a certain point in time
‹UniqueIdentifiers, ›
↳ Checkpoint
Asset whose balances are being recorded in this Checkpoint
Protected context• context: Context
• id: BigNumber
Checkpoint identifier number
• uuid: string
Retrieve all Asset Holder balances at this Checkpoint
note supports pagination
Parameters:
paginationOpts?
▸ balance(args?: undefined | object): Promise‹BigNumber›
Retrieve the balance of a specific Asset Holder Identity at this Checkpoint
note A checkpoint only records balances when they change. The implementation is to query for all balance updates for [ticker, did] pair. If no balance updates have happened since the Checkpoint has been created, then the storage will not have an entry for the user. Instead the current balance should be used. The balance is stored only when the Identity makes a transaction after a Checkpoint is created. This helps keep storage usage to a minimum
Parameters:
args?
undefined | object
Returns: Promise‹BigNumber›
▸ createdAt(): Promise‹Date›
Retrieve this Checkpoint's creation date
Returns: Promise‹Date›
▸ exists(): Promise‹boolean›
Determine whether this Checkpoint exists on chain
Returns: Promise‹boolean›
Determine whether this Entity is the same as another one
Parameters:
entity
Returns: boolean
Return the Checkpoint's ticker and identifier
▸ totalSupply(): Promise‹BigNumber›
Retrieve the Asset'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
Parameters:
identifiers
Identifiers
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
serialized
string
UUID to unserialize
Returns: Identifiers
• asset:
Defined in
Inherited from .
Defined in
Defined in
Inherited from .
Defined in
▸ allBalances(paginationOpts?: ): Promise‹‹››
Defined in
note current Asset holders who didn't hold any tokens when the Checkpoint was created will be listed with a balance of 0. This arises from a chain storage optimization and pagination. @see for a more detailed explanation of the logic
Returns: Promise‹‹››
Defined in
Defined in
Overrides .
Defined in
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
â–¸ toHuman():
Overrides .
Defined in
Returns:
Defined in
Inherited from .
Defined in
Inherited from .
Defined in