SecurityToken

Class used to manage all the Security Token functionality

Hierarchy

  • Entity‹UniqueIdentifiers, string›

    SecurityToken

Index

Properties

Methods

Properties

checkpoints

checkpoints: Checkpoints

Defined in src/api/entities/SecurityToken/index.ts:109

compliance

compliance: Compliance

Defined in src/api/entities/SecurityToken/index.ts:106

Protected context

context: Context

Inherited from Entity.context

Defined in src/api/entities/Entity.ts:48

corporateActions

corporateActions: CorporateActions

Defined in src/api/entities/SecurityToken/index.ts:110

did

did: string

Defined in src/api/entities/SecurityToken/index.ts:94

identity id of the Security Token

documents

documents: Documents

Defined in src/api/entities/SecurityToken/index.ts:102

issuance

issuance: Issuance

Defined in src/api/entities/SecurityToken/index.ts:105

offerings

offerings: Offerings

Defined in src/api/entities/SecurityToken/index.ts:108

permissions

permissions: Permissions

Defined in src/api/entities/SecurityToken/index.ts:111

settlements

settlements: Settlements

Defined in src/api/entities/SecurityToken/index.ts:103

ticker

ticker: string

Defined in src/api/entities/SecurityToken/index.ts:99

ticker of the Security Token

tokenHolders

tokenHolders: TokenHolders

Defined in src/api/entities/SecurityToken/index.ts:104

transferRestrictions

transferRestrictions: TransferRestrictions

Defined in src/api/entities/SecurityToken/index.ts:107

uuid

uuid: string

Inherited from Entity.uuid

Defined in src/api/entities/Entity.ts:46

Methods

controllerTransfer

controllerTransfer(args: ControllerTransferParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/SecurityToken/index.ts:498

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

args

ControllerTransferParams

opts?

ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

createdAt

createdAt(): Promise‹EventIdentifier | null›

Defined in src/api/entities/SecurityToken/index.ts:342

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›

Defined in src/api/entities/SecurityToken/index.ts:272

Retrieve the Security Token's funding round

note can be subscribed to

Returns: Promise‹string›

currentFundingRound(callback: SubCallback‹string›): Promise‹UnsubCallback

Defined in src/api/entities/SecurityToken/index.ts:273

Parameters:

Name

Type

callback

SubCallback‹string›

Returns: Promise‹UnsubCallback

details

details(): Promise‹SecurityTokenDetails

Defined in src/api/entities/SecurityToken/index.ts:201

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

Returns: Promise‹SecurityTokenDetails

details(callback: SubCallbackSecurityTokenDetails›): Promise‹UnsubCallback

Defined in src/api/entities/SecurityToken/index.ts:202

Parameters:

Name

Type

callback

SubCallbackSecurityTokenDetails

Returns: Promise‹UnsubCallback

freeze

freeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueSecurityToken››

Defined in src/api/entities/SecurityToken/index.ts:364

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?

ProcedureOpts

Returns: Promise‹TransactionQueueSecurityToken››

getIdentifiers

getIdentifiers(): Promise‹TokenIdentifier[]›

Defined in src/api/entities/SecurityToken/index.ts:306

Retrieve the Security Token's asset identifiers list

note can be subscribed to

Returns: Promise‹TokenIdentifier[]›

getIdentifiers(callback?: SubCallbackTokenIdentifier[]›): Promise‹UnsubCallback

Defined in src/api/entities/SecurityToken/index.ts:307

Parameters:

Name

Type

callback?

SubCallbackTokenIdentifier[]›

Returns: Promise‹UnsubCallback

investorCount

investorCount(): Promise‹number›

Defined in src/api/entities/SecurityToken/index.ts:462

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

Defined in src/api/entities/SecurityToken/index.ts:463

Parameters:

Name

Type

callback

SubCallback‹number›

Returns: Promise‹UnsubCallback

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from Entity.isEqual

Defined in src/api/entities/Entity.ts:61

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Entity‹unknown, unknown›

Returns: boolean

isFrozen

isFrozen(): Promise‹boolean›

Defined in src/api/entities/SecurityToken/index.ts:383

Check whether transfers are frozen for the Security Token

note can be subscribed to

Returns: Promise‹boolean›

isFrozen(callback: SubCallback‹boolean›): Promise‹UnsubCallback

Defined in src/api/entities/SecurityToken/index.ts:384

Parameters:

Name

Type

callback

SubCallback‹boolean›

Returns: Promise‹UnsubCallback

modify

modify(args: ModifyTokenParams, opts?: ProcedureOpts): Promise‹TransactionQueueSecurityToken››

Defined in src/api/entities/SecurityToken/index.ts:192

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

args

ModifyTokenParams

opts?

ProcedureOpts

Returns: Promise‹TransactionQueueSecurityToken››

modifyPrimaryIssuanceAgent

modifyPrimaryIssuanceAgent(args: ModifyPrimaryIssuanceAgentParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/SecurityToken/index.ts:423

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

Defined in src/api/entities/SecurityToken/index.ts:449

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

args

RedeemTokenParams

opts?

ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

removePrimaryIssuanceAgent

removePrimaryIssuanceAgent(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/SecurityToken/index.ts:437

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?

ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): string

Overrides Entity.toJson

Defined in src/api/entities/SecurityToken/index.ts:505

Return the Token's ticker

Returns: string

transferOwnership

transferOwnership(args: TransferTokenOwnershipParams, opts?: ProcedureOpts): Promise‹TransactionQueueSecurityToken››

Defined in src/api/entities/SecurityToken/index.ts:180

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

args

TransferTokenOwnershipParams

opts?

ProcedureOpts

Returns: Promise‹TransactionQueueSecurityToken››

unfreeze

unfreeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueSecurityToken››

Defined in src/api/entities/SecurityToken/index.ts:374

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?

ProcedureOpts

Returns: Promise‹TransactionQueueSecurityToken››

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from Entity.generateUuid

Defined in src/api/entities/Entity.ts:14

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

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

Identifiers

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers