Namespace: mgvTestUtil

Enumerations

• AccountName

Type Aliases

Account

Ƭ Account: Object

Type declaration

Name	Type
name	string
address	string
signer	ethers.Signer
connectedContracts	{ mangrove: typechain.IMangrove ; testMaker: typechain.SimpleTestMaker ; tokenA: typechain.TestToken ; tokenB: typechain.TestToken }
connectedContracts.mangrove	typechain.IMangrove
connectedContracts.testMaker	typechain.SimpleTestMaker
connectedContracts.tokenA	typechain.TestToken
connectedContracts.tokenB	typechain.TestToken

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:10

---

Balances

Ƭ Balances: Object

Type declaration

Name	Type
ether	ethers.BigNumber
tokenA	ethers.BigNumber
tokenB	ethers.BigNumber

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:23

---

AddressAndSigner

Ƭ AddressAndSigner: Object

Type declaration

Name	Type
address	string
signer	string

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:31

---

Addresses

Ƭ Addresses: Object

Type declaration

Name	Type
mangrove	AddressAndSigner
testMaker	AddressAndSigner
tokenA	AddressAndSigner
tokenB	AddressAndSigner

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:33

---

Contracts

Ƭ Contracts: Object

Type declaration

Name	Type
mangrove	typechain.IMangrove
testMaker	typechain.SimpleTestMaker
tokenA	typechain.TestToken
tokenB	typechain.TestToken

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:89

---

NewOffer

Ƭ NewOffer: Object

Type declaration

Name	Type
market	Market
ba	BA
maker	Account
tick?	ethers.BigNumberish
gives?	ethers.BigNumberish
gasreq?	ethers.BigNumberish
shouldFail?	boolean
shouldReturnData?	boolean
shouldRevert?	boolean

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:218

Variables

bidsAsks

• Const bidsAsks: BA[]

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:29

---

rawMinGivesBase

• Const rawMinGivesBase: BigNumber

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:46

---

rawMinGivesQuote

• Const rawMinGivesQuote: BigNumber

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:47

---

isTrackingPolls

• isTrackingPolls: boolean = false

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:230

---

eventsForLastTxHaveBeenGeneratedPromise

• eventsForLastTxHaveBeenGeneratedPromise: Promise<void>

Await this when you want to wait for all events corresponding to the last sent tx to have been sent.

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:239

Functions

setConfig

▸ setConfig(_mgv, accounts): void

Parameters

Name	Type
_mgv	Mangrove
accounts	any

Returns

void

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:55

---

getAddresses

▸ getAddresses(): Promise<Addresses>

Returns

Promise<Addresses>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:62

---

logAddresses

▸ logAddresses(): Promise<void>

Returns

Promise<void>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:82

---

getContracts

▸ getContracts(signer): Promise<Contracts>

Parameters

Name	Type
signer	Signer

Returns

Promise<Contracts>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:96

---

getAccount

▸ getAccount(name): Promise<Account>

Parameters

Name	Type
name	AccountName

Returns

Promise<Account>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:127

---

getAccountBalances

▸ getAccountBalances(account, provider): Promise<Balances>

Parameters

Name	Type
account	Account
provider	Provider

Returns

Promise<Balances>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:140

---

getBalances

▸ getBalances(accounts, provider): Promise<Map<string, Balances>>

Parameters

Name	Type
accounts	Account[]
provider	Provider

Returns

Promise<Map<string, Balances>>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:151

---

logBalances

▸ logBalances(accounts, balancesBefore, balancesAfter): Promise<void>

Parameters

Name	Type
accounts	Account[]
balancesBefore	Map<string, Balances>
balancesAfter	Map<string, Balances>

Returns

Promise<void>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:162

---

waitForBlock

▸ waitForBlock(mgv, blockNumber): Promise<void>

Parameters

Name	Type
mgv	Mangrove
blockNumber	number

Returns

Promise<void>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:243

---

initPollOfTransactionTracking

▸ initPollOfTransactionTracking(provider): void

Call this to enable tracking of whether the last transaction sent by this library has been mined and polled.

Parameters

Name	Type
provider	Provider

Returns

void

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:282

---

stopPollOfTransactionTracking

▸ stopPollOfTransactionTracking(): void

Call this disable tracking of whether the last transaction sent by this library has been mined and polled.

Returns

void

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:292

---

waitForTransactions

▸ waitForTransactions(txPromises): Promise<TransactionReceipt[]>

Use this to await transactions. In addition to convenience, it allows us to track when events for the last tx have been generated. NB: Only works when this is awaited before sending more tx's.

Parameters

Name	Type
txPromises	(undefined | ContractTransaction | Promise<undefined | ContractTransaction>)[] | Promise<(undefined | ContractTransaction | Promise<undefined | ContractTransaction>)[]>

Returns

Promise<TransactionReceipt[]>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:303

---

waitForOptionalTransaction

▸ waitForOptionalTransaction(txPromise): Promise<TransactionReceipt | undefined>

Use this to await transactions or return immediately if promise returns undefined. In addition to convenience, it allows us to track when events for the last tx have been generated. NB: Only works when this is awaited before sending more tx's.

Parameters

Name	Type
txPromise	undefined | ContractTransaction | Promise<undefined | ContractTransaction>

Returns

Promise<TransactionReceipt | undefined>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:331

---

waitForTransaction

▸ waitForTransaction(txPromise): Promise<TransactionReceipt>

Use this to await transactions. In addition to convenience, it allows us to track when events for the last tx have been generated. NB: Only works when this is awaited before sending more tx's.

Parameters

Name	Type
txPromise	ContractTransaction | Promise<ContractTransaction>

Returns

Promise<TransactionReceipt>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:355

---

postNewOffer

▸ postNewOffer(«destructured»): Promise<TransactionReceipt>

Parameters

Name	Type
«destructured»	NewOffer

Returns

Promise<TransactionReceipt>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:366

---

postNewRevertingOffer

▸ postNewRevertingOffer(market, ba, maker): Promise<TransactionReceipt>

Parameters

Name	Type
market	Market
ba	BA
maker	Account

Returns

Promise<TransactionReceipt>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:408

---

postNewSucceedingOffer

▸ postNewSucceedingOffer(market, ba, maker): Promise<TransactionReceipt>

Parameters

Name	Type
market	Market
ba	BA
maker	Account

Returns

Promise<TransactionReceipt>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:423

---

postNewFailingOffer

▸ postNewFailingOffer(market, ba, maker): Promise<TransactionReceipt>

Parameters

Name	Type
market	Market
ba	BA
maker	Account

Returns

Promise<TransactionReceipt>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:431

---

setMgvGasPrice

▸ setMgvGasPrice(gasPrice): Promise<void>

Parameters

Name	Type
gasPrice	BigNumberish

Returns

Promise<void>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:439

---

mint

▸ mint(token, receiver, amount): Promise<void>

Parameters

Name	Type
token	Token
receiver	Account
amount	number

Returns

Promise<void>

Defined in

@mangrovedao/mangrove.js/src/util/test/mgvIntegrationTestUtil.ts:477