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

Hierarchy

Index

Properties

Methods

Properties

asset

asset: Asset
Asset whose balances are being recorded in this Checkpoint

Protected context

context: Context
Inherited from CheckpointSchedule.context

id

id: BigNumber
Checkpoint identifier number

uuid

uuid: string
Inherited from CheckpointSchedule.uuid

Methods

allBalances

allBalances(paginationOpts?: PaginationOptions): Promise‹ResultSetIdentityBalance››
Retrieve all Asset Holder balances at this Checkpoint
note supports pagination
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 balance for a more detailed explanation of the logic
Parameters:
Name
Type
paginationOpts?
Returns: Promise‹ResultSetIdentityBalance››

balance

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:
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 CheckpointSchedule.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 Asset's total supply at this checkpoint
Returns: Promise‹BigNumber›

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
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
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers