Class: GeometricKandelLib
Title
Management of a single Kandel instance.
Constructors
constructor
• new GeometricKandelLib(params): GeometricKandelLib
Creates a KandelLib object to perform static calls toward a KandelLib.
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | The parameters used to create an instance. |
params.address | string | The address of the KandelLib instance. |
params.signer | Signer | The signer used to interact with the KandelLib instance. |
params.market | KeyResolvedForCalculation | The key data about the market. |
params.kandelLibInstance? | GeometricKandel | A KandelLib instance to inject. If not provided, a new one will be created. |
Returns
A new KandelLib.
Defined in
@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelLib.ts:22
Properties
kandelLib
• kandelLib: GeometricKandel
Defined in
@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelLib.ts:11
market
• market: KeyResolvedForCalculation
Defined in
@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelLib.ts:12
Methods
createPartialGeometricDistribution
▸ createPartialGeometricDistribution(params): Promise<OfferDistribution>
Parameters
| Name | Type |
|---|---|
params | Object |
params.from | number |
params.to | number |
params.baseQuoteTickIndex0 | number |
params.baseQuoteTickOffset | number |
params.firstAskIndex | number |
params.bidGives | undefined | BigSource |
params.askGives | undefined | BigSource |
params.pricePoints | number |
params.stepSize | number |
Returns
Promise<OfferDistribution>
Defined in
@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelLib.ts:35
createFullGeometricDistribution
▸ createFullGeometricDistribution(params): Promise<GeometricKandelDistribution>
Parameters
| Name | Type |
|---|---|
params | Object |
params.baseQuoteTickIndex0 | number |
params.baseQuoteTickOffset | number |
params.firstAskIndex | number |
params.bidGives | undefined | BigSource |
params.askGives | undefined | BigSource |
params.pricePoints | number |
params.stepSize | number |
Returns
Promise<GeometricKandelDistribution>
Defined in
@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelLib.ts:84