Sto
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents a Security Token Offering in the Polymesh blockchain
‹UniqueIdentifiers, ›
↳ Sto
Protected context• id: BigNumber
identifier number of the Offering
• ticker: string
ticker of the Security Token being offered
• uuid: string
Close the STO
Parameters:
args
void
opts?
Retrieve the STO's details
note can be subscribed to
Parameters:
callback
▸ exists(): Promise‹boolean›
Determine whether this STO exists on chain
Returns: Promise‹boolean›
Freeze the STO
Parameters:
args
void
opts?
Retrieve all investments made on this STO
note supports pagination
note uses the middleware
Parameters:
â–ªDefault value opts: object= {}
size?
undefined | number
page size
start?
undefined | number
page offset
Invest in the STO
note required roles:
Purchase Portfolio Custodian
Funding Portfolio Custodian
Parameters:
args
opts?
Determine whether this Entity is the same as another one
Parameters:
entity
Returns: boolean
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
Parameters:
args
opts?
Return the Sto's ID and Token ticker
Unfreeze the STO
Parameters:
args
void
opts?
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters:
â–ª Identifiers
Parameters:
identifiers
Identifiers
Returns: string
Static unserialize▸ unserialize‹Identifiers›(serialized: string): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
serialized
string
UUID to unserialize
Returns: Identifiers
• context:
Inherited from .
Defined in
Defined in
Defined in
Inherited from .
Defined in
▸ close(args: void, opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call close.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ details(): Promise‹›
Defined in
Returns: Promise‹›
▸ details(callback: ‹›): Promise‹›
Defined in
‹›
Returns: Promise‹›
Overrides .
Defined in
▸ freeze(args: void, opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call freeze.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
▸ getInvestments(opts: object): Promise‹‹››
Defined in
Returns: Promise‹‹››
▸ invest(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call invest.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
▸ modifyTimes(args: , opts?: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call modifyTimes.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››
â–¸ toJson():
Overrides .
Defined in
Returns:
▸ unfreeze(args: void, opts?: ): Promise‹‹››
Defined in
note this method is of type , which means you can call unfreeze.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
Inherited from .
Defined in
Inherited from .
Defined in