api.entities.Asset.Fungible.Checkpoints.Schedules

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

api/entities/Asset/Fungible/Checkpoints/Schedules

Classes

Schedules

Defined in: api/entities/Asset/Fungible/Checkpoints/Schedules.ts:27

Handles all Asset Checkpoint Schedules related functionality

Extends

• Namespace<FungibleAsset>

Methods

create()

create(args, opts?): Promise<GenericPolymeshTransaction<CheckpointSchedule, CheckpointSchedule>>

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

Create a schedule for Checkpoint creation (e.g. "Create a checkpoint every week for 5 weeks, starting next tuesday")

Parameters

Parameter	Type
args	CreateCheckpointScheduleParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<CheckpointSchedule, CheckpointSchedule>>

Note

⚠️ Chain v6 introduces changes in how checkpoints are created. Only a set amount of points can be specified, infinitely repeating schedules are deprecated

Note

due to chain limitations, schedules are advanced and (if appropriate) executed whenever the Asset is redeemed, issued or transferred between portfolios. This means that on an Asset without much movement, there may be disparities between intended Checkpoint creation dates and the actual date when they are created. This, however, has no effect on the Checkpoint's accuracy regarding to balances

Note

this method is of type ProcedureMethod, 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(): Promise<ScheduleWithDetails[]>

Defined in: api/entities/Asset/Fungible/Checkpoints/Schedules.ts:83

Retrieve all active Checkpoint Schedules

Returns

Promise<ScheduleWithDetails[]>

getNextCheckpoint()

getNextCheckpoint(): Promise<NextCheckpoints | null>

Defined in: api/entities/Asset/Fungible/Checkpoints/Schedules.ts:141

Retrieve the cached next Checkpoint information for this Asset, aggregated across all of its active Schedules

Returns

Promise<NextCheckpoints | null>

null if the Asset has no active Schedules

getOne()

getOne(__namedParameters): Promise<ScheduleWithDetails>

Defined in: api/entities/Asset/Fungible/Checkpoints/Schedules.ts:65

Retrieve a single Checkpoint Schedule associated to this Asset by its ID

Parameters

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

Returns

Promise<ScheduleWithDetails>

Throws

if there is no Schedule with the passed ID

maxComplexity()

maxComplexity(): Promise<BigNumber>

Defined in: api/entities/Asset/Fungible/Checkpoints/Schedules.ts:128

Retrieve the maximum allowed Schedule complexity for this Asset

Returns

Promise<BigNumber>

remove()

remove(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Defined in: api/entities/Asset/Fungible/Checkpoints/Schedules.ts:58

Remove the supplied Checkpoint Schedule for a given Asset

Parameters

Parameter	Type
args	RemoveCheckpointScheduleParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it