Polymesh SDK API Reference
v7.0.0
v7.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • Agent
    • 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
    • PermissionGroup
    • Permissions
    • 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
    • KnownPermissionGroup
    • KnownTokenType
    • 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
    • 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
    • GroupedInstructions
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • 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
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenPiaRole
    • TransactionPermissions
    • 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
  • permissions
  • settlements
  • ticker
  • tokenHolders
  • transferRestrictions
  • uuid
  • Methods
  • controllerTransfer
  • createdAt
  • currentFundingRound
  • details
  • freeze
  • getIdentifiers
  • investorCount
  • isEqual
  • isFrozen
  • modify
  • modifyPrimaryIssuanceAgent
  • redeem
  • removePrimaryIssuanceAgent
  • toJson
  • 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, string›

    ↳ SecurityToken

Index

Properties

Methods

Properties

checkpoints

compliance

Protected context

corporateActions

did

• did: string

identity id of the Security Token

documents

issuance

offerings

permissions

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

opts?

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

opts?

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

opts?

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

deprecated in favor of inviteAgent

Parameters:

Name

Type

args

opts?

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

opts?

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

deprecated

Parameters:

Name

Type

args

void

opts?

toJson

â–¸ toJson(): string

Return the Token's ticker

Returns: string

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

opts?

unfreeze

Unfreeze transfers and minting of the Security Token

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

void

opts?

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

• compliance:

Defined in

• context:

Inherited from .

Defined in

• corporateActions:

Defined in

Defined in

• documents:

Defined in

• issuance:

Defined in

• offerings:

Defined in

• permissions:

Defined in

• settlements:

Defined in

Defined in

• tokenHolders:

Defined in

• transferRestrictions:

Defined in

Inherited from .

Defined in

▸ controllerTransfer(args: , opts?: ): 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, opts?: ): 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, unknown›): boolean

Inherited from .

Defined in

‹unknown, unknown›

Defined in

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

Defined in

‹boolean›

Returns: Promise‹›

▸ modify(args: , opts?: ): 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: , opts?: ): 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: , opts?: ): 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, opts?: ): 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››

Overrides .

Defined in

▸ transferOwnership(args: , opts?: ): 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, opts?: ): 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:109
Compliance
src/api/entities/SecurityToken/index.ts:106
Context
src/api/entities/Entity.ts:48
CorporateActions
src/api/entities/SecurityToken/index.ts:110
src/api/entities/SecurityToken/index.ts:94
Documents
src/api/entities/SecurityToken/index.ts:102
Issuance
src/api/entities/SecurityToken/index.ts:105
Offerings
src/api/entities/SecurityToken/index.ts:108
Permissions
src/api/entities/SecurityToken/index.ts:111
Settlements
src/api/entities/SecurityToken/index.ts:103
src/api/entities/SecurityToken/index.ts:99
TokenHolders
src/api/entities/SecurityToken/index.ts:104
TransferRestrictions
src/api/entities/SecurityToken/index.ts:107
src/api/entities/Entity.ts:46
ControllerTransferParams
ProcedureOpts
TransactionQueue
src/api/entities/SecurityToken/index.ts:524
ProcedureMethod
TransactionQueue
EventIdentifier
src/api/entities/SecurityToken/index.ts:348
EventIdentifier
src/api/entities/SecurityToken/index.ts:278
src/api/entities/SecurityToken/index.ts:279
SecurityTokenDetails
src/api/entities/SecurityToken/index.ts:207
SecurityTokenDetails
src/api/entities/SecurityToken/index.ts:208
ProcedureOpts
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/index.ts:373
ProcedureMethod
TransactionQueue
SecurityToken
TokenIdentifier
src/api/entities/SecurityToken/index.ts:312
TokenIdentifier
src/api/entities/SecurityToken/index.ts:313
src/api/entities/SecurityToken/index.ts:485
src/api/entities/SecurityToken/index.ts:486
Entity
src/api/entities/Entity.ts:61
src/api/entities/SecurityToken/index.ts:395
src/api/entities/SecurityToken/index.ts:396
src/api/entities/SecurityToken/index.ts:198
ProcedureMethod
TransactionQueue
SecurityToken
ModifyPrimaryIssuanceAgentParams
ProcedureOpts
TransactionQueue
src/api/entities/SecurityToken/index.ts:438
ProcedureMethod
TransactionQueue
RedeemTokenParams
ProcedureOpts
TransactionQueue
src/api/entities/SecurityToken/index.ts:472
ProcedureMethod
TransactionQueue
ProcedureOpts
TransactionQueue
src/api/entities/SecurityToken/index.ts:455
ProcedureMethod
TransactionQueue
src/api/entities/SecurityToken/index.ts:531
TransferTokenOwnershipParams
ProcedureOpts
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/index.ts:183
Authorization Requests
Accounts
Identities
ProcedureMethod
TransactionQueue
SecurityToken
ProcedureOpts
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/index.ts:386
ProcedureMethod
TransactionQueue
SecurityToken
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
checkpoints
compliance
context
corporateActions
did
documents
issuance
offerings
permissions
settlements
ticker
tokenHolders
transferRestrictions
uuid
controllerTransfer
createdAt
currentFundingRound
details
freeze
getIdentifiers
investorCount
isEqual
isFrozen
modify
modifyPrimaryIssuanceAgent
redeem
removePrimaryIssuanceAgent
toJson
transferOwnership
unfreeze
generateUuid
unserialize
ControllerTransferParams
ProcedureOpts
ProcedureOpts
Entity
ProcedureOpts
ModifyPrimaryIssuanceAgentParams
ProcedureOpts
RedeemTokenParams
ProcedureOpts
ProcedureOpts
TransferTokenOwnershipParams
ProcedureOpts
ProcedureOpts
Entity
Entity
SecurityTokenDetails
TokenIdentifier
Entity
ProcedureOpts
TransactionQueue
SecurityToken
Entity
Entity
Entity
SecurityTokenDetails
TokenIdentifier
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
ModifyTokenParams
SubCallback
SubCallback
SubCallback
SubCallback
SubCallback
ModifyTokenParams
context
uuid
isEqual
toJson
generateUuid
unserialize