Class: KandelConfiguration
Title
Provides recommended configuration for deploying Kandel instances.
Constructors
constructor
• new KandelConfiguration(configurationOverride?): KandelConfiguration
Constructor to provide specific configuration.
Parameters
| Name | Type | Description |
|---|---|---|
configurationOverride? | PartialKandelConfiguration | Optional configuration overrides that replace the values from the current configuration in configuration. |
Returns
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelConfiguration.ts:19
Properties
rawConfiguration
• rawConfiguration: PartialKandelConfiguration
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelConfiguration.ts:14
Methods
getMostSpecificConfig
▸ getMostSpecificConfig(networkName, baseId, quoteId, tickSpacing): KandelNetworkConfiguration & Partial<KandelMarketConfiguration>
Gets the most specific available config for the network and the base/quote pair.
Parameters
| Name | Type | Description |
|---|---|---|
networkName | string | The name of the network. |
baseId | string | The ID of the base token. |
quoteId | string | The ID of the quote token. |
tickSpacing | number | The tick spacing of the market. |
Returns
KandelNetworkConfiguration & Partial<KandelMarketConfiguration>
The most specific configuration available for the network and the base/quote pair.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelConfiguration.ts:36
getConfigForBaseQuoteTickSpacing
▸ getConfigForBaseQuoteTickSpacing(networkName, baseId, quoteId, tickSpacing): KandelNetworkConfiguration & KandelMarketConfiguration
Gets the config for the network and the base/quote/tickSpacing set.
Parameters
| Name | Type | Description |
|---|---|---|
networkName | string | The name of the network. |
baseId | string | The ID of the base token. |
quoteId | string | The ID of the quote token. |
tickSpacing | number | The tick spacing of the market. |
Returns
KandelNetworkConfiguration & KandelMarketConfiguration
The configuration for the network and the base/quote/tickSpacing set.
Throws
If the full config is not available for the network and the base/quote/tickSpacing set.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelConfiguration.ts:82
getConfig
▸ getConfig(market): KandelNetworkConfiguration & KandelMarketConfiguration
Gets the config for the market.
Parameters
| Name | Type | Description |
|---|---|---|
market | Market | The market. |
Returns
KandelNetworkConfiguration & KandelMarketConfiguration
The configuration for the market.
Throws
If the full config is not available for the market.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelConfiguration.ts:127
getConfiguredMarkets
▸ getConfiguredMarkets(mgv): { base: string ; quote: string ; tickSpacing: number }[]
Gets the list of markets that are configured for the network for the given Mangrove instance.
Parameters
| Name | Type | Description |
|---|---|---|
mgv | Mangrove | The Mangrove instance. |
Returns
{ base: string ; quote: string ; tickSpacing: number }[]
The list of markets that are configured for the network for the given Mangrove instance.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelConfiguration.ts:142
getConfiguredMarketsForNetwork
▸ getConfiguredMarketsForNetwork(networkName): { base: string ; quote: string ; tickSpacing: number }[]
Gets the list of markets that are configured for the network.
Parameters
| Name | Type | Description |
|---|---|---|
networkName | string | The name of the network. |
Returns
{ base: string ; quote: string ; tickSpacing: number }[]
The list of markets that are configured for the network.
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelConfiguration.ts:150
getNetworks
▸ getNetworks(): string[]
Gets the networks with some configuration.
Returns
string[]
Defined in
@mangrovedao/mangrove.js/src/kandel/kandelConfiguration.ts:171