CheckpointSchedule
Represents a Schedule in which Checkpoints are created for a specific Security Token. Schedules can be set up to create checkpoints

Hierarchy

Index

Properties

Methods

Properties

complexity

complexity: number
abstract measure of the complexity of this Schedule. Shorter periods translate into more complexity

Protected context

context: Context
Inherited from Entity.context

expiryDate

expiryDate: Date | null
date at which the last Checkpoint will be created with this Schedule. A null value means that this Schedule never expires

id

id: BigNumber
schedule identifier number

period

period: CalendarPeriod | null
how often this Schedule creates a Checkpoint. A null value means this Schedule creates a single Checkpoint and then expires

start

start: Date
first Checkpoint creation date

ticker

ticker: string
ticker of the Security Token for which Checkpoints are scheduled

uuid

uuid: string
Inherited from Entity.uuid

Methods

details

details(): Promise‹ScheduleDetails
Retrieve information specific to this Schedule
Returns: Promise‹ScheduleDetails

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this Checkpoint Schedule exists on chain
Returns: Promise‹boolean›

getCheckpoints

getCheckpoints(): Promise‹Checkpoint[]›
Retrieve all Checkpoints created by this Schedule
Returns: Promise‹Checkpoint[]›

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from Entity.isEqual
Determine whether this Entity is the same as another one
Parameters:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean

toJson

toJson(): HumanReadable
Overrides Entity.toJson
Return the Schedule's ID and Token ticker
Returns: HumanReadable

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
Generate the Entity's UUID from its identifying properties
Type parameters:
Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers
Inherited from Entity.unserialize
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago