> For the complete documentation index, see [llms.txt](https://developers.polymath.network/classic-sdk/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/classic-sdk/classes/_entities_checkpoint_.checkpoint.md).

# Checkpoint

Represents a snapshot of the Security Token's supply and Tokenholder balances at a certain point in time

## Hierarchy

* [Entity](/classic-sdk/classes/_entities_entity_.entity.md)‹[Params](/classic-sdk/interfaces/_entities_checkpoint_.params.md)›

  ↳ **Checkpoint**

## Index

### Constructors

* [constructor](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#constructor)

### Properties

* [createdAt](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#createdat)
* [dividendDistributions](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#dividenddistributions)
* [index](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#index)
* [securityTokenId](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#securitytokenid)
* [securityTokenSymbol](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#securitytokensymbol)
* [tokenholderBalances](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#tokenholderbalances)
* [totalSupply](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#totalsupply)
* [uid](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#uid)

### Methods

* [\_refresh](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#_refresh)
* [toPojo](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#topojo)
* [generateId](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#static-generateid)
* [unserialize](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md#static-unserialize)

## Constructors

### constructor

\+ **new Checkpoint**(`params`: [Params](/classic-sdk/interfaces/_entities_checkpoint_.params.md) & [UniqueIdentifiers](/classic-sdk/interfaces/_entities_checkpoint_.uniqueidentifiers.md)): [*Checkpoint*](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md)

*Defined in* [*src/entities/Checkpoint.ts:106*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L106)

Create a new Chekpoint instance

**Parameters:**

| Name     | Type                                                                                                                                                        |
| -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `params` | [Params](/classic-sdk/interfaces/_entities_checkpoint_.params.md) & [UniqueIdentifiers](/classic-sdk/interfaces/_entities_checkpoint_.uniqueidentifiers.md) |

**Returns:** [*Checkpoint*](/classic-sdk/classes/_entities_checkpoint_.checkpoint.md)

## Properties

### createdAt

• **createdAt**: *Date*

*Defined in* [*src/entities/Checkpoint.ts:106*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L106)

### dividendDistributions

• **dividendDistributions**: [*DividendDistribution*](/classic-sdk/classes/_entities_dividenddistribution_.dividenddistribution.md)*\[]*

*Defined in* [*src/entities/Checkpoint.ts:88*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L88)

dividend distributions associated to this snapshot

### index

• **index**: *number*

*Defined in* [*src/entities/Checkpoint.ts:97*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L97)

numerical index of the checkpoint associated to this snapshot

### securityTokenId

• **securityTokenId**: *string*

*Defined in* [*src/entities/Checkpoint.ts:92*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L92)

### securityTokenSymbol

• **securityTokenSymbol**: *string*

*Defined in* [*src/entities/Checkpoint.ts:90*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L90)

### tokenholderBalances

• **tokenholderBalances**: [*TokenholderBalance*](/classic-sdk/interfaces/_types_index_.tokenholderbalance.md)*\[]*

*Defined in* [*src/entities/Checkpoint.ts:102*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L102)

tokenholder balances at this specific checkpoint

### totalSupply

• **totalSupply**: *BigNumber*

*Defined in* [*src/entities/Checkpoint.ts:104*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L104)

### uid

• **uid**: *string*

*Overrides* [*Entity*](/classic-sdk/classes/_entities_entity_.entity.md)*.*[*uid*](/classic-sdk/classes/_entities_entity_.entity.md#abstract-uid)

*Defined in* [*src/entities/Checkpoint.ts:83*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L83)

## Methods

### \_refresh

▸ **\_refresh**(`params`: Partial‹[Params](/classic-sdk/interfaces/_entities_checkpoint_.params.md)›): *void*

*Overrides* [*Entity*](/classic-sdk/classes/_entities_entity_.entity.md)*.*[*\_refresh*](/classic-sdk/classes/_entities_entity_.entity.md#abstract-_refresh)

*Defined in* [*src/entities/Checkpoint.ts:164*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L164)

Hydrate the entity

**Parameters:**

| Name     | Type                                                                       |
| -------- | -------------------------------------------------------------------------- |
| `params` | Partial‹[Params](/classic-sdk/interfaces/_entities_checkpoint_.params.md)› |

**Returns:** *void*

### toPojo

▸ **toPojo**(): *object*

*Overrides* [*Entity*](/classic-sdk/classes/_entities_entity_.entity.md)*.*[*toPojo*](/classic-sdk/classes/_entities_entity_.entity.md#abstract-topojo)

*Defined in* [*src/entities/Checkpoint.ts:137*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L137)

Convert entity to a POJO (Plain Old Javascript Object)

**Returns:** *object*

* **createdAt**: *Date*
* **dividendDistributions**: *object\[]* = dividendDistributions.map(distribution => distribution.toPojo())
* **index**: *number*
* **securityTokenId**: *string*
* **securityTokenSymbol**: *string*
* **tokenholderBalances**: [*TokenholderBalance*](/classic-sdk/interfaces/_types_index_.tokenholderbalance.md)*\[]*
* **totalSupply**: *BigNumber*
* **uid**: *string*

### `Static` generateId

▸ **generateId**(`__namedParameters`: object): *string*

*Defined in* [*src/entities/Checkpoint.ts:58*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/Checkpoint.ts#L58)

Generate the Checkpoint's UUID from its identifying properties

**Parameters:**

▪ **\_\_namedParameters**: *object*

| Name              | Type   |
| ----------------- | ------ |
| `index`           | number |
| `securityTokenId` | string |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**(`serialized`: string): [*UniqueIdentifiers*](/classic-sdk/interfaces/_entities_checkpoint_.uniqueidentifiers.md)

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

Unserialize string to Checkpoint object

**Parameters:**

| Name         | Type   |
| ------------ | ------ |
| `serialized` | string |

**Returns:** [*UniqueIdentifiers*](/classic-sdk/interfaces/_entities_checkpoint_.uniqueidentifiers.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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/classic-sdk/classes/_entities_checkpoint_.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.