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:47

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

Parameters:

Default value opts: object= {}

Name

Type

Description

status?

Partial‹StoStatus

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

Returns: Promise‹StoWithDetails[]›

launch

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

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

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:

Name

Type

args

LaunchStoParams

opts?

Returns: Promise‹TransactionQueueSto››

Last updated