Polymesh SDK API Reference
v3.0.0
v3.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Claims
    • Compliance
    • Context
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • SecurityToken
    • Settlements
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferStatus
    • VenueType
  • Interfaces
    • AccountBalance
    • AccountData
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • CddProviderRole
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • Leg
    • MiddlewareConfig
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RegisterIdentityParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCustodianParams
    • SetTokenDocumentsParams
    • SimpleEnumTransactionArgument
    • TickerOwnerRole
    • TickerReservationDetails
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenDocument
    • TokenHolderOptions
    • TokenHolderProperties
    • TokenIdentifier
    • TokenOwnerRole
    • TransferPolyXParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • compliance
  • Protected context
  • did
  • documents
  • issuance
  • settlements
  • ticker
  • tokenHolders
  • uuid
  • Methods
  • createdAt
  • currentFundingRound
  • details
  • freeze
  • getIdentifiers
  • isFrozen
  • modify
  • modifyPrimaryIssuanceAgent
  • removePrimaryIssuanceAgent
  • transferOwnership
  • unfreeze
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

SecurityToken

PreviousRequirementsNextSettlements

Last updated 4 years ago

Was this helpful?

Class used to manage all the Security Token functionality

Hierarchy

  • ‹UniqueIdentifiers›

    ↳ SecurityToken

Index

Properties

Methods

Properties

compliance

Protected context

did

• did: string

identity id of the Security Token

documents

issuance

settlements

ticker

• ticker: string

ticker of the Security Token

tokenHolders

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

freeze

Freezes transfers and minting of the Security Token

getIdentifiers

Retrive the Security Token's asset identifiers list

note can be subscribed to

Parameters:

Name

Type

callback?

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

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

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

transferOwnership

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

Parameters:

Name

Type

args

unfreeze

Unfreeze transfers and minting of the Security Token

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

• compliance:

Defined in

• context:

Inherited from .

Defined in

Defined in

• documents:

Defined in

• issuance:

Defined in

• settlements:

Defined in

Defined in

• tokenHolders:

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

▸ freeze(): Promise‹‹››

Defined in

Returns: Promise‹‹››

▸ getIdentifiers(): Promise‹[]›

Defined in

Returns: Promise‹[]›

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

Defined in

‹[]›

Returns: Promise‹›

Defined in

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

Defined in

‹boolean›

Returns: Promise‹›

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

Defined in

Returns: Promise‹‹››

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

Defined in

Returns: Promise‹‹void››

▸ removePrimaryIssuanceAgent(): Promise‹‹void››

Defined in

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

Returns: Promise‹‹››

▸ unfreeze(): Promise‹‹››

Defined in

Returns: Promise‹‹››

Inherited from .

Defined in

Inherited from .

Defined in

Compliance
src/api/entities/SecurityToken/index.ts:81
Context
src/api/entities/Entity.ts:48
src/api/entities/SecurityToken/index.ts:69
Documents
src/api/entities/SecurityToken/index.ts:77
Issuance
src/api/entities/SecurityToken/index.ts:80
Settlements
src/api/entities/SecurityToken/index.ts:78
src/api/entities/SecurityToken/index.ts:74
TokenHolders
src/api/entities/SecurityToken/index.ts:79
src/api/entities/Entity.ts:46
EventIdentifier
src/api/entities/SecurityToken/index.ts:259
EventIdentifier
src/api/entities/SecurityToken/index.ts:189
src/api/entities/SecurityToken/index.ts:190
SecurityTokenDetails
src/api/entities/SecurityToken/index.ts:134
SecurityTokenDetails
src/api/entities/SecurityToken/index.ts:135
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/index.ts:286
TransactionQueue
SecurityToken
TokenIdentifier
src/api/entities/SecurityToken/index.ts:223
TokenIdentifier
src/api/entities/SecurityToken/index.ts:224
src/api/entities/SecurityToken/index.ts:304
src/api/entities/SecurityToken/index.ts:305
src/api/entities/SecurityToken/index.ts:124
TransactionQueue
SecurityToken
ModifyPrimaryIssuanceAgentParams
TransactionQueue
src/api/entities/SecurityToken/index.ts:342
TransactionQueue
TransactionQueue
src/api/entities/SecurityToken/index.ts:354
TransactionQueue
TransferTokenOwnershipParams
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/index.ts:111
Authorization Requests
Accounts
Identities
TransactionQueue
SecurityToken
TransactionQueue
SecurityToken
src/api/entities/SecurityToken/index.ts:294
TransactionQueue
SecurityToken
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
compliance
context
did
documents
issuance
settlements
ticker
tokenHolders
uuid
createdAt
currentFundingRound
details
freeze
getIdentifiers
isFrozen
modify
modifyPrimaryIssuanceAgent
removePrimaryIssuanceAgent
transferOwnership
unfreeze
generateUuid
unserialize
ModifyPrimaryIssuanceAgentParams
TransferTokenOwnershipParams
Entity
Entity
SecurityTokenDetails
TokenIdentifier
TransactionQueue
SecurityToken
Entity
Entity
SecurityTokenDetails
TokenIdentifier
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
SubCallback
UnsubCallback
UnsubCallback
ModifyTokenParams
SubCallback
SubCallback
SubCallback
SubCallback
ModifyTokenParams
context
uuid
generateUuid
unserialize