# Checkpoint

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

## Hierarchy

* [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)‹UniqueIdentifiers, [HumanReadable](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/humanreadable.md)›

  ↳ **Checkpoint**

## Index

### Properties

* [context](#protected-context)
* [id](#id)
* [ticker](#ticker)
* [uuid](#uuid)

### Methods

* [allBalances](#allbalances)
* [balance](#balance)
* [createdAt](#createdat)
* [exists](#exists)
* [isEqual](#isequal)
* [toJson](#tojson)
* [totalSupply](#totalsupply)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/context)

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)*.*[*context*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/entity#protected-context)

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

***

### id

• **id**: *BigNumber*

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

checkpoint identifier number

***

### ticker

• **ticker**: *string*

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

ticker of the Security Token whose balances are being recorded

***

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/entity#uuid)

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

## Methods

### allBalances

▸ **allBalances**(`paginationOpts?`: [PaginationOptions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/paginationoptions.md)): *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/resultset.md)*‹*[*IdentityBalance*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/identitybalance.md)*››*

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

Retrieve all Tokenholder balances at this Checkpoint

**`note`** supports pagination

**Parameters:**

| Name              | Type                                                                                                                    |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `paginationOpts?` | [PaginationOptions](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/paginationoptions.md) |

**Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/resultset.md)*‹*[*IdentityBalance*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/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/da0f7fd7/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:82*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/src/api/entities/Checkpoint.ts#L82)

Retrieve this Checkpoint's creation date

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

***

### exists

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

*Overrides* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)*.*[*exists*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/entity#abstract-exists)

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

Determine whether this Checkpoint exists on chain

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

***

### isEqual

▸ **isEqual**(`entity`: [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)‹unknown, unknown›): *boolean*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)*.*[*isEqual*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/entity#isequal)

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

Determine whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                                                              |
| -------- | ----------------------------------------------------------------------------------------------------------------- |
| `entity` | [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)‹unknown, unknown› |

**Returns:** *boolean*

***

### toJson

▸ **toJson**(): [*HumanReadable*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/humanreadable.md)

*Overrides* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)*.*[*toJson*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/entity#abstract-tojson)

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

Return the Checkpoint's ticker and identifier

**Returns:** [*HumanReadable*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v11/docs/interfaces/humanreadable.md)

***

### totalSupply

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

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

Retrieve the Security Token's total supply at this checkpoint

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

***

### `Static` generateUuid

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

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)*.*[*generateUuid*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/entity#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/da0f7fd7/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*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/classes/entity)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/v11.0.2/entity#static-unserialize)

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