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
  • Protected context
  • id
  • ticker
  • uuid
  • Methods
  • allBalances
  • balance
  • createdAt
  • exists
  • isEqual
  • toJson
  • totalSupply
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

Checkpoint

PreviousAuthorizationsNextCheckpointSchedule

Last updated 3 years ago

Was this helpful?

Represents a snapshot of the Security Token's holders and their respective balances at a certain point in time

Hierarchy

  • ‹UniqueIdentifiers, ›

    ↳ Checkpoint

Index

Properties

Methods

Properties

Protected context

id

• id: BigNumber

checkpoint identifier number

ticker

• ticker: string

ticker of the Security Token whose balances are being recorded

uuid

• uuid: string

Methods

allBalances

Retrieve all Tokenholder balances at this Checkpoint

note supports pagination

Parameters:

Name
Type

paginationOpts?

balance

▸ balance(args?: undefined | object): Promise‹BigNumber›

Retrieve the balance of a specific Tokenholder Identity at this Checkpoint

Parameters:

Name
Type

args?

undefined | object

Returns: Promise‹BigNumber›

createdAt

▸ createdAt(): Promise‹Date›

Retrieve this Checkpoint's creation date

Returns: Promise‹Date›

exists

▸ exists(): Promise‹boolean›

Determine whether this Checkpoint exists on chain

Returns: Promise‹boolean›

isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean

toJson

Return the Checkpoint's ticker and identifier

totalSupply

▸ totalSupply(): Promise‹BigNumber›

Retrieve the Security Token's total supply at this checkpoint

Returns: Promise‹BigNumber›

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

• context:

Inherited from .

Defined in

Defined in

Defined in

Inherited from .

Defined in

▸ allBalances(paginationOpts?: ): Promise‹‹››

Defined in

Returns: Promise‹‹››

Defined in

Defined in

Overrides .

Defined in

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

Inherited from .

Defined in

‹unknown, unknown›

â–¸ toJson():

Overrides .

Defined in

Returns:

Defined in

Inherited from .

Defined in

Inherited from .

Defined in

Context
src/api/entities/Entity.ts:48
src/api/entities/Checkpoint.ts:48
src/api/entities/Checkpoint.ts:53
src/api/entities/Entity.ts:46
PaginationOptions
ResultSet
IdentityBalance
src/api/entities/Checkpoint.ts:100
ResultSet
IdentityBalance
src/api/entities/Checkpoint.ts:182
src/api/entities/Checkpoint.ts:84
src/api/entities/Checkpoint.ts:222
Entity
src/api/entities/Entity.ts:61
HumanReadable
src/api/entities/Checkpoint.ts:242
HumanReadable
src/api/entities/Checkpoint.ts:70
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
HumanReadable
context
id
ticker
uuid
allBalances
balance
createdAt
exists
isEqual
toJson
totalSupply
generateUuid
unserialize
PaginationOptions
Entity
Entity
Entity
Entity
Entity
Entity
Entity
Entity
context
uuid
exists
isEqual
toJson
generateUuid
unserialize