Polymesh SDK API Reference
v10.0.0
v10.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • PermissionGroupType
    • PermissionType
    • ProposalStage
    • RoleType
    • ScopeType
    • SignerType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddPairBaseParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • AgentWithGroup
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateGroupParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • FeesBreakdown
    • GroupedInstructions
    • HistoricAgentOperation
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityRole
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • InviteExternalAgentParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProcedureOpts
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveExternalAgentParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetGroupPermissionsParams
    • SetPercentageTransferRestrictionsParams
    • SetPermissionGroupParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • Subsidy
    • TaxWithholding
    • ThirdPartyFees
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenBase
    • TokenDocument
    • TokenIdentifier
    • TokenWithGroup
    • TransactionPermissions
    • TransactionsParams
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • TxGroupParams
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
    • WaivePermissionsParams
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • complexity
  • Protected context
  • expiryDate
  • id
  • period
  • start
  • ticker
  • uuid
  • Methods
  • details
  • exists
  • getCheckpoints
  • isEqual
  • toJson
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

CheckpointSchedule

PreviousCheckpointNextCheckpoints

Last updated 3 years ago

Was this helpful?

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

Hierarchy

  • ‹UniqueIdentifiers, ›

    ↳ CheckpointSchedule

Index

Properties

Methods

Properties

complexity

• complexity: number

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

Protected 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

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

Methods

details

Retrieve information specific to this Schedule

exists

▸ exists(): Promise‹boolean›

Determine whether this Checkpoint Schedule exists on chain

Returns: Promise‹boolean›

getCheckpoints

Retrieve all Checkpoints created by this Schedule

isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean

toJson

Return the Schedule's ID and Token ticker

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

identifiers

Identifiers

Returns: string

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

Defined in

• context:

Inherited from .

Defined in

Defined in

Defined in

• period: | null

Defined in

Defined in

Defined in

Inherited from .

Defined in

▸ details(): Promise‹›

Defined in

Returns: Promise‹›

Overrides .

Defined in

▸ getCheckpoints(): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ isEqual(entity: ‹unknown, unknown›): boolean

Inherited from .

Defined in

‹unknown, unknown›

â–¸ toJson():

Overrides .

Defined in

Returns:

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/CheckpointSchedule/index.ts:83
Context
src/api/entities/Entity.ts:48
src/api/entities/CheckpointSchedule/index.ts:78
src/api/entities/CheckpointSchedule/index.ts:56
CalendarPeriod
src/api/entities/CheckpointSchedule/index.ts:67
src/api/entities/CheckpointSchedule/index.ts:72
src/api/entities/CheckpointSchedule/index.ts:61
src/api/entities/Entity.ts:46
ScheduleDetails
src/api/entities/CheckpointSchedule/index.ts:119
ScheduleDetails
src/api/entities/CheckpointSchedule/index.ts:185
Checkpoint
src/api/entities/CheckpointSchedule/index.ts:153
Checkpoint
Entity
src/api/entities/Entity.ts:61
HumanReadable
src/api/entities/CheckpointSchedule/index.ts:207
HumanReadable
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
HumanReadable
complexity
context
expiryDate
id
period
start
ticker
uuid
details
exists
getCheckpoints
isEqual
toJson
generateUuid
unserialize
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
context
uuid
exists
isEqual
toJson
generateUuid
unserialize