Sto
Represents a Security Token Offering in the Polymesh blockchain
Hierarchy
Entity‹UniqueIdentifiers›
↳ Sto
Index
Properties
Methods
Properties
close
• close: ProcedureMethod‹void, void›
Defined in src/api/entities/Sto/index.ts:143
Close the STO
Protected context
Protected context• context: Context
Inherited from CheckpointSchedule.context
Defined in src/api/entities/Entity.ts:48
freeze
• freeze: ProcedureMethod‹void, Sto›
Defined in src/api/entities/Sto/index.ts:151
Freeze the STO
note required role:
Security Token Primary Issuance Agent
id
• id: BigNumber
Defined in src/api/entities/Sto/index.ts:48
identifier number of the Offering
invest
• invest: ProcedureMethod‹InvestInStoParams, void›
Defined in src/api/entities/Sto/index.ts:189
Invest in the STO
param portfolio in which the purchased Tokens will be stored
param portfolio from which funds will be withdrawn to pay for the Tokens
param amount of tokens to purchase
param maximum average price to pay per Token (optional)
note required roles:
Purchase Portfolio Custodian
Funding Portfolio Custodian
modifyTimes
• modifyTimes: ProcedureMethod‹ModifyStoTimesParams, void›
Defined in src/api/entities/Sto/index.ts:175
Modify the start/end time of the STO
param new start time (optional, will be left the same if not passed)
param new end time (optional, will be left th same if not passed). A null value means the STO doesn't end
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
ticker
• ticker: string
Defined in src/api/entities/Sto/index.ts:53
ticker of the Security Token being offered
unfreeze
• unfreeze: ProcedureMethod‹void, Sto›
Defined in src/api/entities/Sto/index.ts:159
Unfreeze the STO
note required role:
Security Token Primary Issuance Agent
uuid
• uuid: string
Inherited from CheckpointSchedule.uuid
Defined in src/api/entities/Entity.ts:46
Methods
details
▸ details(): Promise‹StoDetails›
Defined in src/api/entities/Sto/index.ts:93
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:94
Parameters:
Name
Type
callback
Returns: Promise‹UnsubCallback›
getInvestments
▸ getInvestments(opts: object): Promise‹ResultSet‹Investment››
Defined in src/api/entities/Sto/index.ts:200
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››
isEqual
▸ isEqual(entity: Entity‹object›): 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
Entity‹object›
Returns: boolean
Static generateUuid
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: object
Parameters:
Name
Type
Description
identifiers
Identifiers
Returns: string
Static unserialize
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: object
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last updated
Was this helpful?