api_entities_Offering.Offering
@polymeshassociation/polymesh-sdk / Modules / api/entities/Offering / Offering
Class: Offering
api/entities/Offering.Offering
Represents an Asset Offering in the Polymesh blockchain
Hierarchy
Entity<UniqueIdentifiers,HumanReadable>↳
Offering
Table of contents
Properties
Methods
Properties
asset
• asset: Asset
Asset being offered
Defined in
api/entities/Offering/index.ts:66
id
• id: BigNumber
identifier number of the Offering
Defined in
api/entities/Offering/index.ts:61
uuid
• uuid: string
Inherited from
Defined in
Methods
close
▸ close(opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Close the Offering
note this method is of type NoArgsProcedureMethod, which means you can call close.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Parameters
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
api/entities/Offering/index.ts:159
details
▸ details(): Promise<OfferingDetails>
Retrieve the Offering's details
note can be subscribed to
Returns
Promise<OfferingDetails>
Defined in
api/entities/Offering/index.ts:112
▸ details(callback): Promise<UnsubCallback>
Parameters
callback
Returns
Promise<UnsubCallback>
Defined in
api/entities/Offering/index.ts:113
exists
▸ exists(): Promise<boolean>
Determine whether this Offering exists on chain
Returns
Promise<boolean>
Overrides
Defined in
api/entities/Offering/index.ts:278
freeze
▸ freeze(opts?): Promise<TransactionQueue<Offering, Offering, unknown[][]>>
Freeze the Offering
note this method is of type NoArgsProcedureMethod, which means you can call freeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Parameters
opts?
Returns
Promise<TransactionQueue<Offering, Offering, unknown[][]>>
Defined in
api/entities/Offering/index.ts:169
getInvestments
▸ getInvestments(opts?): Promise<ResultSet<Investment>>
Retrieve all investments made on this Offering
note supports pagination
note uses the middleware
Parameters
opts
Object
-
opts.size?
BigNumber
page size
opts.start?
BigNumber
page offset
Returns
Promise<ResultSet<Investment>>
Defined in
api/entities/Offering/index.ts:221
invest
▸ invest(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Invest in the Offering
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 signing Account and Identity have the required roles and permissions to run it
Parameters
opts?
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
api/entities/Offering/index.ts:208
isEqual
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Entity<unknown, unknown>
Returns
boolean
Inherited from
Defined in
modifyTimes
▸ modifyTimes(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Modify the start/end time of the Offering
throws if:
Trying to modify the start time on an Offering that already started
Trying to modify anything on an Offering 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 signing Account and Identity have the required roles and permissions to run it
Parameters
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
api/entities/Offering/index.ts:194
toHuman
▸ toHuman(): HumanReadable
Return the Offering's ID and Asset ticker
Returns
HumanReadable
Overrides
Defined in
api/entities/Offering/index.ts:296
unfreeze
▸ unfreeze(opts?): Promise<TransactionQueue<Offering, Offering, unknown[][]>>
Unfreeze the Offering
note this method is of type NoArgsProcedureMethod, which means you can call unfreeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Parameters
opts?
Returns
Promise<TransactionQueue<Offering, Offering, unknown[][]>>
Defined in
api/entities/Offering/index.ts:179
generateUuid
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
unserialize
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
Last updated
Was this helpful?