Offerings
Namespace that handles all Offering related functionality
Hierarchy
↳ Offerings
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Offerings(securityToken: SecurityToken, context: Context): Offerings
Inherited from SubModule.constructor
Defined in src/entities/SecurityToken/SubModule.ts:10
Create a new SubModule instance
Parameters:
Returns: Offerings
Properties
Protected context
Protected context• context: Context
Inherited from SubModule.context
Defined in src/entities/SecurityToken/SubModule.ts:10
Protected securityToken
Protected securityToken• securityToken: SecurityToken
Inherited from SubModule.securityToken
Defined in src/entities/SecurityToken/SubModule.ts:8
Methods
getSto
▸ getSto(args: GetStoParams | string): Promise‹any›
Defined in src/entities/SecurityToken/Issuance/Offerings.ts:223
Retrieve an STO by type and address or UUID
Parameters:
Returns: Promise‹any›
getStos
▸ getStos(opts: object): Promise‹SimpleSto | TieredSto[]›
Defined in src/entities/SecurityToken/Issuance/Offerings.ts:260
Retrieve all STOs attached to a security token
Parameters:
▪Default value opts: object= { stoTypes: [StoType.Simple, StoType.Tiered], }
Returns: Promise‹SimpleSto | TieredSto[]›
launchSimpleSto
▸ launchSimpleSto(args: object): Promise‹TransactionQueue‹LaunchSimpleStoProcedureArgs, SimpleSto››
Defined in src/entities/SecurityToken/Issuance/Offerings.ts:168
Launch a Simple STO
Parameters:
▪ args: object
Returns: Promise‹TransactionQueue‹LaunchSimpleStoProcedureArgs, SimpleSto››
launchTieredSto
▸ launchTieredSto(args: LaunchTieredStoParams): Promise‹any›
Defined in src/entities/SecurityToken/Issuance/Offerings.ts:203
Launch a Tiered STO
Parameters:
Returns: Promise‹any›
Last updated