Class: GeneralKandelDistributionGenerator
Title
Helper for generating general Kandel distributions with fully specified bids and asks with tick and volumes.
Constructors
constructor
• new GeneralKandelDistributionGenerator(generalDistributionHelper): GeneralKandelDistributionGenerator
Parameters
| Name | Type |
|---|---|
generalDistributionHelper | GeneralKandelDistributionHelper |
Returns
GeneralKandelDistributionGenerator
Defined in
@mangrovedao/mangrove.js/src/kandel/generalKandelDistributionGenerator.ts:11
Properties
generalDistributionHelper
• generalDistributionHelper: GeneralKandelDistributionHelper
Defined in
@mangrovedao/mangrove.js/src/kandel/generalKandelDistributionGenerator.ts:9
Methods
uniformlyChangeVolume
▸ uniformlyChangeVolume(params): Object
Creates a new distribution with uniformly changed volume.
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | The parameters for the change. |
params.distribution | KandelDistribution | The distribution to change. |
params.baseDelta? | BigSource | The change in base volume. |
params.quoteDelta? | BigSource | The change in quote volume. |
params.minimumBasePerOffer | BigSource | The minimum amount of base to give for each offer. Should be at least minimumBasePerOfferFactor from KandelConfiguration multiplied with the minimum volume for the market. |
params.minimumQuotePerOffer | BigSource | The minimum amount of quote to give for each offer. Should be at least minimumQuotePerOfferFactor from KandelConfiguration multiplied with the minimum volume for the market. |
Returns
Object
The new distribution.
| Name | Type |
|---|---|
distribution | GeneralKandelDistribution |
totalBaseChange | Big |
totalQuoteChange | Big |
Remarks
The decrease has to respect minimums, and thus may decrease some offers more than others.
Defined in
@mangrovedao/mangrove.js/src/kandel/generalKandelDistributionGenerator.ts:27
createDistributionWithOffers
▸ createDistributionWithOffers(params): GeneralKandelDistribution
Creates a distribution based on an explicit set of offers. Either based on an original distribution or parameters for one.
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | The parameters for the distribution. |
params.explicitOffers | Object | The explicit offers to use. |
params.explicitOffers.bids | OffersWithGives | - |
params.explicitOffers.asks | OffersWithGives | - |
params.distribution | KandelDistribution | { pricePoints: number ; stepSize: number } | The original distribution or parameters for one. If pricePoints is not provided, then the number of offers is used. |
Returns
The new distribution.
Defined in
@mangrovedao/mangrove.js/src/kandel/generalKandelDistributionGenerator.ts:56