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

api/entities/Asset/Fungible/Offerings

Classes

Offerings

Defined in: api/entities/Asset/Fungible/Offerings/index.ts:29

Handles all Asset Offering related functionality

Extends

• Namespace<FungibleAsset>

Methods

get()

get(opts?): Promise<OfferingWithDetails[]>

Defined in: api/entities/Asset/Fungible/Offerings/index.ts:78

Retrieve all of the Asset's Offerings and their details. Can be filtered using parameters

Parameters

Parameter	Type	Description
opts	{ status?: Partial<OfferingStatus>; }	-
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[]>

getOne()

getOne(args): Promise<Offering>

Defined in: api/entities/Asset/Fungible/Offerings/index.ts:56

Retrieve a single Offering associated to this Asset by its ID

Parameters

Parameter	Type
args	{ id: BigNumber; }
args.id	BigNumber

Returns

Promise<Offering>

Throws

if there is no Offering with the passed ID

launch()

launch(args, opts?): Promise<GenericPolymeshTransaction<Offering, Offering>>

Defined in: api/entities/Asset/Fungible/Offerings/index.ts:49

Launch an Asset Offering

Parameters

Parameter	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