api_entities_Checkpoint.Checkpoint
Previousapi_entities_AuthorizationRequest.AuthorizationRequestNextapi_entities_CheckpointSchedule.CheckpointSchedule
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / Checkpoint
.Checkpoint
Represents a snapshot of the Asset's holders and their respective balances at a certain point in time
<, HumanReadable>
↳ Checkpoint
Asset whose balances are being recorded in this Checkpoint
Defined in
• id: BigNumber
Checkpoint identifier number
Defined in
• uuid: string
Inherited from
Defined in
Retrieve all Asset Holder balances at this Checkpoint
note supports pagination
Parameters
paginationOpts?
Returns
Defined in
â–¸ balance(args?): 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?
Object
-
args.identity
defaults to the signing Identity
Returns
Promise<BigNumber>
Defined in
â–¸ createdAt(): Promise<Date>
Retrieve this Checkpoint's creation date
Returns
Promise<Date>
Defined in
â–¸ exists(): Promise<boolean>
Determine whether this Checkpoint exists on chain
Returns
Promise<boolean>
Overrides
Defined in
â–¸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Returns
boolean
Inherited from
Defined in
â–¸ toHuman(): HumanReadable
Return the Checkpoint's ticker and identifier
Returns
HumanReadable
Overrides
Defined in
â–¸ totalSupply(): Promise<BigNumber>
Retrieve the Asset's total supply at this checkpoint
Returns
Promise<BigNumber>
Defined in
â–¸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
â–¸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
• asset:
.
â–¸ allBalances(paginationOpts?): Promise<<>>
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
Promise<<>>
string |
.
<unknown, unknown>
.
.
.
.