api_entities_Asset_Offerings.Offerings

@polymeshassociation/polymesh-sdk / Modules / api/entities/Asset/Offerings / Offerings

Class: Offerings

api/entities/Asset/Offerings.Offerings

Handles all Asset Offering related functionality

Hierarchy

• Namespace<Asset>

  ↳ Offerings

Table of contents

Methods

• get

• getOne

• launch

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/Offerings.ts:81

---

getOne

▸ getOne(args): Promise<Offering>

Retrieve a single Offering associated to this Asset by its ID

throws if there is no Offering with the passed ID

Parameters

Name	Type
args	Object
args.id	BigNumber

Returns

Promise<Offering>

Defined in

api/entities/Asset/Offerings.ts:56

---

launch

▸ launch(args, opts?): Promise<TransactionQueue<Offering, Offering, unknown[][]>>

Launch an Asset 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

Parameters

Name	Type
args	LaunchOfferingParams
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<Offering, Offering, unknown[][]>>

Defined in

api/entities/Asset/Offerings.ts:47