SecurityToken
Last updated
Last updated
Class used to manage all the Security Token functionality
‹UniqueIdentifiers›
↳ SecurityToken
Protected context• did: string
identity id of the Security Token
• ticker: string
ticker of the Security Token
• uuid: string
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
▸ currentFundingRound(): Promise‹string›
Retrieve the Security Token's funding round
note can be subscribed to
Returns: Promise‹string›
Parameters:
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
Parameters:
Freezes transfers and minting of the Security Token
Retrive the Security Token's asset identifiers list
note can be subscribed to
Parameters:
▸ isFrozen(): Promise‹boolean›
Check whether transfers are frozen for the Security Token
note can be subscribed to
Returns: Promise‹boolean›
Parameters:
Modify some properties of the Security Token
throws if the passed values result in no changes being made to the token
Parameters:
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:
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
Transfer ownership of the Security Token to another Identity. This generates an authorization request that must be accepted by the destinatary
Parameters:
Unfreeze transfers and minting of the Security Token
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
▪ Identifiers: object
Parameters:
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
▪ Identifiers: object
Parameters:
Returns: Identifiers
• compliance:
Defined in
• context:
Inherited from .
Defined in
Defined in
• documents:
Defined in
• issuance:
Defined in
• settlements:
Defined in
Defined in
• tokenHolders:
Defined in
Inherited from .
Defined in
▸ createdAt(): Promise‹ | null›
Defined in
Returns: Promise‹ | null›
Defined in
▸ currentFundingRound(callback: ‹string›): Promise‹›
Defined in
Returns: Promise‹›
▸ details(): Promise‹›
Defined in
Returns: Promise‹›
▸ details(callback: ‹›): Promise‹›
Defined in
Returns: Promise‹›
▸ freeze(): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ getIdentifiers(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getIdentifiers(callback?: ‹[]›): Promise‹›
Defined in
Returns: Promise‹›
Defined in
▸ isFrozen(callback: ‹boolean›): Promise‹›
Defined in
Returns: Promise‹›
▸ modify(args: ): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ modifyPrimaryIssuanceAgent(args: ): Promise‹‹void››
Defined in
Returns: Promise‹‹void››
▸ removePrimaryIssuanceAgent(): Promise‹‹void››
Defined in
Returns: Promise‹‹void››
▸ transferOwnership(args: ): Promise‹‹››
Defined in
note this will create which have to be accepted by the corresponding and/or . An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived
Returns: Promise‹‹››
▸ unfreeze(): Promise‹‹››
Defined in
Returns: Promise‹‹››
Inherited from .
Defined in
Inherited from .
Defined in
Name | Type | Description |
| Identifiers |
Name | Type | Description |
| string | UUID to unserialize |
Name | Type |
|
Name | Type |
|
Name | Type |
|
Name | Type |
|
Name | Type |
|
Name | Type |
|
Name | Type |
|
‹string›
‹›
‹[]›
‹boolean›