Class: GeneralKandelDistributionHelper
Title
Helper for handling general Kandel offer distributions.
Constructors
constructor
• new GeneralKandelDistributionHelper(helper): GeneralKandelDistributionHelper
Parameters
| Name | Type |
|---|---|
helper | KandelDistributionHelper |
Returns
GeneralKandelDistributionHelper
Defined in
@mangrovedao/mangrove.js/src/kandel/generalKandelDistributionHelper.ts:12
Properties
helper
• helper: KandelDistributionHelper
Defined in
@mangrovedao/mangrove.js/src/kandel/generalKandelDistributionHelper.ts:10
Methods
createDistributionWithOffers
▸ createDistributionWithOffers(explicitOffers, distribution): 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 |
|---|---|---|
explicitOffers | Object | The explicit offers to use. |
explicitOffers.bids | OffersWithGives | The explicit bids to use. |
explicitOffers.asks | OffersWithGives | The explicit asks to use. |
distribution | KandelDistribution | { pricePoints: number ; stepSize: number } | The original distribution. If pricePoints is not provided, then the number of offers is used. |
Returns
The new distribution.
Defined in
@mangrovedao/mangrove.js/src/kandel/generalKandelDistributionHelper.ts:23
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? | Big | The change in base volume. |
params.quoteDelta? | Big | The change in quote volume. |
params.minimumBasePerOffer | Big | The minimum base per offer. Only applies for decrease in base volume. |
params.minimumQuotePerOffer | Big | The minimum quote per offer. Only applies for decrease in quote volume. |
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/generalKandelDistributionHelper.ts:59