SecurityToken
Class used to manage all the Security Token functionality
Hierarchy
Entity‹UniqueIdentifiers›
↳ SecurityToken
Index
Properties
Methods
Properties
compliance
• compliance: Compliance
Defined in src/api/entities/SecurityToken/index.ts:79
Protected context
Protected context• context: Context
Defined in src/api/entities/Entity.ts:48
did
• did: string
Defined in src/api/entities/SecurityToken/index.ts:67
identity id of the Security Token
documents
• documents: Documents
Defined in src/api/entities/SecurityToken/index.ts:75
issuance
• issuance: Issuance
Defined in src/api/entities/SecurityToken/index.ts:78
settlements
• settlements: Settlements
Defined in src/api/entities/SecurityToken/index.ts:76
ticker
• ticker: string
Defined in src/api/entities/SecurityToken/index.ts:72
ticker of the Security Token
tokenHolders
• tokenHolders: TokenHolders
Defined in src/api/entities/SecurityToken/index.ts:77
uuid
• uuid: string
Defined in src/api/entities/Entity.ts:46
Methods
createdAt
▸ createdAt(): Promise‹EventIdentifier | null›
Defined in src/api/entities/SecurityToken/index.ts:257
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:187
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:188
Parameters:
Name
Type
callback
SubCallback‹string›
Returns: Promise‹UnsubCallback›
details
▸ details(): Promise‹SecurityTokenDetails›
Defined in src/api/entities/SecurityToken/index.ts:132
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:133
Parameters:
Name
Type
callback
Returns: Promise‹UnsubCallback›
freeze
▸ freeze(): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/index.ts:284
Freezes transfers and minting of the Security Token
Returns: Promise‹TransactionQueue‹SecurityToken››
getIdentifiers
▸ getIdentifiers(): Promise‹TokenIdentifier[]›
Defined in src/api/entities/SecurityToken/index.ts:221
Retrive 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:222
Parameters:
Name
Type
callback?
Returns: Promise‹UnsubCallback›
isFrozen
▸ isFrozen(): Promise‹boolean›
Defined in src/api/entities/SecurityToken/index.ts:302
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:303
Parameters:
Name
Type
callback
SubCallback‹boolean›
Returns: Promise‹UnsubCallback›
modify
▸ modify(args: ModifyTokenParams): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/index.ts:122
Modify some properties of the Security Token
throws if the passed values result in no changes being made to the token
Parameters:
Name
Type
Returns: Promise‹TransactionQueue‹SecurityToken››
modifyPrimaryIssuanceAgent
▸ modifyPrimaryIssuanceAgent(args: ModifyPrimaryIssuanceAgentParams): Promise‹TransactionQueue‹void››
Defined in src/api/entities/SecurityToken/index.ts:340
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
Returns: Promise‹TransactionQueue‹void››
removePrimaryIssuanceAgent
▸ removePrimaryIssuanceAgent(): Promise‹TransactionQueue‹void››
Defined in src/api/entities/SecurityToken/index.ts:352
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
Returns: Promise‹TransactionQueue‹void››
transferOwnership
▸ transferOwnership(args: TransferTokenOwnershipParams): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/index.ts:109
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
Parameters:
Name
Type
Returns: Promise‹TransactionQueue‹SecurityToken››
unfreeze
▸ unfreeze(): Promise‹TransactionQueue‹SecurityToken››
Defined in src/api/entities/SecurityToken/index.ts:292
Unfreeze transfers and minting of the Security Token
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: object
Parameters:
Name
Type
Description
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: object
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last updated
Was this helpful?