SecurityToken
Class used to manage all the Security Token functionality

Hierarchy

  • Entity‹UniqueIdentifiers, string›
    SecurityToken

Index

Properties

Methods

Properties

checkpoints

checkpoints: Checkpoints

compliance

compliance: Compliance

Protected context

context: Context
Inherited from Entity.context

corporateActions

corporateActions: CorporateActions

did

did: string
identity id of the Security Token

documents

documents: Documents

issuance

issuance: Issuance

offerings

offerings: Offerings

permissions

permissions: Permissions

settlements

settlements: Settlements

ticker

ticker: string
ticker of the Security Token

tokenHolders

tokenHolders: TokenHolders

transferRestrictions

transferRestrictions: TransferRestrictions

uuid

uuid: string
Inherited from Entity.uuid

Methods

controllerTransfer

controllerTransfer(args: ControllerTransferParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Force a transfer from a given Portfolio to the caller’s default Portfolio
note this method is of type ProcedureMethod, which means you can call controllerTransfer.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹void››

createdAt

createdAt(): Promise‹EventIdentifier | null›
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
Returns: Promise‹EventIdentifier | null›

currentFundingRound

currentFundingRound(): Promise‹string›
Retrieve the Security Token's funding round
note can be subscribed to
Returns: Promise‹string›
currentFundingRound(callback: SubCallback‹string›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
SubCallback‹string›
Returns: Promise‹UnsubCallback

details

details(): Promise‹SecurityTokenDetails
Retrieve the Security Token's data
note can be subscribed to
Returns: Promise‹SecurityTokenDetails
details(callback: SubCallbackSecurityTokenDetails›): Promise‹UnsubCallback
Parameters:
Name
Type
Returns: Promise‹UnsubCallback

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this Security Token exists on chain
Returns: Promise‹boolean›

freeze

freeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueSecurityToken››
Freezes transfers and minting of the Security Token
note this method is of type ProcedureMethod, which means you can call freeze.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueueSecurityToken››

getIdentifiers

getIdentifiers(): Promise‹TokenIdentifier[]›
Retrieve the Security Token's asset identifiers list
note can be subscribed to
Returns: Promise‹TokenIdentifier[]›
getIdentifiers(callback?: SubCallbackTokenIdentifier[]›): Promise‹UnsubCallback
Parameters:
Name
Type
callback?
Returns: Promise‹UnsubCallback

getOperationHistory

getOperationHistory(): Promise‹HistoricAgentOperation[]›
Retrieve this Security Token's Operation History
note Operations are grouped by the Agent Identity who performed them
note uses the middleware
Returns: Promise‹HistoricAgentOperation[]›

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›
investorCount(callback: SubCallback‹number›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
SubCallback‹number›
Returns: Promise‹UnsubCallback

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from Entity.isEqual
Determine whether this Entity is the same as another one
Parameters:
Name
Type
entity
Entity‹unknown, unknown›
Returns: boolean

isFrozen

isFrozen(): Promise‹boolean›
Check whether transfers are frozen for the Security Token
note can be subscribed to
Returns: Promise‹boolean›
isFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
SubCallback‹boolean›
Returns: Promise‹UnsubCallback

modify

modify(args: ModifyTokenParams, opts?: ProcedureOpts): Promise‹TransactionQueueSecurityToken››
Modify some properties of the Security Token
throws if the passed values result in no changes being made to the token
note this method is of type ProcedureMethod, which means you can call modify.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueueSecurityToken››

modifyPrimaryIssuanceAgent

modifyPrimaryIssuanceAgent(args: ModifyPrimaryIssuanceAgentParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
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
deprecated in favor of inviteAgent
note this method is of type ProcedureMethod, which means you can call modifyPrimaryIssuanceAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Returns: Promise‹TransactionQueue‹void››

redeem

redeem(args: RedeemTokenParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Redeem (burn) an amount of this Security Token
note Tokens are removed from the caller's Default Portfolio.
note this method is of type ProcedureMethod, which means you can call redeem.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹void››

removePrimaryIssuanceAgent

removePrimaryIssuanceAgent(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹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
deprecated
note this method is of type ProcedureMethod, which means you can call removePrimaryIssuanceAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): string
Overrides Entity.toJson
Return the Token's ticker
Returns: string

transferOwnership

transferOwnership(args: TransferTokenOwnershipParams, opts?: ProcedureOpts): Promise‹TransactionQueueSecurityToken››
Transfer ownership of the Security Token to another Identity. This generates an authorization request that must be accepted by the destinatary
note this will create Authorization Requests which have to be accepted by the corresponding Accounts and/or Identities. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived
note this method is of type ProcedureMethod, which means you can call transferOwnership.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueueSecurityToken››

unfreeze

unfreeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueSecurityToken››
Unfreeze transfers and minting of the Security Token
note this method is of type ProcedureMethod, which means you can call unfreeze.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueueSecurityToken››

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string
Inherited from Entity.generateUuid
Generate the Entity's UUID from its identifying properties
Type parameters:
Identifiers
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string

Static unserialize

unserializeIdentifiers›(serialized: string): Identifiers
Inherited from Entity.unserialize
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 3mo ago