@mangrovedao/mangrove.js

Namespaces

Classes

Interfaces

JsonWalletOptions

References

default

Renames and re-exports Mangrove

Type Aliases

RecursivePartial

Ƭ RecursivePartial<T>: { [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object | undefined ? RecursivePartial<T[P]> : T[P] }

Type parameters

Name
`T`

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:25

network

Ƭ network: string

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:33

address

Ƭ address: string

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:34

tokenId

Ƭ tokenId: string

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:35

tokenSymbol

Ƭ tokenSymbol: string

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:36

NamedAddresses

Ƭ NamedAddresses: Record<string, address>

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:38

AddressesConfig

Ƭ AddressesConfig: Record<network, NamedAddresses>

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:39

TokenConfig

Ƭ TokenConfig: Object

Type declaration

Name	Type
`symbol?`	`tokenSymbol`
`decimals?`	`number`
`displayName?`	`string`
`displayedDecimals?`	`number`
`displayedAsPriceDecimals?`	`number`
`cashness?`	`number`

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:41

TokenDefaults

Ƭ TokenDefaults: Object

Type declaration

Name	Type
`defaultDisplayedDecimals`	`number`
`defaultDisplayedPriceDecimals`	`number`

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:49

ReliableEventSubscriberConfig

Ƭ ReliableEventSubscriberConfig: Object

Type declaration

Name	Type
`defaultBlockManagerOptions`	`BlockManager.Options`
`blockManagerOptionsByNetwork`	`Record`<`network`, `BlockManager.Options`>
`defaultReliableHttpProviderOptions`	`Omit`<`ReliableHttpProvider.Options`, `"onError"`>
`reliableHttpProviderOptionsByNetwork`	`Record`<`network`, `Omit`<`ReliableHttpProvider.Options`, `"onError"`>>
`defaultReliableWebSocketOptions`	`Omit`<`ReliableWebsocketProvider.Options`, `"wsUrl"`>
`reliableWebSocketOptionsByNetwork`	`Record`<`network`, `Omit`<`ReliableWebsocketProvider.Options`, `"wsUrl"`>>

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:54

KandelNetworkConfiguration

Ƭ KandelNetworkConfiguration: Object

Kandel configuration for a specific chain.

Param

The factor to multiply the gasprice by. This is used to ensure that the Kandel offers do not fail to be reposted even if Mangrove's gasprice increases up to this.

Param

The maximum number of offers to include in a single populate transaction to avoid exceeding the gas limit.

Param

The maximum number of offers to include in a single retract transaction to avoid exceeding the gas limit.

Type declaration

Name	Type
`gaspriceFactor`	`number`
`maxOffersInPopulateChunk`	`number`
`maxOffersInRetractChunk`	`number`

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:80

KandelMarketConfiguration

Ƭ KandelMarketConfiguration: Object

Kandel configuration for a specific market.

Param

Whether AaveKandel should be allowed to be used.

Param

Additional factor for the minimum amount of base token that should be offered per offer to stay above density requirements.

Param

Additional factor for the minimum amount of quote token that should be offered per offer to stay above density requirements.

Param

The default step size used when transporting funds from an offer to its dual.

Param

The default baseQuoteTickOffset number of ticks to jump between two price points - this gives the geometric progression. Should be >=1.

Type declaration

Name	Type
`aaveEnabled`	`boolean`
`minimumBasePerOfferFactor`	`Big`
`minimumQuotePerOfferFactor`	`Big`
`stepSize`	`number`
`baseQuoteTickOffset`	`number`

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:93

KandelRawMarketConfiguration

Ƭ KandelRawMarketConfiguration: Omit<KandelMarketConfiguration, "minimumBasePerOfferFactor" | "minimumQuotePerOfferFactor" | "baseQuoteTickOffset"> & { minimumBasePerOfferFactor: Bigish ; minimumQuotePerOfferFactor: Bigish ; baseQuoteTickOffset: number }

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:101

KandelAllConfigurationFields

Ƭ KandelAllConfigurationFields: KandelNetworkConfiguration & KandelRawMarketConfiguration

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:112

PartialKandelAllConfigurationFields

Ƭ PartialKandelAllConfigurationFields: Partial<KandelAllConfigurationFields>

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:115

PartialMarketConfig

Ƭ PartialMarketConfig: PartialKandelAllConfigurationFields

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:117

PartialNetworkConfig

Ƭ PartialNetworkConfig: PartialKandelAllConfigurationFields & { markets?: Record<tokenId, Record<tokenId, Record<number, PartialMarketConfig>>> }

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:118

PartialKandelConfiguration

Ƭ PartialKandelConfiguration: PartialKandelAllConfigurationFields & { networks?: Record<network, PartialNetworkConfig> }

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:125

MangroveOrderNetworkConfiguration

Ƭ MangroveOrderNetworkConfiguration: Object

Mangrove order configuration for a specific chain.

Param

The gasreq for a resting order using the MangroveOrder contract.

Param

The factor to multiply the gasprice by. This is used to ensure that the offers do not fail to be reposted even if Mangrove's gasprice increases up to this.

Param

The overhead of making a market order using the take function on MangroveOrder vs a market order directly on Mangrove.

Type declaration

Name	Type
`restingOrderGasreq`	`number`
`restingOrderGaspriceFactor`	`number`
`takeGasOverhead`	`number`

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:134

PartialMangroveOrderConfiguration

Ƭ PartialMangroveOrderConfiguration: Partial<MangroveOrderNetworkConfiguration> & { networks?: Record<network, Partial<MangroveOrderNetworkConfiguration>> }

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:140

Configuration

Ƭ Configuration: Object

Type declaration

Name	Type
`addressesByNetwork`	`AddressesConfig`
`tokenDefaults`	`TokenDefaults`
`tokens`	`Record`<`tokenId`, `TokenConfig`>
`tokenSymbolDefaultIdsByNetwork`	`Record`<`tokenSymbol`, `Record`<`network`, `tokenId`>>
`mangroveOrder`	`PartialMangroveOrderConfiguration`
`reliableEventSubscriber`	`ReliableEventSubscriberConfig`
`kandel`	`PartialKandelConfiguration`

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:145

PartialConfiguration

Ƭ PartialConfiguration: RecursivePartial<Configuration>

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:157

MarketOrMarketFactory

Ƭ MarketOrMarketFactory: Market | (baseAddress: string, quoteAddress: string, tickSpacing: number) => Promise<Market>

Defined in

@mangrovedao/mangrove.js/src/kandel/coreKandelInstance.ts:22

KandelParameters

Ƭ KandelParameters: Object

Notice

Parameters for a Kandel instance.

Param

The gas price used when provisioning offers.

Param

The gas required to execute a trade.

Param

The step size used when transporting funds from an offer to its dual. Should be >=1.

Param

The number of price points. Should be >=2.

Type declaration

Name	Type
`gasprice`	`number`
`gasreq`	`number`
`stepSize`	`number`
`pricePoints`	`number`

Defined in

@mangrovedao/mangrove.js/src/kandel/coreKandelInstance.ts:37

KandelParameterOverrides

Ƭ KandelParameterOverrides: Object

Notice

Parameters for a Kandel instance where provided properties override current values. baseQuoteTickOffset takes precedence over priceRatio. Note that baseQuoteTickOffset and pricePoints are normally provided via the KandelDistribution. @seeKandelParameters for more information.

Remarks

Cannot simply be Partial<KandelParameters> due to Big vs Bigish.

Type declaration

Name	Type
`gasprice?`	`number`
`gasreq?`	`number`
`stepSize?`	`number`
`pricePoints?`	`number`

Defined in

@mangrovedao/mangrove.js/src/kandel/coreKandelInstance.ts:49

PriceDistributionParams

Ƭ PriceDistributionParams: Object

Price and price ratio parameters for calculating a geometric price distribution.

Param

The minimum price in the distribution (used to derive minTick).

Param

The maximum price in the distribution.

Param

The ratio between each price point (used to derive baseQuoteTickOffset).

Param

The mid-price used to determine when to switch from bids to asks. (used to derive midTick).

Param

The step size used when transporting funds from an offer to its dual.

Param

Whether to generate the distribution outwards from the midPrice or upwards from the minPrice.

Type declaration

Name	Type
`minPrice?`	`Bigish`
`maxPrice?`	`Bigish`
`priceRatio?`	`Bigish`
`midPrice?`	`Bigish`
`stepSize`	`number`
`generateFromMid`	`boolean`

Defined in

@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelDistributionHelper.ts:16

TickDistributionParams

Ƭ TickDistributionParams: Object

Tick and offset parameters for calculating a geometric price distribution. Parameters should conform to tickSpacing of the market (i.e. be divisible by it).

Param

The minimum base quote tick in the distribution.

Param

The maximum base quote tick in the distribution (used to derive minTick).

Param

The number of ticks to jump between two price points.

Param

The number of price points in the distribution.

Param

The mid-price as base quote tick used to determine when to switch from bids to asks.

Param

The step size used when transporting funds from an offer to its dual.

Param

Whether to generate the distribution outwards from the midPrice or upwards from the minPrice.

Type declaration

Name	Type
`minBaseQuoteTick`	`number`
`maxBaseQuoteTick`	`number`
`baseQuoteTickOffset`	`number`
`midBaseQuoteTick`	`number`
`pricePoints`	`number`
`stepSize`	`number`
`generateFromMid`	`boolean`

Defined in

@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelDistributionHelper.ts:34

DistributionParams

Ƭ DistributionParams: PriceDistributionParams & Partial<TickDistributionParams>

Parameters for calculating a geometric price distribution. Exactly three of minPrice (or minTick), maxPrice (or maxTick), priceRatio (or baseQuoteTickOffset), and pricePoints must be provided.

Defined in

@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelDistributionHelper.ts:45

GeometricKandelParameterOverrides

Ƭ GeometricKandelParameterOverrides: Object

Notice

Parameters specific to a geometric Kandel instance where provided properties override current values. baseQuoteTickOffset takes precedence over priceRatio. Note that baseQuoteTickOffset and pricePoints are normally provided via the KandelDistribution.

See

GeometricKandelParameters for more information.

Remarks

Cannot simply be Partial<GeometricKandelParameters> due to Big vs Bigish.

Type declaration

Name	Type
`baseQuoteTickOffset?`	`number`
`priceRatio?`	`Bigish`

Defined in

@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelInstance.ts:38

OffersWithLiveness

Ƭ OffersWithLiveness: { tick: number ; index: number ; id: number ; live: boolean }[]

Offers with their price, liveness, and Kandel index.

Param

The tick of the offer.

Param

The index of the price point in Kandel.

Param

The Mangrove offer id of the offer.

Param

Whether the offer is live.

Defined in

@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelStatus.ts:11

OfferStatus

Ƭ OfferStatus: Object

The status of an offer at a price point.

Param

Whether a bid is expected to be live.

Param

Whether an ask is expected to be live.

Param

The expected price of the offer based on extrapolation from a live offer near the mid price.

Param

The expected ask tick of the offer (negate for bids) based on extrapolation from a live offer near the mid price.

Param

The status of the current ask at the price point or undefined if there never was an ask at this point.

Param

Whether the offer is live.

Param

The Mangrove offer id.

Param

The actual price of the offer.

Param

The status of the current bid at the price point or undefined if there is no bid.

Param

Whether the offer is live.

Param

The Mangrove offer id.

Param

The actual price of the offer.

Type declaration

Name	Type
`expectedLiveBid`	`boolean`
`expectedLiveAsk`	`boolean`
`expectedBaseQuoteTick`	`number`
`expectedPrice`	`Big`
`asks`	`undefined` \| { `live`: `boolean` ; `id`: `number` ; `tick`: `number` ; `price`: `Big` }
`bids`	`undefined` \| { `live`: `boolean` ; `id`: `number` ; `tick`: `number` ; `price`: `Big` }

Defined in

@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelStatus.ts:32

Statuses

Ƭ Statuses: Object

Statuses of offers at each price point.

Param

The status of each offer.

Param

Offers that are live but have an index above pricePoints. This does not happen if populate is not called when offers are live.

Param

The live offer that is selected near the mid price and used to calculate expected prices.

Param

The minimum price of the offers. This is the price of the offer at index 0 if it is live; otherwise, the expected price at index 0.

Param

The maximum price of the offers. This is the price of the offer at index pricePoints - 1 if it is live; otherwise, the expected price at index pricePoints - 1.

Param

The price ratio calculated based on the baseQuoteTickOffset

Param

The offset in ticks between two price points of the geometric distribution.

Type declaration

Name	Type
`statuses`	`OfferStatus`[]
`liveOutOfRange`	{ `offerType`: `BA` ; `id`: `number` ; `index`: `number` }[]
`baseOffer`	{ `offerType`: `BA` ; `index`: `number` ; `id`: `number` }
`baseOffer.offerType`	`BA`
`baseOffer.index`	`number`
`baseOffer.id`	`number`
`minPrice`	`Big`
`maxPrice`	`Big`
`minBaseQuoteTick`	`number`
`maxBaseQuoteTick`	`number`
`priceRatio`	`Big`
`baseQuoteTickOffset`	`number`

Defined in

@mangrovedao/mangrove.js/src/kandel/geometricKandel/geometricKandelStatus.ts:64

OfferList

Ƭ OfferList: { index: number ; gives: Big ; tick: number }[]

A list of bids or asks with their index, tick, and gives.

Param

The index of the price point in Kandel.

Param

The amount of tokens (base for ask, quote for bid) the offer should give.

Param

The tick for the offer (the tick price of base per quote for bids and quote per base for asks)

Defined in

@mangrovedao/mangrove.js/src/kandel/kandelDistribution.ts:10

OfferDistribution

Ƭ OfferDistribution: Object

Distribution of bids and asks and their base and quote amounts. Take care to ensure duals are included or already populated with correct parameters.

Param

The bids in the distribution.

Param

The asks in the distribution.

Type declaration

Name	Type
`bids`	`OfferList`
`asks`	`OfferList`

Defined in

@mangrovedao/mangrove.js/src/kandel/kandelDistribution.ts:20

OffersWithGives

Ƭ OffersWithGives: { tick: number ; index: number ; gives: Bigish }[]

Offers with their tick, Kandel index, and gives amount.

Param

The tick of the offer.

Param

The index of the price point in Kandel.

Param

The amount of base or quote that the offer gives.

Defined in

@mangrovedao/mangrove.js/src/kandel/kandelDistributionHelper.ts:11

KandelSeed

Ƭ KandelSeed: Object

The parameters for sowing the Kandel instance.

Param

Whether to create an AaveKandel which supplies liquidity on Aave to earn yield, or a standard Kandel.

Param

The market to create the Kandel for.

Param

Whether to enable liquidity sharing for the Kandel so that the signer can publish the same liquidity for multiple router-based Kandels (currently AaveKandel).

Type declaration

Name	Type
`onAave`	`boolean`
`market`	`Market`
`liquiditySharing`	`boolean`

Defined in

@mangrovedao/mangrove.js/src/kandel/kandelSeeder.ts:19

AmountAndOverrides

Ƭ AmountAndOverrides: Object

Type declaration

Name	Type
`amount`	`Bigish`
`overrides`	`ethers.Overrides`

Defined in

@mangrovedao/mangrove.js/src/token.ts:22

ApproveArgs

Ƭ ApproveArgs: Bigish | ethers.Overrides | AmountAndOverrides

Defined in

@mangrovedao/mangrove.js/src/token.ts:26

Bigish

Ƭ Bigish: BigSource

Defined in

@mangrovedao/mangrove.js/src/util.ts:3

prettyPrintFilter

Defined in

@mangrovedao/mangrove.js/src/util/prettyPrint.ts:4

RoundingMode

Ƭ RoundingMode: "nearest" | "roundDown" | "roundUp"

roundDown rounds down to a representable value, roundUp rounds up to a representable value, and nearest rounds to the nearest representable value.

Defined in

@mangrovedao/mangrove.js/src/util/tickPriceHelper.ts:10

CleanUnitParams

Ƭ CleanUnitParams: Object

Type declaration

Name	Type
`ba`	`BA`
`targets`	{ `offerId`: `number` ; `tick`: `number` ; `gasreq`: `ethers.BigNumber` ; `takerWants`: `ethers.BigNumber` }[]
`taker`	`string`
`gasLowerBound?`	`ethers.BigNumberish`

Defined in

@mangrovedao/mangrove.js/src/util/trade.ts:12

Optional

Ƭ Optional<T, K>: Pick<Partial<T>, K> & Omit<T, K>

Type parameters

Name	Type
`T`	`T`
`K`	extends keyof `T`

Defined in

@mangrovedao/mangrove.js/src/util/tradeEventManagement.ts:24

OrderResultWithOptionalSummary

Ƭ OrderResultWithOptionalSummary: Optional<DirtyOrderResult, "summary">

Defined in

@mangrovedao/mangrove.js/src/util/tradeEventManagement.ts:26

Variables

configuration

• Const configuration: Object

Type declaration

Name	Type
`addresses`	{ `getAllAddresses`: (`network`: `string`) => [`string`, `string`][] ; `getAddress`: (`name`: `string`, `network`: `string`) => `string` ; `watchAddress`: (`network`: `string`, `name`: `string`, `callback`: (`address`: `string`) => `void`) => `void` ; `setAddress`: (`name`: `string`, `address`: `string`, `network`: `string`) => `void` }
`addresses.getAllAddresses`	(`network`: `string`) => [`string`, `string`][]
`addresses.getAddress`	(`name`: `string`, `network`: `string`) => `string`
`addresses.watchAddress`	(`network`: `string`, `name`: `string`, `callback`: (`address`: `string`) => `void`) => `void`
`addresses.setAddress`	(`name`: `string`, `address`: `string`, `network`: `string`) => `void`
`tokens`	{ `isTokenIdRegistered`: (`tokenId`: `string`) => `boolean` ; `getDefaultIdForSymbolOnNetwork`: (`tokenSymbol`: `string`, `network`: `string`) => `string` ; `getTokenIdFromAddress`: (`address`: `string`, `network`: `string`) => `undefined` \| `string` ; `getDecimals`: (`tokenId`: `string`) => `number` ; `getOrFetchDecimals`: (`tokenId`: `string`, `provider`: `Provider`) => `Promise`<`number`> ; `fetchDecimals`: (`tokenId`: `string`, `provider`: `Provider`) => `Promise`<`number`> ; `getSymbol`: (`tokenId`: `string`) => `undefined` \| `string` ; `getOrFetchSymbol`: (`tokenId`: `string`, `provider`: `Provider`) => `Promise`<`string`> ; `fetchSymbol`: (`tokenId`: `string`, `provider`: `Provider`) => `Promise`<`string`> ; `fetchSymbolFromAddress`: (`address`: `string`, `provider`: `Provider`) => `Promise`<`string`> ; `getDisplayName`: (`tokenId`: `string`) => `undefined` \| `string` ; `getDisplayedDecimals`: (`tokenId`: `string`) => `number` ; `getDisplayedPriceDecimals`: (`tokenId`: `string`) => `number` ; `getCashness`: (`tokenId`: `string`) => `undefined` \| `number` ; `setDefaultIdForSymbolOnNetwork`: (`tokenSymbol`: `string`, `network`: `string`, `tokenId`: `string`) => `void` ; `setDecimals`: (`tokenId`: `string`, `dec`: `number`) => `void` ; `setSymbol`: (`tokenId`: `string`, `symbol`: `string`) => `void` ; `setDisplayName`: (`tokenId`: `string`, `displayName`: `string`) => `void` ; `setDisplayedDecimals`: (`tokenId`: `string`, `dec`: `number`) => `void` ; `setDisplayedPriceDecimals`: (`tokenId`: `string`, `dec`: `number`) => `void` ; `setCashness`: (`tokenId`: `string`, `cashness`: `number`) => `void` }
`tokens.isTokenIdRegistered`	[object Object]
`tokens.getDefaultIdForSymbolOnNetwork`	[object Object]
`tokens.getTokenIdFromAddress`	(`address`: `string`, `network`: `string`) => `undefined` \| `string`
`tokens.getDecimals`	(`tokenId`: `string`) => `number`
`tokens.getOrFetchDecimals`	(`tokenId`: `string`, `provider`: `Provider`) => `Promise`<`number`>
`tokens.fetchDecimals`	(`tokenId`: `string`, `provider`: `Provider`) => `Promise`<`number`>
`tokens.getSymbol`	(`tokenId`: `string`) => `undefined` \| `string`
`tokens.getOrFetchSymbol`	(`tokenId`: `string`, `provider`: `Provider`) => `Promise`<`string`>
`tokens.fetchSymbol`	(`tokenId`: `string`, `provider`: `Provider`) => `Promise`<`string`>
`tokens.fetchSymbolFromAddress`	(`address`: `string`, `provider`: `Provider`) => `Promise`<`string`>
`tokens.getDisplayName`	(`tokenId`: `string`) => `undefined` \| `string`
`tokens.getDisplayedDecimals`	(`tokenId`: `string`) => `number`
`tokens.getDisplayedPriceDecimals`	(`tokenId`: `string`) => `number`
`tokens.getCashness`	(`tokenId`: `string`) => `undefined` \| `number`
`tokens.setDefaultIdForSymbolOnNetwork`	[object Object]
`tokens.setDecimals`	(`tokenId`: `string`, `dec`: `number`) => `void`
`tokens.setSymbol`	(`tokenId`: `string`, `symbol`: `string`) => `void`
`tokens.setDisplayName`	(`tokenId`: `string`, `displayName`: `string`) => `void`
`tokens.setDisplayedDecimals`	(`tokenId`: `string`, `dec`: `number`) => `void`
`tokens.setDisplayedPriceDecimals`	(`tokenId`: `string`, `dec`: `number`) => `void`
`tokens.setCashness`	(`tokenId`: `string`, `cashness`: `number`) => `void`
`reliableEventSubscriber`	{ `getLogsTimeout`: (`network`: `string`) => `number` ; `getBlockManagerOptions`: (`network`: `string`) => `Options` ; `getReliableHttpProviderOptions`: (`network`: `string`) => `Omit`<`Options`, `"onError"`> ; `getReliableWebSocketOptions`: (`network`: `string`) => `Omit`<`Options`, `"wsUrl"`> }
`reliableEventSubscriber.getLogsTimeout`	(`network`: `string`) => `number`
`reliableEventSubscriber.getBlockManagerOptions`	(`network`: `string`) => `Options`
`reliableEventSubscriber.getReliableHttpProviderOptions`	(`network`: `string`) => `Omit`<`Options`, `"onError"`>
`reliableEventSubscriber.getReliableWebSocketOptions`	(`network`: `string`) => `Omit`<`Options`, `"wsUrl"`>
`kandel`	{ `getRawConfiguration`: () => `PartialKandelConfiguration` }
`kandel.getRawConfiguration`	() => `PartialKandelConfiguration`
`mangroveOrder`	{ `getRestingOrderGasreq`: (`network`: `string`) => `number` ; `getRestingOrderGaspriceFactor`: (`network`: `string`) => `number` ; `getTakeGasOverhead`: (`network`: `string`) => `number` }
`mangroveOrder.getRestingOrderGasreq`	(`network`: `string`) => `number`
`mangroveOrder.getRestingOrderGaspriceFactor`	(`network`: `string`) => `number`
`mangroveOrder.getTakeGasOverhead`	(`network`: `string`) => `number`
`resetConfiguration`	() => `void`
`updateConfiguration`	(`defaults`: `RecursivePartial`<`Configuration`>) => `void`

Defined in

@mangrovedao/mangrove.js/src/configuration.ts:771

Functions

enableLogging

▸ enableLogging(): void

Returns

void

Defined in

@mangrovedao/mangrove.js/src/util/logger.ts:10

Namespaces​

Classes​

Interfaces​

References​

default​

Type Aliases​

RecursivePartial​

Type parameters​

Defined in​

network​

Defined in​

address​

Defined in​

tokenId​

Defined in​

tokenSymbol​

Defined in​

NamedAddresses​

Defined in​

AddressesConfig​

Defined in​

TokenConfig​

Type declaration​

Defined in​

TokenDefaults​

Type declaration​

Defined in​

ReliableEventSubscriberConfig​

Type declaration​

Defined in​

KandelNetworkConfiguration​

Type declaration​

Defined in​

KandelMarketConfiguration​

Type declaration​

Defined in​

KandelRawMarketConfiguration​

Defined in​

KandelAllConfigurationFields​

Defined in​

PartialKandelAllConfigurationFields​

Defined in​

PartialMarketConfig​

Defined in​

PartialNetworkConfig​

Defined in​

PartialKandelConfiguration​

Defined in​

MangroveOrderNetworkConfiguration​

Type declaration​

Defined in​

PartialMangroveOrderConfiguration​

Defined in​

Configuration​

Type declaration​

Defined in​

PartialConfiguration​

Defined in​

MarketOrMarketFactory​

Defined in​

KandelParameters​

Type declaration​

Defined in​

KandelParameterOverrides​

Type declaration​

Defined in​

PriceDistributionParams​

Type declaration​

Defined in​

TickDistributionParams​

Type declaration​

Defined in​

DistributionParams​

Defined in​

GeometricKandelParameterOverrides​

Type declaration​

Defined in​

OffersWithLiveness​

Defined in​

OfferStatus​

Namespaces

Classes

Interfaces

References

default

Type Aliases

RecursivePartial

Type parameters

Defined in

network

Defined in

address

Defined in

tokenId

Defined in

tokenSymbol

Defined in

NamedAddresses

Defined in

AddressesConfig

Defined in

TokenConfig

Type declaration

Defined in

TokenDefaults

Type declaration

Defined in

ReliableEventSubscriberConfig

Type declaration

Defined in

KandelNetworkConfiguration

Type declaration

Defined in

KandelMarketConfiguration

Type declaration

Defined in

KandelRawMarketConfiguration

Defined in

KandelAllConfigurationFields

Defined in

PartialKandelAllConfigurationFields

Defined in

PartialMarketConfig

Defined in

PartialNetworkConfig

Defined in

PartialKandelConfiguration

Defined in

MangroveOrderNetworkConfiguration

Type declaration

Defined in

PartialMangroveOrderConfiguration

Defined in

Configuration

Type declaration

Defined in

PartialConfiguration

Defined in

MarketOrMarketFactory

Defined in

KandelParameters

Type declaration

Defined in

KandelParameterOverrides

Type declaration

Defined in

PriceDistributionParams

Type declaration

Defined in

TickDistributionParams

Type declaration

Defined in

DistributionParams

Defined in

GeometricKandelParameterOverrides

Type declaration

Defined in

OffersWithLiveness

Defined in

OfferStatus