Sto

Abstract class used as a base to manage sto functionalities

Type parameters

▪ P

Hierarchy

• Entity‹P›

  ↳ Sto

  ↳ SimpleSto

  ↳ TieredSto

Index

Constructors

• constructor

Properties

• address

• beneficialInvestmentsAllowed

• capReached

• context

• endDate

• fundraiseCurrencies

• investorCount

• isFinalized

• isPaused

• preIssueAllowed

• raisedAmount

• raisedFundsWallet

• securityTokenId

• securityTokenSymbol

• soldTokensAmount

• startDate

• stoType

• uid

• unsoldTokensWallet

Methods

• _refresh

• allowBeneficialInvestments

• allowPreIssuing

• assignRole

• disallowBeneficialInvestments

• disallowPreIssuing

• finalize

• pause

• revokeRole

• toPojo

• unpause

• unserialize

Constructors

constructor

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

Defined in src/entities/Sto.ts:195

Create a new sto instance

Parameters:

Name	Type
params	Params & UniqueIdentifiers
context	Context

Returns: Sto

Properties

address

• address: string

Defined in src/entities/Sto.ts:107

ethereum address for the STO

beneficialInvestmentsAllowed

• beneficialInvestmentsAllowed: boolean

Defined in src/entities/Sto.ts:175

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

capReached

• capReached: boolean

Defined in src/entities/Sto.ts:160

whether the STO cap has been reached or not

Protected context

• context: Context

Defined in src/entities/Sto.ts:177

endDate

• endDate: Date

Defined in src/entities/Sto.ts:120

fundraiseCurrencies

• fundraiseCurrencies: Currency[]

Defined in src/entities/Sto.ts:150

types of currency in which funds can be raised

investorCount

• investorCount: number

Defined in src/entities/Sto.ts:145

number of investors that have purchased tokens in the STO

isFinalized

• isFinalized: boolean

Defined in src/entities/Sto.ts:165

whether the STO has been finalized or not

isPaused

• isPaused: boolean

Defined in src/entities/Sto.ts:155

whether the STO is currently paused or not

preIssueAllowed

• preIssueAllowed: boolean

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

Defined in src/entities/Sto.ts:135

amount of funds that have been raised so far

raisedFundsWallet

• raisedFundsWallet: string

Defined in src/entities/Sto.ts:125

wallet where raised funds will be forwarded to

securityTokenId

• securityTokenId: string

Defined in src/entities/Sto.ts:111

securityTokenSymbol

• securityTokenSymbol: string

Defined in src/entities/Sto.ts:109

soldTokensAmount

• soldTokensAmount: BigNumber

Defined in src/entities/Sto.ts:140

total number of tokens that have been sold so far

startDate

• startDate: Date

Defined in src/entities/Sto.ts:118

stoType

• stoType: StoType

Defined in src/entities/Sto.ts:116

type of STO setup

Abstract uid

• uid: string

Overrides Entity.uid

Defined in src/entities/Sto.ts:102

Uniquely generated id for the STO

unsoldTokensWallet

• unsoldTokensWallet: string

Defined in src/entities/Sto.ts:130

wallet where unsold tokens will be returned to

Methods

_refresh

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

Overrides Entity._refresh

Defined in src/entities/Sto.ts:438

Hydrate the entity

Parameters:

Name	Type
params	Partial‹Params›

Returns: void

allowBeneficialInvestments

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

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››

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››

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››

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››

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››

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››

pause

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

Defined in src/entities/Sto.ts:246

Pause the offering

Returns: Promise‹TransactionQueue‹TogglePauseStoProcedureArgs, void››

revokeRole

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

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 Entity.toPojo

Defined in src/entities/Sto.ts:393

Convert entity to a POJO (Plain Old Javascript Object)

Returns: object

• address: string

• beneficialInvestmentsAllowed: boolean

• capReached: boolean

• endDate: Date

• fundraiseCurrencies: FundRaiseType[]

• investorCount: number

• isFinalized: boolean

• isPaused: boolean

• preIssueAllowed: boolean

• raisedAmount: BigNumber

• raisedFundsWallet: string

• securityTokenId: string

• securityTokenSymbol: string

• soldTokensAmount: BigNumber

• startDate: Date

• uid: string

• unsoldTokensWallet: string

unpause

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

Defined in src/entities/Sto.ts:260

Unpause the offering

Returns: Promise‹TransactionQueue‹TogglePauseStoProcedureArgs, void››

Static unserialize

▸ unserialize(serialized: string): UniqueIdentifiers

Defined in src/entities/Sto.ts:184

Unserialize string to a Security Token Offering object representation

Parameters:

Name	Type
serialized	string

Returns: UniqueIdentifiers