Class: GeometricKandelDistributionHelper
Title
Helper for handling geometric Kandel offer distributions.
Constructors
constructor
• new GeometricKandelDistributionHelper(market): GeometricKandelDistributionHelper
Constructor
Parameters
| Name | Type | Description |
|---|---|---|
market | KeyResolvedForCalculation | The key data about the market. |
Returns
GeometricKandelDistributionHelper
Defined in
@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelDistributionHelper.ts:55
Properties
helper
• helper: KandelDistributionHelper
Defined in
@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelDistributionHelper.ts:50
Methods
getBaseQuoteTicksFromTick
▸ getBaseQuoteTicksFromTick(offerType, index, tickAtIndex, baseQuoteTickOffset, pricePoints): number[]
Gets the ticks for the geometric distribution based on a single known tick at an index.
Parameters
| Name | Type | Description |
|---|---|---|
offerType | BA | The offer type. |
index | number | The index of the known price. |
tickAtIndex | number | The known tick (the tick price of base per quote for bids and quote per base for asks). |
baseQuoteTickOffset | number | The offset in ticks between two price points of the geometric distribution. |
pricePoints | number | The number of price points in the distribution. |
Returns
number[]
The quote per base ticks in the distribution.
Defined in
@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelDistributionHelper.ts:67
calculateBaseQuoteTickOffset
▸ calculateBaseQuoteTickOffset(priceRatio): number
Calculates the base quote tick offset closely corresponding to the given ratio.
Parameters
| Name | Type | Description |
|---|---|---|
priceRatio | Big | the price ratio. |
Returns
number
The base quote tick offset.
Defined in
@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelDistributionHelper.ts:94
getPriceRatioFromBaseQuoteOffset
▸ getPriceRatioFromBaseQuoteOffset(baseQuoteTickOffset): Big
Gets the price ratio given by the baseQuoteTickOffset.
Parameters
| Name | Type | Description |
|---|---|---|
baseQuoteTickOffset | number | The base quote tick offset. |
Returns
Big
The price ratio.
Defined in
@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelDistributionHelper.ts:116
getTickDistributionParams
▸ getTickDistributionParams(params): Object
Gets tick based parameters for a distribution based on tick or price params.
Parameters
| Name | Type | Description |
|---|---|---|
params | Omit<DistributionParams, "generateFromMid"> | The distribution parameters, see DistributionParams |
Returns
Object
The tick based parameters, see TickDistributionParams
| Name | Type |
|---|---|
minBaseQuoteTick | number |
baseQuoteTickOffset | number |
midBaseQuoteTick | number |
pricePoints | number |
Defined in
@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelDistributionHelper.ts:129