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

api/entities/Asset/Fungible/Checkpoints

Classes

Checkpoints

Defined in: api/entities/Asset/Fungible/Checkpoints/index.ts:33

Handles all Asset Checkpoints related functionality

Extends

• Namespace<FungibleAsset>

Properties

schedules

schedules: Schedules

Defined in: api/entities/Asset/Fungible/Checkpoints/index.ts:34

Methods

create()

create(opts?): Promise<GenericPolymeshTransaction<Checkpoint, Checkpoint>>

Defined in: api/entities/Asset/Fungible/Checkpoints/index.ts:53

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

Parameters

Parameter	Type
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<Checkpoint, Checkpoint>>

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

get()

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

Defined in: api/entities/Asset/Fungible/Checkpoints/index.ts:85

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

Parameters

Parameter	Type
paginationOpts?	PaginationOptions

Returns

Promise<ResultSet<CheckpointWithData>>

Note

supports pagination

getOne()

getOne(args): Promise<Checkpoint>

Defined in: api/entities/Asset/Fungible/Checkpoints/index.ts:60

Retrieve a single Checkpoint for this Asset by its ID

Parameters

Parameter	Type
args	{ id: BigNumber; }
args.id	BigNumber

Returns

Promise<Checkpoint>

Throws

if there is no Checkpoint with the passed ID