Use eth_feeHistory as a fallback for gas estimates #614

mcmire · 2021-10-08T22:51:42Z

If we are on an EIP-1559-supported network and the Metaswap API fails
for some reason, fall back to using eth_feeHistory to calculate gas
estimates (which the API uses anyway). This code is more or less taken
from the code for the API (1).

Fixes #600.

src/gas/fetchFeeHistory.ts

src/gas/fetchGasEstimatesViaEthFeeHistory.test.ts

src/gas/fetchGasEstimatesViaEthFeeHistory.ts

mcmire · 2021-10-08T22:56:58Z

src/util.test.ts

@@ -20,50 +18,6 @@ const GAS_PRICE = 'gasPrice';
 const FAIL = 'lol';
 const PASS = '0x1';

-const mockFlags: { [key: string]: any } = {


I am not sure why these were here. I assume that they existed once to test out the query function, but we don't actually need a real EthQuery object to test that.

src/gas/fetchFeeHistory.ts

src/gas/fetchGasEstimatesViaEthFeeHistory.ts

mcmire · 2021-10-11T20:19:42Z

src/gas/determineGasFeeSuggestions.ts

@@ -69,7 +75,12 @@ export default async function determineGasFeeSuggestions({

  if (isEIP1559Compatible) {
    strategies.push(async () => {
-      const estimates = await fetchGasEstimates(fetchGasEstimatesUrl, clientId);
+      let estimates: GasFeeEstimates;


@danjm Is this what you had in mind? i.e., do we still want to use eth_feeHistory as a fallback for the EIP-1559 Metaswap API, and then continue to use eth_gasPrice as an ultimate fallback whether EIP-1559 or not?

yes, this looks right

danjm · 2021-10-26T13:15:58Z

src/util.ts

+    if (typeof ethQuery[method] === 'function') {
+      ethQuery[method](...args, cb);
+    } else {
+      ethQuery.sendAsync({ method, params: args }, cb);


Is this need because ethQuery doesn't yet have explicit support for eth_feeHistory?

Yes, exactly. web3.js does, but eth-query does not. A bit annoying :/

I suppose we could just use sendAsync directly in this case without "patching" eth-query, but eth-query's sendAsync doesn't return a promise, it only accepts a callback, which is another thing that this query function tries to paper over.

.eslintrc.js

mcmire · 2021-11-01T16:48:55Z

Will update this with some new changes today, stay tuned.

mcmire · 2021-11-01T22:27:21Z

package.json

@@ -76,6 +76,7 @@
    "@metamask/eslint-config-nodejs": "^9.0.0",
    "@metamask/eslint-config-typescript": "^9.0.1",
    "@types/jest": "^26.0.22",
+    "@types/jest-when": "^2.7.3",


jest-when lets you make assertions on different invocations of mock functions (e.g. let the return value be Y only when X is given). See the README for more: https://www.npmjs.com/package/jest-when

mcmire · 2021-11-01T22:29:53Z

src/gas/fetchBlockFeeHistory.ts

+      ? await query(ethQuery, 'blockNumber')
+      : givenEndBlock;
+
+  const requestChunkSpecifiers = determineRequestChunkSpecifiers(


In case the numberOfBlocks is more than 1024, this function will make multiple calls to eth_feeHistory in order to gather all of the desired blocks. This comes in handy later when we want to provide a fallback to Sam's "busy threshold" endpoint, which requires fetching 20,000 blocks.

mcmire · 2021-11-01T22:34:16Z

src/gas/fetchGasEstimatesViaEthFeeHistory.ts

+type Percentile = typeof PRIORITY_LEVEL_PERCENTILES[number];
+
+// This code is translated from the MetaSwap API:
+// <https://gitlab.com/ConsenSys/codefi/products/metaswap/gas-api/-/blob/017436f628b2d5967f6e8734780a9114f9e58af9/src/eip1559/feeHistory.ts>


Note that this file is not a direct translation of the MetaSwap API. I rearranged the code because it made more sense to me and was easier to follow when presented this way (also, fetchBlockFeeHistory returns data in a different format than eth_feeHistory).

mcmire · 2021-11-01T22:34:46Z

This is now ready for review.

If we are on an EIP-1559-supported network and the Metaswap API fails for some reason, fall back to using `eth_feeHistory` to calculate gas estimates (which the API uses anyway). This code is more or less taken from the code for the API ([1]). [1]: https://gitlab.com/ConsenSys/codefi/products/metaswap/gas-api/-/blob/eae6927b1a0c445e02cb3cba9e9e6b0f35857a12/src/eip1559/feeHistory.ts

jpuri

👍 great work

If we are on an EIP-1559-supported network and the Metaswap API fails for some reason, fall back to using `eth_feeHistory` to calculate gas estimates (which the API uses anyway). This code is more or less taken from the code for the API ([1]). [1]: https://gitlab.com/ConsenSys/codefi/products/metaswap/gas-api/-/blob/eae6927b1a0c445e02cb3cba9e9e6b0f35857a12/src/eip1559/feeHistory.ts

mcmire requested a review from a team as a code owner October 8, 2021 22:51

mcmire commented Oct 8, 2021

View reviewed changes

mcmire force-pushed the add-eth-fee-history-fallback-for-gas-estimates branch from a886e92 to cbcf79f Compare October 11, 2021 16:21

mcmire commented Oct 11, 2021

View reviewed changes

mcmire mentioned this pull request Oct 11, 2021

[WIP] Refactor try/catch code in determineGasFeeSuggestions #613

Closed

danjm reviewed Oct 26, 2021

View reviewed changes

mcmire force-pushed the add-eth-fee-history-fallback-for-gas-estimates branch from e7359cd to 5cef2af Compare October 26, 2021 18:17

mcmire changed the base branch from refactor-determine-gas-fee-suggestions to extract-gas-fee-recommendations October 26, 2021 18:17

mcmire commented Oct 26, 2021

View reviewed changes

.eslintrc.js Outdated Show resolved Hide resolved

mcmire force-pushed the extract-gas-fee-recommendations branch 2 times, most recently from 4d5a23b to ecac47e Compare October 28, 2021 20:04

mcmire force-pushed the add-eth-fee-history-fallback-for-gas-estimates branch from 5cef2af to 883b2fe Compare October 28, 2021 20:15

mcmire marked this pull request as draft November 1, 2021 16:48

mcmire changed the title ~~Use eth_feeHistory as a fallback for gas estimates~~ [WIP] Use eth_feeHistory as a fallback for gas estimates Nov 1, 2021

mcmire force-pushed the add-eth-fee-history-fallback-for-gas-estimates branch 2 times, most recently from 6873f34 to 709d386 Compare November 1, 2021 22:21

mcmire changed the title ~~[WIP] Use eth_feeHistory as a fallback for gas estimates~~ Use eth_feeHistory as a fallback for gas estimates Nov 1, 2021

mcmire marked this pull request as ready for review November 1, 2021 22:21

mcmire force-pushed the add-eth-fee-history-fallback-for-gas-estimates branch from 709d386 to b4f23df Compare November 1, 2021 22:32

mcmire commented Nov 1, 2021

View reviewed changes

mcmire force-pushed the extract-gas-fee-recommendations branch 2 times, most recently from fe524df to 809566b Compare November 30, 2021 23:23

mcmire force-pushed the add-eth-fee-history-fallback-for-gas-estimates branch 2 times, most recently from 6c94a80 to 47e0fa0 Compare November 30, 2021 23:35

Base automatically changed from extract-gas-fee-recommendations to eip-1559-v2 December 1, 2021 19:13

mcmire force-pushed the add-eth-fee-history-fallback-for-gas-estimates branch from 47e0fa0 to fbbc906 Compare December 2, 2021 00:29

mcmire force-pushed the add-eth-fee-history-fallback-for-gas-estimates branch from fbbc906 to 46c3788 Compare December 2, 2021 00:32

jpuri approved these changes Dec 2, 2021

View reviewed changes

mcmire merged commit e1d1419 into eip-1559-v2 Dec 2, 2021

mcmire deleted the add-eth-fee-history-fallback-for-gas-estimates branch December 2, 2021 16:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use eth_feeHistory as a fallback for gas estimates #614

Use eth_feeHistory as a fallback for gas estimates #614

mcmire commented Oct 8, 2021

mcmire Oct 8, 2021

mcmire Oct 11, 2021

danjm Oct 26, 2021

danjm Oct 26, 2021

mcmire Oct 26, 2021 •

edited

mcmire Oct 26, 2021

mcmire commented Nov 1, 2021

mcmire Nov 1, 2021 •

edited

mcmire Nov 1, 2021

mcmire Nov 1, 2021 •

edited

mcmire commented Nov 1, 2021

jpuri left a comment

Use eth_feeHistory as a fallback for gas estimates #614

Use eth_feeHistory as a fallback for gas estimates #614

Conversation

mcmire commented Oct 8, 2021

mcmire Oct 8, 2021

Choose a reason for hiding this comment

mcmire Oct 11, 2021

Choose a reason for hiding this comment

danjm Oct 26, 2021

Choose a reason for hiding this comment

danjm Oct 26, 2021

Choose a reason for hiding this comment

mcmire Oct 26, 2021 • edited

Choose a reason for hiding this comment

mcmire Oct 26, 2021

Choose a reason for hiding this comment

mcmire commented Nov 1, 2021

mcmire Nov 1, 2021 • edited

Choose a reason for hiding this comment

mcmire Nov 1, 2021

Choose a reason for hiding this comment

mcmire Nov 1, 2021 • edited

Choose a reason for hiding this comment

mcmire commented Nov 1, 2021

jpuri left a comment

Choose a reason for hiding this comment

mcmire Oct 26, 2021 •

edited

mcmire Nov 1, 2021 •

edited

mcmire Nov 1, 2021 •

edited