Class: Mangrove

Constructors

constructor

• new Mangrove(params): Mangrove

Parameters

Name	Type
params	Object
params.signer	Signer
params.network	ProviderNetwork
params.readOnly	boolean
params.blockManagerOptions	Options
params.reliableHttpProvider	Options
params.getLogsTimeout	number
params.eventEmitter	EventEmitter
params.reliableWebSocketOptions?	Object
params.reliableWebSocketOptions.options	Options
params.reliableWebSocketOptions.wsUrl	string
params.shouldNotListenToNewEvents?	boolean
params.multicallContract	Multicall2
params.address	string
params.contract	IMangrove
params.readerContract	MgvReader
params.orderContract	MangroveOrder
params.config	GlobalConfig

Returns

Mangrove

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:306

Properties

provider

• provider: Provider

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:123

---

signer

• signer: Signer

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:124

---

network

• network: ProviderNetwork

Defined in

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

---

_readOnly

• _readOnly: boolean

Defined in

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

---

address

• address: string

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:127

---

contract

• contract: IMangrove

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:128

---

readerContract

• readerContract: MgvReader

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:129

---

multicallContract

• multicallContract: Multicall2

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:130

---

orderContract

• orderContract: MangroveOrder

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:131

---

reliableProvider

• reliableProvider: ReliableProvider

Defined in

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

---

mangroveEventSubscriber

• mangroveEventSubscriber: MangroveEventSubscriber

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:133

---

shouldNotListenToNewEvents

• shouldNotListenToNewEvents: boolean

Defined in

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

---

olKeyHashToOLKeyStructMap

• olKeyHashToOLKeyStructMap: Map<string, OLKeyStruct>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:135

---

olKeyStructToOlKeyHashMap

• olKeyStructToOlKeyHashMap: Map<string, string>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:136

---

nativeToken

• nativeToken: TokenCalculations

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:137

---

eventEmitter

• eventEmitter: EventEmitter

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:139

---

_config

• _config: GlobalConfig

Defined in

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

---

devNode

▪ Static devNode: DevNode

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:142

---

typechain

▪ Static typechain: __module = typechain

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:143

Methods

connect

▸ connect(options?): Promise<Mangrove>

Creates an instance of the Mangrove Typescript object

Parameters

Name	Type	Description
options?	string | CreateOptions	Optional provider options

Returns

Promise<Mangrove>

Returns an instance mangrove.js

Example

const mgv = await require('mangrove.js').connect(options); // web browser

if options is a string s, it is considered to be {provider:s} const mgv = await require('mangrove.js').connect('http://127.0.0.1:8545'); // HTTP provider

Options:

• privateKey: 0x...
• mnemonic: horse battery ...
• path: m/44'/60'/0'/...
• provider: url, provider object, or chain string

See

Mangrove.CreateOptions for more details on optional provider parameters.

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:168

---

disconnect

▸ disconnect(): void

Disconnect from Mangrove.

Removes all listeners from the provider and stops the reliable provider.

Returns

void

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:295

---

getOlKeyHash

▸ getOlKeyHash(olKey): string

Parameters

Name	Type
olKey	OLKeyStruct

Returns

string

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:384

---

getOlKeyStruct

▸ getOlKeyStruct(olKeyHash): Promise<undefined | OLKeyStruct>

Parameters

Name	Type
olKeyHash	string

Returns

Promise<undefined | OLKeyStruct>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:397

---

calculateOLKeyHash

▸ calculateOLKeyHash(olKey): string

Parameters

Name	Type
olKey	OLKeyStruct

Returns

string

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:417

---

updateConfiguration

▸ updateConfiguration(config?): void

Update the configuration by providing a partial configuration containing only the values that should be changed/added.

Parameters

Name	Type	Description
config?	RecursivePartial<Configuration>	Partial configuration that should be merged into the existing configuration.

Returns

void

Example

updateConfiguration({
  tokens: {
    SYM: {
      decimals: 18
    }
  }
})

This adds configuration for a new token with symbol "SYM". Or, if "SYM" was already configured, ensures that its decimals is set to 18.

Defined in

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

---

resetConfiguration

▸ resetConfiguration(): void

Reset the configuration to defaults provided by mangrove.js

Returns

void

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:445

---

market

▸ market(params): Promise<Market>

---

Parameters

Name	Type
params	Key & { bookOptions?: BookOptions }

Returns

Promise<Market>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:481

---

offerLogic

▸ offerLogic(logic): OfferLogic

Get an OfferLogic object allowing one to monitor and set up an onchain offer logic

Parameters

Name	Type
logic	string

Returns

OfferLogic

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:506

---

liquidityProvider

▸ liquidityProvider(p): Promise<LiquidityProvider>

Get a LiquidityProvider object to enable Mangrove's signer to pass buy and sell orders.

Parameters

Name	Type
p	Market | { base: string ; quote: string ; tickSpacing: number ; bookOptions?: BookOptions }

Returns

Promise<LiquidityProvider>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:522

---

token

▸ token(symbolOrId, options?): Promise<Token>

Return Token instance, fetching data (decimals) from chain if needed.

Parameters

Name	Type
symbolOrId	string
options?	ConstructorOptions

Returns

Promise<Token>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:551

---

tokenFromSymbol

▸ tokenFromSymbol(symbol, options?): Promise<Token>

Return Token instance, fetching data (decimals) from chain if needed.

Parameters

Name	Type
symbol	string
options?	ConstructorOptions

Returns

Promise<Token>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:559

---

tokenFromId

▸ tokenFromId(tokenId, options?): Promise<Token>

Return Token instance, fetching data (decimals) from chain if needed.

Parameters

Name	Type
tokenId	string
options?	ConstructorOptions

Returns

Promise<Token>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:567

---

tokenFromAddress

▸ tokenFromAddress(address): Promise<Token>

Return token instance from address, fetching data (decimals) from chain if needed.

Parameters

Name	Type
address	string

Returns

Promise<Token>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:577

---

getAddress

▸ getAddress(name): string

Read a contract address on the current network.

Note that this reads from the static Mangrove address registry which is shared across instances of this class.

Parameters

Name	Type
name	string

Returns

string

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:586

---

getTokenAddress

▸ getTokenAddress(symbolOrId): string

Read a token address on the current network.

Note that this reads from the static Mangrove address registry which is shared across instances of this class.

Parameters

Name	Type
symbolOrId	string

Returns

string

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:598

---

setAddress

▸ setAddress(name, address): void

Set a contract address on the current network.

Note that this writes to the static Mangrove address registry which is shared across instances of this class.

Parameters

Name	Type
name	string
address	string

Returns

void

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:607

---

balanceOf

▸ balanceOf(address, overrides?): Promise<Big>

Provision available at mangrove for address given in argument, in ethers

Parameters

Name	Type
address	string
overrides	Overrides

Returns

Promise<Big>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:616

---

fundMangrove

▸ fundMangrove(amount, maker, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
amount	BigSource
maker	string
overrides	Overrides

Returns

Promise<ContractTransaction>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:624

---

withdraw

▸ withdraw(amount, overrides?): Promise<ContractTransaction>

Parameters

Name	Type
amount	BigSource
overrides	Overrides

Returns

Promise<ContractTransaction>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:636

---

optValueToPayableOverride

▸ optValueToPayableOverride(overrides, fund?): PayableOverrides

Parameters

Name	Type
overrides	Overrides
fund?	BigSource

Returns

PayableOverrides

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:643

---

approveMangrove

▸ approveMangrove(tokenId, arg?): Promise<ContractTransaction>

Parameters

Name	Type
tokenId	string
arg	ApproveArgs

Returns

Promise<ContractTransaction>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:654

---

calculateOfferProvision

▸ calculateOfferProvision(gasprice, gasreq, gasbase): Big

Calculates the provision required or locked for an offer based on the given parameters

Parameters

Name	Type	Description
gasprice	number	the gas price for the offer in Mwei.
gasreq	number	the gas requirement for the offer
gasbase	number	the offer list's offer_gasbase.

Returns

Big

the required provision, in ethers.

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:668

---

calculateOffersProvision

▸ calculateOffersProvision(offers): Big

Calculates the provision required or locked for offers based on the given parameters

Parameters

Name	Type	Description
offers	OfferProvisionParams[]	the offers to calculate provision for.

Returns

Big

the required provision, in ethers.

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:680

---

getMissingProvision

▸ getMissingProvision(lockedProvision, totalRequiredProvision): Big

Gets the missing provision based on the required provision and the locked provision.

Parameters

Name	Type	Description
lockedProvision	BigSource	the provision already locked for an offer.
totalRequiredProvision	BigSource	the provision required for an offer.

Returns

Big

the additional required provision, in ethers.

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:699

---

config

▸ config(): GlobalConfig

Return global Mangrove config from cache.

Returns

GlobalConfig

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:711

---

fetchConfig

▸ fetchConfig(): Promise<GlobalConfig>

Return global Mangrove config from chain.

Returns

Promise<GlobalConfig>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:718

---

rawConfigToConfig

▸ rawConfigToConfig(rawConfig): GlobalConfig

Parameters

Name	Type
rawConfig	GlobalUnpackedStructOutput

Returns

GlobalConfig

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:724

---

normalizePermitData

▸ normalizePermitData(params): Promise<PermitData>

Permit data normalization Autofill/convert 'nonce' field of permit data if need, convert deadline to num if needed.

Parameters

Name	Type
params	SimplePermitData

Returns

Promise<PermitData>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:743

---

simpleSignPermitData

▸ simpleSignPermitData(params): Promise<string>

Sign typed data for permit(). To set the deadline to +days or +months, you can do let date = new Date(); date.setDate(date.getDate() + days); date.setMonth(date.getMonth() + months);

• Nonce is auto-selected if needed and can be a number
• Date can be a Date or a number

Parameters

Name	Type
params	SimplePermitData

Returns

Promise<string>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:774

---

signPermitData

▸ signPermitData(data): Promise<string>

Permit data generator for normalized permit data input

Parameters

Name	Type
data	PermitData

Returns

Promise<string>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:780

---

permit

▸ permit(params): Promise<ContractTransaction>

Give permit to Mangrove. Permit params.spender to buy on behalf of owner on the outbound/inbound offer list up to value. Default deadline is now + 1 day. Default nonce is current owner nonce.

Parameters

Name	Type
params	SimplePermitData

Returns

Promise<ContractTransaction>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:816

---

getAllAddresses

▸ getAllAddresses(network): [string, string][]

Read all contract addresses on the given network.

Parameters

Name	Type
network	string

Returns

[string, string][]

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:848

---

getAddress

▸ getAddress(name, network): string

Read a contract address on a given network.

Parameters

Name	Type
name	string
network	string

Returns

string

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:855

---

setAddress

▸ setAddress(name, address, network): void

Set a contract address on the given network.

Parameters

Name	Type
name	string
address	string
network	string

Returns

void

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:862

---

initAndListenToDevNode

▸ initAndListenToDevNode(devNode): Promise<void>

Setup dev node necessary contracts if needed, register dev Multicall2 address, listen to future additions (a script external to mangrove.js may deploy contracts during execution).

Parameters

Name	Type
devNode	DevNode

Returns

Promise<void>

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:871

---

openMarkets

▸ openMarkets(params?): Promise<OpenMarketInfo[]>

Returns open markets data according to MgvReader.

Parameters

Name	Type	Description
params	Object	-
params.from?	number	start at market from. Default 0.
params.maxLen?	number | BigNumber	max number of markets returned. Default all.
params.configs?	boolean	fetch market's config information. Default true.

Returns

Promise<OpenMarketInfo[]>

Note

If an open market has a token with no/bad decimals/symbol function, this function will revert.

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:902

---

toBaseQuoteByCashness

▸ toBaseQuoteByCashness(token0, token1): Object

Parameters

Name	Type
token0	Token
token1	Token

Returns

Object

Name	Type
base	Token
quote	Token

Defined in

@mangrovedao/mangrove.js/src/mangrove.ts:979