Class: KandelFarm
Title
Repository for Kandel instances.
Constructors
constructor
• new KandelFarm(mgv): KandelFarm
Constructor
Parameters
| Name | Type | Description |
|---|---|---|
mgv | Mangrove | The Mangrove to get kandels for. |
Returns
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelFarm.ts:20
Properties
mgv
• mgv: Mangrove
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelFarm.ts:11
tradeEventManagement
• tradeEventManagement: TradeEventManagement
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelFarm.ts:12
aaveKandelSeeder
• aaveKandelSeeder: AaveKandelSeeder
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelFarm.ts:14
kandelSeeder
• kandelSeeder: KandelSeeder
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelFarm.ts:15
Methods
getKandels
▸ getKandels(filter?): Promise<{ kandelAddress: string = x.args.kandel; ownerAddress: string = x.args.owner; onAave: boolean = false; baseAddress: string = baseToken.address; base: Token = baseToken; quoteAddress: string = quoteToken.address; quote: Token = quoteToken }[]>
Gets all Kandels matching a given filter.
Parameters
| Name | Type | Description |
|---|---|---|
filter? | Object | The filter to apply. |
filter.owner? | null | string | The Kandel instance owner - the one who invoked sow. |
filter.baseQuoteOlKey? | null | OLKeyStruct | The low-level identifier of the market for the Kandel instance. Takes precedence over baseQuoteOfferList if both are provided. |
filter.baseQuoteOfferList? | null | { base: string ; quote: string ; tickSpacing: number } | The identifier of the market for the Kandel instance using Mangrove token identifiers. |
filter.onAave? | boolean | Whether the Kandel instance uses the Aave router. |
Returns
Promise<{ kandelAddress: string = x.args.kandel; ownerAddress: string = x.args.owner; onAave: boolean = false; baseAddress: string = baseToken.address; base: Token = baseToken; quoteAddress: string = quoteToken.address; quote: Token = quoteToken }[]>
All kandels matching the filter.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelFarm.ts:51