Offerings

Namespace that handles all Offering related functionality

Hierarchy

• SubModule

  ↳ Offerings

Index

Constructors

• constructor

Properties

• context

• securityToken

Methods

• getSto

• getStos

• launchSimpleSto

• launchTieredSto

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:

Name	Type
securityToken	SecurityToken
context	Context

Returns: Offerings

Properties

Protected context

• context: Context

Inherited from SubModule.context

Defined in src/entities/SecurityToken/SubModule.ts:10

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:

Name	Type	Description
args	GetStoParams | string	STO uuid or object containing its type and address

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], }

Name	Type
stoTypes	StoType[]

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

Name	Type
allowPreIssuance?	undefined | false | true
currency	Currency.ETH | Currency.POLY
endDate	Date
raisedFundsWallet	string
rate	BigNumber
startDate	Date
tokensOnSale	BigNumber
unsoldTokensWallet	string

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:

Name	Type
args	LaunchTieredStoParams

Returns: Promise‹any›