Class: KandelStrategies
Entrypoint for the Kandel strategies. Kandel is an Automated Market Making strategy that uses on-chain order flow to repost offers instantly, without any latency. Within a market and price range you select, Kandel automatically posts bids and asks. Its main goal is to buy low and sell high - profits are made through accumulated spread.
Constructors
constructor
• new KandelStrategies(mgv): KandelStrategies
Constructor
Parameters
| Name | Type | Description |
|---|---|---|
mgv | Mangrove | The Mangrove to interact with. |
Returns
Defined in
@mangrovedao/mangrove.js/src/kandelStrategies.ts:34
Properties
seeder
• seeder: KandelSeeder
Seeder for creating Kandel instances on-chain.
Defined in
@mangrovedao/mangrove.js/src/kandelStrategies.ts:20
farm
• farm: KandelFarm
Repository for Kandel instances.
Defined in
@mangrovedao/mangrove.js/src/kandelStrategies.ts:23
mgv
• mgv: Mangrove
The Mangrove to interact with.
Defined in
@mangrovedao/mangrove.js/src/kandelStrategies.ts:26
configuration
• configuration: KandelConfiguration
The default configuration values to use for Kandel.
Defined in
@mangrovedao/mangrove.js/src/kandelStrategies.ts:29
Methods
instance
▸ instance(params): Promise<GeometricKandelInstance>
Creates a KandelInstance object to interact with a Kandel strategy on Mangrove.
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | The parameters for creating the KandelInstance. |
params.address | string | The address of the Kandel strategy. |
params.market | Market | (baseAddress: string, quoteAddress: string, tickSpacing: number) => Promise<Market> | The market used by the Kandel instance or a factory function to create the market. |
Returns
Promise<GeometricKandelInstance>
A new KandelInstance.
Dev
If a factory function is provided for the market, then remember to disconnect market when no longer needed.
Defined in
@mangrovedao/mangrove.js/src/kandelStrategies.ts:48
generator
▸ generator(market): GeometricKandelDistributionGenerator
Creates a generator for generating Kandel distributions for the given market.
Parameters
| Name | Type | Description |
|---|---|---|
market | Market | The market to calculate for. |
Returns
GeometricKandelDistributionGenerator
A new KandelDistributionGenerator.
Defined in
@mangrovedao/mangrove.js/src/kandelStrategies.ts:93