api.entities.Asset.Checkpoints.Schedules.Schedules

Class: Schedules

api/entities/Asset/Checkpoints/Schedules.Schedules

Handles all Asset Checkpoint Schedules related functionality

Hierarchy

• Namespace<Asset>

  ↳ Schedules

Table of contents

Methods

• create
• get
• getOne
• maxComplexity
• remove

Methods

create

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

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

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

Parameters

Name	Type
args	CreateCheckpointScheduleParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<CheckpointSchedule, CheckpointSchedule>>

---

get

▸ get(): Promise<ScheduleWithDetails[]>

Retrieve all active Checkpoint Schedules

Returns

Promise<ScheduleWithDetails[]>

---

getOne

▸ getOne(__namedParameters): Promise<ScheduleWithDetails>

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

Throws

if there is no Schedule with the passed ID

Parameters

Name	Type
__namedParameters	Object
__namedParameters.id	BigNumber

Returns

Promise<ScheduleWithDetails>

---

maxComplexity

▸ maxComplexity(): Promise<BigNumber>

Retrieve the maximum allowed Schedule complexity for this Asset

Returns

Promise<BigNumber>

---

remove

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

Remove the supplied Checkpoint Schedule for a given Asset

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

Parameters

Name	Type
args	RemoveCheckpointScheduleParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>