Offerings

Handles all Security Token Offering related functionality

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11


Protected parent

parent: SecurityToken

Inherited from void

Defined in src/api/entities/Namespace.ts:9

Methods

get

get(opts: object): Promise‹StoWithDetails[]›

Defined in src/api/entities/SecurityToken/Offerings.ts:81

Retrieve all of the Token's Offerings and their details. Can be filtered using parameters

Parameters:

Default value opts: object= {}

NameTypeDescription

status?

Partial‹StoStatus

status of the offerings to fetch. If defined, only STOs that have all passed statuses will be returned

Returns: Promise‹StoWithDetails[]›


getOne

getOne(args: object): Promise‹Sto

Defined in src/api/entities/SecurityToken/Offerings.ts:56

Retrieve a single Offering associated to this Security Token by its ID

throws if there is no Offering with the passed ID

Parameters:

args: object

NameType

id

BigNumber

Returns: Promise‹Sto


launch

launch(args: LaunchStoParams, opts?: ProcedureOpts): Promise‹TransactionQueueSto››

Defined in src/api/entities/SecurityToken/Offerings.ts:47

Launch a Security Token Offering

note required roles:

  • Offering Portfolio Custodian

  • Raising Portfolio Custodian

note this method is of type ProcedureMethod, which means you can call launch.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

NameType

args

LaunchStoParams

opts?

Returns: Promise‹TransactionQueueSto››

Last updated