> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/checkpoint.md).

# 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-v9/classes/entity.md)‹UniqueIdentifiers, [HumanReadable](/polymesh-sdk-api-reference/docs-v9/interfaces/humanreadable.md)›

  ↳ **Checkpoint**

## Index

### Properties

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

### Methods

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

## Properties

### `Protected` context

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

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#protected-context)

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

### id

• **id**: *BigNumber*

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

checkpoint identifier number

### ticker

• **ticker**: *string*

*Defined in* [*src/api/entities/Checkpoint.ts:53*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Checkpoint.ts#L53)

ticker of the Security Token whose balances are being recorded

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#uuid)

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

## Methods

### allBalances

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

*Defined in* [*src/api/entities/Checkpoint.ts:100*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Checkpoint.ts#L100)

Retrieve all Tokenholder balances at this Checkpoint

**`note`** supports pagination

**Parameters:**

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

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

### balance

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

*Defined in* [*src/api/entities/Checkpoint.ts:182*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Checkpoint.ts#L182)

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

Retrieve this Checkpoint's creation date

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

### exists

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

*Defined in* [*src/api/entities/Checkpoint.ts:222*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Checkpoint.ts#L222)

Retrieve whether the Checkpoint still exists on chain

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

### isEqual

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

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/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-v9/classes/entity.md)‹unknown, unknown› |

**Returns:** *boolean*

### toJson

▸ **toJson**(): [*HumanReadable*](/polymesh-sdk-api-reference/docs-v9/interfaces/humanreadable.md)

*Overrides* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*toJson*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#abstract-tojson)

*Defined in* [*src/api/entities/Checkpoint.ts:242*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Checkpoint.ts#L242)

Return the Checkpoint's ticker and identifier

**Returns:** [*HumanReadable*](/polymesh-sdk-api-reference/docs-v9/interfaces/humanreadable.md)

### totalSupply

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

*Defined in* [*src/api/entities/Checkpoint.ts:70*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Checkpoint.ts#L70)

Retrieve the Security Token's total supply at this checkpoint

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

### `Static` generateUuid

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

*Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/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* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/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*