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:348

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:278

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:279

Parameters:

Name

Type

callback

SubCallback‹string›

Returns: Promise‹UnsubCallback›

details

▸ details(): Promise‹SecurityTokenDetails›

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

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: SubCallback‹SecurityTokenDetails›): Promise‹UnsubCallback›

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

Parameters:

Name

Type

callback

SubCallback‹SecurityTokenDetails›

Returns: Promise‹UnsubCallback›

freeze

▸ freeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››

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

Freezes transfers and minting of the Security Token

note required role:

Security Token Owner

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

getIdentifiers

▸ getIdentifiers(): Promise‹TokenIdentifier[]›

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

Retrieve the Security Token's asset identifiers list

note can be subscribed to

Returns: Promise‹TokenIdentifier[]›

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

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

Parameters:

Name

Type

callback?

SubCallback‹TokenIdentifier[]›

Returns: Promise‹UnsubCallback›

investorCount

▸ investorCount(): Promise‹number›

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

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:486

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:395

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:396

Parameters:

Name

Type

callback

SubCallback‹boolean›

Returns: Promise‹UnsubCallback›

modify

▸ modify(args: ModifyTokenParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››

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

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

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

modifyPrimaryIssuanceAgent

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

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

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

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:

Name

Type

args

ModifyPrimaryIssuanceAgentParams

opts?

ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

redeem

▸ redeem(args: RedeemTokenParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

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

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:455

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

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:531

Return the Token's ticker

Returns: string

transferOwnership

▸ transferOwnership(args: TransferTokenOwnershipParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››

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

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 required role:

Security Token Owner

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

unfreeze

▸ unfreeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››

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

Unfreeze transfers and minting of the Security Token

note required role:

Security Token Owner

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

`Static` generateUuid

▸ generateUuid‹Identifiers›(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

▸ unserialize‹Identifiers›(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

PreviousSchedules NextSettlements

Last updated 2 years ago

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

`Protected` context

`Static` generateUuid

`Static` unserialize