From 59212f7a2b8b99c92e59aaa11bc38e16ba9e0d17 Mon Sep 17 00:00:00 2001 From: Erik Marks <25517051+rekmarks@users.noreply.github.com> Date: Tue, 13 Oct 2020 14:13:54 -0700 Subject: [PATCH] Remove dead gas estimation functions, rename function (#9579) --- ui/app/pages/send/send.utils.js | 4 +-- ui/app/pages/send/tests/send-utils.test.js | 34 ++++++++++----------- ui/app/pages/swaps/swaps.util.test.js | 3 -- ui/app/store/actions.js | 35 ++-------------------- 4 files changed, 21 insertions(+), 55 deletions(-) diff --git a/ui/app/pages/send/send.utils.js b/ui/app/pages/send/send.utils.js index 32dc1939a..ab30f0374 100644 --- a/ui/app/pages/send/send.utils.js +++ b/ui/app/pages/send/send.utils.js @@ -26,7 +26,7 @@ export { calcGasTotal, calcTokenBalance, doesAmountErrorRequireUpdate, - estimateGas, + estimateGasForSend, generateTokenTransferData, getAmountErrorObject, getGasFeeErrorObject, @@ -193,7 +193,7 @@ function doesAmountErrorRequireUpdate ({ return amountErrorRequiresUpdate } -async function estimateGas ({ +async function estimateGasForSend ({ selectedAddress, sendToken, blockGasLimit = MIN_GAS_LIMIT_HEX, diff --git a/ui/app/pages/send/tests/send-utils.test.js b/ui/app/pages/send/tests/send-utils.test.js index 0d23947ff..e3a98ea0c 100644 --- a/ui/app/pages/send/tests/send-utils.test.js +++ b/ui/app/pages/send/tests/send-utils.test.js @@ -45,7 +45,7 @@ const sendUtils = proxyquire('../send.utils.js', { const { calcGasTotal, - estimateGas, + estimateGasForSend, doesAmountErrorRequireUpdate, generateTokenTransferData, getAmountErrorObject, @@ -288,7 +288,7 @@ describe('send utils', function () { }) }) - describe('estimateGas', function () { + describe('estimateGasForSend', function () { const baseMockParams = { blockGasLimit: '0x64', selectedAddress: 'mockAddress', @@ -322,8 +322,8 @@ describe('send utils', function () { global.eth.getCode.resetHistory() }) - it('should call ethQuery.estimateGas with the expected params', async function () { - const result = await sendUtils.estimateGas(baseMockParams) + it('should call ethQuery.estimateGasForSend with the expected params', async function () { + const result = await estimateGasForSend(baseMockParams) assert.equal(baseMockParams.estimateGasMethod.callCount, 1) assert.deepEqual( baseMockParams.estimateGasMethod.getCall(0).args[0], @@ -332,8 +332,8 @@ describe('send utils', function () { assert.equal(result, '0xabc16') }) - it('should call ethQuery.estimateGas with the expected params when initialGasLimitHex is lower than the upperGasLimit', async function () { - const result = await estimateGas({ ...baseMockParams, blockGasLimit: '0xbcd' }) + it('should call ethQuery.estimateGasForSend with the expected params when initialGasLimitHex is lower than the upperGasLimit', async function () { + const result = await estimateGasForSend({ ...baseMockParams, blockGasLimit: '0xbcd' }) assert.equal(baseMockParams.estimateGasMethod.callCount, 1) assert.deepEqual( baseMockParams.estimateGasMethod.getCall(0).args[0], @@ -342,8 +342,8 @@ describe('send utils', function () { assert.equal(result, '0xabc16x1.5') }) - it('should call ethQuery.estimateGas with a value of 0x0 and the expected data and to if passed a sendToken', async function () { - const result = await estimateGas({ data: 'mockData', sendToken: { address: 'mockAddress' }, ...baseMockParams }) + it('should call ethQuery.estimateGasForSend with a value of 0x0 and the expected data and to if passed a sendToken', async function () { + const result = await estimateGasForSend({ data: 'mockData', sendToken: { address: 'mockAddress' }, ...baseMockParams }) assert.equal(baseMockParams.estimateGasMethod.callCount, 1) assert.deepEqual( baseMockParams.estimateGasMethod.getCall(0).args[0], @@ -357,10 +357,10 @@ describe('send utils', function () { assert.equal(result, '0xabc16') }) - it('should call ethQuery.estimateGas without a recipient if the recipient is empty and data passed', async function () { + it('should call ethQuery.estimateGasForSend without a recipient if the recipient is empty and data passed', async function () { const data = 'mockData' const to = '' - const result = await estimateGas({ ...baseMockParams, data, to }) + const result = await estimateGasForSend({ ...baseMockParams, data, to }) assert.equal(baseMockParams.estimateGasMethod.callCount, 1) assert.deepEqual( baseMockParams.estimateGasMethod.getCall(0).args[0], @@ -371,40 +371,40 @@ describe('send utils', function () { it(`should return ${SIMPLE_GAS_COST} if ethQuery.getCode does not return '0x'`, async function () { assert.equal(baseMockParams.estimateGasMethod.callCount, 0) - const result = await estimateGas({ ...baseMockParams, to: '0x123' }) + const result = await estimateGasForSend({ ...baseMockParams, to: '0x123' }) assert.equal(result, SIMPLE_GAS_COST) }) it(`should return ${SIMPLE_GAS_COST} if not passed a sendToken or truthy to address`, async function () { assert.equal(baseMockParams.estimateGasMethod.callCount, 0) - const result = await estimateGas({ ...baseMockParams, to: null }) + const result = await estimateGasForSend({ ...baseMockParams, to: null }) assert.equal(result, SIMPLE_GAS_COST) }) it(`should not return ${SIMPLE_GAS_COST} if passed a sendToken`, async function () { assert.equal(baseMockParams.estimateGasMethod.callCount, 0) - const result = await estimateGas({ ...baseMockParams, to: '0x123', sendToken: { address: '0x0' } }) + const result = await estimateGasForSend({ ...baseMockParams, to: '0x123', sendToken: { address: '0x0' } }) assert.notEqual(result, SIMPLE_GAS_COST) }) it(`should return ${BASE_TOKEN_GAS_COST} if passed a sendToken but no to address`, async function () { - const result = await estimateGas({ ...baseMockParams, to: null, sendToken: { address: '0x0' } }) + const result = await estimateGasForSend({ ...baseMockParams, to: null, sendToken: { address: '0x0' } }) assert.equal(result, BASE_TOKEN_GAS_COST) }) it(`should return the adjusted blockGasLimit if it fails with a 'Transaction execution error.'`, async function () { - const result = await estimateGas({ ...baseMockParams, to: 'isContract willFailBecauseOf:Transaction execution error.' }) + const result = await estimateGasForSend({ ...baseMockParams, to: 'isContract willFailBecauseOf:Transaction execution error.' }) assert.equal(result, '0x64x0.95') }) it(`should return the adjusted blockGasLimit if it fails with a 'gas required exceeds allowance or always failing transaction.'`, async function () { - const result = await estimateGas({ ...baseMockParams, to: 'isContract willFailBecauseOf:gas required exceeds allowance or always failing transaction.' }) + const result = await estimateGasForSend({ ...baseMockParams, to: 'isContract willFailBecauseOf:gas required exceeds allowance or always failing transaction.' }) assert.equal(result, '0x64x0.95') }) it(`should reject other errors`, async function () { try { - await estimateGas({ ...baseMockParams, to: 'isContract willFailBecauseOf:some other error' }) + await estimateGasForSend({ ...baseMockParams, to: 'isContract willFailBecauseOf:some other error' }) } catch (err) { assert.equal(err.message, 'some other error') } diff --git a/ui/app/pages/swaps/swaps.util.test.js b/ui/app/pages/swaps/swaps.util.test.js index bf5b166da..527fee29f 100644 --- a/ui/app/pages/swaps/swaps.util.test.js +++ b/ui/app/pages/swaps/swaps.util.test.js @@ -12,9 +12,6 @@ import { } from './swaps-util-test-constants' const swapsUtils = proxyquire('./swaps.util.js', { - '../../store/actions': { - estimateGasFromTxParams: () => Promise.resolve('0x8888'), - }, '../../helpers/utils/fetch-with-cache': { default: (url, fetchObject) => { assert.equal(fetchObject.method, 'GET') diff --git a/ui/app/store/actions.js b/ui/app/store/actions.js index c65ad0368..91dadc4eb 100644 --- a/ui/app/store/actions.js +++ b/ui/app/store/actions.js @@ -5,7 +5,7 @@ import log from 'loglevel' import { capitalize } from 'lodash' import getBuyEthUrl from '../../../app/scripts/lib/buy-eth-url' import { checksumAddress } from '../helpers/utils/util' -import { calcTokenBalance, estimateGas } from '../pages/send/send.utils' +import { calcTokenBalance, estimateGasForSend } from '../pages/send/send.utils' import { fetchLocale, loadRelativeTimeFormatLocaleData } from '../helpers/utils/i18n-helper' import { getMethodDataAsync } from '../helpers/utils/transactions.util' import { fetchSymbolAndDecimals } from '../helpers/utils/token-util' @@ -626,7 +626,7 @@ export function updateGasData ({ }) { return (dispatch) => { dispatch(gasLoadingStarted()) - return estimateGas({ + return estimateGasForSend({ estimateGasMethod: promisifiedBackground.estimateGas, blockGasLimit, selectedAddress, @@ -796,37 +796,6 @@ const updateMetamaskStateFromBackground = () => { }) } -export function estimateGasMethod ({ - gasPrice, - blockGasLimit, - selectedAddress, - sendToken, - to, - value, - data, -}) { - return estimateGas({ - estimateGasMethod: promisifiedBackground.estimateGas, - blockGasLimit, - selectedAddress, - sendToken, - to, - value, - gasPrice, - data, - }) -} - -export async function estimateGasFromTxParams (txParams) { - const backgroundState = await updateMetamaskStateFromBackground() - const blockGasLimit = backgroundState.currentBlockGasLimit - return estimateGasMethod({ - ...txParams, - selectedAddress: txParams.from, - blockGasLimit, - }) -} - export function updateTransaction (txData, dontShowLoadingIndicator) { return (dispatch) => { !dontShowLoadingIndicator && dispatch(showLoadingIndication())