Offerings
Handles all Asset Offering related functionality
Hierarchy
Namespace‹Asset›
↳ Offerings
Index
Properties
Methods
Properties
Protected context
Protected context• context: Context
Inherited from void
Defined in src/api/entities/Namespace.ts:11
Protected parent
Protected parent• parent: Asset
Inherited from void
Defined in src/api/entities/Namespace.ts:9
Methods
get
▸ get(opts: object): Promise‹OfferingWithDetails[]›
Defined in src/api/entities/Asset/Offerings.ts:81
Retrieve all of the Asset's Offerings and their details. Can be filtered using parameters
Parameters:
▪Default value opts: object= {}
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: object): Promise‹Offering›
Defined in src/api/entities/Asset/Offerings.ts:56
Retrieve a single Offering associated to this Asset by its ID
throws if there is no Offering with the passed ID
Parameters:
▪ args: object
id
BigNumber
Returns: Promise‹Offering›
launch
▸ launch(args: LaunchOfferingParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Offering››
Defined in src/api/entities/Asset/Offerings.ts:47
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:
args
LaunchOfferingParams
opts?
Returns: Promise‹TransactionQueue‹Offering››
Last updated