Sto

Represents a Security Token Offering in the Polymesh blockchain

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from Entity.context

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

id

id: BigNumber

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

identifier number of the Offering

ticker

ticker: string

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

ticker of the Security Token being offered

uuid

uuid: string

Inherited from Entity.uuid

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

Methods

close

close(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

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

opts?

Returns: Promise‹TransactionQueue‹void››

details

details(): Promise‹StoDetails

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

Retrieve the STO's details

note can be subscribed to

Returns: Promise‹StoDetails

details(callback: SubCallbackStoDetails›): Promise‹UnsubCallback

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

Parameters:

Name

Type

callback

Returns: Promise‹UnsubCallback

freeze

freeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueSto››

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

Freeze the STO

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

opts?

Returns: Promise‹TransactionQueueSto››

getInvestments

getInvestments(opts: object): Promise‹ResultSetInvestment››

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

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

invest

invest(args: InvestInStoParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

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:

Returns: Promise‹TransactionQueue‹void››

isEqual

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

Inherited from Entity.isEqual

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

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Entity‹unknown, unknown›

Returns: boolean

modifyTimes

modifyTimes(args: ModifyStoTimesParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

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

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

Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): HumanReadable

Overrides Entity.toJson

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

Return the Sto's ID and Token ticker

Returns: HumanReadable

unfreeze

unfreeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueSto››

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

Unfreeze the STO

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

opts?

Returns: Promise‹TransactionQueueSto››

Static generateUuid

generateUuidIdentifiers›(identifiers: Identifiers): string

Inherited from Entity.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

unserializeIdentifiers›(serialized: string): Identifiers

Inherited from Entity.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

Last updated