api.entities.Asset.Fungible.Offerings.Offerings - PolymeshAssociation/polymesh-sdk GitHub Wiki
Class: Offerings
api/entities/Asset/Fungible/Offerings.Offerings
Handles all Asset Offering related functionality
Hierarchy
-
Namespace<FungibleAsset>↳
Offerings
Table of contents
Methods
Methods
get
▸ get(opts?): Promise<OfferingWithDetails[]>
Retrieve all of the Asset's Offerings and their details. Can be filtered using parameters
Parameters
| Name | Type | Description |
|---|---|---|
opts |
Object |
- |
opts.status? |
Partial<OfferingStatus> |
status of the Offerings to fetch. If defined, only Offerings that have all passed statuses will be returned |
Returns
Promise<OfferingWithDetails[]>
Defined in
api/entities/Asset/Fungible/Offerings/index.ts:85
getOne
▸ getOne(args): Promise<Offering>
Retrieve a single Offering associated to this Asset by its ID
Parameters
| Name | Type |
|---|---|
args |
Object |
args.id |
BigNumber |
Returns
Promise<Offering>
Throws
if there is no Offering with the passed ID
Defined in
api/entities/Asset/Fungible/Offerings/index.ts:60
launch
▸ launch(args, opts?): Promise<GenericPolymeshTransaction<Offering, Offering>>
Launch an Asset Offering
Parameters
| Name | Type |
|---|---|
args |
LaunchOfferingParams |
opts? |
ProcedureOpts |
Returns
Promise<GenericPolymeshTransaction<Offering, Offering>>
Note
required roles:
- Offering Portfolio Custodian
- Raising Portfolio Custodian
Note
this method is of type ProcedureMethod, which means you can call launch.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it