> For the complete documentation index, see [llms.txt](https://developers.polymath.network/classic-sdk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/classic-sdk/external-modules/_entities_securitytoken_issuance_offerings_.offerings.md).

# Offerings

Namespace that handles all Offering related functionality

## Hierarchy

* [SubModule](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md)

  ↳ **Offerings**

## Index

### Constructors

* [constructor](/classic-sdk/classes/_entities_securitytoken_issuance_offerings_.offerings.md#constructor)

### Properties

* [context](/classic-sdk/classes/_entities_securitytoken_issuance_offerings_.offerings.md#protected-context)
* [securityToken](/classic-sdk/classes/_entities_securitytoken_issuance_offerings_.offerings.md#protected-securitytoken)

### Methods

* [getSto](/classic-sdk/classes/_entities_securitytoken_issuance_offerings_.offerings.md#getsto)
* [getStos](/classic-sdk/classes/_entities_securitytoken_issuance_offerings_.offerings.md#getstos)
* [launchSimpleSto](/classic-sdk/classes/_entities_securitytoken_issuance_offerings_.offerings.md#launchsimplesto)
* [launchTieredSto](/classic-sdk/classes/_entities_securitytoken_issuance_offerings_.offerings.md#launchtieredsto)

## Constructors

### constructor

\+ **new Offerings**(`securityToken`: [SecurityToken](/classic-sdk/classes/_entities_securitytoken_securitytoken_.securitytoken.md), `context`: [Context](/classic-sdk/classes/_context_.context.md)): [*Offerings*](/classic-sdk/classes/_entities_securitytoken_issuance_offerings_.offerings.md)

*Inherited from* [*SubModule*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md)*.*[*constructor*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md#constructor)

*Defined in* [*src/entities/SecurityToken/SubModule.ts:10*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)

Create a new SubModule instance

**Parameters:**

| Name            | Type                                                                                          |
| --------------- | --------------------------------------------------------------------------------------------- |
| `securityToken` | [SecurityToken](/classic-sdk/classes/_entities_securitytoken_securitytoken_.securitytoken.md) |
| `context`       | [Context](/classic-sdk/classes/_context_.context.md)                                          |

**Returns:** [*Offerings*](/classic-sdk/classes/_entities_securitytoken_issuance_offerings_.offerings.md)

## Properties

### `Protected` context

• **context**: [*Context*](/classic-sdk/classes/_context_.context.md)

*Inherited from* [*SubModule*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md)*.*[*context*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md#protected-context)

*Defined in* [*src/entities/SecurityToken/SubModule.ts:10*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L10)

### `Protected` securityToken

• **securityToken**: [*SecurityToken*](/classic-sdk/classes/_entities_securitytoken_securitytoken_.securitytoken.md)

*Inherited from* [*SubModule*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md)*.*[*securityToken*](/classic-sdk/classes/_entities_securitytoken_submodule_.submodule.md#protected-securitytoken)

*Defined in* [*src/entities/SecurityToken/SubModule.ts:8*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/SubModule.ts#L8)

## Methods

### getSto

▸ **getSto**(`args`: [GetStoParams](/classic-sdk/interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md) | string): *Promise‹any›*

*Defined in* [*src/entities/SecurityToken/Issuance/Offerings.ts:223*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L223)

Retrieve an STO by type and address or UUID

**Parameters:**

| Name   | Type                                                                                                          | Description                                        |
| ------ | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `args` | [GetStoParams](/classic-sdk/interfaces/_entities_securitytoken_issuance_offerings_.getstoparams.md) \| string | STO uuid or object containing its type and address |

**Returns:** *Promise‹any›*

### getStos

▸ **getStos**(`opts`: object): *Promise‹*[*SimpleSto*](/classic-sdk/classes/_entities_simplesto_.simplesto.md) *|* [*TieredSto*](/classic-sdk/classes/_entities_tieredsto_.tieredsto.md)*\[]›*

*Defined in* [*src/entities/SecurityToken/Issuance/Offerings.ts:260*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L260)

Retrieve all STOs attached to a security token

**Parameters:**

▪`Default value` **opts**: *object*= { stoTypes: \[StoType.Simple, StoType.Tiered], }

| Name       | Type                                                      |
| ---------- | --------------------------------------------------------- |
| `stoTypes` | [StoType](/classic-sdk/enums/_types_index_.stotype.md)\[] |

**Returns:** *Promise‹*[*SimpleSto*](/classic-sdk/classes/_entities_simplesto_.simplesto.md) *|* [*TieredSto*](/classic-sdk/classes/_entities_tieredsto_.tieredsto.md)*\[]›*

### launchSimpleSto

▸ **launchSimpleSto**(`args`: object): *Promise‹*[*TransactionQueue*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*LaunchSimpleStoProcedureArgs*](/classic-sdk/interfaces/_types_index_.launchsimplestoprocedureargs.md)*,* [*SimpleSto*](/classic-sdk/classes/_entities_simplesto_.simplesto.md)*››*

*Defined in* [*src/entities/SecurityToken/Issuance/Offerings.ts:168*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L168)

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*](/classic-sdk/classes/_entities_transactionqueue_.transactionqueue.md)*‹*[*LaunchSimpleStoProcedureArgs*](/classic-sdk/interfaces/_types_index_.launchsimplestoprocedureargs.md)*,* [*SimpleSto*](/classic-sdk/classes/_entities_simplesto_.simplesto.md)*››*

### launchTieredSto

▸ **launchTieredSto**(`args`: [LaunchTieredStoParams](/classic-sdk/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md)): *Promise‹any›*

*Defined in* [*src/entities/SecurityToken/Issuance/Offerings.ts:203*](https://github.com/PolymathNetwork/polymath-sdk/blob/e8bbc1e/src/entities/SecurityToken/Issuance/Offerings.ts#L203)

Launch a Tiered STO

**Parameters:**

| Name   | Type                                                                                                                  |
| ------ | --------------------------------------------------------------------------------------------------------------------- |
| `args` | [LaunchTieredStoParams](/classic-sdk/interfaces/_entities_securitytoken_issuance_offerings_.launchtieredstoparams.md) |

**Returns:** *Promise‹any›*