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

Create a new SubModule instance

Parameters:

Name

Type

securityToken

context

Returns: Offerings

Properties

Protected context

• context: Context

Inherited from SubModule.context

Protected securityToken

• securityToken: SecurityToken

Inherited from SubModule.securityToken

Methods

getSto

▸ getSto(args: GetStoParams | string): Promise‹any›

Retrieve an STO by type and address or UUID

Parameters:

Name

Type

Description

args

STO uuid or object containing its type and address

Returns: Promise‹any›

getStos

▸ getStos(opts: object): Promise‹SimpleSto | TieredSto[]›

Retrieve all STOs attached to a security token

Parameters:

â–ªDefault value opts: object= { stoTypes: [StoType.Simple, StoType.Tiered], }

Name

Type

stoTypes

Returns: Promise‹SimpleSto | TieredSto[]›

launchSimpleSto

▸ launchSimpleSto(args: object): Promise‹TransactionQueue‹LaunchSimpleStoProcedureArgs, SimpleSto››

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›

Launch a Tiered STO

Parameters:

Name

Type

args

Returns: Promise‹any›

Previousentities/SecurityToken/Issuance/OfferingsNextGetStoMethod

Last updated

Was this helpful?