Sto

Represents a Security Token Offering in the Polymesh blockchain

Hierarchy

  • Entity‹UniqueIdentifiers›

    ↳ Sto

Index

Properties

Methods

Properties

Protected context

• context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

id

• id: BigNumber

Defined in src/api/entities/Sto/index.ts:55

identifier number of the Offering

ticker

• ticker: string

Defined in src/api/entities/Sto/index.ts:60

ticker of the Security Token being offered

uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

close

▸ close(args: void): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Sto/index.ts:153

Close the STO

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

Parameters:

Name

Type

args

void

Returns: Promise‹TransactionQueue‹void››

details

▸ details(): Promise‹StoDetails›

Defined in src/api/entities/Sto/index.ts:100

Retrieve the STO's details

note can be subscribed to

Returns: Promise‹StoDetails›

▸ details(callback: SubCallback‹StoDetails›): Promise‹UnsubCallback›

Defined in src/api/entities/Sto/index.ts:101

Parameters:

Name

Type

callback

Returns: Promise‹UnsubCallback›

freeze

▸ freeze(args: void): Promise‹TransactionQueue‹Sto››

Defined in src/api/entities/Sto/index.ts:166

Freeze the STO

note required role:

  • Security Token Primary Issuance Agent

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

Parameters:

Name

Type

args

void

Returns: Promise‹TransactionQueue‹Sto››

getInvestments

▸ getInvestments(opts: object): Promise‹ResultSet‹Investment››

Defined in src/api/entities/Sto/index.ts:224

Retrieve all investments made on this STO

note supports pagination

note uses the middleware

Parameters:

▪Default value opts: object= {}

Name

Type

Description

size?

undefined | number

page size

start?

undefined | number

page offset

Returns: Promise‹ResultSet‹Investment››

invest

▸ invest(args: InvestInStoParams): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Sto/index.ts:211

Invest in the STO

note required roles:

  • Purchase Portfolio Custodian

  • Funding Portfolio Custodian

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

Parameters:

Name

Type

args

Returns: Promise‹TransactionQueue‹void››

isEqual

▸ isEqual(entity: Entity‹unknown›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Returns: boolean

modifyTimes

▸ modifyTimes(args: ModifyStoTimesParams): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Sto/index.ts:197

Modify the start/end time of the STO

throws if:

  • Trying to modify the start time on an STO that already started

  • Trying to modify anything on an STO that already ended

  • Trying to change start or end time to a past date

note required role:

  • Security Token Primary Issuance Agent

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

Parameters:

Name

Type

args

Returns: Promise‹TransactionQueue‹void››

unfreeze

▸ unfreeze(args: void): Promise‹TransactionQueue‹Sto››

Defined in src/api/entities/Sto/index.ts:179

Unfreeze the STO

note required role:

  • Security Token Primary Issuance Agent

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

Parameters:

Name

Type

args

void

Returns: Promise‹TransactionQueue‹Sto››

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers

Parameters:

Name

Type

Description

identifiers

Identifiers

Returns: string

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name

Type

Description

serialized

string

UUID to unserialize

Returns: Identifiers

PreviousSettlementsNextTickerReservation

Last updated