api.entities.CheckpointSchedule.CheckpointSchedule

Class: CheckpointSchedule

api/entities/CheckpointSchedule.CheckpointSchedule

Represents a Checkpoint Schedule for an Asset. Schedules can be set up to create Checkpoints at regular intervals

Hierarchy

• Entity<UniqueIdentifiers, HumanReadable>

  ↳ CheckpointSchedule

Table of contents

Properties

• asset
• expiryDate
• id
• pendingPoints
• uuid

Methods

• details
• exists
• getCheckpoints
• isEqual
• toHuman
• generateUuid
• unserialize

Properties

asset

• asset: FungibleAsset

Asset for which Checkpoints are scheduled

Defined in

api/entities/CheckpointSchedule/index.ts:53

---

expiryDate

• expiryDate: Date

date at which the last Checkpoint will be created with this Schedule.

Defined in

api/entities/CheckpointSchedule/index.ts:63

---

id

• id: BigNumber

schedule identifier number

Defined in

api/entities/CheckpointSchedule/index.ts:48

---

pendingPoints

• pendingPoints: Date[]

dates in the future where checkpoints are schedule to be created

Defined in

api/entities/CheckpointSchedule/index.ts:58

---

uuid

• uuid: string

Inherited from

Entity.uuid

Defined in

api/entities/Entity.ts:46

Methods

details

▸ details(): Promise<ScheduleDetails>

Retrieve information specific to this Schedule

Returns

Promise<ScheduleDetails>

Defined in

api/entities/CheckpointSchedule/index.ts:85

---

exists

▸ exists(): Promise<boolean>

Determine whether this Checkpoint Schedule exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

Defined in

api/entities/CheckpointSchedule/index.ts:156

---

getCheckpoints

▸ getCheckpoints(): Promise<Checkpoint[]>

Retrieve all Checkpoints created by this Schedule

Returns

Promise<Checkpoint[]>

Defined in

api/entities/CheckpointSchedule/index.ts:123

---

isEqual

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

Name	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

Defined in

api/entities/Entity.ts:61

---

toHuman

▸ toHuman(): HumanReadable

Return the Schedule's static data

Returns

HumanReadable

Overrides

Entity.toHuman

Defined in

api/entities/CheckpointSchedule/index.ts:181

---

generateUuid

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

Name	Type
identifiers	Identifiers

Returns

string

Inherited from

Entity.generateUuid

Defined in

api/entities/Entity.ts:14

---

unserialize

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

Name	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize

Defined in

api/entities/Entity.ts:23