Checkpoint

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

Hierarchy

• Entity‹UniqueIdentifiers, HumanReadable›

  ↳ Checkpoint

Index

Properties

• asset

• context

• id

• uuid

Methods

• allBalances

• balance

• createdAt

• exists

• isEqual

• toHuman

• totalSupply

• generateUuid

• unserialize

Properties

asset

• asset: Asset

Defined in src/api/entities/Checkpoint.ts:51

Asset whose balances are being recorded in this Checkpoint

---

Protected context

• context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

---

id

• id: BigNumber

Defined in src/api/entities/Checkpoint.ts:46

Checkpoint identifier number

---

uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

allBalances

▸ allBalances(paginationOpts?: PaginationOptions): Promise‹ResultSet‹IdentityBalance››

Defined in src/api/entities/Checkpoint.ts:108

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?	PaginationOptions

Returns: Promise‹ResultSet‹IdentityBalance››

---

balance

▸ balance(args?: undefined | object): Promise‹BigNumber›

Defined in src/api/entities/Checkpoint.ts:201

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›

Defined in src/api/entities/Checkpoint.ts:86

Retrieve this Checkpoint's creation date

Returns: Promise‹Date›

---

exists

▸ exists(): Promise‹boolean›

Overrides Entity.exists

Defined in src/api/entities/Checkpoint.ts:245

Determine whether this Checkpoint exists on chain

Returns: Promise‹boolean›

---

isEqual

▸ isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

---

toHuman

▸ toHuman(): HumanReadable

Overrides Entity.toHuman

Defined in src/api/entities/Checkpoint.ts:265

Return the Checkpoint's ticker and identifier

Returns: HumanReadable

---

totalSupply

▸ totalSupply(): Promise‹BigNumber›

Defined in src/api/entities/Checkpoint.ts:68

Retrieve the Asset's total supply at this checkpoint

Returns: Promise‹BigNumber›

---

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
identifiers	Identifiers

Returns: string

---

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers