SecurityToken
Last updated
Was this helpful?
Last updated
Was this helpful?
Class used to manage all the Security Token functionality
‹UniqueIdentifiers, string›
↳ SecurityToken
Protected context• did: string
identity id of the Security Token
• ticker: string
ticker of the Security Token
• uuid: string
Force a transfer from a given Portfolio to the PIA’s default Portfolio
note required role:
Security Token Primary Issuance Agent
Parameters:
Name
Type
args
opts?
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:
Name
Type
callback
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:
Name
Type
callback
Freezes transfers and minting of the Security Token
note required role:
Security Token Owner
Parameters:
Name
Type
args
void
opts?
Retrieve the Security Token's asset identifiers list
note can be subscribed to
Parameters:
Name
Type
callback?
▸ investorCount(): Promise‹number›
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›
Parameters:
Name
Type
callback
Whether this Entity is the same as another one
Parameters:
Name
Type
entity
Returns: boolean
▸ isFrozen(): Promise‹boolean›
Check whether transfers are frozen for the Security Token
note can be subscribed to
Returns: Promise‹boolean›
Parameters:
Name
Type
callback
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
Parameters:
Name
Type
args
opts?
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
Parameters:
Name
Type
args
opts?
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
Parameters:
Name
Type
args
opts?
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
Parameters:
Name
Type
args
void
opts?
â–¸ toJson(): string
Return the Token's ticker
Returns: string
Transfer ownership of the Security Token to another Identity. This generates an authorization request that must be accepted by the destinatary
note required role:
Security Token Owner
Parameters:
Name
Type
args
opts?
Unfreeze transfers and minting of the Security Token
note required role:
Security Token Owner
Parameters:
Name
Type
args
void
opts?
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
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
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
• checkpoints:
Defined in
• compliance:
Defined in
• context:
Inherited from .
Defined in
• corporateActions:
Defined in
Defined in
• documents:
Defined in
• issuance:
Defined in
• offerings:
Defined in
• permissions:
Defined in
• settlements:
Defined in
Defined in
• tokenHolders:
Defined in
• transferRestrictions:
Defined in
Inherited from .
Defined in
▸ controllerTransfer(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call controllerTransfer.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ createdAt(): Promise‹ | null›
Defined in
Returns: Promise‹ | null›
Defined in
▸ currentFundingRound(callback: ‹string›): Promise‹›
Defined in
‹string›
Returns: Promise‹›
▸ details(): Promise‹›
Defined in
Returns: Promise‹›
▸ details(callback: ‹›): Promise‹›
Defined in
‹›
Returns: Promise‹›
▸ freeze(args: void, opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call freeze.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ getIdentifiers(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getIdentifiers(callback?: ‹[]›): Promise‹›
Defined in
‹[]›
Returns: Promise‹›
Defined in
▸ investorCount(callback: ‹number›): Promise‹›
Defined in
‹number›
Returns: Promise‹›
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
Defined in
▸ isFrozen(callback: ‹boolean›): Promise‹›
Defined in
‹boolean›
Returns: Promise‹›
▸ modify(args: , opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call modify.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ modifyPrimaryIssuanceAgent(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call modifyPrimaryIssuanceAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ redeem(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call redeem.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ removePrimaryIssuanceAgent(args: void, opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call removePrimaryIssuanceAgent.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
Overrides .
Defined in
▸ transferOwnership(args: , opts?: ): 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
note this method is of type , which means you can call transferOwnership.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ unfreeze(args: void, opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call unfreeze.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
Inherited from .
Defined in
Inherited from .
Defined in