# Checkpoint

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

## Hierarchy

* [Entity](/polymesh-sdk-api-reference/docs-v6/classes/entity.md)‹UniqueIdentifiers›

  ↳ **Checkpoint**

## Index

### Properties

* [context](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#protected-context)
* [id](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#id)
* [ticker](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#ticker)
* [uuid](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#uuid)

### Methods

* [allBalances](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#allbalances)
* [balance](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#balance)
* [createdAt](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#createdat)
* [exists](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#exists)
* [isEqual](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#isequal)
* [totalSupply](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#totalsupply)
* [generateUuid](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#static-generateuuid)
* [unserialize](/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md#static-unserialize)

## Properties

### `Protected` context

• **context**: [*Context*](/polymesh-sdk-api-reference/docs-v6/classes/context.md)

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#protected-context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Entity.ts#L48)

### id

• **id**: *BigNumber*

*Defined in* [*src/api/entities/Checkpoint.ts:43*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Checkpoint.ts#L43)

checkpoint identifier number

### ticker

• **ticker**: *string*

*Defined in* [*src/api/entities/Checkpoint.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Checkpoint.ts#L48)

ticker of the Security Token whose balances are being recorded

### uuid

• **uuid**: *string*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#uuid)

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Entity.ts#L46)

## Methods

### allBalances

▸ **allBalances**(`paginationOpts?`: [PaginationOptions](/polymesh-sdk-api-reference/docs-v6/interfaces/paginationoptions.md)): *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v6/interfaces/resultset.md)*‹*[*IdentityBalance*](/polymesh-sdk-api-reference/docs-v6/interfaces/identitybalance.md)*››*

*Defined in* [*src/api/entities/Checkpoint.ts:95*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Checkpoint.ts#L95)

Retrieve all Tokenholder balances at this Checkpoint

**`note`** supports pagination

**Parameters:**

| Name              | Type                                                                                     |
| ----------------- | ---------------------------------------------------------------------------------------- |
| `paginationOpts?` | [PaginationOptions](/polymesh-sdk-api-reference/docs-v6/interfaces/paginationoptions.md) |

**Returns:** *Promise‹*[*ResultSet*](/polymesh-sdk-api-reference/docs-v6/interfaces/resultset.md)*‹*[*IdentityBalance*](/polymesh-sdk-api-reference/docs-v6/interfaces/identitybalance.md)*››*

### balance

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

*Defined in* [*src/api/entities/Checkpoint.ts:177*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Checkpoint.ts#L177)

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:79*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Checkpoint.ts#L79)

Retrieve this Checkpoint's creation date

**Returns:** *Promise‹Date›*

### exists

▸ **exists**(): *Promise‹boolean›*

*Defined in* [*src/api/entities/Checkpoint.ts:217*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Checkpoint.ts#L217)

Retrieve whether the Checkpoint still exists on chain

**Returns:** *Promise‹boolean›*

### isEqual

▸ **isEqual**(`entity`: [Entity](/polymesh-sdk-api-reference/docs-v6/classes/entity.md)‹unknown›): *boolean*

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Entity.ts#L61)

Whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                     |
| -------- | ------------------------------------------------------------------------ |
| `entity` | [Entity](/polymesh-sdk-api-reference/docs-v6/classes/entity.md)‹unknown› |

**Returns:** *boolean*

### totalSupply

▸ **totalSupply**(): *Promise‹BigNumber›*

*Defined in* [*src/api/entities/Checkpoint.ts:65*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Checkpoint.ts#L65)

Retrieve the Security Token's total supply at this checkpoint

**Returns:** *Promise‹BigNumber›*

### `Static` generateUuid

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

*Inherited from* [*CheckpointSchedule*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Entity.ts#L14)

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*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpoint.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.