SimpleSto

Class used to manage a simple sto

Hierarchy

↳ Sto‹Params›

↳ SimpleSto

Index

Constructors

• constructor

Properties

• address

• beneficialInvestmentsAllowed

• cap

• capReached

• context

• endDate

• fundraiseCurrencies

• investorCount

• isFinalized

• isPaused

• preIssueAllowed

• raisedAmount

• raisedFundsWallet

• rate

• securityTokenId

• securityTokenSymbol

• soldTokensAmount

• startDate

• stoType

• uid

• unsoldTokensWallet

Methods

• _refresh

• allowBeneficialInvestments

• allowPreIssuing

• assignRole

• disallowBeneficialInvestments

• disallowPreIssuing

• finalize

• getInvestments

• invest

• pause

• revokeRole

• toPojo

• unpause

• generateId

• unserialize

Constructors

constructor

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

Overrides Sto.constructor

Defined in src/entities/SimpleSto.ts:61

Create a new simple sto instance

Parameters:

Name	Type
params	Params & UniqueIdentifiers
context	Context

Returns: SimpleSto

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

cap

• cap: BigNumber

Defined in src/entities/SimpleSto.ts:56

cap of total tokens that can be sold in sto

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

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

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

rate

• rate: BigNumber

Defined in src/entities/SimpleSto.ts:61

rate at which the tokens will be sold in sto

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

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

uid

• uid: string

Overrides Sto.uid

Defined in src/entities/SimpleSto.ts:51

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/SimpleSto.ts:151

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

getInvestments

▸ getInvestments(): Promise‹Investment[]›

Defined in src/entities/SimpleSto.ts:81

Retrieve all investments that have been made on this STO

Returns: Promise‹Investment[]›

invest

▸ invest(args: object): Promise‹TransactionQueue‹InvestInSimpleStoProcedureArgs, void››

Defined in src/entities/SimpleSto.ts:126

Invest in the STO

Parameters:

▪ args: object

Name	Type	Description
amount	BigNumber	amount to spend
beneficiary?	undefined | string	address that will receive the purchased tokens (defaults to current wallet, will fail if beneficial investments are not allowed for the STO, only applicable if the STO currency is ETH)

Returns: Promise‹TransactionQueue‹InvestInSimpleStoProcedureArgs, 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/SimpleSto.ts:137

Convert entity to a POJO (Plain Old Javascript Object)

Returns: object

• cap: BigNumber

• rate: BigNumber

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/SimpleSto.ts:40

Generate the Simple 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