api_entities_Asset_Checkpoints.Checkpoints

@polymeshassociation/polymesh-sdk / Modules / api/entities/Asset/Checkpoints / Checkpoints

Class: Checkpoints

api/entities/Asset/Checkpoints.Checkpoints

Handles all Asset Checkpoints related functionality

Hierarchy

• Namespace<Asset>

  ↳ Checkpoints

Table of contents

Properties

• schedules

Methods

• create

• get

• getOne

Properties

schedules

• schedules: Schedules

Defined in

api/entities/Asset/Checkpoints/index.ts:30

Methods

create

▸ create(opts?): Promise<TransactionQueue<Checkpoint, Checkpoint, unknown[][]>>

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

note this method is of type NoArgsProcedureMethod, which means you can call create.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

Returns

Promise<TransactionQueue<Checkpoint, Checkpoint, unknown[][]>>

Defined in

api/entities/Asset/Checkpoints/index.ts:54

---

get

▸ get(paginationOpts?): Promise<ResultSet<CheckpointWithData>>

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

note supports pagination

Parameters

Name	Type
paginationOpts?	PaginationOptions

Returns

Promise<ResultSet<CheckpointWithData>>

Defined in

api/entities/Asset/Checkpoints/index.ts:88

---

getOne

▸ getOne(args): Promise<Checkpoint>

Retrieve a single Checkpoint for this Asset by its ID

throws if there is no Checkpoint with the passed ID

Parameters

Name	Type
args	Object
args.id	BigNumber

Returns

Promise<Checkpoint>

Defined in

api/entities/Asset/Checkpoints/index.ts:63