Issuance
Namespace that handles all Issuance related functionality
Hierarchy
↳ Issuance
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Issuance(securityToken
: SecurityToken, context
: Context): Issuance
Overrides SubModule.constructor
Defined in src/entities/SecurityToken/Issuance/Issuance.ts:14
Create a new Issuance instance
Parameters:
Name | Type |
| |
|
Returns: Issuance
Properties
Protected
context
Protected
context• context: Context
Inherited from SubModule.context
Defined in src/entities/SecurityToken/SubModule.ts:10
offerings
• offerings: Offerings
Defined in src/entities/SecurityToken/Issuance/Issuance.ts:14
Protected
securityToken
Protected
securityToken• securityToken: SecurityToken
Inherited from SubModule.securityToken
Defined in src/entities/SecurityToken/SubModule.ts:8
Methods
allowed
▸ allowed(): Promise‹Boolean›
Defined in src/entities/SecurityToken/Issuance/Issuance.ts:73
Retrieve whether the issuance of tokens is allowed or not Can be permanently frozen with freeze
Returns: Promise‹Boolean›
freeze
▸ freeze(args?
: undefined | object): Promise‹TransactionQueue‹FreezeIssuanceProcedureArgs, void››
Defined in src/entities/SecurityToken/Issuance/Issuance.ts:48
Permanently freeze issuance of the security token
Parameters:
Name | Type |
| undefined | object |
Returns: Promise‹TransactionQueue‹FreezeIssuanceProcedureArgs, void››
issue
▸ issue(args
: object): Promise‹TransactionQueue‹IssueTokensProcedureArgs, Tokenholder[]››
Defined in src/entities/SecurityToken/Issuance/Issuance.ts:32
Issue a certain amount of tokens to an address. The address must already have been added via modifyData
. Otherwise, the corresponding tokenholder data for that address must be supplied to this method NOTE: If tokenholder data is supplied, client-side validations to verify if the transfer is possible won't be performed
Parameters:
▪ args: object
Name | Type |
|
Returns: Promise‹TransactionQueue‹IssueTokensProcedureArgs, Tokenholder[]››
signFreezeAck
▸ signFreezeAck(): Promise‹TransactionQueue‹SignFreezeIssuanceAckProcedureArgs, void››
Defined in src/entities/SecurityToken/Issuance/Issuance.ts:61
Generate a signature string that can be used to permanently freeze issuance of the Security Token
Note that only the owner's signature is valid for this operation
Returns: Promise‹TransactionQueue‹SignFreezeIssuanceAckProcedureArgs, void››
Last updated