# Checkpoints

Handles all Asset Checkpoints related functionality

## Hierarchy

* Namespace‹[Asset](https://developers.polymath.network/polymesh-sdk-api-reference/classes/asset)›

  ↳ **Checkpoints**

## Index

### Properties

* [context](#protected-context)
* [parent](#protected-parent)
* [schedules](#schedules)

### Methods

* [create](#create)
* [get](#get)
* [getOne](#getone)

## Properties

### `Protected` context

• **context**: *Context*

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:11*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/Namespace.ts#L11)

***

### `Protected` parent

• **parent**: [*Asset*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/asset)

*Inherited from void*

*Defined in* [*src/api/entities/Namespace.ts:9*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/Namespace.ts#L9)

***

### schedules

• **schedules**: [*Schedules*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/schedules)

*Defined in* [*src/api/entities/Asset/Checkpoints/index.ts:29*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/Asset/Checkpoints/index.ts#L29)

## Methods

### create

▸ **create**(`opts?`: [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/checkpoint)*››*

*Defined in* [*src/api/entities/Asset/Checkpoints/index.ts:53*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/Asset/Checkpoints/index.ts#L53)

Create a snapshot of Asset Holders and their respective balances at this moment

**`note`** this method is of type [NoArgsProcedureMethod](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/noargsproceduremethod.md), which means you can call [create.checkAuthorization](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/noargsproceduremethod.md#checkauthorization) on it to see whether the signing Account and Identity have the required roles and permissions to run it

**Parameters:**

| Name    | Type                                                                                                                |
| ------- | ------------------------------------------------------------------------------------------------------------------- |
| `opts?` | [ProcedureOpts](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/procedureopts.md) |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/transactionqueue)*‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/checkpoint)*››*

***

### get

▸ **get**(`paginationOpts?`: [PaginationOptions](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/paginationoptions.md)): *Promise‹*[*ResultSet*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/resultset.md)*‹*[*CheckpointWithData*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/checkpointwithdata.md)*››*

*Defined in* [*src/api/entities/Asset/Checkpoints/index.ts:87*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/Asset/Checkpoints/index.ts#L87)

Retrieve all Checkpoints created on this Asset, together with their corresponding creation Date and Total Supply

**`note`** supports pagination

**Parameters:**

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

**Returns:** *Promise‹*[*ResultSet*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/resultset.md)*‹*[*CheckpointWithData*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/docs/v14/docs/interfaces/checkpointwithdata.md)*››*

***

### getOne

▸ **getOne**(`args`: object): *Promise‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/checkpoint)*›*

*Defined in* [*src/api/entities/Asset/Checkpoints/index.ts:62*](https://github.com/PolymeshAssociation/polymesh-sdk/blob/46845947/src/api/entities/Asset/Checkpoints/index.ts#L62)

Retrieve a single Checkpoint for this Asset by its ID

**`throws`** if there is no Checkpoint with the passed ID

**Parameters:**

▪ **args**: *object*

| Name | Type      |
| ---- | --------- |
| `id` | BigNumber |

**Returns:** *Promise‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/classes/checkpoint)*›*