Class: Trade

Constructors

constructor

• new Trade(): Trade

Returns

Trade

Properties

tradeEventManagement

• tradeEventManagement: TradeEventManagement

Defined in

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

Methods

getParamsForTrade

▸ getParamsForTrade(params, market, bs): Object

Get raw parameters to send to Mangrove for a buy or sell order for the given trade and market parameters.

Parameters

Name	Type
params	TradeParams
market	KeyResolvedForCalculation
bs	BS

Returns

Object

Name	Type
maxTick	number
fillVolume	BigNumber
fillWants	boolean

Defined in

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

---

validateSlippage

▸ validateSlippage(slippage?): number

Parameters

Name	Type	Default value
slippage	number	0

Returns

number

Defined in

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

---

comparePrices

▸ comparePrices(price, priceComparison, referencePrice): boolean

Parameters

Name	Type
price	BigSource
priceComparison	"gt" | "lt"
referencePrice	BigSource

Returns

boolean

Defined in

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

---

isPriceBetter

▸ isPriceBetter(price, referencePrice, ba): boolean

Parameters

Name	Type
price	undefined | BigSource
referencePrice	undefined | BigSource
ba	BA

Returns

boolean

Defined in

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

---

isPriceWorse

▸ isPriceWorse(price, referencePrice, ba): boolean

Parameters

Name	Type
price	undefined | BigSource
referencePrice	undefined | BigSource
ba	BA

Returns

boolean

Defined in

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

---

getRawParams

▸ getRawParams(bs, params, market): Object

Get raw parameters to send to Mangrove for a buy or sell order for the given trade and market parameters.

Parameters

Name	Type	Description
bs	BS	buy or sell
params	TradeParams	trade parameters - see Market.TradeParams
market	Market	market to trade on

Returns

Object

raw parameters for a market order to send to Mangrove

Name	Type
maxTick	number
fillVolume	BigNumber
fillWants	boolean
restingOrderParams	undefined | null | RestingOrderParams
orderType	string

Defined in

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

---

order

▸ order(bs, params, market, overrides?): Promise<Transaction<OrderResult>>

Market order. Will attempt to buy or sell base token using quote tokens.

Parameters

Name	Type	Description
bs	BS	whether to buy or sell base token
params	TradeParams	trade parameters - see Market.TradeParams
market	Market	the market to trade on
overrides	Overrides	ethers overrides for the transaction

Returns

Promise<Transaction<OrderResult>>

a promise that resolves to the transaction response and the result of the trade

Defined in

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

---

updateRestingOrder

▸ updateRestingOrder(market, ba, params, overrides?): Promise<Transaction<void>>

Update a resting order posted by MangroveOrder.

Parameters

Name	Type	Description
market	Market	the market to retract the order on
ba	BA	whether the offer is a bid or ask
params	UpdateRestingOrderParams	update parameters - see Market.UpdateRestingOrderParams
overrides	Overrides	overrides for the transaction

Returns

Promise<Transaction<void>>

a promise that resolves to the transaction response and the result of the update.

Defined in

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

---

getRawUpdateRestingOrderParams

▸ getRawUpdateRestingOrderParams(params, market, ba, tick, gives): Object

Gets parameters to send to function market.mgv.orderContract.updateOffer.

Parameters

Name	Type	Description
params	UpdateRestingOrderParams	update parameters - see Market.UpdateRestingOrderParams
market	KeyResolvedForCalculation	the market to retract the order on
ba	BA	whether the offer is a bid or ask
tick	number	-
gives	Big	-

Returns

Object

the raw parameters to send to the MangroveOrder contract

Name	Type
gives	BigNumber
tick	number

Defined in

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

---

retractRestingOrder

▸ retractRestingOrder(market, ba, id, deprovision?, overrides?): Promise<Transaction<void>>

Retract a resting order posted by MangroveOrder.

Parameters

Name	Type	Default value	Description
market	Market	undefined	the market to retract the order on
ba	BA	undefined	whether the offer is a bid or ask
id	number	undefined	the offer id
deprovision	boolean	false	whether to deprovision the offer. If true, the offer's provision will be returned to the maker's balance on Mangrove.
overrides	Overrides	{}	overrides for the transaction

Returns

Promise<Transaction<void>>

Defined in

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

---

clean

▸ clean(params, market, overrides?): Promise<{ result: Promise<CleanResult> ; response: Promise<ContractTransaction> }>

Clean a set of given offers.

Parameters

Name	Type	Description
params	CleanParams	Parameters for the cleaning, specifying the target offers, the side of the market to clean, and optionally the taker to impersonate.
market	Market	the market to clean on
overrides	Overrides	ethers overrides for the transaction

Returns

Promise<{ result: Promise<CleanResult> ; response: Promise<ContractTransaction> }>

a promise that resolves to the transaction response and the result of the cleaning.

See

Market.CleanParams for a more thorough description of cleaning parameters.

Defined in

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

---

getRawCleanParams

▸ getRawCleanParams(params, market): Promise<RawCleanParams>

Gets parameters to send to function market.mgv.cleanerContract.cleanByImpersonation.

Parameters

Name	Type	Description
params	CleanParams	Parameters for the cleaning, specifying the target offers, the side of the market to clean, and optionally the taker to impersonate.
market	Market	the market to clean on

Returns

Promise<RawCleanParams>

a promise that resolves to the raw parameters to send to the cleaner contract

Remarks

See

Market.CleanParams for a more thorough description of cleaning parameters.

Defined in

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

---

estimateGas

▸ estimateGas(bs, params, market): Promise<BigNumber>

Estimate amount of gas for a buy or sell order for the given volume.

Parameters

Name	Type	Description
bs	BS	buy or sell
params	TradeParams	The parameters for the trade
market	Market	The market

Returns

Promise<BigNumber>

an estimate of the gas required for the trade

Defined in

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

---

simulateGas

▸ simulateGas(bs, params, market): Promise<undefined | BigNumber>

Simulate the gas required for a market order.

Parameters

Name	Type	Description
bs	BS	buy or sell
params	TradeParams	trade parameters - see Market.TradeParams
market	Market	the market to trade on

Returns

Promise<undefined | BigNumber>

an estimate of the gas required for the trade

Defined in

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

---

createTxWithOptionalGasEstimation

▸ createTxWithOptionalGasEstimation<T>(createTx, estimateTx, gasLowerBound, overrides, args): Promise<ContractTransaction>

Type parameters

Name	Type
T	extends any[]

Parameters

Name	Type
createTx	(...args: T) => Promise<ContractTransaction>
estimateTx	(...args: T) => Promise<BigNumber>
gasLowerBound	BigNumberish
overrides	Overrides
args	T

Returns

Promise<ContractTransaction>

Defined in

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

---

marketOrder

▸ marketOrder(«destructured», overrides): Promise<Transaction<OrderResult>>

Low level Mangrove market order. If orderType is "buy", the base/quote market will be used,

If orderType is "sell", the quote/base market will be used,

fillWants defines whether the market order stops immediately once wants tokens have been purchased or whether it tries to keep going until gives tokens have been spent.

In addition, slippage defines an allowed slippage in % of the amount of quote token.

Returns a promise for market order result after 1 confirmation. Will throw on same conditions as ethers.js transaction.wait.

Parameters

Name	Type
«destructured»	Object
› maxTick	number
› fillVolume	BigNumber
› orderType	BS
› fillWants	boolean
› market	Market
› gasLowerBound	BigNumberish
overrides	Overrides

Returns

Promise<Transaction<OrderResult>>

Defined in

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

---

responseToMarketOrderResult

▸ responseToMarketOrderResult(response, orderType, fillWants, fillVolume, market): Promise<OrderResult>

Parameters

Name	Type
response	Promise<ContractTransaction>
orderType	BS
fillWants	boolean
fillVolume	BigNumber
market	Market

Returns

Promise<OrderResult>

Defined in

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

---

mangroveOrder

▸ mangroveOrder(«destructured», overrides): Promise<Transaction<OrderResult>>

Low level resting order.

Returns a promise for market order result after 1 confirmation.

Will throw on same conditions as ethers.js transaction.wait.

Parameters

Name	Type
«destructured»	Object
› maxTick	number
› fillVolume	BigNumber
› orderType	BS
› fillWants	boolean
› fillOrKill	boolean
› expiryDate	number
› restingParams	undefined | RestingOrderParams
› market	Market
› gasLowerBound	BigNumberish
overrides	Overrides

Returns

Promise<Transaction<OrderResult>>

Defined in

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

---

responseToMangroveOrderResult

▸ responseToMangroveOrderResult(response, orderType, fillWants, fillVolume, market, offerId): Promise<OrderResult>

Parameters

Name	Type
response	Promise<ContractTransaction>
orderType	BS
fillWants	boolean
fillVolume	BigNumber
market	Market
offerId	undefined | number

Returns

Promise<OrderResult>

Defined in

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

---

getRestingOrderParams

▸ getRestingOrderParams(params, market, ba): Promise<{ provision: BigSource ; restingOrderGasreq: number ; gaspriceFactor: number ; restingOrderBa: string }>

Determines the parameters for a resting order which can be provided via default configuration value.

Parameters

Name	Type	Description
params	RestingOrderParams	The resting order params. See Market.RestingOrderParams.
market	Market	The market.
ba	BA	The BA of the taker order; the resting order will be the opposite.

Returns

Promise<{ provision: BigSource ; restingOrderGasreq: number ; gaspriceFactor: number ; restingOrderBa: string }>

The resting order parameters.

Defined in

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

---

initialResult

▸ initialResult(receipt): OrderResultWithOptionalSummary

Parameters

Name	Type
receipt	ContractReceipt

Returns

OrderResultWithOptionalSummary

Defined in

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

---

baToBs

▸ baToBs(ba): BS

Parameters

Name	Type
ba	BA

Returns

BS

Defined in

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

---

bsToBa

▸ bsToBa(bs): BA

Parameters

Name	Type
bs	BS

Returns

BA

Defined in

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

---

getCleanRawParamsFromUnitParams

▸ getCleanRawParamsFromUnitParams(unitParams, market): Promise<RawCleanParams>

Gets parameters to send to functions market.mgv.contract.cleanByImpersonation.

Parameters

Name	Type
unitParams	CleanUnitParams
market	Market

Returns

Promise<RawCleanParams>

Defined in

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

---

cleanWithRawParameters

▸ cleanWithRawParameters(raw, market, overrides): Promise<{ result: Promise<DirtyOrderResult> ; response: Promise<ContractTransaction> }>

Low level sniping of targets.

Returns a promise for clean result after 1 confirmation. Will throw on same conditions as ethers.js transaction.wait.

Parameters

Name	Type
raw	RawCleanParams
market	Market
overrides	Overrides

Returns

Promise<{ result: Promise<DirtyOrderResult> ; response: Promise<ContractTransaction> }>

Defined in

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

---

responseToCleanResult

▸ responseToCleanResult(response, raw, market): Promise<OrderResult>

Parameters

Name	Type
response	Promise<ContractTransaction>
raw	RawCleanParams
market	Market

Returns

Promise<OrderResult>

Defined in

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