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:114
compliance
• compliance: Compliance
Defined in src/api/entities/SecurityToken/index.ts:111
Protected context
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
corporateActions
• corporateActions: CorporateActions
Defined in src/api/entities/SecurityToken/index.ts:115
did
• did: string
Defined in src/api/entities/SecurityToken/index.ts:99
identity id of the Security Token
documents
• documents: Documents
Defined in src/api/entities/SecurityToken/index.ts:107
issuance
• issuance: Issuance
Defined in src/api/entities/SecurityToken/index.ts:110
offerings
• offerings: Offerings
Defined in src/api/entities/SecurityToken/index.ts:113
permissions
• permissions: Permissions
Defined in src/api/entities/SecurityToken/index.ts:116
settlements
• settlements: Settlements
Defined in src/api/entities/SecurityToken/index.ts:108
ticker
• ticker: string
Defined in src/api/entities/SecurityToken/index.ts:104
ticker of the Security Token
tokenHolders
• tokenHolders: TokenHolders
Defined in src/api/entities/SecurityToken/index.ts:109
transferRestrictions
• transferRestrictions: TransferRestrictions
Defined in src/api/entities/SecurityToken/index.ts:112
uuid
• uuid: string
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:531
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:
args
opts?
Returns: Promise‹TransactionQueue‹void››
createdAt
▸ createdAt(): Promise‹EventIdentifier | null›
Defined in src/api/entities/SecurityToken/index.ts:375
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:305
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:306
Parameters:
callback
Returns: Promise‹UnsubCallback›
details
▸ details(): Promise‹SecurityTokenDetails›
Defined in src/api/entities/SecurityToken/index.ts:206
Retrieve the Security Token's data
note can be subscribed to
Returns: Promise‹SecurityTokenDetails›
▸ details(callback: SubCallback‹SecurityTokenDetails›): Promise‹UnsubCallback›
Defined in src/api/entities/SecurityToken/index.ts:207
Parameters:
callback
Returns: Promise‹UnsubCallback›
exists
▸ exists(): Promise‹boolean›
Defined in src/api/entities/SecurityToken/index.ts:568
Determine whether this Security Token exists on chain
Returns: Promise‹boolean›
freeze
▸ freeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/index.ts:397
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:
args
void
opts?
Returns: Promise‹TransactionQueue‹SecurityToken››
getIdentifiers
▸ getIdentifiers(): Promise‹TokenIdentifier[]›
Defined in src/api/entities/SecurityToken/index.ts:339
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:340
Parameters:
callback?
Returns: Promise‹UnsubCallback›
getOperationHistory
▸ getOperationHistory(): Promise‹HistoricAgentOperation[]›
Defined in src/api/entities/SecurityToken/index.ts:542
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›
Defined in src/api/entities/SecurityToken/index.ts:495
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:496
Parameters:
callback
Returns: Promise‹UnsubCallback›
isEqual
▸ isEqual(entity: Entity‹unknown, unknown›): boolean
Defined in src/api/entities/Entity.ts:61
Determine whether this Entity is the same as another one
Parameters:
entity
Returns: boolean
isFrozen
▸ isFrozen(): Promise‹boolean›
Defined in src/api/entities/SecurityToken/index.ts:416
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:417
Parameters:
callback
Returns: Promise‹UnsubCallback›
modify
▸ modify(args: ModifyTokenParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/index.ts:197
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:
args
opts?
Returns: Promise‹TransactionQueue‹SecurityToken››
modifyPrimaryIssuanceAgent
▸ modifyPrimaryIssuanceAgent(args: ModifyPrimaryIssuanceAgentParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/SecurityToken/index.ts:456
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:
args
opts?
Returns: Promise‹TransactionQueue‹void››
redeem
▸ redeem(args: RedeemTokenParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/SecurityToken/index.ts:482
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:
args
opts?
Returns: Promise‹TransactionQueue‹void››
removePrimaryIssuanceAgent
▸ removePrimaryIssuanceAgent(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
Defined in src/api/entities/SecurityToken/index.ts:470
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:
args
void
opts?
Returns: Promise‹TransactionQueue‹void››
toJson
▸ toJson(): string
Defined in src/api/entities/SecurityToken/index.ts:581
Return the Token's ticker
Returns: string
transferOwnership
▸ transferOwnership(args: TransferTokenOwnershipParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/index.ts:185
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:
args
opts?
Returns: Promise‹TransactionQueue‹SecurityToken››
unfreeze
▸ unfreeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/index.ts:407
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:
args
void
opts?
Returns: Promise‹TransactionQueue‹SecurityToken››
Static generateUuid
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:
identifiers
Identifiers
Returns: string
Static unserialize
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:
serialized
string
UUID to unserialize
Returns: Identifiers
Last updated