Polymesh SDK API Reference
v12.0.2
v12.0.2
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • Protected parent
  • Methods
  • get
  • getOne
  • launch

Was this helpful?

  1. Classes

Offerings

PreviousNumberedPortfolioNextPercentage

Last updated 3 years ago

Was this helpful?

Handles all Security Token Offering related functionality

Hierarchy

  • Namespace‹›

    ↳ Offerings

Index

Properties

Methods

Properties

Protected context

Inherited from void


Protected parent

Inherited from void

Methods

get

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

Parameters:

▪Default value opts: object= {}

Name
Type
Description

status?

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


getOne

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

Name
Type

id

BigNumber


launch

Launch a Security Token Offering

note required roles:

  • Offering Portfolio Custodian

  • Raising Portfolio Custodian

Parameters:

Name
Type

args

LaunchStoParams

opts?

• context:

Defined in

• parent:

Defined in

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

Defined in

Partial‹›

Returns: Promise‹[]›

▸ getOne(args: object): Promise‹›

Defined in

Returns: Promise‹›

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

Defined in

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

Returns: Promise‹‹››

Context
src/api/entities/Namespace.ts:11
SecurityToken
src/api/entities/Namespace.ts:9
StoWithDetails
src/api/entities/SecurityToken/Offerings.ts:81
StoWithDetails
Sto
src/api/entities/SecurityToken/Offerings.ts:56
Sto
ProcedureOpts
TransactionQueue
Sto
src/api/entities/SecurityToken/Offerings.ts:47
ProcedureMethod
TransactionQueue
Sto
SecurityToken
context
parent
get
getOne
launch
StoStatus
ProcedureOpts