TheDude
/
ciphermask
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Capturing default gas estimates in txMeta and passing it to metrics (#13385)

Browse Source
feature/default_network_editable
Jyoti Puri 3 years ago committed by GitHub
parent 516de24cbe
commit 41df6eac1c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 119 additions and 31 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 62
      app/scripts/controllers/transactions/index.js
  2. 88
      app/scripts/controllers/transactions/index.test.js

62
app/scripts/controllers/transactions/index.js
Unescape View File

@ -543,6 +543,13 @@ export default class TransactionController extends EventEmitter {
txMeta.txParams.gas = defaultGasLimit;
txMeta.originalGasEstimate = defaultGasLimit;
}
txMeta.defaultGasEstimates = {
estimateType: txMeta.userFeeLevel,
gas: txMeta.txParams.gas,
gasPrice: txMeta.txParams.gasPrice,
maxFeePerGas: txMeta.txParams.maxFeePerGas,
maxPriorityFeePerGas: txMeta.txParams.maxPriorityFeePerGas,
};
return txMeta;
}
@ -1130,12 +1137,12 @@ export default class TransactionController extends EventEmitter {
* fragment for
* @param {valueOf<TRANSACTION_EVENTS>} event - event type to create
*/
createTransactionEventFragment(transactionId, event) {
async createTransactionEventFragment(transactionId, event) {
const txMeta = this.txStateManager.getTransaction(transactionId);
const {
properties,
sensitiveProperties,
} = this._buildEventFragmentProperties(txMeta);
} = await this._buildEventFragmentProperties(txMeta);
this._createTransactionEventFragment(
txMeta,
event,
@ -1474,7 +1481,7 @@ export default class TransactionController extends EventEmitter {
}
}
_buildEventFragmentProperties(txMeta, extraParams) {
async _buildEventFragmentProperties(txMeta, extraParams) {
const {
type,
time,
@ -1489,6 +1496,7 @@ export default class TransactionController extends EventEmitter {
estimateSuggested,
estimateUsed,
},
defaultGasEstimates,
metamaskNetworkId: network,
} = txMeta;
const source = referrer === 'metamask' ? 'user' : 'dapp';
@ -1502,6 +1510,43 @@ export default class TransactionController extends EventEmitter {
gasParams.gas_price = gasPrice;
}
if (defaultGasEstimates) {
const { estimateType } = defaultGasEstimates;
if (estimateType) {
gasParams.default_estimate = estimateType;
let defaultMaxFeePerGas = txMeta.defaultGasEstimates.maxFeePerGas;
let defaultMaxPriorityFeePerGas =
txMeta.defaultGasEstimates.maxPriorityFeePerGas;
if (
[
GAS_RECOMMENDATIONS.LOW,
GAS_RECOMMENDATIONS.MEDIUM,
GAS_RECOMMENDATIONS.MEDIUM.HIGH,
].includes(estimateType)
) {
const { gasFeeEstimates } = await this._getEIP1559GasFeeEstimates();
if (gasFeeEstimates?.[estimateType]?.suggestedMaxFeePerGas) {
defaultMaxFeePerGas =
gasFeeEstimates[estimateType]?.suggestedMaxFeePerGas;
gasParams.default_max_fee_per_gas = defaultMaxFeePerGas;
}
if (gasFeeEstimates?.[estimateType]?.suggestedMaxPriorityFeePerGas) {
defaultMaxPriorityFeePerGas =
gasFeeEstimates[estimateType]?.suggestedMaxPriorityFeePerGas;
gasParams.default_max_priority_fee_per_gas = defaultMaxPriorityFeePerGas;
}
}
}
if (txMeta.defaultGasEstimates.gas) {
gasParams.default_gas = txMeta.defaultGasEstimates.gas;
}
if (txMeta.defaultGasEstimates.gasPrice) {
gasParams.default_gas_price = txMeta.defaultGasEstimates.gasPrice;
}
}
if (estimateSuggested) {
gasParams.estimate_suggested = estimateSuggested;
}
@ -1512,12 +1557,19 @@ export default class TransactionController extends EventEmitter {
const gasParamsInGwei = this._getGasValuesInGWEI(gasParams);
let eip1559Version = '0';
if (txMeta.txParams.maxFeePerGas) {
const { eip1559V2Enabled } = this.preferencesStore.getState();
eip1559Version = eip1559V2Enabled ? '2' : '1';
}
const properties = {
chain_id: chainId,
referrer,
source,
network,
type,
eip_1559_version: eip1559Version,
};
const sensitiveProperties = {
@ -1661,14 +1713,14 @@ export default class TransactionController extends EventEmitter {
* @param {TransactionMetaMetricsEventString} event - the name of the transaction event
* @param {Object} extraParams - optional props and values to include in sensitiveProperties
*/
_trackTransactionMetricsEvent(txMeta, event, extraParams = {}) {
async _trackTransactionMetricsEvent(txMeta, event, extraParams = {}) {
if (!txMeta) {
return;
}
const {
properties,
sensitiveProperties,
} = this._buildEventFragmentProperties(txMeta, extraParams);
} = await this._buildEventFragmentProperties(txMeta, extraParams);
// Create event fragments for event types that spawn fragments, and ensure
// existence of fragments for event types that act upon them.

88
app/scripts/controllers/transactions/index.test.js
Unescape View File

@ -9,6 +9,7 @@ import {
createTestProviderTools,
getTestAccounts,
} from '../../../../test/stub/provider';
import mockEstimates from '../../../../test/data/mock-estimates.json';
import {
TRANSACTION_STATUSES,
TRANSACTION_TYPES,
@ -1561,6 +1562,10 @@ describe('Transaction Controller', function () {
txController,
'finalizeEventFragment',
);
sinon
.stub(txController, '_getEIP1559GasFeeEstimates')
.resolves(mockEstimates['fee-market']);
});
afterEach(function () {
@ -1587,10 +1592,14 @@ describe('Transaction Controller', function () {
chainId: currentChainId,
time: 1624408066355,
metamaskNetworkId: currentNetworkId,
defaultGasEstimates: {
gas: '0x7b0d',
gasPrice: '0x77359400',
},
};
});
it('should create an event fragment when transaction added', function () {
it('should create an event fragment when transaction added', async function () {
const expectedPayload = {
initialEvent: 'Transaction Added',
successEvent: 'Transaction Approved',
@ -1600,12 +1609,15 @@ describe('Transaction Controller', function () {
persist: true,
properties: {
chain_id: '0x2a',
eip_1559_version: '0',
network: '42',
referrer: 'metamask',
source: 'user',
type: TRANSACTION_TYPES.SIMPLE_SEND,
},
sensitiveProperties: {
default_gas: '0.000031501',
default_gas_price: '2',
gas_price: '2',
gas_limit: '0x7b0d',
first_seen: 1624408066355,
@ -1614,7 +1626,7 @@ describe('Transaction Controller', function () {
},
};
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.ADDED,
);
@ -1626,9 +1638,9 @@ describe('Transaction Controller', function () {
);
});
it('Should finalize the transaction added fragment as abandoned if user rejects transaction', function () {
it('Should finalize the transaction added fragment as abandoned if user rejects transaction', async function () {
fragmentExists = true;
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.REJECTED,
);
@ -1643,9 +1655,9 @@ describe('Transaction Controller', function () {
});
});
it('Should finalize the transaction added fragment if user approves transaction', function () {
it('Should finalize the transaction added fragment if user approves transaction', async function () {
fragmentExists = true;
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.APPROVED,
);
@ -1661,7 +1673,7 @@ describe('Transaction Controller', function () {
);
});
it('should create an event fragment when transaction is submitted', function () {
it('should create an event fragment when transaction is submitted', async function () {
const expectedPayload = {
initialEvent: 'Transaction Submitted',
successEvent: 'Transaction Finalized',
@ -1670,12 +1682,15 @@ describe('Transaction Controller', function () {
persist: true,
properties: {
chain_id: '0x2a',
eip_1559_version: '0',
network: '42',
referrer: 'metamask',
source: 'user',
type: TRANSACTION_TYPES.SIMPLE_SEND,
},
sensitiveProperties: {
default_gas: '0.000031501',
default_gas_price: '2',
gas_price: '2',
gas_limit: '0x7b0d',
first_seen: 1624408066355,
@ -1684,7 +1699,7 @@ describe('Transaction Controller', function () {
},
};
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.SUBMITTED,
);
@ -1696,9 +1711,9 @@ describe('Transaction Controller', function () {
);
});
it('Should finalize the transaction submitted fragment when transaction finalizes', function () {
it('Should finalize the transaction submitted fragment when transaction finalizes', async function () {
fragmentExists = true;
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.FINALIZED,
);
@ -1733,10 +1748,14 @@ describe('Transaction Controller', function () {
chainId: currentChainId,
time: 1624408066355,
metamaskNetworkId: currentNetworkId,
defaultGasEstimates: {
gas: '0x7b0d',
gasPrice: '0x77359400',
},
};
});
it('should create an event fragment when transaction added', function () {
it('should create an event fragment when transaction added', async function () {
const expectedPayload = {
initialEvent: 'Transaction Added',
successEvent: 'Transaction Approved',
@ -1746,12 +1765,15 @@ describe('Transaction Controller', function () {
persist: true,
properties: {
chain_id: '0x2a',
eip_1559_version: '0',
network: '42',
referrer: 'other',
source: 'dapp',
type: TRANSACTION_TYPES.SIMPLE_SEND,
},
sensitiveProperties: {
default_gas: '0.000031501',
default_gas_price: '2',
gas_price: '2',
gas_limit: '0x7b0d',
first_seen: 1624408066355,
@ -1760,7 +1782,7 @@ describe('Transaction Controller', function () {
},
};
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.ADDED,
);
@ -1772,10 +1794,10 @@ describe('Transaction Controller', function () {
);
});
it('Should finalize the transaction added fragment as abandoned if user rejects transaction', function () {
it('Should finalize the transaction added fragment as abandoned if user rejects transaction', async function () {
fragmentExists = true;
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.REJECTED,
);
@ -1790,10 +1812,10 @@ describe('Transaction Controller', function () {
});
});
it('Should finalize the transaction added fragment if user approves transaction', function () {
it('Should finalize the transaction added fragment if user approves transaction', async function () {
fragmentExists = true;
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.APPROVED,
);
@ -1809,7 +1831,7 @@ describe('Transaction Controller', function () {
);
});
it('should create an event fragment when transaction is submitted', function () {
it('should create an event fragment when transaction is submitted', async function () {
const expectedPayload = {
initialEvent: 'Transaction Submitted',
successEvent: 'Transaction Finalized',
@ -1818,12 +1840,15 @@ describe('Transaction Controller', function () {
persist: true,
properties: {
chain_id: '0x2a',
eip_1559_version: '0',
network: '42',
referrer: 'other',
source: 'dapp',
type: TRANSACTION_TYPES.SIMPLE_SEND,
},
sensitiveProperties: {
default_gas: '0.000031501',
default_gas_price: '2',
gas_price: '2',
gas_limit: '0x7b0d',
first_seen: 1624408066355,
@ -1832,7 +1857,7 @@ describe('Transaction Controller', function () {
},
};
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.SUBMITTED,
);
@ -1844,10 +1869,10 @@ describe('Transaction Controller', function () {
);
});
it('Should finalize the transaction submitted fragment when transaction finalizes', function () {
it('Should finalize the transaction submitted fragment when transaction finalizes', async function () {
fragmentExists = true;
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.FINALIZED,
);
@ -1864,7 +1889,7 @@ describe('Transaction Controller', function () {
});
});
it('should create missing fragments when events happen out of order or are missing', function () {
it('should create missing fragments when events happen out of order or are missing', async function () {
const txMeta = {
id: 1,
status: TRANSACTION_STATUSES.UNAPPROVED,
@ -1890,6 +1915,7 @@ describe('Transaction Controller', function () {
persist: true,
properties: {
chain_id: '0x2a',
eip_1559_version: '0',
network: '42',
referrer: 'other',
source: 'dapp',
@ -1903,7 +1929,7 @@ describe('Transaction Controller', function () {
status: 'unapproved',
},
};
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.APPROVED,
);
@ -1920,7 +1946,7 @@ describe('Transaction Controller', function () {
assert.deepEqual(finalizeEventFragmentSpy.getCall(0).args[1], undefined);
});
it('should call _trackMetaMetricsEvent with the correct payload (extra params)', function () {
it('should call _trackMetaMetricsEvent with the correct payload (extra params)', async function () {
const txMeta = {
id: 1,
status: TRANSACTION_STATUSES.UNAPPROVED,
@ -1950,6 +1976,7 @@ describe('Transaction Controller', function () {
source: 'dapp',
type: TRANSACTION_TYPES.SIMPLE_SEND,
chain_id: '0x2a',
eip_1559_version: '0',
},
sensitiveProperties: {
baz: 3.0,
@ -1962,7 +1989,7 @@ describe('Transaction Controller', function () {
},
};
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.ADDED,
{
@ -1978,7 +2005,7 @@ describe('Transaction Controller', function () {
);
});
it('should call _trackMetaMetricsEvent with the correct payload (EIP-1559)', function () {
it('should call _trackMetaMetricsEvent with the correct payload (EIP-1559)', async function () {
const txMeta = {
id: 1,
status: TRANSACTION_STATUSES.UNAPPROVED,
@ -1997,6 +2024,11 @@ describe('Transaction Controller', function () {
chainId: currentChainId,
time: 1624408066355,
metamaskNetworkId: currentNetworkId,
defaultGasEstimates: {
estimateType: 'medium',
maxFeePerGas: '0x77359400',
maxPriorityFeePerGas: '0x77359400',
},
};
const expectedPayload = {
initialEvent: 'Transaction Added',
@ -2007,6 +2039,7 @@ describe('Transaction Controller', function () {
category: 'Transactions',
properties: {
chain_id: '0x2a',
eip_1559_version: '1',
network: '42',
referrer: 'other',
source: 'dapp',
@ -2023,10 +2056,13 @@ describe('Transaction Controller', function () {
status: 'unapproved',
estimate_suggested: GAS_RECOMMENDATIONS.MEDIUM,
estimate_used: GAS_RECOMMENDATIONS.HIGH,
default_estimate: 'medium',
default_max_fee_per_gas: '70',
default_max_priority_fee_per_gas: '7',
},
};
txController._trackTransactionMetricsEvent(
await txController._trackTransactionMetricsEvent(
txMeta,
TRANSACTION_EVENTS.ADDED,
{

Write Preview
Loading…
Cancel
Save