@metamask-previews/gas-fee-controller 20.0.0-preview-cf09c0a → 20.0.0-preview-09a2ffd5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/GasFeeController.js +14 -0
- package/dist/GasFeeController.js.map +1 -0
- package/dist/GasFeeController.mjs +12 -296
- package/dist/GasFeeController.mjs.map +1 -1
- package/dist/chunk-2MFVV2BX.js +156 -0
- package/dist/chunk-2MFVV2BX.js.map +1 -0
- package/dist/chunk-R3IOI7AK.mjs +156 -0
- package/dist/chunk-R3IOI7AK.mjs.map +1 -0
- package/dist/chunk-S5H5NUEH.js +401 -0
- package/dist/chunk-S5H5NUEH.js.map +1 -0
- package/dist/chunk-WXXOCPNT.mjs +401 -0
- package/dist/chunk-WXXOCPNT.mjs.map +1 -0
- package/dist/determineGasFeeCalculations.js +8 -0
- package/dist/determineGasFeeCalculations.js.map +1 -0
- package/dist/determineGasFeeCalculations.mjs +7 -101
- package/dist/determineGasFeeCalculations.mjs.map +1 -1
- package/dist/gas-util.js +15 -0
- package/dist/gas-util.js.map +1 -0
- package/dist/gas-util.mjs +14 -138
- package/dist/gas-util.mjs.map +1 -1
- package/dist/index.js +12 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +11 -1
- package/dist/index.mjs.map +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -0
- package/dist/{GasFeeController.d.mts → types/GasFeeController.d.ts} +5 -5
- package/dist/types/GasFeeController.d.ts.map +1 -0
- package/dist/{determineGasFeeCalculations.d.cts → types/determineGasFeeCalculations.d.ts} +2 -2
- package/dist/types/determineGasFeeCalculations.d.ts.map +1 -0
- package/dist/{gas-util.d.cts → types/gas-util.d.ts} +3 -3
- package/dist/types/gas-util.d.ts.map +1 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/index.d.ts.map +1 -0
- package/package.json +7 -12
- package/dist/GasFeeController.cjs +0 -298
- package/dist/GasFeeController.cjs.map +0 -1
- package/dist/GasFeeController.d.cts +0 -244
- package/dist/GasFeeController.d.cts.map +0 -1
- package/dist/GasFeeController.d.mts.map +0 -1
- package/dist/determineGasFeeCalculations.cjs +0 -105
- package/dist/determineGasFeeCalculations.cjs.map +0 -1
- package/dist/determineGasFeeCalculations.d.cts.map +0 -1
- package/dist/determineGasFeeCalculations.d.mts +0 -42
- package/dist/determineGasFeeCalculations.d.mts.map +0 -1
- package/dist/gas-util.cjs +0 -143
- package/dist/gas-util.cjs.map +0 -1
- package/dist/gas-util.d.cts.map +0 -1
- package/dist/gas-util.d.mts +0 -43
- package/dist/gas-util.d.mts.map +0 -1
- package/dist/index.cjs +0 -18
- package/dist/index.cjs.map +0 -1
- package/dist/index.d.cts +0 -2
- package/dist/index.d.cts.map +0 -1
- package/dist/index.d.mts +0 -2
- package/dist/index.d.mts.map +0 -1
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
var __accessCheck = (obj, member, msg) => {
|
|
2
|
+
if (!member.has(obj))
|
|
3
|
+
throw TypeError("Cannot " + msg);
|
|
4
|
+
};
|
|
5
|
+
var __privateGet = (obj, member, getter) => {
|
|
6
|
+
__accessCheck(obj, member, "read from private field");
|
|
7
|
+
return getter ? getter.call(obj) : member.get(obj);
|
|
8
|
+
};
|
|
9
|
+
var __privateAdd = (obj, member, value) => {
|
|
10
|
+
if (member.has(obj))
|
|
11
|
+
throw TypeError("Cannot add the same private member more than once");
|
|
12
|
+
member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
|
|
13
|
+
};
|
|
14
|
+
var __privateSet = (obj, member, value, setter) => {
|
|
15
|
+
__accessCheck(obj, member, "write to private field");
|
|
16
|
+
setter ? setter.call(obj, value) : member.set(obj, value);
|
|
17
|
+
return value;
|
|
18
|
+
};
|
|
19
|
+
var __privateMethod = (obj, member, method) => {
|
|
20
|
+
__accessCheck(obj, member, "access private method");
|
|
21
|
+
return method;
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
// src/gas-util.ts
|
|
25
|
+
import {
|
|
26
|
+
query,
|
|
27
|
+
handleFetch,
|
|
28
|
+
gweiDecToWEIBN,
|
|
29
|
+
weiHexToGweiDec
|
|
30
|
+
} from "@metamask/controller-utils";
|
|
31
|
+
import BN from "bn.js";
|
|
32
|
+
var makeClientIdHeader = (clientId) => ({ "X-Client-Id": clientId });
|
|
33
|
+
function normalizeGWEIDecimalNumbers(n) {
|
|
34
|
+
const numberAsWEIHex = gweiDecToWEIBN(n).toString(16);
|
|
35
|
+
const numberAsGWEI = weiHexToGweiDec(numberAsWEIHex);
|
|
36
|
+
return numberAsGWEI;
|
|
37
|
+
}
|
|
38
|
+
async function fetchGasEstimates(url, clientId) {
|
|
39
|
+
const estimates = await handleFetch(
|
|
40
|
+
url,
|
|
41
|
+
clientId ? { headers: makeClientIdHeader(clientId) } : void 0
|
|
42
|
+
);
|
|
43
|
+
return {
|
|
44
|
+
low: {
|
|
45
|
+
...estimates.low,
|
|
46
|
+
suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(
|
|
47
|
+
estimates.low.suggestedMaxPriorityFeePerGas
|
|
48
|
+
),
|
|
49
|
+
suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(
|
|
50
|
+
estimates.low.suggestedMaxFeePerGas
|
|
51
|
+
)
|
|
52
|
+
},
|
|
53
|
+
medium: {
|
|
54
|
+
...estimates.medium,
|
|
55
|
+
suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(
|
|
56
|
+
estimates.medium.suggestedMaxPriorityFeePerGas
|
|
57
|
+
),
|
|
58
|
+
suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(
|
|
59
|
+
estimates.medium.suggestedMaxFeePerGas
|
|
60
|
+
)
|
|
61
|
+
},
|
|
62
|
+
high: {
|
|
63
|
+
...estimates.high,
|
|
64
|
+
suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(
|
|
65
|
+
estimates.high.suggestedMaxPriorityFeePerGas
|
|
66
|
+
),
|
|
67
|
+
suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(
|
|
68
|
+
estimates.high.suggestedMaxFeePerGas
|
|
69
|
+
)
|
|
70
|
+
},
|
|
71
|
+
estimatedBaseFee: normalizeGWEIDecimalNumbers(estimates.estimatedBaseFee),
|
|
72
|
+
historicalBaseFeeRange: estimates.historicalBaseFeeRange,
|
|
73
|
+
baseFeeTrend: estimates.baseFeeTrend,
|
|
74
|
+
latestPriorityFeeRange: estimates.latestPriorityFeeRange,
|
|
75
|
+
historicalPriorityFeeRange: estimates.historicalPriorityFeeRange,
|
|
76
|
+
priorityFeeTrend: estimates.priorityFeeTrend,
|
|
77
|
+
networkCongestion: estimates.networkCongestion
|
|
78
|
+
};
|
|
79
|
+
}
|
|
80
|
+
async function fetchLegacyGasPriceEstimates(url, clientId) {
|
|
81
|
+
const result = await handleFetch(url, {
|
|
82
|
+
referrer: url,
|
|
83
|
+
referrerPolicy: "no-referrer-when-downgrade",
|
|
84
|
+
method: "GET",
|
|
85
|
+
mode: "cors",
|
|
86
|
+
headers: {
|
|
87
|
+
"Content-Type": "application/json",
|
|
88
|
+
...clientId && makeClientIdHeader(clientId)
|
|
89
|
+
}
|
|
90
|
+
});
|
|
91
|
+
return {
|
|
92
|
+
low: result.SafeGasPrice,
|
|
93
|
+
medium: result.ProposeGasPrice,
|
|
94
|
+
high: result.FastGasPrice
|
|
95
|
+
};
|
|
96
|
+
}
|
|
97
|
+
async function fetchEthGasPriceEstimate(ethQuery) {
|
|
98
|
+
const gasPrice = await query(ethQuery, "gasPrice");
|
|
99
|
+
return {
|
|
100
|
+
gasPrice: weiHexToGweiDec(gasPrice).toString()
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
function calculateTimeEstimate(maxPriorityFeePerGas, maxFeePerGas, gasFeeEstimates) {
|
|
104
|
+
const { low, medium, high, estimatedBaseFee } = gasFeeEstimates;
|
|
105
|
+
const maxPriorityFeePerGasInWEI = gweiDecToWEIBN(maxPriorityFeePerGas);
|
|
106
|
+
const maxFeePerGasInWEI = gweiDecToWEIBN(maxFeePerGas);
|
|
107
|
+
const estimatedBaseFeeInWEI = gweiDecToWEIBN(estimatedBaseFee);
|
|
108
|
+
const effectiveMaxPriorityFee = BN.min(
|
|
109
|
+
maxPriorityFeePerGasInWEI,
|
|
110
|
+
maxFeePerGasInWEI.sub(estimatedBaseFeeInWEI)
|
|
111
|
+
);
|
|
112
|
+
const lowMaxPriorityFeeInWEI = gweiDecToWEIBN(
|
|
113
|
+
low.suggestedMaxPriorityFeePerGas
|
|
114
|
+
);
|
|
115
|
+
const mediumMaxPriorityFeeInWEI = gweiDecToWEIBN(
|
|
116
|
+
medium.suggestedMaxPriorityFeePerGas
|
|
117
|
+
);
|
|
118
|
+
const highMaxPriorityFeeInWEI = gweiDecToWEIBN(
|
|
119
|
+
high.suggestedMaxPriorityFeePerGas
|
|
120
|
+
);
|
|
121
|
+
let lowerTimeBound;
|
|
122
|
+
let upperTimeBound;
|
|
123
|
+
if (effectiveMaxPriorityFee.lt(lowMaxPriorityFeeInWEI)) {
|
|
124
|
+
lowerTimeBound = null;
|
|
125
|
+
upperTimeBound = "unknown";
|
|
126
|
+
} else if (effectiveMaxPriorityFee.gte(lowMaxPriorityFeeInWEI) && effectiveMaxPriorityFee.lt(mediumMaxPriorityFeeInWEI)) {
|
|
127
|
+
lowerTimeBound = low.minWaitTimeEstimate;
|
|
128
|
+
upperTimeBound = low.maxWaitTimeEstimate;
|
|
129
|
+
} else if (effectiveMaxPriorityFee.gte(mediumMaxPriorityFeeInWEI) && effectiveMaxPriorityFee.lt(highMaxPriorityFeeInWEI)) {
|
|
130
|
+
lowerTimeBound = medium.minWaitTimeEstimate;
|
|
131
|
+
upperTimeBound = medium.maxWaitTimeEstimate;
|
|
132
|
+
} else if (effectiveMaxPriorityFee.eq(highMaxPriorityFeeInWEI)) {
|
|
133
|
+
lowerTimeBound = high.minWaitTimeEstimate;
|
|
134
|
+
upperTimeBound = high.maxWaitTimeEstimate;
|
|
135
|
+
} else {
|
|
136
|
+
lowerTimeBound = 0;
|
|
137
|
+
upperTimeBound = high.maxWaitTimeEstimate;
|
|
138
|
+
}
|
|
139
|
+
return {
|
|
140
|
+
lowerTimeBound,
|
|
141
|
+
upperTimeBound
|
|
142
|
+
};
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
export {
|
|
146
|
+
__privateGet,
|
|
147
|
+
__privateAdd,
|
|
148
|
+
__privateSet,
|
|
149
|
+
__privateMethod,
|
|
150
|
+
normalizeGWEIDecimalNumbers,
|
|
151
|
+
fetchGasEstimates,
|
|
152
|
+
fetchLegacyGasPriceEstimates,
|
|
153
|
+
fetchEthGasPriceEstimate,
|
|
154
|
+
calculateTimeEstimate
|
|
155
|
+
};
|
|
156
|
+
//# sourceMappingURL=chunk-R3IOI7AK.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/gas-util.ts"],"sourcesContent":["import {\n query,\n handleFetch,\n gweiDecToWEIBN,\n weiHexToGweiDec,\n} from '@metamask/controller-utils';\nimport type EthQuery from '@metamask/eth-query';\nimport BN from 'bn.js';\n\nimport type {\n GasFeeEstimates,\n EthGasPriceEstimate,\n EstimatedGasFeeTimeBounds,\n unknownString,\n LegacyGasPriceEstimate,\n} from './GasFeeController';\n\nconst makeClientIdHeader = (clientId: string) => ({ 'X-Client-Id': clientId });\n\n/**\n * Convert a decimal GWEI value to a decimal string rounded to the nearest WEI.\n *\n * @param n - The input GWEI amount, as a decimal string or a number.\n * @returns The decimal string GWEI amount.\n */\nexport function normalizeGWEIDecimalNumbers(n: string | number) {\n const numberAsWEIHex = gweiDecToWEIBN(n).toString(16);\n const numberAsGWEI = weiHexToGweiDec(numberAsWEIHex);\n return numberAsGWEI;\n}\n\n/**\n * Fetch gas estimates from the given URL.\n *\n * @param url - The gas estimate URL.\n * @param clientId - The client ID used to identify to the API who is asking for estimates.\n * @returns The gas estimates.\n */\nexport async function fetchGasEstimates(\n url: string,\n clientId?: string,\n): Promise<GasFeeEstimates> {\n const estimates = await handleFetch(\n url,\n clientId ? { headers: makeClientIdHeader(clientId) } : undefined,\n );\n return {\n low: {\n ...estimates.low,\n suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(\n estimates.low.suggestedMaxPriorityFeePerGas,\n ),\n suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(\n estimates.low.suggestedMaxFeePerGas,\n ),\n },\n medium: {\n ...estimates.medium,\n suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(\n estimates.medium.suggestedMaxPriorityFeePerGas,\n ),\n suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(\n estimates.medium.suggestedMaxFeePerGas,\n ),\n },\n high: {\n ...estimates.high,\n suggestedMaxPriorityFeePerGas: normalizeGWEIDecimalNumbers(\n estimates.high.suggestedMaxPriorityFeePerGas,\n ),\n suggestedMaxFeePerGas: normalizeGWEIDecimalNumbers(\n estimates.high.suggestedMaxFeePerGas,\n ),\n },\n estimatedBaseFee: normalizeGWEIDecimalNumbers(estimates.estimatedBaseFee),\n historicalBaseFeeRange: estimates.historicalBaseFeeRange,\n baseFeeTrend: estimates.baseFeeTrend,\n latestPriorityFeeRange: estimates.latestPriorityFeeRange,\n historicalPriorityFeeRange: estimates.historicalPriorityFeeRange,\n priorityFeeTrend: estimates.priorityFeeTrend,\n networkCongestion: estimates.networkCongestion,\n };\n}\n\n/**\n * Hit the legacy MetaSwaps gasPrices estimate api and return the low, medium\n * high values from that API.\n *\n * @param url - The URL to fetch gas price estimates from.\n * @param clientId - The client ID used to identify to the API who is asking for estimates.\n * @returns The gas price estimates.\n */\nexport async function fetchLegacyGasPriceEstimates(\n url: string,\n clientId?: string,\n): Promise<LegacyGasPriceEstimate> {\n const result = await handleFetch(url, {\n referrer: url,\n referrerPolicy: 'no-referrer-when-downgrade',\n method: 'GET',\n mode: 'cors',\n headers: {\n 'Content-Type': 'application/json',\n ...(clientId && makeClientIdHeader(clientId)),\n },\n });\n return {\n low: result.SafeGasPrice,\n medium: result.ProposeGasPrice,\n high: result.FastGasPrice,\n };\n}\n\n/**\n * Get a gas price estimate from the network using the `eth_gasPrice` method.\n *\n * @param ethQuery - The EthQuery instance to call the network with.\n * @returns A gas price estimate.\n */\nexport async function fetchEthGasPriceEstimate(\n ethQuery: EthQuery,\n): Promise<EthGasPriceEstimate> {\n const gasPrice = await query(ethQuery, 'gasPrice');\n return {\n gasPrice: weiHexToGweiDec(gasPrice).toString(),\n };\n}\n\n/**\n * Estimate the time it will take for a transaction to be confirmed.\n *\n * @param maxPriorityFeePerGas - The max priority fee per gas.\n * @param maxFeePerGas - The max fee per gas.\n * @param gasFeeEstimates - The gas fee estimates.\n * @returns The estimated lower and upper bounds for when this transaction will be confirmed.\n */\nexport function calculateTimeEstimate(\n maxPriorityFeePerGas: string,\n maxFeePerGas: string,\n gasFeeEstimates: GasFeeEstimates,\n): EstimatedGasFeeTimeBounds {\n const { low, medium, high, estimatedBaseFee } = gasFeeEstimates;\n\n const maxPriorityFeePerGasInWEI = gweiDecToWEIBN(maxPriorityFeePerGas);\n const maxFeePerGasInWEI = gweiDecToWEIBN(maxFeePerGas);\n const estimatedBaseFeeInWEI = gweiDecToWEIBN(estimatedBaseFee);\n\n const effectiveMaxPriorityFee = BN.min(\n maxPriorityFeePerGasInWEI,\n maxFeePerGasInWEI.sub(estimatedBaseFeeInWEI),\n );\n\n const lowMaxPriorityFeeInWEI = gweiDecToWEIBN(\n low.suggestedMaxPriorityFeePerGas,\n );\n const mediumMaxPriorityFeeInWEI = gweiDecToWEIBN(\n medium.suggestedMaxPriorityFeePerGas,\n );\n const highMaxPriorityFeeInWEI = gweiDecToWEIBN(\n high.suggestedMaxPriorityFeePerGas,\n );\n\n let lowerTimeBound;\n let upperTimeBound;\n\n if (effectiveMaxPriorityFee.lt(lowMaxPriorityFeeInWEI)) {\n lowerTimeBound = null;\n upperTimeBound = 'unknown' as unknownString;\n } else if (\n effectiveMaxPriorityFee.gte(lowMaxPriorityFeeInWEI) &&\n effectiveMaxPriorityFee.lt(mediumMaxPriorityFeeInWEI)\n ) {\n lowerTimeBound = low.minWaitTimeEstimate;\n upperTimeBound = low.maxWaitTimeEstimate;\n } else if (\n effectiveMaxPriorityFee.gte(mediumMaxPriorityFeeInWEI) &&\n effectiveMaxPriorityFee.lt(highMaxPriorityFeeInWEI)\n ) {\n lowerTimeBound = medium.minWaitTimeEstimate;\n upperTimeBound = medium.maxWaitTimeEstimate;\n } else if (effectiveMaxPriorityFee.eq(highMaxPriorityFeeInWEI)) {\n lowerTimeBound = high.minWaitTimeEstimate;\n upperTimeBound = high.maxWaitTimeEstimate;\n } else {\n lowerTimeBound = 0;\n upperTimeBound = high.maxWaitTimeEstimate;\n }\n\n return {\n lowerTimeBound,\n upperTimeBound,\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,OAAO,QAAQ;AAUf,IAAM,qBAAqB,CAAC,cAAsB,EAAE,eAAe,SAAS;AAQrE,SAAS,4BAA4B,GAAoB;AAC9D,QAAM,iBAAiB,eAAe,CAAC,EAAE,SAAS,EAAE;AACpD,QAAM,eAAe,gBAAgB,cAAc;AACnD,SAAO;AACT;AASA,eAAsB,kBACpB,KACA,UAC0B;AAC1B,QAAM,YAAY,MAAM;AAAA,IACtB;AAAA,IACA,WAAW,EAAE,SAAS,mBAAmB,QAAQ,EAAE,IAAI;AAAA,EACzD;AACA,SAAO;AAAA,IACL,KAAK;AAAA,MACH,GAAG,UAAU;AAAA,MACb,+BAA+B;AAAA,QAC7B,UAAU,IAAI;AAAA,MAChB;AAAA,MACA,uBAAuB;AAAA,QACrB,UAAU,IAAI;AAAA,MAChB;AAAA,IACF;AAAA,IACA,QAAQ;AAAA,MACN,GAAG,UAAU;AAAA,MACb,+BAA+B;AAAA,QAC7B,UAAU,OAAO;AAAA,MACnB;AAAA,MACA,uBAAuB;AAAA,QACrB,UAAU,OAAO;AAAA,MACnB;AAAA,IACF;AAAA,IACA,MAAM;AAAA,MACJ,GAAG,UAAU;AAAA,MACb,+BAA+B;AAAA,QAC7B,UAAU,KAAK;AAAA,MACjB;AAAA,MACA,uBAAuB;AAAA,QACrB,UAAU,KAAK;AAAA,MACjB;AAAA,IACF;AAAA,IACA,kBAAkB,4BAA4B,UAAU,gBAAgB;AAAA,IACxE,wBAAwB,UAAU;AAAA,IAClC,cAAc,UAAU;AAAA,IACxB,wBAAwB,UAAU;AAAA,IAClC,4BAA4B,UAAU;AAAA,IACtC,kBAAkB,UAAU;AAAA,IAC5B,mBAAmB,UAAU;AAAA,EAC/B;AACF;AAUA,eAAsB,6BACpB,KACA,UACiC;AACjC,QAAM,SAAS,MAAM,YAAY,KAAK;AAAA,IACpC,UAAU;AAAA,IACV,gBAAgB;AAAA,IAChB,QAAQ;AAAA,IACR,MAAM;AAAA,IACN,SAAS;AAAA,MACP,gBAAgB;AAAA,MAChB,GAAI,YAAY,mBAAmB,QAAQ;AAAA,IAC7C;AAAA,EACF,CAAC;AACD,SAAO;AAAA,IACL,KAAK,OAAO;AAAA,IACZ,QAAQ,OAAO;AAAA,IACf,MAAM,OAAO;AAAA,EACf;AACF;AAQA,eAAsB,yBACpB,UAC8B;AAC9B,QAAM,WAAW,MAAM,MAAM,UAAU,UAAU;AACjD,SAAO;AAAA,IACL,UAAU,gBAAgB,QAAQ,EAAE,SAAS;AAAA,EAC/C;AACF;AAUO,SAAS,sBACd,sBACA,cACA,iBAC2B;AAC3B,QAAM,EAAE,KAAK,QAAQ,MAAM,iBAAiB,IAAI;AAEhD,QAAM,4BAA4B,eAAe,oBAAoB;AACrE,QAAM,oBAAoB,eAAe,YAAY;AACrD,QAAM,wBAAwB,eAAe,gBAAgB;AAE7D,QAAM,0BAA0B,GAAG;AAAA,IACjC;AAAA,IACA,kBAAkB,IAAI,qBAAqB;AAAA,EAC7C;AAEA,QAAM,yBAAyB;AAAA,IAC7B,IAAI;AAAA,EACN;AACA,QAAM,4BAA4B;AAAA,IAChC,OAAO;AAAA,EACT;AACA,QAAM,0BAA0B;AAAA,IAC9B,KAAK;AAAA,EACP;AAEA,MAAI;AACJ,MAAI;AAEJ,MAAI,wBAAwB,GAAG,sBAAsB,GAAG;AACtD,qBAAiB;AACjB,qBAAiB;AAAA,EACnB,WACE,wBAAwB,IAAI,sBAAsB,KAClD,wBAAwB,GAAG,yBAAyB,GACpD;AACA,qBAAiB,IAAI;AACrB,qBAAiB,IAAI;AAAA,EACvB,WACE,wBAAwB,IAAI,yBAAyB,KACrD,wBAAwB,GAAG,uBAAuB,GAClD;AACA,qBAAiB,OAAO;AACxB,qBAAiB,OAAO;AAAA,EAC1B,WAAW,wBAAwB,GAAG,uBAAuB,GAAG;AAC9D,qBAAiB,KAAK;AACtB,qBAAiB,KAAK;AAAA,EACxB,OAAO;AACL,qBAAiB;AACjB,qBAAiB,KAAK;AAAA,EACxB;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
|
|
@@ -0,0 +1,401 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
var _chunk2MFVV2BXjs = require('./chunk-2MFVV2BX.js');
|
|
11
|
+
|
|
12
|
+
// src/GasFeeController.ts
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
var _controllerutils = require('@metamask/controller-utils');
|
|
18
|
+
var _ethquery = require('@metamask/eth-query'); var _ethquery2 = _interopRequireDefault(_ethquery);
|
|
19
|
+
var _pollingcontroller = require('@metamask/polling-controller');
|
|
20
|
+
var _uuid = require('uuid');
|
|
21
|
+
var LEGACY_GAS_PRICES_API_URL = `https://api.metaswap.codefi.network/gasPrices`;
|
|
22
|
+
var GAS_ESTIMATE_TYPES = {
|
|
23
|
+
FEE_MARKET: "fee-market",
|
|
24
|
+
LEGACY: "legacy",
|
|
25
|
+
ETH_GASPRICE: "eth_gasPrice",
|
|
26
|
+
NONE: "none"
|
|
27
|
+
};
|
|
28
|
+
var metadata = {
|
|
29
|
+
gasFeeEstimatesByChainId: {
|
|
30
|
+
persist: true,
|
|
31
|
+
anonymous: false
|
|
32
|
+
},
|
|
33
|
+
gasFeeEstimates: { persist: true, anonymous: false },
|
|
34
|
+
estimatedGasFeeTimeBounds: { persist: true, anonymous: false },
|
|
35
|
+
gasEstimateType: { persist: true, anonymous: false },
|
|
36
|
+
nonRPCGasFeeApisDisabled: { persist: true, anonymous: false }
|
|
37
|
+
};
|
|
38
|
+
var name = "GasFeeController";
|
|
39
|
+
var defaultState = {
|
|
40
|
+
gasFeeEstimatesByChainId: {},
|
|
41
|
+
gasFeeEstimates: {},
|
|
42
|
+
estimatedGasFeeTimeBounds: {},
|
|
43
|
+
gasEstimateType: GAS_ESTIMATE_TYPES.NONE,
|
|
44
|
+
nonRPCGasFeeApisDisabled: false
|
|
45
|
+
};
|
|
46
|
+
var _getProvider, _onNetworkControllerDidChange, onNetworkControllerDidChange_fn;
|
|
47
|
+
var GasFeeController = class extends _pollingcontroller.StaticIntervalPollingController {
|
|
48
|
+
/**
|
|
49
|
+
* Creates a GasFeeController instance.
|
|
50
|
+
*
|
|
51
|
+
* @param options - The controller options.
|
|
52
|
+
* @param options.interval - The time in milliseconds to wait between polls.
|
|
53
|
+
* @param options.messenger - The controller messenger.
|
|
54
|
+
* @param options.state - The initial state.
|
|
55
|
+
* @param options.getCurrentNetworkEIP1559Compatibility - Determines whether or not the current
|
|
56
|
+
* network is EIP-1559 compatible.
|
|
57
|
+
* @param options.getCurrentNetworkLegacyGasAPICompatibility - Determines whether or not the
|
|
58
|
+
* current network is compatible with the legacy gas price API.
|
|
59
|
+
* @param options.getCurrentAccountEIP1559Compatibility - Determines whether or not the current
|
|
60
|
+
* account is EIP-1559 compatible.
|
|
61
|
+
* @param options.getChainId - Returns the current chain ID.
|
|
62
|
+
* @param options.getProvider - Returns a network provider for the current network.
|
|
63
|
+
* @param options.onNetworkDidChange - A function for registering an event handler for the
|
|
64
|
+
* network state change event.
|
|
65
|
+
* @param options.legacyAPIEndpoint - The legacy gas price API URL. This option is primarily for
|
|
66
|
+
* testing purposes.
|
|
67
|
+
* @param options.EIP1559APIEndpoint - The EIP-1559 gas price API URL.
|
|
68
|
+
* @param options.clientId - The client ID used to identify to the gas estimation API who is
|
|
69
|
+
* asking for estimates.
|
|
70
|
+
*/
|
|
71
|
+
constructor({
|
|
72
|
+
interval = 15e3,
|
|
73
|
+
messenger,
|
|
74
|
+
state,
|
|
75
|
+
getCurrentNetworkEIP1559Compatibility,
|
|
76
|
+
getCurrentAccountEIP1559Compatibility,
|
|
77
|
+
getChainId,
|
|
78
|
+
getCurrentNetworkLegacyGasAPICompatibility,
|
|
79
|
+
getProvider,
|
|
80
|
+
onNetworkDidChange,
|
|
81
|
+
legacyAPIEndpoint = LEGACY_GAS_PRICES_API_URL,
|
|
82
|
+
EIP1559APIEndpoint,
|
|
83
|
+
clientId
|
|
84
|
+
}) {
|
|
85
|
+
super({
|
|
86
|
+
name,
|
|
87
|
+
metadata,
|
|
88
|
+
messenger,
|
|
89
|
+
state: { ...defaultState, ...state }
|
|
90
|
+
});
|
|
91
|
+
_chunk2MFVV2BXjs.__privateAdd.call(void 0, this, _onNetworkControllerDidChange);
|
|
92
|
+
_chunk2MFVV2BXjs.__privateAdd.call(void 0, this, _getProvider, void 0);
|
|
93
|
+
this.intervalDelay = interval;
|
|
94
|
+
this.setIntervalLength(interval);
|
|
95
|
+
this.pollTokens = /* @__PURE__ */ new Set();
|
|
96
|
+
this.getCurrentNetworkEIP1559Compatibility = getCurrentNetworkEIP1559Compatibility;
|
|
97
|
+
this.getCurrentNetworkLegacyGasAPICompatibility = getCurrentNetworkLegacyGasAPICompatibility;
|
|
98
|
+
this.getCurrentAccountEIP1559Compatibility = getCurrentAccountEIP1559Compatibility;
|
|
99
|
+
_chunk2MFVV2BXjs.__privateSet.call(void 0, this, _getProvider, getProvider);
|
|
100
|
+
this.EIP1559APIEndpoint = EIP1559APIEndpoint;
|
|
101
|
+
this.legacyAPIEndpoint = legacyAPIEndpoint;
|
|
102
|
+
this.clientId = clientId;
|
|
103
|
+
this.ethQuery = new (0, _ethquery2.default)(_chunk2MFVV2BXjs.__privateGet.call(void 0, this, _getProvider).call(this));
|
|
104
|
+
if (onNetworkDidChange && getChainId) {
|
|
105
|
+
this.currentChainId = getChainId();
|
|
106
|
+
onNetworkDidChange(async (networkControllerState) => {
|
|
107
|
+
await _chunk2MFVV2BXjs.__privateMethod.call(void 0, this, _onNetworkControllerDidChange, onNetworkControllerDidChange_fn).call(this, networkControllerState);
|
|
108
|
+
});
|
|
109
|
+
} else {
|
|
110
|
+
const { selectedNetworkClientId } = this.messagingSystem.call(
|
|
111
|
+
"NetworkController:getState"
|
|
112
|
+
);
|
|
113
|
+
this.currentChainId = this.messagingSystem.call(
|
|
114
|
+
"NetworkController:getNetworkClientById",
|
|
115
|
+
selectedNetworkClientId
|
|
116
|
+
).configuration.chainId;
|
|
117
|
+
this.messagingSystem.subscribe(
|
|
118
|
+
"NetworkController:networkDidChange",
|
|
119
|
+
// TODO: Either fix this lint violation or explain why it's necessary to ignore.
|
|
120
|
+
// eslint-disable-next-line @typescript-eslint/no-misused-promises
|
|
121
|
+
async (networkControllerState) => {
|
|
122
|
+
await _chunk2MFVV2BXjs.__privateMethod.call(void 0, this, _onNetworkControllerDidChange, onNetworkControllerDidChange_fn).call(this, networkControllerState);
|
|
123
|
+
}
|
|
124
|
+
);
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
async resetPolling() {
|
|
128
|
+
if (this.pollTokens.size !== 0) {
|
|
129
|
+
const tokens = Array.from(this.pollTokens);
|
|
130
|
+
this.stopPolling();
|
|
131
|
+
await this.getGasFeeEstimatesAndStartPolling(tokens[0]);
|
|
132
|
+
tokens.slice(1).forEach((token) => {
|
|
133
|
+
this.pollTokens.add(token);
|
|
134
|
+
});
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
async fetchGasFeeEstimates(options) {
|
|
138
|
+
return await this._fetchGasFeeEstimateData(options);
|
|
139
|
+
}
|
|
140
|
+
async getGasFeeEstimatesAndStartPolling(pollToken) {
|
|
141
|
+
const _pollToken = pollToken || _uuid.v1.call(void 0, );
|
|
142
|
+
this.pollTokens.add(_pollToken);
|
|
143
|
+
if (this.pollTokens.size === 1) {
|
|
144
|
+
await this._fetchGasFeeEstimateData();
|
|
145
|
+
this._poll();
|
|
146
|
+
}
|
|
147
|
+
return _pollToken;
|
|
148
|
+
}
|
|
149
|
+
/**
|
|
150
|
+
* Gets and sets gasFeeEstimates in state.
|
|
151
|
+
*
|
|
152
|
+
* @param options - The gas fee estimate options.
|
|
153
|
+
* @param options.shouldUpdateState - Determines whether the state should be updated with the
|
|
154
|
+
* updated gas estimates.
|
|
155
|
+
* @returns The gas fee estimates.
|
|
156
|
+
*/
|
|
157
|
+
async _fetchGasFeeEstimateData(options = {}) {
|
|
158
|
+
const { shouldUpdateState = true, networkClientId } = options;
|
|
159
|
+
let ethQuery, isEIP1559Compatible, isLegacyGasAPICompatible, decimalChainId;
|
|
160
|
+
if (networkClientId !== void 0) {
|
|
161
|
+
const networkClient = this.messagingSystem.call(
|
|
162
|
+
"NetworkController:getNetworkClientById",
|
|
163
|
+
networkClientId
|
|
164
|
+
);
|
|
165
|
+
isLegacyGasAPICompatible = networkClient.configuration.chainId === "0x38";
|
|
166
|
+
decimalChainId = _controllerutils.convertHexToDecimal.call(void 0, networkClient.configuration.chainId);
|
|
167
|
+
try {
|
|
168
|
+
const result = await this.messagingSystem.call(
|
|
169
|
+
"NetworkController:getEIP1559Compatibility",
|
|
170
|
+
networkClientId
|
|
171
|
+
);
|
|
172
|
+
isEIP1559Compatible = result || false;
|
|
173
|
+
} catch {
|
|
174
|
+
isEIP1559Compatible = false;
|
|
175
|
+
}
|
|
176
|
+
ethQuery = new (0, _ethquery2.default)(networkClient.provider);
|
|
177
|
+
}
|
|
178
|
+
ethQuery ?? (ethQuery = this.ethQuery);
|
|
179
|
+
isLegacyGasAPICompatible ?? (isLegacyGasAPICompatible = this.getCurrentNetworkLegacyGasAPICompatibility());
|
|
180
|
+
decimalChainId ?? (decimalChainId = _controllerutils.convertHexToDecimal.call(void 0, this.currentChainId));
|
|
181
|
+
try {
|
|
182
|
+
isEIP1559Compatible ?? (isEIP1559Compatible = await this.getEIP1559Compatibility());
|
|
183
|
+
} catch (e) {
|
|
184
|
+
console.error(e);
|
|
185
|
+
isEIP1559Compatible ?? (isEIP1559Compatible = false);
|
|
186
|
+
}
|
|
187
|
+
const gasFeeCalculations = await determineGasFeeCalculations({
|
|
188
|
+
isEIP1559Compatible,
|
|
189
|
+
isLegacyGasAPICompatible,
|
|
190
|
+
fetchGasEstimates: _chunk2MFVV2BXjs.fetchGasEstimates,
|
|
191
|
+
fetchGasEstimatesUrl: this.EIP1559APIEndpoint.replace(
|
|
192
|
+
"<chain_id>",
|
|
193
|
+
`${decimalChainId}`
|
|
194
|
+
),
|
|
195
|
+
fetchLegacyGasPriceEstimates: _chunk2MFVV2BXjs.fetchLegacyGasPriceEstimates,
|
|
196
|
+
fetchLegacyGasPriceEstimatesUrl: this.legacyAPIEndpoint.replace(
|
|
197
|
+
"<chain_id>",
|
|
198
|
+
`${decimalChainId}`
|
|
199
|
+
),
|
|
200
|
+
fetchEthGasPriceEstimate: _chunk2MFVV2BXjs.fetchEthGasPriceEstimate,
|
|
201
|
+
calculateTimeEstimate: _chunk2MFVV2BXjs.calculateTimeEstimate,
|
|
202
|
+
clientId: this.clientId,
|
|
203
|
+
ethQuery,
|
|
204
|
+
nonRPCGasFeeApisDisabled: this.state.nonRPCGasFeeApisDisabled
|
|
205
|
+
});
|
|
206
|
+
if (shouldUpdateState) {
|
|
207
|
+
const chainId = _controllerutils.toHex.call(void 0, decimalChainId);
|
|
208
|
+
this.update((state) => {
|
|
209
|
+
if (this.currentChainId === chainId) {
|
|
210
|
+
state.gasFeeEstimates = gasFeeCalculations.gasFeeEstimates;
|
|
211
|
+
state.estimatedGasFeeTimeBounds = gasFeeCalculations.estimatedGasFeeTimeBounds;
|
|
212
|
+
state.gasEstimateType = gasFeeCalculations.gasEstimateType;
|
|
213
|
+
}
|
|
214
|
+
state.gasFeeEstimatesByChainId ?? (state.gasFeeEstimatesByChainId = {});
|
|
215
|
+
state.gasFeeEstimatesByChainId[chainId] = {
|
|
216
|
+
gasFeeEstimates: gasFeeCalculations.gasFeeEstimates,
|
|
217
|
+
estimatedGasFeeTimeBounds: gasFeeCalculations.estimatedGasFeeTimeBounds,
|
|
218
|
+
gasEstimateType: gasFeeCalculations.gasEstimateType
|
|
219
|
+
};
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
return gasFeeCalculations;
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* Remove the poll token, and stop polling if the set of poll tokens is empty.
|
|
226
|
+
*
|
|
227
|
+
* @param pollToken - The poll token to disconnect.
|
|
228
|
+
*/
|
|
229
|
+
disconnectPoller(pollToken) {
|
|
230
|
+
this.pollTokens.delete(pollToken);
|
|
231
|
+
if (this.pollTokens.size === 0) {
|
|
232
|
+
this.stopPolling();
|
|
233
|
+
}
|
|
234
|
+
}
|
|
235
|
+
stopPolling() {
|
|
236
|
+
if (this.intervalId) {
|
|
237
|
+
clearInterval(this.intervalId);
|
|
238
|
+
}
|
|
239
|
+
this.pollTokens.clear();
|
|
240
|
+
this.resetState();
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* Prepare to discard this controller.
|
|
244
|
+
*
|
|
245
|
+
* This stops any active polling.
|
|
246
|
+
*/
|
|
247
|
+
destroy() {
|
|
248
|
+
super.destroy();
|
|
249
|
+
this.stopPolling();
|
|
250
|
+
}
|
|
251
|
+
_poll() {
|
|
252
|
+
if (this.intervalId) {
|
|
253
|
+
clearInterval(this.intervalId);
|
|
254
|
+
}
|
|
255
|
+
this.intervalId = setInterval(async () => {
|
|
256
|
+
await _controllerutils.safelyExecute.call(void 0, () => this._fetchGasFeeEstimateData());
|
|
257
|
+
}, this.intervalDelay);
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Fetching token list from the Token Service API.
|
|
261
|
+
*
|
|
262
|
+
* @private
|
|
263
|
+
* @param networkClientId - The ID of the network client triggering the fetch.
|
|
264
|
+
* @returns A promise that resolves when this operation completes.
|
|
265
|
+
*/
|
|
266
|
+
async _executePoll(networkClientId) {
|
|
267
|
+
await this._fetchGasFeeEstimateData({ networkClientId });
|
|
268
|
+
}
|
|
269
|
+
resetState() {
|
|
270
|
+
this.update(() => {
|
|
271
|
+
return defaultState;
|
|
272
|
+
});
|
|
273
|
+
}
|
|
274
|
+
async getEIP1559Compatibility() {
|
|
275
|
+
const currentNetworkIsEIP1559Compatible = await this.getCurrentNetworkEIP1559Compatibility();
|
|
276
|
+
const currentAccountIsEIP1559Compatible = this.getCurrentAccountEIP1559Compatibility?.() ?? true;
|
|
277
|
+
return currentNetworkIsEIP1559Compatible && currentAccountIsEIP1559Compatible;
|
|
278
|
+
}
|
|
279
|
+
getTimeEstimate(maxPriorityFeePerGas, maxFeePerGas) {
|
|
280
|
+
if (!this.state.gasFeeEstimates || this.state.gasEstimateType !== GAS_ESTIMATE_TYPES.FEE_MARKET) {
|
|
281
|
+
return {};
|
|
282
|
+
}
|
|
283
|
+
return _chunk2MFVV2BXjs.calculateTimeEstimate.call(void 0,
|
|
284
|
+
maxPriorityFeePerGas,
|
|
285
|
+
maxFeePerGas,
|
|
286
|
+
this.state.gasFeeEstimates
|
|
287
|
+
);
|
|
288
|
+
}
|
|
289
|
+
enableNonRPCGasFeeApis() {
|
|
290
|
+
this.update((state) => {
|
|
291
|
+
state.nonRPCGasFeeApisDisabled = false;
|
|
292
|
+
});
|
|
293
|
+
}
|
|
294
|
+
disableNonRPCGasFeeApis() {
|
|
295
|
+
this.update((state) => {
|
|
296
|
+
state.nonRPCGasFeeApisDisabled = true;
|
|
297
|
+
});
|
|
298
|
+
}
|
|
299
|
+
};
|
|
300
|
+
_getProvider = new WeakMap();
|
|
301
|
+
_onNetworkControllerDidChange = new WeakSet();
|
|
302
|
+
onNetworkControllerDidChange_fn = async function({
|
|
303
|
+
selectedNetworkClientId
|
|
304
|
+
}) {
|
|
305
|
+
const newChainId = this.messagingSystem.call(
|
|
306
|
+
"NetworkController:getNetworkClientById",
|
|
307
|
+
selectedNetworkClientId
|
|
308
|
+
).configuration.chainId;
|
|
309
|
+
if (newChainId !== this.currentChainId) {
|
|
310
|
+
this.ethQuery = new (0, _ethquery2.default)(_chunk2MFVV2BXjs.__privateGet.call(void 0, this, _getProvider).call(this));
|
|
311
|
+
await this.resetPolling();
|
|
312
|
+
this.currentChainId = newChainId;
|
|
313
|
+
}
|
|
314
|
+
};
|
|
315
|
+
var GasFeeController_default = GasFeeController;
|
|
316
|
+
|
|
317
|
+
// src/determineGasFeeCalculations.ts
|
|
318
|
+
async function determineGasFeeCalculations(args) {
|
|
319
|
+
try {
|
|
320
|
+
return await getEstimatesUsingFallbacks(args);
|
|
321
|
+
} catch (error) {
|
|
322
|
+
if (error instanceof Error) {
|
|
323
|
+
throw new Error(
|
|
324
|
+
`Gas fee/price estimation failed. Message: ${error.message}`
|
|
325
|
+
);
|
|
326
|
+
}
|
|
327
|
+
throw error;
|
|
328
|
+
}
|
|
329
|
+
}
|
|
330
|
+
async function getEstimatesUsingFallbacks(request) {
|
|
331
|
+
const {
|
|
332
|
+
isEIP1559Compatible,
|
|
333
|
+
isLegacyGasAPICompatible,
|
|
334
|
+
nonRPCGasFeeApisDisabled
|
|
335
|
+
} = request;
|
|
336
|
+
try {
|
|
337
|
+
if (isEIP1559Compatible && !nonRPCGasFeeApisDisabled) {
|
|
338
|
+
return await getEstimatesUsingFeeMarketEndpoint(request);
|
|
339
|
+
}
|
|
340
|
+
if (isLegacyGasAPICompatible && !nonRPCGasFeeApisDisabled) {
|
|
341
|
+
return await getEstimatesUsingLegacyEndpoint(request);
|
|
342
|
+
}
|
|
343
|
+
throw new Error("Main gas fee/price estimation failed. Use fallback");
|
|
344
|
+
} catch {
|
|
345
|
+
return await getEstimatesUsingProvider(request);
|
|
346
|
+
}
|
|
347
|
+
}
|
|
348
|
+
async function getEstimatesUsingFeeMarketEndpoint(request) {
|
|
349
|
+
const {
|
|
350
|
+
fetchGasEstimates: fetchGasEstimates2,
|
|
351
|
+
fetchGasEstimatesUrl,
|
|
352
|
+
clientId,
|
|
353
|
+
calculateTimeEstimate: calculateTimeEstimate2
|
|
354
|
+
} = request;
|
|
355
|
+
const estimates = await fetchGasEstimates2(fetchGasEstimatesUrl, clientId);
|
|
356
|
+
const { suggestedMaxPriorityFeePerGas, suggestedMaxFeePerGas } = estimates.medium;
|
|
357
|
+
const estimatedGasFeeTimeBounds = calculateTimeEstimate2(
|
|
358
|
+
suggestedMaxPriorityFeePerGas,
|
|
359
|
+
suggestedMaxFeePerGas,
|
|
360
|
+
estimates
|
|
361
|
+
);
|
|
362
|
+
return {
|
|
363
|
+
gasFeeEstimates: estimates,
|
|
364
|
+
estimatedGasFeeTimeBounds,
|
|
365
|
+
gasEstimateType: GAS_ESTIMATE_TYPES.FEE_MARKET
|
|
366
|
+
};
|
|
367
|
+
}
|
|
368
|
+
async function getEstimatesUsingLegacyEndpoint(request) {
|
|
369
|
+
const {
|
|
370
|
+
fetchLegacyGasPriceEstimates: fetchLegacyGasPriceEstimates2,
|
|
371
|
+
fetchLegacyGasPriceEstimatesUrl,
|
|
372
|
+
clientId
|
|
373
|
+
} = request;
|
|
374
|
+
const estimates = await fetchLegacyGasPriceEstimates2(
|
|
375
|
+
fetchLegacyGasPriceEstimatesUrl,
|
|
376
|
+
clientId
|
|
377
|
+
);
|
|
378
|
+
return {
|
|
379
|
+
gasFeeEstimates: estimates,
|
|
380
|
+
estimatedGasFeeTimeBounds: {},
|
|
381
|
+
gasEstimateType: GAS_ESTIMATE_TYPES.LEGACY
|
|
382
|
+
};
|
|
383
|
+
}
|
|
384
|
+
async function getEstimatesUsingProvider(request) {
|
|
385
|
+
const { ethQuery, fetchEthGasPriceEstimate: fetchEthGasPriceEstimate2 } = request;
|
|
386
|
+
const estimates = await fetchEthGasPriceEstimate2(ethQuery);
|
|
387
|
+
return {
|
|
388
|
+
gasFeeEstimates: estimates,
|
|
389
|
+
estimatedGasFeeTimeBounds: {},
|
|
390
|
+
gasEstimateType: GAS_ESTIMATE_TYPES.ETH_GASPRICE
|
|
391
|
+
};
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
exports.determineGasFeeCalculations = determineGasFeeCalculations; exports.LEGACY_GAS_PRICES_API_URL = LEGACY_GAS_PRICES_API_URL; exports.GAS_ESTIMATE_TYPES = GAS_ESTIMATE_TYPES; exports.GasFeeController = GasFeeController; exports.GasFeeController_default = GasFeeController_default;
|
|
401
|
+
//# sourceMappingURL=chunk-S5H5NUEH.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/GasFeeController.ts","../src/determineGasFeeCalculations.ts"],"names":["fetchGasEstimates","calculateTimeEstimate","fetchLegacyGasPriceEstimates","fetchEthGasPriceEstimate"],"mappings":";;;;;;;;;;;;AAKA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,OAAO,cAAc;AAUrB,SAAS,uCAAuC;AAEhD,SAAS,MAAM,cAAc;AAUtB,IAAM,4BAA4B;AA4BlC,IAAM,qBAAqB;AAAA,EAChC,YAAY;AAAA,EACZ,QAAQ;AAAA,EACR,cAAc;AAAA,EACd,MAAM;AACR;AAiGA,IAAM,WAAW;AAAA,EACf,0BAA0B;AAAA,IACxB,SAAS;AAAA,IACT,WAAW;AAAA,EACb;AAAA,EACA,iBAAiB,EAAE,SAAS,MAAM,WAAW,MAAM;AAAA,EACnD,2BAA2B,EAAE,SAAS,MAAM,WAAW,MAAM;AAAA,EAC7D,iBAAiB,EAAE,SAAS,MAAM,WAAW,MAAM;AAAA,EACnD,0BAA0B,EAAE,SAAS,MAAM,WAAW,MAAM;AAC9D;AAqDA,IAAM,OAAO;AA0Bb,IAAM,eAA4B;AAAA,EAChC,0BAA0B,CAAC;AAAA,EAC3B,iBAAiB,CAAC;AAAA,EAClB,2BAA2B,CAAC;AAAA,EAC5B,iBAAiB,mBAAmB;AAAA,EACpC,0BAA0B;AAC5B;AAhQA;AAqQO,IAAM,mBAAN,cAA+B,gCAIpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkDA,YAAY;AAAA,IACV,WAAW;AAAA,IACX;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,oBAAoB;AAAA,IACpB;AAAA,IACA;AAAA,EACF,GAcG;AACD,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,MACA,OAAO,EAAE,GAAG,cAAc,GAAG,MAAM;AAAA,IACrC,CAAC;AA+PH,uBAAM;AAzTN;AA2DE,SAAK,gBAAgB;AACrB,SAAK,kBAAkB,QAAQ;AAC/B,SAAK,aAAa,oBAAI,IAAI;AAC1B,SAAK,wCACH;AACF,SAAK,6CACH;AACF,SAAK,wCACH;AACF,uBAAK,cAAe;AACpB,SAAK,qBAAqB;AAC1B,SAAK,oBAAoB;AACzB,SAAK,WAAW;AAEhB,SAAK,WAAW,IAAI,SAAS,mBAAK,cAAL,UAAmB;AAEhD,QAAI,sBAAsB,YAAY;AACpC,WAAK,iBAAiB,WAAW;AAGjC,yBAAmB,OAAO,2BAA2B;AACnD,cAAM,sBAAK,gEAAL,WAAmC;AAAA,MAC3C,CAAC;AAAA,IACH,OAAO;AACL,YAAM,EAAE,wBAAwB,IAAI,KAAK,gBAAgB;AAAA,QACvD;AAAA,MACF;AACA,WAAK,iBAAiB,KAAK,gBAAgB;AAAA,QACzC;AAAA,QACA;AAAA,MACF,EAAE,cAAc;AAChB,WAAK,gBAAgB;AAAA,QACnB;AAAA;AAAA;AAAA,QAGA,OAAO,2BAA2B;AAChC,gBAAM,sBAAK,gEAAL,WAAmC;AAAA,QAC3C;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAAA,EAEA,MAAM,eAAe;AACnB,QAAI,KAAK,WAAW,SAAS,GAAG;AAC9B,YAAM,SAAS,MAAM,KAAK,KAAK,UAAU;AACzC,WAAK,YAAY;AACjB,YAAM,KAAK,kCAAkC,OAAO,CAAC,CAAC;AACtD,aAAO,MAAM,CAAC,EAAE,QAAQ,CAAC,UAAU;AACjC,aAAK,WAAW,IAAI,KAAK;AAAA,MAC3B,CAAC;AAAA,IACH;AAAA,EACF;AAAA,EAEA,MAAM,qBAAqB,SAAsC;AAC/D,WAAO,MAAM,KAAK,yBAAyB,OAAO;AAAA,EACpD;AAAA,EAEA,MAAM,kCACJ,WACiB;AACjB,UAAM,aAAa,aAAa,OAAO;AAEvC,SAAK,WAAW,IAAI,UAAU;AAE9B,QAAI,KAAK,WAAW,SAAS,GAAG;AAC9B,YAAM,KAAK,yBAAyB;AACpC,WAAK,MAAM;AAAA,IACb;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,yBACJ,UAAsC,CAAC,GACjB;AACtB,UAAM,EAAE,oBAAoB,MAAM,gBAAgB,IAAI;AAEtD,QAAI,UACF,qBACA,0BACA;AAEF,QAAI,oBAAoB,QAAW;AACjC,YAAM,gBAAgB,KAAK,gBAAgB;AAAA,QACzC;AAAA,QACA;AAAA,MACF;AACA,iCAA2B,cAAc,cAAc,YAAY;AAEnE,uBAAiB,oBAAoB,cAAc,cAAc,OAAO;AAExE,UAAI;AACF,cAAM,SAAS,MAAM,KAAK,gBAAgB;AAAA,UACxC;AAAA,UACA;AAAA,QACF;AACA,8BAAsB,UAAU;AAAA,MAClC,QAAQ;AACN,8BAAsB;AAAA,MACxB;AACA,iBAAW,IAAI,SAAS,cAAc,QAAQ;AAAA,IAChD;AAEA,4BAAa,KAAK;AAElB,4DACE,KAAK,2CAA2C;AAElD,wCAAmB,oBAAoB,KAAK,cAAc;AAE1D,QAAI;AACF,oDAAwB,MAAM,KAAK,wBAAwB;AAAA,IAC7D,SAAS,GAAG;AACV,cAAQ,MAAM,CAAC;AACf,oDAAwB;AAAA,IAC1B;AAEA,UAAM,qBAAqB,MAAM,4BAA4B;AAAA,MAC3D;AAAA,MACA;AAAA,MACA;AAAA,MACA,sBAAsB,KAAK,mBAAmB;AAAA,QAC5C;AAAA,QACA,GAAG,cAAc;AAAA,MACnB;AAAA,MACA;AAAA,MACA,iCAAiC,KAAK,kBAAkB;AAAA,QACtD;AAAA,QACA,GAAG,cAAc;AAAA,MACnB;AAAA,MACA;AAAA,MACA;AAAA,MACA,UAAU,KAAK;AAAA,MACf;AAAA,MACA,0BAA0B,KAAK,MAAM;AAAA,IACvC,CAAC;AAED,QAAI,mBAAmB;AACrB,YAAM,UAAU,MAAM,cAAc;AACpC,WAAK,OAAO,CAAC,UAAU;AACrB,YAAI,KAAK,mBAAmB,SAAS;AACnC,gBAAM,kBAAkB,mBAAmB;AAC3C,gBAAM,4BACJ,mBAAmB;AACrB,gBAAM,kBAAkB,mBAAmB;AAAA,QAC7C;AACA,cAAM,6BAAN,MAAM,2BAA6B,CAAC;AACpC,cAAM,yBAAyB,OAAO,IAAI;AAAA,UACxC,iBAAiB,mBAAmB;AAAA,UACpC,2BACE,mBAAmB;AAAA,UACrB,iBAAiB,mBAAmB;AAAA,QACtC;AAAA,MACF,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,iBAAiB,WAAmB;AAClC,SAAK,WAAW,OAAO,SAAS;AAChC,QAAI,KAAK,WAAW,SAAS,GAAG;AAC9B,WAAK,YAAY;AAAA,IACnB;AAAA,EACF;AAAA,EAEA,cAAc;AACZ,QAAI,KAAK,YAAY;AACnB,oBAAc,KAAK,UAAU;AAAA,IAC/B;AACA,SAAK,WAAW,MAAM;AACtB,SAAK,WAAW;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOS,UAAU;AACjB,UAAM,QAAQ;AACd,SAAK,YAAY;AAAA,EACnB;AAAA,EAEQ,QAAQ;AACd,QAAI,KAAK,YAAY;AACnB,oBAAc,KAAK,UAAU;AAAA,IAC/B;AAIA,SAAK,aAAa,YAAY,YAAY;AACxC,YAAM,cAAc,MAAM,KAAK,yBAAyB,CAAC;AAAA,IAC3D,GAAG,KAAK,aAAa;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,aAAa,iBAAwC;AACzD,UAAM,KAAK,yBAAyB,EAAE,gBAAgB,CAAC;AAAA,EACzD;AAAA,EAEQ,aAAa;AACnB,SAAK,OAAO,MAAM;AAChB,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AAAA,EAEA,MAAc,0BAA0B;AACtC,UAAM,oCACJ,MAAM,KAAK,sCAAsC;AACnD,UAAM,oCACJ,KAAK,wCAAwC,KAAK;AAEpD,WACE,qCAAqC;AAAA,EAEzC;AAAA,EAEA,gBACE,sBACA,cACmD;AACnD,QACE,CAAC,KAAK,MAAM,mBACZ,KAAK,MAAM,oBAAoB,mBAAmB,YAClD;AACA,aAAO,CAAC;AAAA,IACV;AACA,WAAO;AAAA,MACL;AAAA,MACA;AAAA,MACA,KAAK,MAAM;AAAA,IACb;AAAA,EACF;AAAA,EAkBA,yBAAyB;AACvB,SAAK,OAAO,CAAC,UAAU;AACrB,YAAM,2BAA2B;AAAA,IACnC,CAAC;AAAA,EACH;AAAA,EAEA,0BAA0B;AACxB,SAAK,OAAO,CAAC,UAAU;AACrB,YAAM,2BAA2B;AAAA,IACnC,CAAC;AAAA,EACH;AACF;AApVE;AAyTM;AAAA,kCAA6B,eAAC;AAAA,EAClC;AACF,GAAiB;AACf,QAAM,aAAa,KAAK,gBAAgB;AAAA,IACtC;AAAA,IACA;AAAA,EACF,EAAE,cAAc;AAEhB,MAAI,eAAe,KAAK,gBAAgB;AACtC,SAAK,WAAW,IAAI,SAAS,mBAAK,cAAL,UAAmB;AAChD,UAAM,KAAK,aAAa;AAExB,SAAK,iBAAiB;AAAA,EACxB;AACF;AAeF,IAAO,2BAAQ;;;AC1jBf,eAAO,4BACL,MAC6B;AAC7B,MAAI;AACF,WAAO,MAAM,2BAA2B,IAAI;AAAA,EAC9C,SAAS,OAAO;AACd,QAAI,iBAAiB,OAAO;AAC1B,YAAM,IAAI;AAAA,QACR,6CAA6C,MAAM,OAAO;AAAA,MAC5D;AAAA,IACF;AAEA,UAAM;AAAA,EACR;AACF;AAOA,eAAe,2BACb,SAC6B;AAC7B,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI;AAEJ,MAAI;AACF,QAAI,uBAAuB,CAAC,0BAA0B;AACpD,aAAO,MAAM,mCAAmC,OAAO;AAAA,IACzD;AAEA,QAAI,4BAA4B,CAAC,0BAA0B;AACzD,aAAO,MAAM,gCAAgC,OAAO;AAAA,IACtD;AAEA,UAAM,IAAI,MAAM,oDAAoD;AAAA,EACtE,QAAQ;AACN,WAAO,MAAM,0BAA0B,OAAO;AAAA,EAChD;AACF;AAOA,eAAe,mCACb,SAC6B;AAC7B,QAAM;AAAA,IACJ,mBAAAA;AAAA,IACA;AAAA,IACA;AAAA,IACA,uBAAAC;AAAA,EACF,IAAI;AAEJ,QAAM,YAAY,MAAMD,mBAAkB,sBAAsB,QAAQ;AAExE,QAAM,EAAE,+BAA+B,sBAAsB,IAC3D,UAAU;AAEZ,QAAM,4BAA4BC;AAAA,IAChC;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,SAAO;AAAA,IACL,iBAAiB;AAAA,IACjB;AAAA,IACA,iBAAiB,mBAAmB;AAAA,EACtC;AACF;AAOA,eAAe,gCACb,SAC6B;AAC7B,QAAM;AAAA,IACJ,8BAAAC;AAAA,IACA;AAAA,IACA;AAAA,EACF,IAAI;AAEJ,QAAM,YAAY,MAAMA;AAAA,IACtB;AAAA,IACA;AAAA,EACF;AAEA,SAAO;AAAA,IACL,iBAAiB;AAAA,IACjB,2BAA2B,CAAC;AAAA,IAC5B,iBAAiB,mBAAmB;AAAA,EACtC;AACF;AAOA,eAAe,0BACb,SAC6B;AAC7B,QAAM,EAAE,UAAU,0BAAAC,0BAAyB,IAAI;AAE/C,QAAM,YAAY,MAAMA,0BAAyB,QAAQ;AAEzD,SAAO;AAAA,IACL,iBAAiB;AAAA,IACjB,2BAA2B,CAAC;AAAA,IAC5B,iBAAiB,mBAAmB;AAAA,EACtC;AACF","sourcesContent":["import type {\n ControllerGetStateAction,\n ControllerStateChangeEvent,\n RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport {\n convertHexToDecimal,\n safelyExecute,\n toHex,\n} from '@metamask/controller-utils';\nimport EthQuery from '@metamask/eth-query';\nimport type {\n NetworkClientId,\n NetworkControllerGetEIP1559CompatibilityAction,\n NetworkControllerGetNetworkClientByIdAction,\n NetworkControllerGetStateAction,\n NetworkControllerNetworkDidChangeEvent,\n NetworkState,\n ProviderProxy,\n} from '@metamask/network-controller';\nimport { StaticIntervalPollingController } from '@metamask/polling-controller';\nimport type { Hex } from '@metamask/utils';\nimport { v1 as random } from 'uuid';\n\nimport determineGasFeeCalculations from './determineGasFeeCalculations';\nimport {\n fetchGasEstimates,\n fetchLegacyGasPriceEstimates,\n fetchEthGasPriceEstimate,\n calculateTimeEstimate,\n} from './gas-util';\n\nexport const LEGACY_GAS_PRICES_API_URL = `https://api.metaswap.codefi.network/gasPrices`;\n\n// TODO: Either fix this lint violation or explain why it's necessary to ignore.\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport type unknownString = 'unknown';\n\n// Fee Market describes the way gas is set after the london hardfork, and was\n// defined by EIP-1559.\nexport type FeeMarketEstimateType = 'fee-market';\n// Legacy describes gasPrice estimates from before london hardfork, when the\n// user is connected to mainnet and are presented with fast/average/slow\n// estimate levels to choose from.\nexport type LegacyEstimateType = 'legacy';\n// EthGasPrice describes a gasPrice estimate received from eth_gasPrice. Post\n// london this value should only be used for legacy type transactions when on\n// networks that support EIP-1559. This type of estimate is the most accurate\n// to display on custom networks that don't support EIP-1559.\nexport type EthGasPriceEstimateType = 'eth_gasPrice';\n// NoEstimate describes the state of the controller before receiving its first\n// estimate.\nexport type NoEstimateType = 'none';\n\n/**\n * Indicates which type of gasEstimate the controller is currently returning.\n * This is useful as a way of asserting that the shape of gasEstimates matches\n * expectations. NONE is a special case indicating that no previous gasEstimate\n * has been fetched.\n */\nexport const GAS_ESTIMATE_TYPES = {\n FEE_MARKET: 'fee-market' as FeeMarketEstimateType,\n LEGACY: 'legacy' as LegacyEstimateType,\n ETH_GASPRICE: 'eth_gasPrice' as EthGasPriceEstimateType,\n NONE: 'none' as NoEstimateType,\n};\n\nexport type GasEstimateType =\n | FeeMarketEstimateType\n | EthGasPriceEstimateType\n | LegacyEstimateType\n | NoEstimateType;\n\nexport type EstimatedGasFeeTimeBounds = {\n lowerTimeBound: number | null;\n upperTimeBound: number | unknownString;\n};\n\n/**\n * @type EthGasPriceEstimate\n *\n * A single gas price estimate for networks and accounts that don't support EIP-1559\n * This estimate comes from eth_gasPrice but is converted to dec gwei to match other\n * return values\n * @property gasPrice - A GWEI dec string\n */\n\nexport type EthGasPriceEstimate = {\n gasPrice: string;\n};\n\n/**\n * @type LegacyGasPriceEstimate\n *\n * A set of gas price estimates for networks and accounts that don't support EIP-1559\n * These estimates include low, medium and high all as strings representing gwei in\n * decimal format.\n * @property high - gasPrice, in decimal gwei string format, suggested for fast inclusion\n * @property medium - gasPrice, in decimal gwei string format, suggested for avg inclusion\n * @property low - gasPrice, in decimal gwei string format, suggested for slow inclusion\n */\nexport type LegacyGasPriceEstimate = {\n high: string;\n medium: string;\n low: string;\n};\n\n/**\n * @type Eip1559GasFee\n *\n * Data necessary to provide an estimate of a gas fee with a specific tip\n * @property minWaitTimeEstimate - The fastest the transaction will take, in milliseconds\n * @property maxWaitTimeEstimate - The slowest the transaction will take, in milliseconds\n * @property suggestedMaxPriorityFeePerGas - A suggested \"tip\", a GWEI hex number\n * @property suggestedMaxFeePerGas - A suggested max fee, the most a user will pay. a GWEI hex number\n */\nexport type Eip1559GasFee = {\n minWaitTimeEstimate: number; // a time duration in milliseconds\n maxWaitTimeEstimate: number; // a time duration in milliseconds\n suggestedMaxPriorityFeePerGas: string; // a GWEI decimal number\n suggestedMaxFeePerGas: string; // a GWEI decimal number\n};\n\n/**\n * @type GasFeeEstimates\n *\n * Data necessary to provide multiple GasFee estimates, and supporting information, to the user\n * @property low - A GasFee for a minimum necessary combination of tip and maxFee\n * @property medium - A GasFee for a recommended combination of tip and maxFee\n * @property high - A GasFee for a high combination of tip and maxFee\n * @property estimatedBaseFee - An estimate of what the base fee will be for the pending/next block. A GWEI dec number\n * @property networkCongestion - A normalized number that can be used to gauge the congestion\n * level of the network, with 0 meaning not congested and 1 meaning extremely congested\n */\nexport type GasFeeEstimates = SourcedGasFeeEstimates | FallbackGasFeeEstimates;\n\ntype SourcedGasFeeEstimates = {\n low: Eip1559GasFee;\n medium: Eip1559GasFee;\n high: Eip1559GasFee;\n estimatedBaseFee: string;\n historicalBaseFeeRange: [string, string];\n baseFeeTrend: 'up' | 'down' | 'level';\n latestPriorityFeeRange: [string, string];\n historicalPriorityFeeRange: [string, string];\n priorityFeeTrend: 'up' | 'down' | 'level';\n networkCongestion: number;\n};\n\ntype FallbackGasFeeEstimates = {\n low: Eip1559GasFee;\n medium: Eip1559GasFee;\n high: Eip1559GasFee;\n estimatedBaseFee: string;\n historicalBaseFeeRange: null;\n baseFeeTrend: null;\n latestPriorityFeeRange: null;\n historicalPriorityFeeRange: null;\n priorityFeeTrend: null;\n networkCongestion: null;\n};\n\nconst metadata = {\n gasFeeEstimatesByChainId: {\n persist: true,\n anonymous: false,\n },\n gasFeeEstimates: { persist: true, anonymous: false },\n estimatedGasFeeTimeBounds: { persist: true, anonymous: false },\n gasEstimateType: { persist: true, anonymous: false },\n nonRPCGasFeeApisDisabled: { persist: true, anonymous: false },\n};\n\nexport type GasFeeStateEthGasPrice = {\n gasFeeEstimates: EthGasPriceEstimate;\n estimatedGasFeeTimeBounds: Record<string, never>;\n gasEstimateType: EthGasPriceEstimateType;\n};\n\nexport type GasFeeStateFeeMarket = {\n gasFeeEstimates: GasFeeEstimates;\n estimatedGasFeeTimeBounds: EstimatedGasFeeTimeBounds | Record<string, never>;\n gasEstimateType: FeeMarketEstimateType;\n};\n\nexport type GasFeeStateLegacy = {\n gasFeeEstimates: LegacyGasPriceEstimate;\n estimatedGasFeeTimeBounds: Record<string, never>;\n gasEstimateType: LegacyEstimateType;\n};\n\nexport type GasFeeStateNoEstimates = {\n gasFeeEstimates: Record<string, never>;\n estimatedGasFeeTimeBounds: Record<string, never>;\n gasEstimateType: NoEstimateType;\n};\n\nexport type FetchGasFeeEstimateOptions = {\n shouldUpdateState?: boolean;\n networkClientId?: NetworkClientId;\n};\n\n/**\n * @type GasFeeState\n *\n * Gas Fee controller state\n * @property gasFeeEstimates - Gas fee estimate data based on new EIP-1559 properties\n * @property estimatedGasFeeTimeBounds - Estimates representing the minimum and maximum\n */\nexport type SingleChainGasFeeState =\n | GasFeeStateEthGasPrice\n | GasFeeStateFeeMarket\n | GasFeeStateLegacy\n | GasFeeStateNoEstimates;\n\nexport type GasFeeEstimatesByChainId = {\n gasFeeEstimatesByChainId?: Record<string, SingleChainGasFeeState>;\n};\n\nexport type GasFeeState = GasFeeEstimatesByChainId &\n SingleChainGasFeeState & {\n nonRPCGasFeeApisDisabled?: boolean;\n };\n\nconst name = 'GasFeeController';\n\nexport type GasFeeStateChange = ControllerStateChangeEvent<\n typeof name,\n GasFeeState\n>;\n\nexport type GetGasFeeState = ControllerGetStateAction<typeof name, GasFeeState>;\n\nexport type GasFeeControllerActions = GetGasFeeState;\n\nexport type GasFeeControllerEvents = GasFeeStateChange;\n\ntype AllowedActions =\n | NetworkControllerGetStateAction\n | NetworkControllerGetNetworkClientByIdAction\n | NetworkControllerGetEIP1559CompatibilityAction;\n\ntype GasFeeMessenger = RestrictedControllerMessenger<\n typeof name,\n GasFeeControllerActions | AllowedActions,\n GasFeeControllerEvents | NetworkControllerNetworkDidChangeEvent,\n AllowedActions['type'],\n NetworkControllerNetworkDidChangeEvent['type']\n>;\n\nconst defaultState: GasFeeState = {\n gasFeeEstimatesByChainId: {},\n gasFeeEstimates: {},\n estimatedGasFeeTimeBounds: {},\n gasEstimateType: GAS_ESTIMATE_TYPES.NONE,\n nonRPCGasFeeApisDisabled: false,\n};\n\n/**\n * Controller that retrieves gas fee estimate data and polls for updated data on a set interval\n */\nexport class GasFeeController extends StaticIntervalPollingController<\n typeof name,\n GasFeeState,\n GasFeeMessenger\n> {\n private intervalId?: ReturnType<typeof setTimeout>;\n\n private readonly intervalDelay;\n\n private readonly pollTokens: Set<string>;\n\n private readonly legacyAPIEndpoint: string;\n\n // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n // eslint-disable-next-line @typescript-eslint/naming-convention\n private readonly EIP1559APIEndpoint: string;\n\n private readonly getCurrentNetworkEIP1559Compatibility;\n\n private readonly getCurrentNetworkLegacyGasAPICompatibility;\n\n private readonly getCurrentAccountEIP1559Compatibility;\n\n private currentChainId;\n\n private ethQuery?: EthQuery;\n\n private readonly clientId?: string;\n\n #getProvider: () => ProviderProxy;\n\n /**\n * Creates a GasFeeController instance.\n *\n * @param options - The controller options.\n * @param options.interval - The time in milliseconds to wait between polls.\n * @param options.messenger - The controller messenger.\n * @param options.state - The initial state.\n * @param options.getCurrentNetworkEIP1559Compatibility - Determines whether or not the current\n * network is EIP-1559 compatible.\n * @param options.getCurrentNetworkLegacyGasAPICompatibility - Determines whether or not the\n * current network is compatible with the legacy gas price API.\n * @param options.getCurrentAccountEIP1559Compatibility - Determines whether or not the current\n * account is EIP-1559 compatible.\n * @param options.getChainId - Returns the current chain ID.\n * @param options.getProvider - Returns a network provider for the current network.\n * @param options.onNetworkDidChange - A function for registering an event handler for the\n * network state change event.\n * @param options.legacyAPIEndpoint - The legacy gas price API URL. This option is primarily for\n * testing purposes.\n * @param options.EIP1559APIEndpoint - The EIP-1559 gas price API URL.\n * @param options.clientId - The client ID used to identify to the gas estimation API who is\n * asking for estimates.\n */\n constructor({\n interval = 15000,\n messenger,\n state,\n getCurrentNetworkEIP1559Compatibility,\n getCurrentAccountEIP1559Compatibility,\n getChainId,\n getCurrentNetworkLegacyGasAPICompatibility,\n getProvider,\n onNetworkDidChange,\n legacyAPIEndpoint = LEGACY_GAS_PRICES_API_URL,\n EIP1559APIEndpoint,\n clientId,\n }: {\n interval?: number;\n messenger: GasFeeMessenger;\n state?: GasFeeState;\n getCurrentNetworkEIP1559Compatibility: () => Promise<boolean>;\n getCurrentNetworkLegacyGasAPICompatibility: () => boolean;\n getCurrentAccountEIP1559Compatibility?: () => boolean;\n getChainId?: () => Hex;\n getProvider: () => ProviderProxy;\n onNetworkDidChange?: (listener: (state: NetworkState) => void) => void;\n legacyAPIEndpoint?: string;\n // eslint-disable-next-line @typescript-eslint/naming-convention\n EIP1559APIEndpoint: string;\n clientId?: string;\n }) {\n super({\n name,\n metadata,\n messenger,\n state: { ...defaultState, ...state },\n });\n this.intervalDelay = interval;\n this.setIntervalLength(interval);\n this.pollTokens = new Set();\n this.getCurrentNetworkEIP1559Compatibility =\n getCurrentNetworkEIP1559Compatibility;\n this.getCurrentNetworkLegacyGasAPICompatibility =\n getCurrentNetworkLegacyGasAPICompatibility;\n this.getCurrentAccountEIP1559Compatibility =\n getCurrentAccountEIP1559Compatibility;\n this.#getProvider = getProvider;\n this.EIP1559APIEndpoint = EIP1559APIEndpoint;\n this.legacyAPIEndpoint = legacyAPIEndpoint;\n this.clientId = clientId;\n\n this.ethQuery = new EthQuery(this.#getProvider());\n\n if (onNetworkDidChange && getChainId) {\n this.currentChainId = getChainId();\n // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n // eslint-disable-next-line @typescript-eslint/no-misused-promises\n onNetworkDidChange(async (networkControllerState) => {\n await this.#onNetworkControllerDidChange(networkControllerState);\n });\n } else {\n const { selectedNetworkClientId } = this.messagingSystem.call(\n 'NetworkController:getState',\n );\n this.currentChainId = this.messagingSystem.call(\n 'NetworkController:getNetworkClientById',\n selectedNetworkClientId,\n ).configuration.chainId;\n this.messagingSystem.subscribe(\n 'NetworkController:networkDidChange',\n // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n // eslint-disable-next-line @typescript-eslint/no-misused-promises\n async (networkControllerState) => {\n await this.#onNetworkControllerDidChange(networkControllerState);\n },\n );\n }\n }\n\n async resetPolling() {\n if (this.pollTokens.size !== 0) {\n const tokens = Array.from(this.pollTokens);\n this.stopPolling();\n await this.getGasFeeEstimatesAndStartPolling(tokens[0]);\n tokens.slice(1).forEach((token) => {\n this.pollTokens.add(token);\n });\n }\n }\n\n async fetchGasFeeEstimates(options?: FetchGasFeeEstimateOptions) {\n return await this._fetchGasFeeEstimateData(options);\n }\n\n async getGasFeeEstimatesAndStartPolling(\n pollToken: string | undefined,\n ): Promise<string> {\n const _pollToken = pollToken || random();\n\n this.pollTokens.add(_pollToken);\n\n if (this.pollTokens.size === 1) {\n await this._fetchGasFeeEstimateData();\n this._poll();\n }\n\n return _pollToken;\n }\n\n /**\n * Gets and sets gasFeeEstimates in state.\n *\n * @param options - The gas fee estimate options.\n * @param options.shouldUpdateState - Determines whether the state should be updated with the\n * updated gas estimates.\n * @returns The gas fee estimates.\n */\n async _fetchGasFeeEstimateData(\n options: FetchGasFeeEstimateOptions = {},\n ): Promise<GasFeeState> {\n const { shouldUpdateState = true, networkClientId } = options;\n\n let ethQuery,\n isEIP1559Compatible,\n isLegacyGasAPICompatible,\n decimalChainId: number;\n\n if (networkClientId !== undefined) {\n const networkClient = this.messagingSystem.call(\n 'NetworkController:getNetworkClientById',\n networkClientId,\n );\n isLegacyGasAPICompatible = networkClient.configuration.chainId === '0x38';\n\n decimalChainId = convertHexToDecimal(networkClient.configuration.chainId);\n\n try {\n const result = await this.messagingSystem.call(\n 'NetworkController:getEIP1559Compatibility',\n networkClientId,\n );\n isEIP1559Compatible = result || false;\n } catch {\n isEIP1559Compatible = false;\n }\n ethQuery = new EthQuery(networkClient.provider);\n }\n\n ethQuery ??= this.ethQuery;\n\n isLegacyGasAPICompatible ??=\n this.getCurrentNetworkLegacyGasAPICompatibility();\n\n decimalChainId ??= convertHexToDecimal(this.currentChainId);\n\n try {\n isEIP1559Compatible ??= await this.getEIP1559Compatibility();\n } catch (e) {\n console.error(e);\n isEIP1559Compatible ??= false;\n }\n\n const gasFeeCalculations = await determineGasFeeCalculations({\n isEIP1559Compatible,\n isLegacyGasAPICompatible,\n fetchGasEstimates,\n fetchGasEstimatesUrl: this.EIP1559APIEndpoint.replace(\n '<chain_id>',\n `${decimalChainId}`,\n ),\n fetchLegacyGasPriceEstimates,\n fetchLegacyGasPriceEstimatesUrl: this.legacyAPIEndpoint.replace(\n '<chain_id>',\n `${decimalChainId}`,\n ),\n fetchEthGasPriceEstimate,\n calculateTimeEstimate,\n clientId: this.clientId,\n ethQuery,\n nonRPCGasFeeApisDisabled: this.state.nonRPCGasFeeApisDisabled,\n });\n\n if (shouldUpdateState) {\n const chainId = toHex(decimalChainId);\n this.update((state) => {\n if (this.currentChainId === chainId) {\n state.gasFeeEstimates = gasFeeCalculations.gasFeeEstimates;\n state.estimatedGasFeeTimeBounds =\n gasFeeCalculations.estimatedGasFeeTimeBounds;\n state.gasEstimateType = gasFeeCalculations.gasEstimateType;\n }\n state.gasFeeEstimatesByChainId ??= {};\n state.gasFeeEstimatesByChainId[chainId] = {\n gasFeeEstimates: gasFeeCalculations.gasFeeEstimates,\n estimatedGasFeeTimeBounds:\n gasFeeCalculations.estimatedGasFeeTimeBounds,\n gasEstimateType: gasFeeCalculations.gasEstimateType,\n } as SingleChainGasFeeState;\n });\n }\n\n return gasFeeCalculations;\n }\n\n /**\n * Remove the poll token, and stop polling if the set of poll tokens is empty.\n *\n * @param pollToken - The poll token to disconnect.\n */\n disconnectPoller(pollToken: string) {\n this.pollTokens.delete(pollToken);\n if (this.pollTokens.size === 0) {\n this.stopPolling();\n }\n }\n\n stopPolling() {\n if (this.intervalId) {\n clearInterval(this.intervalId);\n }\n this.pollTokens.clear();\n this.resetState();\n }\n\n /**\n * Prepare to discard this controller.\n *\n * This stops any active polling.\n */\n override destroy() {\n super.destroy();\n this.stopPolling();\n }\n\n private _poll() {\n if (this.intervalId) {\n clearInterval(this.intervalId);\n }\n\n // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n // eslint-disable-next-line @typescript-eslint/no-misused-promises\n this.intervalId = setInterval(async () => {\n await safelyExecute(() => this._fetchGasFeeEstimateData());\n }, this.intervalDelay);\n }\n\n /**\n * Fetching token list from the Token Service API.\n *\n * @private\n * @param networkClientId - The ID of the network client triggering the fetch.\n * @returns A promise that resolves when this operation completes.\n */\n async _executePoll(networkClientId: string): Promise<void> {\n await this._fetchGasFeeEstimateData({ networkClientId });\n }\n\n private resetState() {\n this.update(() => {\n return defaultState;\n });\n }\n\n private async getEIP1559Compatibility() {\n const currentNetworkIsEIP1559Compatible =\n await this.getCurrentNetworkEIP1559Compatibility();\n const currentAccountIsEIP1559Compatible =\n this.getCurrentAccountEIP1559Compatibility?.() ?? true;\n\n return (\n currentNetworkIsEIP1559Compatible && currentAccountIsEIP1559Compatible\n );\n }\n\n getTimeEstimate(\n maxPriorityFeePerGas: string,\n maxFeePerGas: string,\n ): EstimatedGasFeeTimeBounds | Record<string, never> {\n if (\n !this.state.gasFeeEstimates ||\n this.state.gasEstimateType !== GAS_ESTIMATE_TYPES.FEE_MARKET\n ) {\n return {};\n }\n return calculateTimeEstimate(\n maxPriorityFeePerGas,\n maxFeePerGas,\n this.state.gasFeeEstimates,\n );\n }\n\n async #onNetworkControllerDidChange({\n selectedNetworkClientId,\n }: NetworkState) {\n const newChainId = this.messagingSystem.call(\n 'NetworkController:getNetworkClientById',\n selectedNetworkClientId,\n ).configuration.chainId;\n\n if (newChainId !== this.currentChainId) {\n this.ethQuery = new EthQuery(this.#getProvider());\n await this.resetPolling();\n\n this.currentChainId = newChainId;\n }\n }\n\n enableNonRPCGasFeeApis() {\n this.update((state) => {\n state.nonRPCGasFeeApisDisabled = false;\n });\n }\n\n disableNonRPCGasFeeApis() {\n this.update((state) => {\n state.nonRPCGasFeeApisDisabled = true;\n });\n }\n}\n\nexport default GasFeeController;\n","import type {\n EstimatedGasFeeTimeBounds,\n EthGasPriceEstimate,\n GasFeeEstimates,\n GasFeeState as GasFeeCalculations,\n LegacyGasPriceEstimate,\n} from './GasFeeController';\nimport { GAS_ESTIMATE_TYPES } from './GasFeeController';\n\ntype DetermineGasFeeCalculationsRequest = {\n isEIP1559Compatible: boolean;\n isLegacyGasAPICompatible: boolean;\n fetchGasEstimates: (\n url: string,\n clientId?: string,\n ) => Promise<GasFeeEstimates>;\n fetchGasEstimatesUrl: string;\n fetchLegacyGasPriceEstimates: (\n url: string,\n clientId?: string,\n ) => Promise<LegacyGasPriceEstimate>;\n fetchLegacyGasPriceEstimatesUrl: string;\n // TODO: Replace `any` with type\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n fetchEthGasPriceEstimate: (ethQuery: any) => Promise<EthGasPriceEstimate>;\n calculateTimeEstimate: (\n maxPriorityFeePerGas: string,\n maxFeePerGas: string,\n gasFeeEstimates: GasFeeEstimates,\n ) => EstimatedGasFeeTimeBounds;\n clientId: string | undefined;\n // TODO: Replace `any` with type\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n ethQuery: any;\n nonRPCGasFeeApisDisabled?: boolean;\n};\n\n/**\n * Obtains a set of max base and priority fee estimates along with time estimates so that we\n * can present them to users when they are sending transactions or making swaps.\n *\n * @param args - The arguments.\n * @param args.isEIP1559Compatible - Governs whether or not we can use an EIP-1559-only method to\n * produce estimates.\n * @param args.isLegacyGasAPICompatible - Governs whether or not we can use a non-EIP-1559 method to\n * produce estimates (for instance, testnets do not support estimates altogether).\n * @param args.fetchGasEstimates - A function that fetches gas estimates using an EIP-1559-specific\n * API.\n * @param args.fetchGasEstimatesUrl - The URL for the API we can use to obtain EIP-1559-specific\n * estimates.\n * @param args.fetchLegacyGasPriceEstimates - A function that fetches gas estimates using an\n * non-EIP-1559-specific API.\n * @param args.fetchLegacyGasPriceEstimatesUrl - The URL for the API we can use to obtain\n * non-EIP-1559-specific estimates.\n * @param args.fetchEthGasPriceEstimate - A function that fetches gas estimates using\n * `eth_gasPrice`.\n * @param args.calculateTimeEstimate - A function that determine time estimate bounds.\n * @param args.clientId - An identifier that an API can use to know who is asking for estimates.\n * @param args.ethQuery - An EthQuery instance we can use to talk to Ethereum directly.\n * @param args.nonRPCGasFeeApisDisabled - Whether to disable requests to the legacyAPIEndpoint and the EIP1559APIEndpoint\n * @returns The gas fee calculations.\n */\nexport default async function determineGasFeeCalculations(\n args: DetermineGasFeeCalculationsRequest,\n): Promise<GasFeeCalculations> {\n try {\n return await getEstimatesUsingFallbacks(args);\n } catch (error) {\n if (error instanceof Error) {\n throw new Error(\n `Gas fee/price estimation failed. Message: ${error.message}`,\n );\n }\n\n throw error;\n }\n}\n\n/**\n * Retrieve the gas fee estimates using a series of fallback mechanisms.\n * @param request - The request object.\n * @returns The gas fee estimates.\n */\nasync function getEstimatesUsingFallbacks(\n request: DetermineGasFeeCalculationsRequest,\n): Promise<GasFeeCalculations> {\n const {\n isEIP1559Compatible,\n isLegacyGasAPICompatible,\n nonRPCGasFeeApisDisabled,\n } = request;\n\n try {\n if (isEIP1559Compatible && !nonRPCGasFeeApisDisabled) {\n return await getEstimatesUsingFeeMarketEndpoint(request);\n }\n\n if (isLegacyGasAPICompatible && !nonRPCGasFeeApisDisabled) {\n return await getEstimatesUsingLegacyEndpoint(request);\n }\n\n throw new Error('Main gas fee/price estimation failed. Use fallback');\n } catch {\n return await getEstimatesUsingProvider(request);\n }\n}\n\n/**\n * Retrieve gas fee estimates using the EIP-1559 endpoint of the gas API.\n * @param request - The request object.\n * @returns The gas fee estimates.\n */\nasync function getEstimatesUsingFeeMarketEndpoint(\n request: DetermineGasFeeCalculationsRequest,\n): Promise<GasFeeCalculations> {\n const {\n fetchGasEstimates,\n fetchGasEstimatesUrl,\n clientId,\n calculateTimeEstimate,\n } = request;\n\n const estimates = await fetchGasEstimates(fetchGasEstimatesUrl, clientId);\n\n const { suggestedMaxPriorityFeePerGas, suggestedMaxFeePerGas } =\n estimates.medium;\n\n const estimatedGasFeeTimeBounds = calculateTimeEstimate(\n suggestedMaxPriorityFeePerGas,\n suggestedMaxFeePerGas,\n estimates,\n );\n\n return {\n gasFeeEstimates: estimates,\n estimatedGasFeeTimeBounds,\n gasEstimateType: GAS_ESTIMATE_TYPES.FEE_MARKET,\n };\n}\n\n/**\n * Retrieve gas fee estimates using the legacy endpoint of the gas API.\n * @param request - The request object.\n * @returns The gas fee estimates.\n */\nasync function getEstimatesUsingLegacyEndpoint(\n request: DetermineGasFeeCalculationsRequest,\n): Promise<GasFeeCalculations> {\n const {\n fetchLegacyGasPriceEstimates,\n fetchLegacyGasPriceEstimatesUrl,\n clientId,\n } = request;\n\n const estimates = await fetchLegacyGasPriceEstimates(\n fetchLegacyGasPriceEstimatesUrl,\n clientId,\n );\n\n return {\n gasFeeEstimates: estimates,\n estimatedGasFeeTimeBounds: {},\n gasEstimateType: GAS_ESTIMATE_TYPES.LEGACY,\n };\n}\n\n/**\n * Retrieve gas fee estimates using an `eth_gasPrice` call to the RPC provider.\n * @param request - The request object.\n * @returns The gas fee estimates.\n */\nasync function getEstimatesUsingProvider(\n request: DetermineGasFeeCalculationsRequest,\n): Promise<GasFeeCalculations> {\n const { ethQuery, fetchEthGasPriceEstimate } = request;\n\n const estimates = await fetchEthGasPriceEstimate(ethQuery);\n\n return {\n gasFeeEstimates: estimates,\n estimatedGasFeeTimeBounds: {},\n gasEstimateType: GAS_ESTIMATE_TYPES.ETH_GASPRICE,\n };\n}\n"]}
|