Class: Distributions

Defined in: src/api/entities/Asset/Fungible/CorporateActions/Distributions.ts:31

Handles all Asset Distributions related functionality

Extends

• Namespace<FungibleAsset>

Methods

configureDividendDistribution()

configureDividendDistribution(args: ConfigureDividendDistributionParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<DividendDistribution, DividendDistribution>>

Defined in: src/api/entities/Asset/Fungible/CorporateActions/Distributions.ts:38

Create a Dividend Distribution for a subset of the Asset Holders at a certain (existing or future) Checkpoint

Parameters

Parameter	Type
args	ConfigureDividendDistributionParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<DividendDistribution, DividendDistribution>>

Note

required role:

• Origin Portfolio Custodian

Note

this method is of type ProcedureMethod, which means you can call configureDividendDistribution.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

get()

get(): Promise<DistributionWithDetails[]>

Defined in: src/api/entities/Asset/Fungible/CorporateActions/Distributions.ts:113

Retrieve all Dividend Distributions associated to this Asset, along with their details

Returns

Promise<DistributionWithDetails[]>

---

getOne()

getOne(args: object): Promise<DistributionWithDetails>

Defined in: src/api/entities/Asset/Fungible/CorporateActions/Distributions.ts:60

Retrieve a single Dividend Distribution associated to this Asset by its ID

Parameters

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

Returns

Promise<DistributionWithDetails>

Throws

if there is no Distribution with the passed ID