TieredSto

Used to manage a tiered sto

Hierarchy

↳ Sto‹Params›

↳ TieredSto

Index

Constructors

• constructor

Properties

• address

• beneficialInvestmentsAllowed

• capReached

• context

• currentTier

• endDate

• fundraiseCurrencies

• investorCount

• isFinalized

• isPaused

• minimumInvestment

• nonAccreditedInvestmentLimit

• preIssueAllowed

• raisedAmount

• raisedFundsWallet

• securityTokenId

• securityTokenSymbol

• soldTokensAmount

• stableCoinAddresses

• startDate

• stoType

• tiers

• uid

• unsoldTokensWallet

Methods

• _refresh

• allowBeneficialInvestments

• allowPreIssuing

• assignRole

• disallowBeneficialInvestments

• disallowPreIssuing

• finalize

• getCurrency

• getInvestments

• invest

• modifyData

• pause

• revokeRole

• toPojo

• unpause

• generateId

• unserialize

Constructors

constructor

+ new TieredSto(params: Params & UniqueIdentifiers, context: Context): TieredSto

Overrides Sto.constructor

Defined in src/entities/TieredSto.ts:151

Create a new tiered sto instance

Parameters:

Name	Type
params	Params & UniqueIdentifiers
context	Context

Returns: TieredSto

Properties

address

• address: string

Inherited from Sto.address

Defined in src/entities/Sto.ts:107

ethereum address for the STO

beneficialInvestmentsAllowed

• beneficialInvestmentsAllowed: boolean

Inherited from Sto.beneficialInvestmentsAllowed

Defined in src/entities/Sto.ts:175

whether investments can be made on behalf of a beneficiary or not

capReached

• capReached: boolean

Inherited from Sto.capReached

Defined in src/entities/Sto.ts:160

whether the STO cap has been reached or not

Protected context

• context: Context

Inherited from Sto.context

Defined in src/entities/Sto.ts:177

currentTier

• currentTier: number

Defined in src/entities/TieredSto.ts:134

index of the current active tier

endDate

• endDate: Date

Inherited from Sto.endDate

Defined in src/entities/Sto.ts:120

fundraiseCurrencies

• fundraiseCurrencies: Currency[]

Inherited from Sto.fundraiseCurrencies

Defined in src/entities/Sto.ts:150

types of currency in which funds can be raised

investorCount

• investorCount: number

Inherited from Sto.investorCount

Defined in src/entities/Sto.ts:145

number of investors that have purchased tokens in the STO

isFinalized

• isFinalized: boolean

Inherited from Sto.isFinalized

Defined in src/entities/Sto.ts:165

whether the STO has been finalized or not

isPaused

• isPaused: boolean

Inherited from Sto.isPaused

Defined in src/entities/Sto.ts:155

whether the STO is currently paused or not

minimumInvestment

• minimumInvestment: BigNumber

Defined in src/entities/TieredSto.ts:141

nonAccreditedInvestmentLimit

• nonAccreditedInvestmentLimit: BigNumber

Defined in src/entities/TieredSto.ts:139

maximum investment allowed for non-accredited investors

preIssueAllowed

• preIssueAllowed: boolean

Inherited from Sto.preIssueAllowed

Defined in src/entities/Sto.ts:170

whether all tokens due to be sold are issued when the STO starts. If false, the appropriate amount of tokens is issued to the buyer whenever a sale is made

raisedAmount

• raisedAmount: BigNumber

Inherited from Sto.raisedAmount

Defined in src/entities/Sto.ts:135

amount of funds that have been raised so far

raisedFundsWallet

• raisedFundsWallet: string

Inherited from Sto.raisedFundsWallet

Defined in src/entities/Sto.ts:125

wallet where raised funds will be forwarded to

securityTokenId

• securityTokenId: string

Inherited from Sto.securityTokenId

Defined in src/entities/Sto.ts:111

securityTokenSymbol

• securityTokenSymbol: string

Inherited from Sto.securityTokenSymbol

Defined in src/entities/Sto.ts:109

soldTokensAmount

• soldTokensAmount: BigNumber

Inherited from Sto.soldTokensAmount

Defined in src/entities/Sto.ts:140

total number of tokens that have been sold so far

stableCoinAddresses

• stableCoinAddresses: string[]

Defined in src/entities/TieredSto.ts:146

array of Stable Coin ERC20 tokens that can be used to purchase tokens in this Offering

startDate

• startDate: Date

Inherited from Sto.startDate

Defined in src/entities/Sto.ts:118

stoType

• stoType: StoType

Inherited from Sto.stoType

Defined in src/entities/Sto.ts:116

type of STO setup

tiers

• tiers: Tier[]

Defined in src/entities/TieredSto.ts:151

array of tier information

uid

• uid: string

Overrides Sto.uid

Defined in src/entities/TieredSto.ts:129

unique generated Tiered STO id

unsoldTokensWallet

• unsoldTokensWallet: string

Inherited from Sto.unsoldTokensWallet

Defined in src/entities/Sto.ts:130

wallet where unsold tokens will be returned to

Methods

_refresh

▸ _refresh(params: Partial‹Params›): void

Overrides Sto._refresh

Defined in src/entities/TieredSto.ts:349

Hydrate the entity

Parameters:

Name	Type
params	Partial‹Params›

Returns: void

allowBeneficialInvestments

▸ allowBeneficialInvestments(): Promise‹TransactionQueue‹ToggleAllowBeneficialInvestmentsProcedureArgs, void››

Inherited from Sto

Defined in src/entities/Sto.ts:316

Enable a party to invest in the STO on behalf of another party

Returns: Promise‹TransactionQueue‹ToggleAllowBeneficialInvestmentsProcedureArgs, void››

allowPreIssuing

▸ allowPreIssuing(): Promise‹TransactionQueue‹ToggleAllowPreIssuingProcedureArgs, void››

Inherited from Sto

Defined in src/entities/Sto.ts:287

Enable all offered tokens to be issued instantly at STO start (default behavior is to issue on purchase) Can be disabled BEFORE the STO starts by calling disallowPreIssuing

Returns: Promise‹TransactionQueue‹ToggleAllowPreIssuingProcedureArgs, void››

assignRole

▸ assignRole(args: object): Promise‹TransactionQueue‹AssignStoRoleProcedureArgs, void››

Inherited from Sto

Defined in src/entities/Sto.ts:348

Assign a role on the STO to a delegate

Parameters:

▪ args: object

Name	Type
delegateAddress	string
description?	undefined | string
role	StoRole

Returns: Promise‹TransactionQueue‹AssignStoRoleProcedureArgs, void››

disallowBeneficialInvestments

▸ disallowBeneficialInvestments(): Promise‹TransactionQueue‹ToggleAllowBeneficialInvestmentsProcedureArgs, void››

Inherited from Sto

Defined in src/entities/Sto.ts:330

Disable the possibility for a party to invest in the STO on behalf of another party

Returns: Promise‹TransactionQueue‹ToggleAllowBeneficialInvestmentsProcedureArgs, void››

disallowPreIssuing

▸ disallowPreIssuing(): Promise‹TransactionQueue‹ToggleAllowPreIssuingProcedureArgs, void››

Inherited from Sto

Defined in src/entities/Sto.ts:302

Disable pre-issuing of offered tokens at STO start (goes back to default behavior, which is to issue on purchase) Can be re-enabled BEFORE the STO starts by calling allowPreIssuing

Returns: Promise‹TransactionQueue‹ToggleAllowPreIssuingProcedureArgs, void››

finalize

▸ finalize(): Promise‹TransactionQueue‹FinalizeStoProcedureArgs, void››

Inherited from Sto

Defined in src/entities/Sto.ts:275

Finalize the offering. The offering's treasury wallet (or the Security Token's treasury wallet if one was not specified for the offering) will receive the remaining unsold tokens. Throws an error if there are transfer restrictions which do not permit the wallet to receive that amount of tokens

Returns: Promise‹TransactionQueue‹FinalizeStoProcedureArgs, void››

getCurrency

▸ getCurrency(): Promise‹CustomCurrency›

Defined in src/entities/TieredSto.ts:225

Retrieve the denomination in which the tokens are priced in this STO

Returns: Promise‹CustomCurrency›

getInvestments

▸ getInvestments(): Promise‹Investment[]›

Defined in src/entities/TieredSto.ts:181

Retrieve all investments that have been made on this STO

Returns: Promise‹Investment[]›

invest

▸ invest(params: InvestInStableCoinParams): Promise‹TransactionQueue‹InvestInTieredStoProcedureArgs››

Defined in src/entities/TieredSto.ts:296

Invest in the STO

Parameters:

Name	Type
params	InvestInStableCoinParams

Returns: Promise‹TransactionQueue‹InvestInTieredStoProcedureArgs››

▸ invest(params: InvestInOtherParams): Promise‹TransactionQueue‹InvestInTieredStoProcedureArgs››

Defined in src/entities/TieredSto.ts:301

Invest in the STO

Parameters:

Name	Type
params	InvestInOtherParams

Returns: Promise‹TransactionQueue‹InvestInTieredStoProcedureArgs››

modifyData

▸ modifyData(args: object): Promise‹TransactionQueue‹ModifyTieredStoDataProcedureArgs, void››

Defined in src/entities/TieredSto.ts:277

Modify STO parameters. Must be done before the STO starts

Parameters:

▪ args: object

Name	Type	Description
customCurrency?	Partial‹CustomCurrency›	custom currency data. Allows the STO to raise funds pegged to a different currency. Optional, defaults to USD
endDate?	Date	date when the STO should end
fundariseCurrencies?	Currency[]	-
minimumInvestment?	BigNumber	minimum investment amount
nonAccreditedInvestmentLimit?	BigNumber	maximum investment for non-accredited investors
raisedFundsWallet?	undefined | string	wallet address that will receive the funds that are being raised
stableCoinAddresses?	string[]	addresses of supported stablecoins
startDate?	Date	date when the STO should start
tiers?	StoTier[]	tier information
unsoldTokensWallet?	undefined | string	wallet address that will receive unsold tokens when the end date is reached

Returns: Promise‹TransactionQueue‹ModifyTieredStoDataProcedureArgs, void››

pause

▸ pause(): Promise‹TransactionQueue‹TogglePauseStoProcedureArgs, void››

Inherited from Sto

Defined in src/entities/Sto.ts:246

Pause the offering

Returns: Promise‹TransactionQueue‹TogglePauseStoProcedureArgs, void››

revokeRole

▸ revokeRole(args: object): Promise‹TransactionQueue‹AssignStoRoleProcedureArgs, void››

Inherited from Sto

Defined in src/entities/Sto.ts:374

Remove a role from a delegate

Parameters:

▪ args: object

Name	Type
delegateAddress	string
role	StoRole

Returns: Promise‹TransactionQueue‹AssignStoRoleProcedureArgs, void››

toPojo

▸ toPojo(): object

Overrides Sto.toPojo

Defined in src/entities/TieredSto.ts:335

Convert entity to a POJO (Plain Old Javascript Object)

Returns: object

• currentTier: number

• tiers: Tier[]

unpause

▸ unpause(): Promise‹TransactionQueue‹TogglePauseStoProcedureArgs, void››

Inherited from Sto

Defined in src/entities/Sto.ts:260

Unpause the offering

Returns: Promise‹TransactionQueue‹TogglePauseStoProcedureArgs, void››

Static generateId

▸ generateId(__namedParameters: object): string

Defined in src/entities/TieredSto.ts:118

Generate the Tiered STO's UUID from its identifying properties

Parameters:

▪ __namedParameters: object

Name	Type
address	string
securityTokenId	string
stoType	StoType

Returns: string

Static unserialize

▸ unserialize(serialized: string): UniqueIdentifiers

Inherited from Sto.unserialize

Defined in src/entities/Sto.ts:184

Unserialize string to a Security Token Offering object representation

Parameters:

Name	Type
serialized	string

Returns: UniqueIdentifiers