api/entities/CheckpointSchedule.CheckpointSchedule

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

• Entity<UniqueIdentifiers, HumanReadable>

  ↳ CheckpointSchedule

• asset
• expiryDate
• id
• pendingPoints
• uuid

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

• asset: FungibleAsset

Asset for which Checkpoints are scheduled

api/entities/CheckpointSchedule/index.ts:57

---

• expiryDate: Date

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

api/entities/CheckpointSchedule/index.ts:67

---

• id: BigNumber

schedule identifier number

api/entities/CheckpointSchedule/index.ts:52

---

• pendingPoints: Date[]

dates in the future where checkpoints are schedule to be created

api/entities/CheckpointSchedule/index.ts:62

---

• uuid: string

Entity.uuid

api/entities/Entity.ts:46

▸ details(): Promise<ScheduleDetails>

Retrieve information specific to this Schedule

Promise<ScheduleDetails>

api/entities/CheckpointSchedule/index.ts:89

---

▸ exists(): Promise<boolean>

Determine whether this Checkpoint Schedule exists on chain

Promise<boolean>

Entity.exists

api/entities/CheckpointSchedule/index.ts:160

---

▸ getCheckpoints(): Promise<Checkpoint[]>

Retrieve all Checkpoints created by this Schedule

Promise<Checkpoint[]>

api/entities/CheckpointSchedule/index.ts:127

---

▸ isEqual(entity): boolean

Determine whether this Entity is the same as another one

Name	Type
entity	Entity<unknown, unknown>

boolean

Entity.isEqual

api/entities/Entity.ts:61

---

▸ toHuman(): HumanReadable

Return the Schedule's static data

HumanReadable

Entity.toHuman

api/entities/CheckpointSchedule/index.ts:185

---

▸ Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Name
Identifiers

Name	Type
identifiers	Identifiers

string

Entity.generateUuid

api/entities/Entity.ts:14

---

▸ Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Name
Identifiers

Name	Type	Description
serialized	string	UUID to unserialize

Identifiers

Entity.unserialize

api/entities/Entity.ts:23