Sto
Represents a Security Token Offering in the Polymesh blockchain

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from Entity.context

id

id: BigNumber
identifier number of the Offering

ticker

ticker: string
ticker of the Security Token being offered

uuid

uuid: string
Inherited from Entity.uuid

Methods

close

close(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››
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
Retrieve the STO's details
note can be subscribed to
Returns: Promise‹StoDetails
details(callback: SubCallbackStoDetails›): Promise‹UnsubCallback
Parameters:
Name
Type
callback
Returns: Promise‹UnsubCallback

exists

exists(): Promise‹boolean›
Overrides Entity.exists
Determine whether this STO exists on chain
Returns: Promise‹boolean›

freeze

freeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueSto››
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››
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››
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
opts?
Returns: Promise‹TransactionQueue‹void››

isEqual

isEqual(entity: Entity‹unknown, unknown›): boolean
Inherited from Entity.isEqual
Determine 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››
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:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹void››

toJson

toJson(): HumanReadable
Overrides Entity.toJson
Return the Sto's ID and Token ticker
Returns: HumanReadable

unfreeze

unfreeze(args: void, opts?: ProcedureOpts): Promise‹TransactionQueueSto››
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
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
Unserialize a UUID into its Unique Identifiers
Type parameters:
Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Last modified 26d ago