Class: CheckpointSchedule

Defined in: src/api/entities/CheckpointSchedule/index.ts:34

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

Extends

• Entity<UniqueIdentifiers, HumanReadable>

Properties

asset

asset: FungibleAsset

Defined in: src/api/entities/CheckpointSchedule/index.ts:53

Asset for which Checkpoints are scheduled

---

expiryDate

expiryDate: Date

Defined in: src/api/entities/CheckpointSchedule/index.ts:63

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

---

id

id: BigNumber

Defined in: src/api/entities/CheckpointSchedule/index.ts:48

schedule identifier number

---

pendingPoints

pendingPoints: Date[]

Defined in: src/api/entities/CheckpointSchedule/index.ts:58

dates in the future where checkpoints are schedule to be created

---

uuid

uuid: string

Defined in: src/api/entities/Entity.ts:46

Inherited from

Entity.uuid

Methods

details()

details(): Promise<ScheduleDetails>

Defined in: src/api/entities/CheckpointSchedule/index.ts:85

Retrieve information specific to this Schedule

Returns

Promise<ScheduleDetails>

---

exists()

exists(): Promise<boolean>

Defined in: src/api/entities/CheckpointSchedule/index.ts:165

Determine whether this Checkpoint Schedule exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

---

getCheckpoints()

getCheckpoints(): Promise<Checkpoint[]>

Defined in: src/api/entities/CheckpointSchedule/index.ts:132

Retrieve all Checkpoints created by this Schedule

Returns

Promise<Checkpoint[]>

---

isEqual()

isEqual(entity: Entity<unknown, unknown>): boolean

Defined in: src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters

Parameter	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

---

toHuman()

toHuman(): HumanReadable

Defined in: src/api/entities/CheckpointSchedule/index.ts:190

Return the Schedule's static data

Returns

HumanReadable

Overrides

Entity.toHuman

---

generateUuid()

static generateUuid<Identifiers>(identifiers: Identifiers): string

Defined in: src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
identifiers	Identifiers	‐

Returns

string

Inherited from

Entity.generateUuid

---

unserialize()

static unserialize<Identifiers>(serialized: string): Identifiers

Defined in: src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize