From 2ca7be06b8710fb69e247ea0d202a27ae468712c Mon Sep 17 00:00:00 2001
From: DaoDev <88341957+DaoDev44@users.noreply.github.com>
Date: Tue, 23 Nov 2021 11:19:46 -0700
Subject: [PATCH] Fix: rename getMinMax to getZrxMinMax; rename
getSendMaxAmount to getZrxSendMaxAmount
---
.../src/swappers/zrx/ZrxSwapper.test.ts | 20 +++++++++----------
.../swapper/src/swappers/zrx/ZrxSwapper.ts | 8 ++++----
.../getZrxMinMax.test.ts} | 10 +++++-----
.../getZrxMinMax.ts} | 4 ++--
.../getZrxSendMaxAmount.test.ts} | 18 ++++++++---------
.../getZrxSendMaxAmount.ts} | 2 +-
6 files changed, 31 insertions(+), 31 deletions(-)
rename packages/swapper/src/swappers/zrx/{getMinMax/getMinMax.test.ts => getZrxMinMax/getZrxMinMax.test.ts} (71%)
rename packages/swapper/src/swappers/zrx/{getMinMax/getMinMax.ts => getZrxMinMax/getZrxMinMax.ts} (93%)
rename packages/swapper/src/swappers/zrx/{getSendMaxAmount/getSendMaxAmount.test.ts => getZrxSendMaxAmount/getZrxSendMaxAmount.test.ts} (90%)
rename packages/swapper/src/swappers/zrx/{getSendMaxAmount/getSendMaxAmount.ts => getZrxSendMaxAmount/getZrxSendMaxAmount.ts} (98%)
diff --git a/packages/swapper/src/swappers/zrx/ZrxSwapper.test.ts b/packages/swapper/src/swappers/zrx/ZrxSwapper.test.ts
index 6df5a1a69..c83e0de24 100644
--- a/packages/swapper/src/swappers/zrx/ZrxSwapper.test.ts
+++ b/packages/swapper/src/swappers/zrx/ZrxSwapper.test.ts
@@ -9,9 +9,9 @@ import { ZrxBuildQuoteTx } from '../zrx/ZrxBuildQuoteTx/ZrxBuildQuoteTx'
import { ZrxExecuteQuote } from './ZrxExecuteQuote/ZrxExecuteQuote'
import { ZrxApprovalNeeded } from './ZrxApprovalNeeded/ZrxApprovalNeeded'
import { ZrxApproveInfinite } from './ZrxApproveInfinite/ZrxApproveInfinite'
-import { getMinMax } from './getMinMax/getMinMax'
+import { getZrxMinMax } from './getZrxMinMax/getZrxMinMax'
import { getZrxQuote } from './getZrxQuote/getZrxQuote'
-import { getSendMaxAmount } from './getSendMaxAmount/getSendMaxAmount'
+import { getZrxSendMaxAmount } from './getZrxSendMaxAmount/getZrxSendMaxAmount'
import { getUsdRate } from './utils/helpers/helpers'
import { BTC, FOX, WETH } from './utils/test-data/assets'
import { setupQuote } from './utils/test-data/setupSwapQuote'
@@ -29,8 +29,8 @@ jest.mock('./getZrxQuote/getZrxQuote', () => ({
getZrxQuote: jest.fn()
}))
-jest.mock('./getMinMax/getMinMax', () => ({
- getMinMax: jest.fn()
+jest.mock('./getZrxMinMax/getZrxMinMax', () => ({
+ getZrxMinMax: jest.fn()
}))
jest.mock('./ZrxApprovalNeeded/ZrxApprovalNeeded', () => ({
@@ -41,8 +41,8 @@ jest.mock('./ZrxApproveInfinite/ZrxApproveInfinite', () => ({
ZrxApproveInfinite: jest.fn()
}))
-jest.mock('./getSendMaxAmount/getSendMaxAmount', () => ({
- getSendMaxAmount: jest.fn()
+jest.mock('./getZrxSendMaxAmount/getZrxSendMaxAmount', () => ({
+ getZrxSendMaxAmount: jest.fn()
}))
describe('ZrxSwapper', () => {
@@ -109,11 +109,11 @@ describe('ZrxSwapper', () => {
await swapper.getUsdRate(FOX)
expect(getUsdRate).toHaveBeenCalled()
})
- it('calls getMinMax on swapper.getMinMax', async () => {
+ it('calls getZrxMinMax on swapper.getMinMax', async () => {
const swapper = new ZrxSwapper(zrxSwapperDeps)
const { quoteInput } = setupQuote()
await swapper.getMinMax(quoteInput)
- expect(getMinMax).toHaveBeenCalled()
+ expect(getZrxMinMax).toHaveBeenCalled()
})
it('calls ZrxApprovalNeeded on swapper.approvalNeeded', async () => {
@@ -131,7 +131,7 @@ describe('ZrxSwapper', () => {
expect(ZrxApproveInfinite).toHaveBeenCalled()
})
- it('calls getSendMaxAmount on swapper.getSendMaxAmount', async () => {
+ it('calls getZrxSendMaxAmount on swapper.getSendMaxAmount', async () => {
const swapper = new ZrxSwapper(zrxSwapperDeps)
const args = {
quote,
@@ -140,6 +140,6 @@ describe('ZrxSwapper', () => {
feeEstimateKey: chainAdapters.FeeDataKey.Average
}
await swapper.getSendMaxAmount(args)
- expect(getSendMaxAmount).toHaveBeenCalled()
+ expect(getZrxSendMaxAmount).toHaveBeenCalled()
})
})
diff --git a/packages/swapper/src/swappers/zrx/ZrxSwapper.ts b/packages/swapper/src/swappers/zrx/ZrxSwapper.ts
index c0eadd32e..554ff323f 100644
--- a/packages/swapper/src/swappers/zrx/ZrxSwapper.ts
+++ b/packages/swapper/src/swappers/zrx/ZrxSwapper.ts
@@ -21,9 +21,9 @@ import { ZrxApprovalNeeded } from './ZrxApprovalNeeded/ZrxApprovalNeeded'
import { ZrxApproveInfinite } from './ZrxApproveInfinite/ZrxApproveInfinite'
import { ZrxBuildQuoteTx } from './ZrxBuildQuoteTx/ZrxBuildQuoteTx'
import { ZrxExecuteQuote } from './ZrxExecuteQuote/ZrxExecuteQuote'
-import { getMinMax } from './getMinMax/getMinMax'
+import { getZrxMinMax } from './getZrxMinMax/getZrxMinMax'
import { getZrxQuote } from './getZrxQuote/getZrxQuote'
-import { getSendMaxAmount } from './getSendMaxAmount/getSendMaxAmount'
+import { getZrxSendMaxAmount } from './getZrxSendMaxAmount/getZrxSendMaxAmount'
import { getUsdRate } from './utils/helpers/helpers'
export type ZrxSwapperDeps = {
adapterManager: ChainAdapterManager
@@ -62,7 +62,7 @@ export class ZrxSwapper implements Swapper {
}
async getMinMax(input: GetQuoteInput): Promise<MinMaxOutput> {
- return getMinMax(input)
+ return getZrxMinMax(input)
}
getAvailableAssets(assets: Asset[]): Asset[] {
@@ -95,6 +95,6 @@ export class ZrxSwapper implements Swapper {
}
async getSendMaxAmount(args: SendMaxAmountInput): Promise<string> {
- return getSendMaxAmount(this.deps, args)
+ return getZrxSendMaxAmount(this.deps, args)
}
}
diff --git a/packages/swapper/src/swappers/zrx/getMinMax/getMinMax.test.ts b/packages/swapper/src/swappers/zrx/getZrxMinMax/getZrxMinMax.test.ts
similarity index 71%
rename from packages/swapper/src/swappers/zrx/getMinMax/getMinMax.test.ts
rename to packages/swapper/src/swappers/zrx/getZrxMinMax/getZrxMinMax.test.ts
index b093023e2..1382c1b5c 100644
--- a/packages/swapper/src/swappers/zrx/getMinMax/getMinMax.test.ts
+++ b/packages/swapper/src/swappers/zrx/getZrxMinMax/getZrxMinMax.test.ts
@@ -4,7 +4,7 @@ jest.mock('../utils/helpers/helpers')
import { MAX_ZRX_TRADE } from '../utils/constants'
import { BTC, FOX, WETH } from '../utils/test-data/assets'
import { zrxService as mockZrxService } from '../utils/zrxService'
-import { getMinMax } from './getMinMax'
+import { getZrxMinMax } from './getZrxMinMax'
;(<jest.Mock<unknown>>mockZrxService.get).mockImplementation(() => ({
data: { price: '100' }
}))
@@ -13,16 +13,16 @@ jest.mock('../utils/helpers/helpers', () => ({
normalizeAmount: () => '1'
}))
-describe('getMinMax', () => {
+describe('getZrxMinMax', () => {
it('returns minimum, maximum, and minimumPrice', async () => {
- const minMax = await getMinMax({ sellAsset: FOX, buyAsset: WETH })
+ const minMax = await getZrxMinMax({ sellAsset: FOX, buyAsset: WETH })
expect(minMax.minimum).toBe('1')
expect(minMax.maximum).toBe(MAX_ZRX_TRADE)
expect(minMax.minimumPrice).toBe('100')
})
it('fails on non eth asset', async () => {
- await expect(getMinMax({ sellAsset: BTC, buyAsset: WETH })).rejects.toThrow(
- 'ZrxError:getMinMax - must be eth assets'
+ await expect(getZrxMinMax({ sellAsset: BTC, buyAsset: WETH })).rejects.toThrow(
+ 'ZrxError:getZrxMinMax - must be eth assets'
)
})
})
diff --git a/packages/swapper/src/swappers/zrx/getMinMax/getMinMax.ts b/packages/swapper/src/swappers/zrx/getZrxMinMax/getZrxMinMax.ts
similarity index 93%
rename from packages/swapper/src/swappers/zrx/getMinMax/getMinMax.ts
rename to packages/swapper/src/swappers/zrx/getZrxMinMax/getZrxMinMax.ts
index d745b1ed1..a88f7c79d 100644
--- a/packages/swapper/src/swappers/zrx/getMinMax/getMinMax.ts
+++ b/packages/swapper/src/swappers/zrx/getZrxMinMax/getZrxMinMax.ts
@@ -6,13 +6,13 @@ import { getUsdRate, normalizeAmount } from '../utils/helpers/helpers'
import { zrxService } from '../utils/zrxService'
import { ZrxError } from '../ZrxSwapper'
-export const getMinMax = async (
+export const getZrxMinMax = async (
input: Pick<GetQuoteInput, 'sellAsset' | 'buyAsset'>
): Promise<MinMaxOutput> => {
const { sellAsset, buyAsset } = input
if (sellAsset.chain !== ChainTypes.Ethereum || buyAsset.chain !== ChainTypes.Ethereum) {
- throw new ZrxError('getMinMax - must be eth assets')
+ throw new ZrxError('getZrxMinMax - must be eth assets')
}
const buyToken = buyAsset.tokenId || buyAsset.symbol
const sellToken = sellAsset.tokenId || sellAsset.symbol
diff --git a/packages/swapper/src/swappers/zrx/getSendMaxAmount/getSendMaxAmount.test.ts b/packages/swapper/src/swappers/zrx/getZrxSendMaxAmount/getZrxSendMaxAmount.test.ts
similarity index 90%
rename from packages/swapper/src/swappers/zrx/getSendMaxAmount/getSendMaxAmount.test.ts
rename to packages/swapper/src/swappers/zrx/getZrxSendMaxAmount/getZrxSendMaxAmount.test.ts
index 56f13db4a..bc03c97e7 100644
--- a/packages/swapper/src/swappers/zrx/getSendMaxAmount/getSendMaxAmount.test.ts
+++ b/packages/swapper/src/swappers/zrx/getZrxSendMaxAmount/getZrxSendMaxAmount.test.ts
@@ -5,13 +5,13 @@ import BigNumber from 'bignumber.js'
import { ETH_FEE_ESTIMATE_PADDING } from '../utils/constants'
import { setupQuote } from '../utils/test-data/setupSwapQuote'
import { chainAdapterMockFuncs, setupZrxDeps } from '../utils/test-data/setupZrxDeps'
-import { getSendMaxAmount } from './getSendMaxAmount'
+import { getZrxSendMaxAmount } from './getZrxSendMaxAmount'
const createPaddedFee = (value: string) => {
return new BigNumber(value).times(ETH_FEE_ESTIMATE_PADDING).toString()
}
-describe('getSendMaxAmount', () => {
+describe('getZrxSendMaxAmount', () => {
const { web3Instance, adapterManager } = setupZrxDeps()
const { quoteInput: quote } = setupQuote()
const deps = { web3: web3Instance, adapterManager }
@@ -34,7 +34,7 @@ describe('getSendMaxAmount', () => {
})
})
- await expect(getSendMaxAmount(deps, args)).rejects.toThrow(
+ await expect(getZrxSendMaxAmount(deps, args)).rejects.toThrow(
`No balance found for ${quote.sellAsset.symbol}`
)
})
@@ -52,7 +52,7 @@ describe('getSendMaxAmount', () => {
})
})
- await expect(getSendMaxAmount(deps, args)).rejects.toThrow(`No balance found for ETH`)
+ await expect(getZrxSendMaxAmount(deps, args)).rejects.toThrow(`No balance found for ETH`)
})
it('should throw an error if ETH balance is less than the estimated fee', async () => {
@@ -73,7 +73,7 @@ describe('getSendMaxAmount', () => {
})
})
- await expect(getSendMaxAmount(deps, args)).rejects.toThrow(
+ await expect(getZrxSendMaxAmount(deps, args)).rejects.toThrow(
'ETH balance is less than estimated fee'
)
})
@@ -96,7 +96,7 @@ describe('getSendMaxAmount', () => {
})
})
- await expect(getSendMaxAmount(deps, args)).rejects.toThrow(
+ await expect(getZrxSendMaxAmount(deps, args)).rejects.toThrow(
'quote.txData is required to get correct fee estimate'
)
})
@@ -115,7 +115,7 @@ describe('getSendMaxAmount', () => {
})
})
- expect(await getSendMaxAmount(deps, args)).toEqual(erc20Balance)
+ expect(await getZrxSendMaxAmount(deps, args)).toEqual(erc20Balance)
})
it('should return max ETH balance in wei (balance minus txFee)', async () => {
@@ -137,7 +137,7 @@ describe('getSendMaxAmount', () => {
})
})
- expect(await getSendMaxAmount(deps, args)).toEqual(
+ expect(await getZrxSendMaxAmount(deps, args)).toEqual(
new BigNumber(ethBalance).minus(paddedFee).toString()
)
})
@@ -162,7 +162,7 @@ describe('getSendMaxAmount', () => {
})
})
- expect(await getSendMaxAmount(deps, args)).toEqual(
+ expect(await getZrxSendMaxAmount(deps, args)).toEqual(
new BigNumber(ethBalance).minus(paddedFee).toString()
)
})
diff --git a/packages/swapper/src/swappers/zrx/getSendMaxAmount/getSendMaxAmount.ts b/packages/swapper/src/swappers/zrx/getZrxSendMaxAmount/getZrxSendMaxAmount.ts
similarity index 98%
rename from packages/swapper/src/swappers/zrx/getSendMaxAmount/getSendMaxAmount.ts
rename to packages/swapper/src/swappers/zrx/getZrxSendMaxAmount/getZrxSendMaxAmount.ts
index 4d5f7ebee..6cb28e69b 100644
--- a/packages/swapper/src/swappers/zrx/getSendMaxAmount/getSendMaxAmount.ts
+++ b/packages/swapper/src/swappers/zrx/getZrxSendMaxAmount/getZrxSendMaxAmount.ts
@@ -6,7 +6,7 @@ import { bnOrZero } from '../utils/bignumber'
import { ETH_FEE_ESTIMATE_PADDING } from '../utils/constants'
import { ZrxSwapperDeps } from '../ZrxSwapper'
-export async function getSendMaxAmount(
+export async function getZrxSendMaxAmount(
{ adapterManager }: ZrxSwapperDeps,
{
wallet,