Checkpoint

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

Hierarchy

• Entity‹UniqueIdentifiers, HumanReadable›

  ↳ Checkpoint

Index

Properties

• context

• id

• ticker

• uuid

Methods

• allBalances

• balance

• createdAt

• exists

• isEqual

• toJson

• totalSupply

• generateUuid

• unserialize

Properties

Protected context

• context: Context

Inherited from Entity.context

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

---

id

• id: BigNumber

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

checkpoint identifier number

---

ticker

• ticker: string

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

ticker of the Security Token whose balances are being recorded

---

uuid

• uuid: string

Inherited from Entity.uuid

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

Methods

allBalances

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

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

Retrieve all Tokenholder balances at this Checkpoint

note supports pagination

Parameters:

Name	Type
paginationOpts?	PaginationOptions

Returns: Promise‹ResultSet‹IdentityBalance››

---

balance

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

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

Retrieve the balance of a specific Tokenholder Identity at this Checkpoint

Parameters:

Name	Type
args?	undefined | object

Returns: Promise‹BigNumber›

---

createdAt

▸ createdAt(): Promise‹Date›

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

Retrieve this Checkpoint's creation date

Returns: Promise‹Date›

---

exists

▸ exists(): Promise‹boolean›

Overrides Entity.exists

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

Determine whether this Checkpoint exists on chain

Returns: Promise‹boolean›

---

isEqual

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

Inherited from Entity.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

---

toJson

▸ toJson(): HumanReadable

Overrides Entity.toJson

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

Return the Checkpoint's ticker and identifier

Returns: HumanReadable

---

totalSupply

▸ totalSupply(): Promise‹BigNumber›

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

Retrieve the Security Token's total supply at this checkpoint

Returns: Promise‹BigNumber›

---

Static generateUuid

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

Inherited from Entity.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 Entity.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