Polymesh SDK API Reference
v6.0.0
v6.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
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • 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
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • checkpoints
  • compliance
  • Protected context
  • corporateActions
  • did
  • documents
  • issuance
  • offerings
  • settlements
  • ticker
  • tokenHolders
  • transferRestrictions
  • uuid
  • Methods
  • controllerTransfer
  • createdAt
  • currentFundingRound
  • details
  • freeze
  • getIdentifiers
  • investorCount
  • isEqual
  • isFrozen
  • modify
  • modifyPrimaryIssuanceAgent
  • redeem
  • removePrimaryIssuanceAgent
  • transferOwnership
  • unfreeze
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

SecurityToken

PreviousSchedulesNextSettlements

Last updated 3 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

corporateActions

did

• did: string

identity id of the Security Token

documents

issuance

offerings

settlements

ticker

• ticker: string

ticker of the Security Token

tokenHolders

transferRestrictions

uuid

• uuid: string

Methods

controllerTransfer

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

note required role:

  • Security Token Primary Issuance Agent

Parameters:

Name

Type

args

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

freeze

Freezes transfers and minting of the Security Token

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

void

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

modify

Modify some properties of the Security Token

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

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

modifyPrimaryIssuanceAgent

Assign a new primary issuance agent for the Security Token

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

Parameters:

Name

Type

args

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

Parameters:

Name

Type

args

removePrimaryIssuanceAgent

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

Parameters:

Name

Type

args

void

transferOwnership

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

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

unfreeze

Unfreeze transfers and minting of the Security Token

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

void

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

• checkpoints:

Defined in

Defined in

• context:

Inherited from .

Defined in

• corporateActions:

Defined in

Defined in

• documents:

Defined in

• issuance:

Defined in

• offerings:

Defined in

• settlements:

Defined in

Defined in

• tokenHolders:

Defined in

• transferRestrictions:

Defined in

Inherited from .

Defined in

▸ controllerTransfer(args: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call controllerTransfer.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ 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‹›

▸ freeze(args: void): Promise‹‹››

Defined in

note this method is of type , which means you can call freeze.checkAuthorization on it to see whether the Current Account has the required permissions to run it

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: ‹unknown›): boolean

Inherited from .

Defined in

‹unknown›

Defined in

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

Defined in

‹boolean›

Returns: Promise‹›

▸ modify(args: ): Promise‹‹››

Defined in

note this method is of type , which means you can call modify.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹››

▸ modifyPrimaryIssuanceAgent(args: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call modifyPrimaryIssuanceAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ redeem(args: ): Promise‹‹void››

Defined in

note this method is of type , which means you can call redeem.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ removePrimaryIssuanceAgent(args: void): Promise‹‹void››

Defined in

note this method is of type , which means you can call removePrimaryIssuanceAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ transferOwnership(args: ): Promise‹‹››

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

note this method is of type , which means you can call transferOwnership.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹››

▸ unfreeze(args: void): Promise‹‹››

Defined in

note this method is of type , which means you can call unfreeze.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹››

Inherited from .

Defined in

Inherited from .

Defined in

Checkpoints
src/api/entities/SecurityToken/index.ts:100
src/api/entities/SecurityToken/index.ts:97
Context
src/api/entities/Entity.ts:48
CorporateActions
src/api/entities/SecurityToken/index.ts:101
src/api/entities/SecurityToken/index.ts:85
Documents
src/api/entities/SecurityToken/index.ts:93
Issuance
src/api/entities/SecurityToken/index.ts:96
Offerings
src/api/entities/SecurityToken/index.ts:99
Settlements
src/api/entities/SecurityToken/index.ts:94
src/api/entities/SecurityToken/index.ts:90
TokenHolders
src/api/entities/SecurityToken/index.ts:95
TransferRestrictions
src/api/entities/SecurityToken/index.ts:98
src/api/entities/Entity.ts:46
ControllerTransferParams
TransactionQueue
src/api/entities/SecurityToken/index.ts:496
ProcedureMethod
TransactionQueue
EventIdentifier
src/api/entities/SecurityToken/index.ts:324
EventIdentifier
src/api/entities/SecurityToken/index.ts:254
src/api/entities/SecurityToken/index.ts:255
SecurityTokenDetails
src/api/entities/SecurityToken/index.ts:196
SecurityTokenDetails
src/api/entities/SecurityToken/index.ts:197
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/index.ts:349
ProcedureMethod
TransactionQueue
SecurityToken
TokenIdentifier
src/api/entities/SecurityToken/index.ts:288
TokenIdentifier
src/api/entities/SecurityToken/index.ts:289
src/api/entities/SecurityToken/index.ts:457
src/api/entities/SecurityToken/index.ts:458
Entity
src/api/entities/Entity.ts:61
src/api/entities/SecurityToken/index.ts:371
src/api/entities/SecurityToken/index.ts:372
src/api/entities/SecurityToken/index.ts:187
ProcedureMethod
TransactionQueue
SecurityToken
ModifyPrimaryIssuanceAgentParams
TransactionQueue
src/api/entities/SecurityToken/index.ts:412
ProcedureMethod
TransactionQueue
RedeemTokenParams
TransactionQueue
src/api/entities/SecurityToken/index.ts:444
ProcedureMethod
TransactionQueue
TransactionQueue
src/api/entities/SecurityToken/index.ts:427
ProcedureMethod
TransactionQueue
TransferTokenOwnershipParams
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/index.ts:172
ProcedureMethod
TransactionQueue
SecurityToken
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/index.ts:362
ProcedureMethod
TransactionQueue
SecurityToken
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
checkpoints
compliance
context
corporateActions
did
documents
issuance
offerings
settlements
ticker
tokenHolders
transferRestrictions
uuid
controllerTransfer
createdAt
currentFundingRound
details
freeze
getIdentifiers
investorCount
isEqual
isFrozen
modify
modifyPrimaryIssuanceAgent
redeem
removePrimaryIssuanceAgent
transferOwnership
unfreeze
generateUuid
unserialize
ControllerTransferParams
Entity
ModifyPrimaryIssuanceAgentParams
RedeemTokenParams
TransferTokenOwnershipParams
CheckpointSchedule
context
CheckpointSchedule
uuid
CheckpointSchedule
isEqual
CheckpointSchedule
generateUuid
CheckpointSchedule
unserialize
SecurityTokenDetails
TokenIdentifier
TransactionQueue
SecurityToken
Authorization Requests
Accounts
SecurityTokenDetails
TokenIdentifier
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
ModifyTokenParams
SubCallback
SubCallback
SubCallback
SubCallback
SubCallback
ModifyTokenParams
Identities