@polymeshassociation/polymesh-sdk / api/entities/Checkpoint

Defined in: api/entities/Checkpoint.ts:36

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

• Entity<UniqueIdentifiers, HumanReadable>

asset: FungibleAsset

Defined in: api/entities/Checkpoint.ts:55

Asset whose balances are being recorded in this Checkpoint

id: BigNumber

Defined in: api/entities/Checkpoint.ts:50

Checkpoint identifier number

uuid: string

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

Entity.uuid

allBalances(paginationOpts?): Promise<ResultSet<IdentityBalance>>

Defined in: api/entities/Checkpoint.ts:107

Retrieve all Asset Holder balances at this Checkpoint

Parameter	Type
paginationOpts?	PaginationOptions

Promise<ResultSet<IdentityBalance>>

supports pagination

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.

balance for a more detailed explanation of the logic

balance(args?): Promise<BigNumber>

Defined in: api/entities/Checkpoint.ts:209

Retrieve the balance of a specific Asset Holder Identity at this Checkpoint

Parameter	Type	Description
args?	{ identity: string | Identity; }	-
args.identity?	string | Identity	defaults to the signing Identity

Promise<BigNumber>

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

createdAt(): Promise<Date>

Defined in: api/entities/Checkpoint.ts:87

Retrieve this Checkpoint's creation date

Promise<Date>

exists(): Promise<boolean>

Defined in: api/entities/Checkpoint.ts:254

Determine whether this Checkpoint exists on chain

Promise<boolean>

Entity.exists

isEqual(entity): boolean

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

Determine whether this Entity is the same as another one

Parameter	Type
entity	Entity<unknown, unknown>

boolean

Entity.isEqual

toHuman(): HumanReadable

Defined in: api/entities/Checkpoint.ts:276

Return the Checkpoint's ticker and identifier

HumanReadable

Entity.toHuman

totalSupply(): Promise<BigNumber>

Defined in: api/entities/Checkpoint.ts:72

Retrieve the Asset's total supply at this checkpoint

Promise<BigNumber>

static generateUuid<Identifiers>(identifiers): string

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

Generate the Entity's UUID from its identifying properties

Type Parameter
Identifiers

Parameter	Type	Description
identifiers	Identifiers	-

string

Entity.generateUuid

static unserialize<Identifiers>(serialized): Identifiers

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

Unserialize a UUID into its Unique Identifiers

Type Parameter
Identifiers

Parameter	Type	Description
serialized	string	UUID to unserialize

Identifiers

Entity.unserialize

Defined in: api/entities/Checkpoint.ts:27

assetId: string

Defined in: api/entities/Checkpoint.ts:29

id: string

Defined in: api/entities/Checkpoint.ts:28

---

Defined in: api/entities/Checkpoint.ts:22

assetId: string

Defined in: api/entities/Checkpoint.ts:24

id: BigNumber

Defined in: api/entities/Checkpoint.ts:23