Class: LiquidityProvider

The LiquidityProvider class connects an offerLogic (or an EOA) to a market. It posts onchain offers.

Constructors

constructor

• new LiquidityProvider(p): LiquidityProvider

Parameters

Name	Type
p	ConstructionParams

Returns

LiquidityProvider

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:63

Properties

mgv

• mgv: Mangrove

Defined in

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

---

logic

• Optional logic: OfferLogic

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:55

---

contract

• Optional contract: ILiquidityProvider

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:56

---

eoa

• Optional eoa: string

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:57

---

market

• market: Market

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:58

---

prettyP

• prettyP: PrettyPrint

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:59

---

gasreq

• gasreq: number

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:60

---

trade

• trade: Trade

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:61

Methods

connect

▸ connect(offerLogic, offerGasreq, p): Promise<LiquidityProvider>

Connects the logic to a Market in order to pass market orders. This assumes the underlying contract of offer logic is an ILiquidityProvider.

Parameters

Name	Type	Description
offerLogic	OfferLogic	The offer logic.
offerGasreq	number	The gas required for the offer execution on the offer logic.
p	Market | { base: string ; quote: string ; tickSpacing: number ; bookOptions?: BookOptions }	The market to connect to. Can be a Market object or a market descriptor.

Returns

Promise<LiquidityProvider>

A LiquidityProvider.

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:89

---

computeOfferProvision

▸ computeOfferProvision(ba, opts?): Promise<Big>

Gets the missing provision in ethers for an offer to be posted or updated with the given parameters, while taking already locked provision into account.

Parameters

Name	Type	Description
ba	BA	bids or asks
opts	Object	optional parameters for the calculation.
opts.id?	number	the id of the offer to update. If undefined, then the offer is a new offer and nothing is locked.
opts.gasreq?	number	gas required for the offer execution. If undefined, the liquidity provider's gasreq.
opts.gasprice?	number	gas price to use for the calculation. If undefined, then Mangrove's current gas price is used.

Returns

Promise<Big>

the additional required provision, in ethers.

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:126

---

computeBidProvision

▸ computeBidProvision(opts?): Promise<Big>

Gets the missing provision in ethers for a bid using computeOfferProvision.

Parameters

Name	Type
opts	Object
opts.id?	number
opts.gasreq?	number
opts.gasprice?	number

Returns

Promise<Big>

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:156

---

computeAskProvision

▸ computeAskProvision(opts?): Promise<Big>

Gets the missing provision in ethers for an ask using computeOfferProvision.

Parameters

Name	Type
opts	Object
opts.id?	number
opts.gasreq?	number
opts.gasprice?	number

Returns

Promise<Big>

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:163

---

asks

▸ asks(): Offer[]

List all of the maker's asks in the cache

Returns

Offer[]

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:170

---

bids

▸ bids(): Offer[]

List all of the maker's bids in the cache

Returns

Offer[]

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:180

---

consoleAsks

▸ consoleAsks(filter?): void

Pretty prints the current state of the asks for the maker

Parameters

Name	Type
filter?	prettyPrintFilter

Returns

void

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:190

---

consoleBids

▸ consoleBids(filter?): void

Pretty prints the current state of the bids for the maker

Parameters

Name	Type
filter?	prettyPrintFilter

Returns

void

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:195

---

normalizeOfferParams

▸ normalizeOfferParams(p, market): Object

Given offer params (bids/asks + price info as wants&gives or price&volume), return {tick,gives,fund}

Parameters

Name	Type
p	{ ba: BA } & OfferParams
market	KeyResolvedForCalculation

Returns

Object

Name	Type
tick	number
gives	Big
fund?	BigSource

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:203

---

newAsk

▸ newAsk(p, overrides?): Promise<{ id: number ; event: Log }>

Post a new ask

Parameters

Name	Type
p	OfferParams
overrides	Overrides

Returns

Promise<{ id: number ; event: Log }>

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:238

---

newBid

▸ newBid(p, overrides?): Promise<{ id: number ; event: Log }>

Post a new bid

Parameters

Name	Type
p	OfferParams
overrides	Overrides

Returns

Promise<{ id: number ; event: Log }>

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:246

---

newOffer

▸ newOffer(p, overrides?): Promise<{ id: number ; event: Log }>

Parameters

Name	Type
p	{ ba: BA } & OfferParams
overrides	Overrides

Returns

Promise<{ id: number ; event: Log }>

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:267

---

updateAsk

▸ updateAsk(id, p, overrides?): Promise<{ event: Log }>

to change volume and price of the offer, and update its gas requirement and fund 0.01 ether to maker balance

Parameters

Name	Type
id	number
p	OfferParams
overrides	PayableOverrides

Returns

Promise<{ event: Log }>

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:353

---

updateBid

▸ updateBid(id, p, overrides?): Promise<{ event: Log }>

Update an existing offer

Parameters

Name	Type
id	number
p	OfferParams
overrides	PayableOverrides

Returns

Promise<{ event: Log }>

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:362

---

updateOffer

▸ updateOffer(id, p, overrides?): Promise<{ event: Log }>

Parameters

Name	Type
id	number
p	{ ba: BA } & OfferParams
overrides	PayableOverrides

Returns

Promise<{ event: Log }>

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:374

---

retractAsk

▸ retractAsk(id, deprovision?, overrides?): Promise<void>

Cancel an ask. If deprovision is true, will return the offer's provision to the maker balance at Mangrove.

Parameters

Name	Type	Default value
id	number	undefined
deprovision	boolean	false
overrides	Overrides	{}

Returns

Promise<void>

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:443

---

retractBid

▸ retractBid(id, deprovision?, overrides?): Promise<void>

Cancel a bid. If deprovision is true, will return the offer's provision to the maker balance at Mangrove.

Parameters

Name	Type	Default value
id	number	undefined
deprovision	boolean	false
overrides	Overrides	{}

Returns

Promise<void>

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:452

---

retractOffer

▸ retractOffer(ba, id, deprovision?, overrides?): Promise<void>

Parameters

Name	Type	Default value
ba	BA	undefined
id	number	undefined
deprovision	boolean	false
overrides	Overrides	{}

Returns

Promise<void>

Defined in

@mangrovedao/mangrove.js/src/liquidityProvider.ts:461