Polymesh SDK API Reference
v5.0.0
v5.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyXParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • checkpoints
  • compliance
  • Protected context
  • controllerTransfer
  • corporateActions
  • did
  • documents
  • freeze
  • issuance
  • modify
  • modifyPrimaryIssuanceAgent
  • offerings
  • redeem
  • removePrimaryIssuanceAgent
  • settlements
  • ticker
  • tokenHolders
  • transferOwnership
  • transferRestrictions
  • unfreeze
  • uuid
  • Methods
  • createdAt
  • currentFundingRound
  • details
  • getIdentifiers
  • investorCount
  • isEqual
  • isFrozen
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

SecurityToken

PreviousSchedulesNextSettlements

Last updated 4 years ago

Was this helpful?

Class used to manage all the Security Token functionality

Hierarchy

  • ‹UniqueIdentifiers›

    ↳ SecurityToken

Index

Properties

Methods

Properties

checkpoints

compliance

• compliance: Compliance

Protected context

controllerTransfer

Force a transfer from a given Portfolio to the PIA’s default Portfolio

param portfolio (or portfolio ID) from which tokens will be transferred

param amount of tokens to transfer

note required role:

  • Security Token Primary Issuance Agent

corporateActions

did

• did: string

identity id of the Security Token

documents

freeze

Freezes transfers and minting of the Security Token

note required role:

  • Security Token Owner

issuance

modify

Modify some properties of the Security Token

param makes an indivisible token divisible

throws if the passed values result in no changes being made to the token

note required role:

  • Security Token Owner

modifyPrimaryIssuanceAgent

Assign a new primary issuance agent for the Security Token

param identity to be set as primary issuance agent

param date at which the authorization request to modify the primary issuance agent expires (optional, never expires if a date is not provided)

note this may create AuthorizationRequest which have to be accepted by the corresponding Account. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

note required role:

  • Security Token Owner

offerings

redeem

Redeem (burn) an amount of this Security Token

note Tokens are removed from the Primary Issuance Agent's Default Portfolio. If the Security Token has no Primary Issuance Agent, funds are removed from the owner's Default Portfolio instead

note required role:

  • Security Token Primary Issuance Agent

removePrimaryIssuanceAgent

• removePrimaryIssuanceAgent: ProcedureMethod‹void, void›

Remove the primary issuance agent of the Security Token

note if primary issuance agent is not set, Security Token owner would be used by default

note required role:

  • Security Token Owner

settlements

ticker

• ticker: string

ticker of the Security Token

tokenHolders

transferOwnership

Transfer ownership of the Security Token to another Identity. This generates an authorization request that must be accepted by the destinatary

param date at which the authorization request for transfer expires (optional)

note required role:

  • Security Token Owner

transferRestrictions

unfreeze

Unfreeze transfers and minting of the Security Token

note required role:

  • Security Token Owner

uuid

• uuid: string

Methods

createdAt

Retrieve the identifier data (block number, date and event index) of the event that was emitted when the token was created

note uses the middleware

note there is a possibility that the data is not ready by the time it is requested. In that case, null is returned

currentFundingRound

▸ currentFundingRound(): Promise‹string›

Retrieve the Security Token's funding round

note can be subscribed to

Returns: Promise‹string›

Parameters:

Name

Type

callback

details

Retrieve the Security Token's name, total supply, whether it is divisible or not and the Identity of the owner

note can be subscribed to

Parameters:

Name

Type

callback

getIdentifiers

Retrieve the Security Token's asset identifiers list

note can be subscribed to

Parameters:

Name

Type

callback?

investorCount

▸ investorCount(): Promise‹number›

Retrieve the amount of unique investors that hold this Security Token

note this takes into account the Scope ID of Investor Uniqueness Claims. If an investor holds balances of this token in two or more different Identities, but they all have Investor Uniqueness Claims with the same Scope ID, then they will only be counted once for the purposes of this result

note can be subscribed to

Returns: Promise‹number›

Parameters:

Name

Type

callback

isEqual

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Returns: boolean

isFrozen

▸ isFrozen(): Promise‹boolean›

Check whether transfers are frozen for the Security Token

note can be subscribed to

Returns: Promise‹boolean›

Parameters:

Name

Type

callback

Static generateUuid

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

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers: object

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: object

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

• checkpoints:

Defined in

Defined in

• context:

Inherited from .

Defined in

• controllerTransfer: ProcedureMethod‹, void›

Defined in

• corporateActions:

Defined in

Defined in

• documents:

Defined in

• freeze: ProcedureMethod‹void, ›

Defined in

• issuance:

Defined in

• modify: ProcedureMethod‹, ›

Defined in

• modifyPrimaryIssuanceAgent: ProcedureMethod‹, void›

Defined in

• offerings:

Defined in

• redeem: ProcedureMethod‹, void›

Defined in

Defined in

• settlements:

Defined in

Defined in

• tokenHolders:

Defined in

• transferOwnership: ProcedureMethod‹, ›

Defined in

note this will create which have to be accepted by the corresponding and/or . An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

• transferRestrictions:

Defined in

• unfreeze: ProcedureMethod‹void, ›

Defined in

Inherited from .

Defined in

▸ createdAt(): Promise‹ | null›

Defined in

Returns: Promise‹ | null›

Defined in

▸ currentFundingRound(callback: ‹string›): Promise‹›

Defined in

‹string›

Returns: Promise‹›

▸ details(): Promise‹›

Defined in

Returns: Promise‹›

▸ details(callback: ‹›): Promise‹›

Defined in

‹›

Returns: Promise‹›

▸ getIdentifiers(): Promise‹[]›

Defined in

Returns: Promise‹[]›

▸ getIdentifiers(callback?: ‹[]›): Promise‹›

Defined in

‹[]›

Returns: Promise‹›

Defined in

▸ investorCount(callback: ‹number›): Promise‹›

Defined in

‹number›

Returns: Promise‹›

▸ isEqual(entity: ‹object›): boolean

Inherited from .

Defined in

‹object›

Defined in

▸ isFrozen(callback: ‹boolean›): Promise‹›

Defined in

‹boolean›

Returns: Promise‹›

Inherited from .

Defined in

Inherited from .

Defined in

Entity
checkpoints
compliance
context
controllerTransfer
corporateActions
did
documents
freeze
issuance
modify
modifyPrimaryIssuanceAgent
offerings
redeem
removePrimaryIssuanceAgent
settlements
ticker
tokenHolders
transferOwnership
transferRestrictions
unfreeze
uuid
createdAt
currentFundingRound
details
getIdentifiers
investorCount
isEqual
isFrozen
generateUuid
unserialize
Checkpoints
src/api/entities/SecurityToken/index.ts:93
src/api/entities/SecurityToken/index.ts:90
Context
CheckpointSchedule
context
src/api/entities/Entity.ts:48
ControllerTransferParams
src/api/entities/SecurityToken/index.ts:460
CorporateActions
src/api/entities/SecurityToken/index.ts:94
src/api/entities/SecurityToken/index.ts:78
Documents
src/api/entities/SecurityToken/index.ts:86
SecurityToken
src/api/entities/SecurityToken/index.ts:332
Issuance
src/api/entities/SecurityToken/index.ts:89
ModifyTokenParams
SecurityToken
src/api/entities/SecurityToken/index.ts:175
ModifyPrimaryIssuanceAgentParams
src/api/entities/SecurityToken/index.ts:388
Offerings
src/api/entities/SecurityToken/index.ts:92
RedeemTokenParams
src/api/entities/SecurityToken/index.ts:410
src/api/entities/SecurityToken/index.ts:398
Settlements
src/api/entities/SecurityToken/index.ts:87
src/api/entities/SecurityToken/index.ts:83
TokenHolders
src/api/entities/SecurityToken/index.ts:88
TransferTokenOwnershipParams
SecurityToken
src/api/entities/SecurityToken/index.ts:164
Authorization Requests
Accounts
Identities
TransferRestrictions
src/api/entities/SecurityToken/index.ts:91
SecurityToken
src/api/entities/SecurityToken/index.ts:340
CheckpointSchedule
uuid
src/api/entities/Entity.ts:46
EventIdentifier
src/api/entities/SecurityToken/index.ts:310
EventIdentifier
src/api/entities/SecurityToken/index.ts:240
SubCallback
UnsubCallback
src/api/entities/SecurityToken/index.ts:241
UnsubCallback
SecurityTokenDetails
src/api/entities/SecurityToken/index.ts:182
SecurityTokenDetails
SubCallback
SecurityTokenDetails
UnsubCallback
src/api/entities/SecurityToken/index.ts:183
UnsubCallback
TokenIdentifier
src/api/entities/SecurityToken/index.ts:274
TokenIdentifier
SubCallback
TokenIdentifier
UnsubCallback
src/api/entities/SecurityToken/index.ts:275
UnsubCallback
src/api/entities/SecurityToken/index.ts:421
SubCallback
UnsubCallback
src/api/entities/SecurityToken/index.ts:422
UnsubCallback
Entity
CheckpointSchedule
isEqual
src/api/entities/Entity.ts:61
src/api/entities/SecurityToken/index.ts:347
SubCallback
UnsubCallback
src/api/entities/SecurityToken/index.ts:348
UnsubCallback
CheckpointSchedule
generateUuid
src/api/entities/Entity.ts:14
CheckpointSchedule
unserialize
src/api/entities/Entity.ts:23
SubCallback
SubCallback
SecurityTokenDetails
SubCallback
TokenIdentifier
SubCallback
Entity
SubCallback