mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-10-22 19:26:13 +02:00
972 lines
32 KiB
JavaScript
972 lines
32 KiB
JavaScript
import EventEmitter from 'safe-event-emitter'
|
|
import { ObservableStore } from '@metamask/obs-store'
|
|
import ethUtil from 'ethereumjs-util'
|
|
import Transaction from 'ethereumjs-tx'
|
|
import EthQuery from 'ethjs-query'
|
|
import { ethErrors } from 'eth-json-rpc-errors'
|
|
import abi from 'human-standard-token-abi'
|
|
import { ethers } from 'ethers'
|
|
import NonceTracker from 'nonce-tracker'
|
|
import log from 'loglevel'
|
|
import BigNumber from 'bignumber.js'
|
|
import cleanErrorStack from '../../lib/cleanErrorStack'
|
|
import {
|
|
hexToBn,
|
|
bnToHex,
|
|
BnMultiplyByFraction,
|
|
addHexPrefix,
|
|
} from '../../lib/util'
|
|
import { TRANSACTION_NO_CONTRACT_ERROR_KEY } from '../../../../ui/app/helpers/constants/error-keys'
|
|
import { getSwapsTokensReceivedFromTxMeta } from '../../../../ui/app/pages/swaps/swaps.util'
|
|
import {
|
|
TRANSACTION_CATEGORIES,
|
|
TRANSACTION_STATUSES,
|
|
TRANSACTION_TYPES,
|
|
} from '../../../../shared/constants/transaction'
|
|
import TransactionStateManager from './tx-state-manager'
|
|
import TxGasUtil from './tx-gas-utils'
|
|
import PendingTransactionTracker from './pending-tx-tracker'
|
|
import * as txUtils from './lib/util'
|
|
|
|
const hstInterface = new ethers.utils.Interface(abi)
|
|
|
|
const SIMPLE_GAS_COST = '0x5208' // Hex for 21000, cost of a simple send.
|
|
const MAX_MEMSTORE_TX_LIST_SIZE = 100 // Number of transactions (by unique nonces) to keep in memory
|
|
|
|
/**
|
|
Transaction Controller is an aggregate of sub-controllers and trackers
|
|
composing them in a way to be exposed to the metamask controller
|
|
<br>- txStateManager
|
|
responsible for the state of a transaction and
|
|
storing the transaction
|
|
<br>- pendingTxTracker
|
|
watching blocks for transactions to be include
|
|
and emitting confirmed events
|
|
<br>- txGasUtil
|
|
gas calculations and safety buffering
|
|
<br>- nonceTracker
|
|
calculating nonces
|
|
|
|
@class
|
|
@param {Object} opts
|
|
@param {Object} opts.initState - initial transaction list default is an empty array
|
|
@param {Object} opts.networkStore - an observable store for network number
|
|
@param {Object} opts.blockTracker - An instance of eth-blocktracker
|
|
@param {Object} opts.provider - A network provider.
|
|
@param {Function} opts.signTransaction - function the signs an ethereumjs-tx
|
|
@param {Object} opts.getPermittedAccounts - get accounts that an origin has permissions for
|
|
@param {Function} opts.signTransaction - ethTx signer that returns a rawTx
|
|
@param {number} [opts.txHistoryLimit] - number *optional* for limiting how many transactions are in state
|
|
@param {Object} opts.preferencesStore
|
|
*/
|
|
|
|
export default class TransactionController extends EventEmitter {
|
|
constructor(opts) {
|
|
super()
|
|
this.networkStore = opts.networkStore || new ObservableStore({})
|
|
this._getCurrentChainId = opts.getCurrentChainId
|
|
this.preferencesStore = opts.preferencesStore || new ObservableStore({})
|
|
this.provider = opts.provider
|
|
this.getPermittedAccounts = opts.getPermittedAccounts
|
|
this.blockTracker = opts.blockTracker
|
|
this.signEthTx = opts.signTransaction
|
|
this.inProcessOfSigning = new Set()
|
|
this._trackMetaMetricsEvent = opts.trackMetaMetricsEvent
|
|
this._getParticipateInMetrics = opts.getParticipateInMetrics
|
|
|
|
this.memStore = new ObservableStore({})
|
|
this.query = new EthQuery(this.provider)
|
|
|
|
this.txGasUtil = new TxGasUtil(this.provider)
|
|
this._mapMethods()
|
|
this.txStateManager = new TransactionStateManager({
|
|
initState: opts.initState,
|
|
txHistoryLimit: opts.txHistoryLimit,
|
|
getNetwork: this.getNetwork.bind(this),
|
|
})
|
|
this._onBootCleanUp()
|
|
|
|
this.store = this.txStateManager.store
|
|
this.nonceTracker = new NonceTracker({
|
|
provider: this.provider,
|
|
blockTracker: this.blockTracker,
|
|
getPendingTransactions: this.txStateManager.getPendingTransactions.bind(
|
|
this.txStateManager,
|
|
),
|
|
getConfirmedTransactions: this.txStateManager.getConfirmedTransactions.bind(
|
|
this.txStateManager,
|
|
),
|
|
})
|
|
|
|
this.pendingTxTracker = new PendingTransactionTracker({
|
|
provider: this.provider,
|
|
nonceTracker: this.nonceTracker,
|
|
publishTransaction: (rawTx) => this.query.sendRawTransaction(rawTx),
|
|
getPendingTransactions: () => {
|
|
const pending = this.txStateManager.getPendingTransactions()
|
|
const approved = this.txStateManager.getApprovedTransactions()
|
|
return [...pending, ...approved]
|
|
},
|
|
approveTransaction: this.approveTransaction.bind(this),
|
|
getCompletedTransactions: this.txStateManager.getConfirmedTransactions.bind(
|
|
this.txStateManager,
|
|
),
|
|
})
|
|
|
|
this.txStateManager.store.subscribe(() => this.emit('update:badge'))
|
|
this._setupListeners()
|
|
// memstore is computed from a few different stores
|
|
this._updateMemstore()
|
|
this.txStateManager.store.subscribe(() => this._updateMemstore())
|
|
this.networkStore.subscribe(() => {
|
|
this._onBootCleanUp()
|
|
this._updateMemstore()
|
|
})
|
|
|
|
// request state update to finalize initialization
|
|
this._updatePendingTxsAfterFirstBlock()
|
|
}
|
|
|
|
/**
|
|
* Gets the current chainId in the network store as a number, returning 0 if
|
|
* the chainId parses to NaN.
|
|
*
|
|
* @returns {number} The numerical chainId.
|
|
*/
|
|
getChainId() {
|
|
const networkState = this.networkStore.getState()
|
|
const chainId = this._getCurrentChainId()
|
|
const integerChainId = parseInt(chainId, 16)
|
|
if (networkState === 'loading' || Number.isNaN(integerChainId)) {
|
|
return 0
|
|
}
|
|
return integerChainId
|
|
}
|
|
|
|
/**
|
|
Adds a tx to the txlist
|
|
@emits ${txMeta.id}:unapproved
|
|
*/
|
|
addTx(txMeta) {
|
|
this.txStateManager.addTx(txMeta)
|
|
this.emit(`${txMeta.id}:unapproved`, txMeta)
|
|
}
|
|
|
|
/**
|
|
Wipes the transactions for a given account
|
|
@param {string} address - hex string of the from address for txs being removed
|
|
*/
|
|
wipeTransactions(address) {
|
|
this.txStateManager.wipeTransactions(address)
|
|
}
|
|
|
|
/**
|
|
* Add a new unapproved transaction to the pipeline
|
|
*
|
|
* @returns {Promise<string>} the hash of the transaction after being submitted to the network
|
|
* @param {Object} txParams - txParams for the transaction
|
|
* @param {Object} opts - with the key origin to put the origin on the txMeta
|
|
*/
|
|
async newUnapprovedTransaction(txParams, opts = {}) {
|
|
log.debug(
|
|
`MetaMaskController newUnapprovedTransaction ${JSON.stringify(txParams)}`,
|
|
)
|
|
|
|
const initialTxMeta = await this.addUnapprovedTransaction(
|
|
txParams,
|
|
opts.origin,
|
|
)
|
|
|
|
// listen for tx completion (success, fail)
|
|
return new Promise((resolve, reject) => {
|
|
this.txStateManager.once(
|
|
`${initialTxMeta.id}:finished`,
|
|
(finishedTxMeta) => {
|
|
switch (finishedTxMeta.status) {
|
|
case TRANSACTION_STATUSES.SUBMITTED:
|
|
return resolve(finishedTxMeta.hash)
|
|
case TRANSACTION_STATUSES.REJECTED:
|
|
return reject(
|
|
cleanErrorStack(
|
|
ethErrors.provider.userRejectedRequest(
|
|
'MetaMask Tx Signature: User denied transaction signature.',
|
|
),
|
|
),
|
|
)
|
|
case TRANSACTION_STATUSES.FAILED:
|
|
return reject(
|
|
cleanErrorStack(
|
|
ethErrors.rpc.internal(finishedTxMeta.err.message),
|
|
),
|
|
)
|
|
default:
|
|
return reject(
|
|
cleanErrorStack(
|
|
ethErrors.rpc.internal(
|
|
`MetaMask Tx Signature: Unknown problem: ${JSON.stringify(
|
|
finishedTxMeta.txParams,
|
|
)}`,
|
|
),
|
|
),
|
|
)
|
|
}
|
|
},
|
|
)
|
|
})
|
|
}
|
|
|
|
/**
|
|
* Validates and generates a txMeta with defaults and puts it in txStateManager
|
|
* store.
|
|
*
|
|
* @returns {txMeta}
|
|
*/
|
|
async addUnapprovedTransaction(txParams, origin) {
|
|
// validate
|
|
const normalizedTxParams = txUtils.normalizeTxParams(txParams)
|
|
|
|
txUtils.validateTxParams(normalizedTxParams)
|
|
|
|
/**
|
|
`generateTxMeta` adds the default txMeta properties to the passed object.
|
|
These include the tx's `id`. As we use the id for determining order of
|
|
txes in the tx-state-manager, it is necessary to call the asynchronous
|
|
method `this._determineTransactionCategory` after `generateTxMeta`.
|
|
*/
|
|
let txMeta = this.txStateManager.generateTxMeta({
|
|
txParams: normalizedTxParams,
|
|
type: TRANSACTION_TYPES.STANDARD,
|
|
})
|
|
|
|
if (origin === 'metamask') {
|
|
// Assert the from address is the selected address
|
|
if (normalizedTxParams.from !== this.getSelectedAddress()) {
|
|
throw ethErrors.rpc.internal({
|
|
message: `Internally initiated transaction is using invalid account.`,
|
|
data: {
|
|
origin,
|
|
fromAddress: normalizedTxParams.from,
|
|
selectedAddress: this.getSelectedAddress(),
|
|
},
|
|
})
|
|
}
|
|
} else {
|
|
// Assert that the origin has permissions to initiate transactions from
|
|
// the specified address
|
|
const permittedAddresses = await this.getPermittedAccounts(origin)
|
|
if (!permittedAddresses.includes(normalizedTxParams.from)) {
|
|
throw ethErrors.provider.unauthorized({ data: { origin } })
|
|
}
|
|
}
|
|
|
|
txMeta.origin = origin
|
|
|
|
const {
|
|
transactionCategory,
|
|
getCodeResponse,
|
|
} = await this._determineTransactionCategory(txParams)
|
|
txMeta.transactionCategory = transactionCategory
|
|
|
|
// ensure value
|
|
txMeta.txParams.value = txMeta.txParams.value
|
|
? addHexPrefix(txMeta.txParams.value)
|
|
: '0x0'
|
|
|
|
this.addTx(txMeta)
|
|
this.emit('newUnapprovedTx', txMeta)
|
|
|
|
try {
|
|
txMeta = await this.addTxGasDefaults(txMeta, getCodeResponse)
|
|
} catch (error) {
|
|
log.warn(error)
|
|
txMeta = this.txStateManager.getTx(txMeta.id)
|
|
txMeta.loadingDefaults = false
|
|
this.txStateManager.updateTx(txMeta, 'Failed to calculate gas defaults.')
|
|
throw error
|
|
}
|
|
|
|
txMeta.loadingDefaults = false
|
|
// save txMeta
|
|
this.txStateManager.updateTx(txMeta, 'Added new unapproved transaction.')
|
|
|
|
return txMeta
|
|
}
|
|
|
|
/**
|
|
* Adds the tx gas defaults: gas && gasPrice
|
|
* @param {Object} txMeta - the txMeta object
|
|
* @returns {Promise<object>} resolves with txMeta
|
|
*/
|
|
async addTxGasDefaults(txMeta, getCodeResponse) {
|
|
const defaultGasPrice = await this._getDefaultGasPrice(txMeta)
|
|
const {
|
|
gasLimit: defaultGasLimit,
|
|
simulationFails,
|
|
} = await this._getDefaultGasLimit(txMeta, getCodeResponse)
|
|
|
|
// eslint-disable-next-line no-param-reassign
|
|
txMeta = this.txStateManager.getTx(txMeta.id)
|
|
if (simulationFails) {
|
|
txMeta.simulationFails = simulationFails
|
|
}
|
|
if (defaultGasPrice && !txMeta.txParams.gasPrice) {
|
|
txMeta.txParams.gasPrice = defaultGasPrice
|
|
}
|
|
if (defaultGasLimit && !txMeta.txParams.gas) {
|
|
txMeta.txParams.gas = defaultGasLimit
|
|
}
|
|
return txMeta
|
|
}
|
|
|
|
/**
|
|
* Gets default gas price, or returns `undefined` if gas price is already set
|
|
* @param {Object} txMeta - The txMeta object
|
|
* @returns {Promise<string|undefined>} The default gas price
|
|
*/
|
|
async _getDefaultGasPrice(txMeta) {
|
|
if (txMeta.txParams.gasPrice) {
|
|
return undefined
|
|
}
|
|
const gasPrice = await this.query.gasPrice()
|
|
|
|
return addHexPrefix(gasPrice.toString(16))
|
|
}
|
|
|
|
/**
|
|
* Gets default gas limit, or debug information about why gas estimate failed.
|
|
* @param {Object} txMeta - The txMeta object
|
|
* @param {string} getCodeResponse - The transaction category code response, used for debugging purposes
|
|
* @returns {Promise<Object>} Object containing the default gas limit, or the simulation failure object
|
|
*/
|
|
async _getDefaultGasLimit(txMeta, getCodeResponse) {
|
|
if (txMeta.txParams.gas) {
|
|
return {}
|
|
} else if (
|
|
txMeta.txParams.to &&
|
|
txMeta.transactionCategory === TRANSACTION_CATEGORIES.SENT_ETHER
|
|
) {
|
|
// if there's data in the params, but there's no contract code, it's not a valid transaction
|
|
if (txMeta.txParams.data) {
|
|
const err = new Error(
|
|
'TxGasUtil - Trying to call a function on a non-contract address',
|
|
)
|
|
// set error key so ui can display localized error message
|
|
err.errorKey = TRANSACTION_NO_CONTRACT_ERROR_KEY
|
|
|
|
// set the response on the error so that we can see in logs what the actual response was
|
|
err.getCodeResponse = getCodeResponse
|
|
throw err
|
|
}
|
|
|
|
// This is a standard ether simple send, gas requirement is exactly 21k
|
|
return { gasLimit: SIMPLE_GAS_COST }
|
|
}
|
|
|
|
const {
|
|
blockGasLimit,
|
|
estimatedGasHex,
|
|
simulationFails,
|
|
} = await this.txGasUtil.analyzeGasUsage(txMeta)
|
|
|
|
// add additional gas buffer to our estimation for safety
|
|
const gasLimit = this.txGasUtil.addGasBuffer(
|
|
addHexPrefix(estimatedGasHex),
|
|
blockGasLimit,
|
|
)
|
|
return { gasLimit, simulationFails }
|
|
}
|
|
|
|
/**
|
|
* Creates a new approved transaction to attempt to cancel a previously submitted transaction. The
|
|
* new transaction contains the same nonce as the previous, is a basic ETH transfer of 0x value to
|
|
* the sender's address, and has a higher gasPrice than that of the previous transaction.
|
|
* @param {number} originalTxId - the id of the txMeta that you want to attempt to cancel
|
|
* @param {string} [customGasPrice] - the hex value to use for the cancel transaction
|
|
* @returns {txMeta}
|
|
*/
|
|
async createCancelTransaction(originalTxId, customGasPrice) {
|
|
const originalTxMeta = this.txStateManager.getTx(originalTxId)
|
|
const { txParams } = originalTxMeta
|
|
const { gasPrice: lastGasPrice, from, nonce } = txParams
|
|
|
|
const newGasPrice =
|
|
customGasPrice ||
|
|
bnToHex(BnMultiplyByFraction(hexToBn(lastGasPrice), 11, 10))
|
|
const newTxMeta = this.txStateManager.generateTxMeta({
|
|
txParams: {
|
|
from,
|
|
to: from,
|
|
nonce,
|
|
gas: '0x5208',
|
|
value: '0x0',
|
|
gasPrice: newGasPrice,
|
|
},
|
|
lastGasPrice,
|
|
loadingDefaults: false,
|
|
status: TRANSACTION_STATUSES.APPROVED,
|
|
type: TRANSACTION_TYPES.CANCEL,
|
|
})
|
|
|
|
this.addTx(newTxMeta)
|
|
await this.approveTransaction(newTxMeta.id)
|
|
return newTxMeta
|
|
}
|
|
|
|
/**
|
|
* Creates a new approved transaction to attempt to speed up a previously submitted transaction. The
|
|
* new transaction contains the same nonce as the previous. By default, the new transaction will use
|
|
* the same gas limit and a 10% higher gas price, though it is possible to set a custom value for
|
|
* each instead.
|
|
* @param {number} originalTxId - the id of the txMeta that you want to speed up
|
|
* @param {string} [customGasPrice] - The new custom gas price, in hex
|
|
* @param {string} [customGasLimit] - The new custom gas limt, in hex
|
|
* @returns {txMeta}
|
|
*/
|
|
async createSpeedUpTransaction(originalTxId, customGasPrice, customGasLimit) {
|
|
const originalTxMeta = this.txStateManager.getTx(originalTxId)
|
|
const { txParams } = originalTxMeta
|
|
const { gasPrice: lastGasPrice } = txParams
|
|
|
|
const newGasPrice =
|
|
customGasPrice ||
|
|
bnToHex(BnMultiplyByFraction(hexToBn(lastGasPrice), 11, 10))
|
|
|
|
const newTxMeta = this.txStateManager.generateTxMeta({
|
|
txParams: {
|
|
...txParams,
|
|
gasPrice: newGasPrice,
|
|
},
|
|
lastGasPrice,
|
|
loadingDefaults: false,
|
|
status: TRANSACTION_STATUSES.APPROVED,
|
|
type: TRANSACTION_TYPES.RETRY,
|
|
})
|
|
|
|
if (customGasLimit) {
|
|
newTxMeta.txParams.gas = customGasLimit
|
|
}
|
|
|
|
this.addTx(newTxMeta)
|
|
await this.approveTransaction(newTxMeta.id)
|
|
return newTxMeta
|
|
}
|
|
|
|
/**
|
|
updates the txMeta in the txStateManager
|
|
@param {Object} txMeta - the updated txMeta
|
|
*/
|
|
async updateTransaction(txMeta) {
|
|
this.txStateManager.updateTx(txMeta, 'confTx: user updated transaction')
|
|
}
|
|
|
|
/**
|
|
updates and approves the transaction
|
|
@param {Object} txMeta
|
|
*/
|
|
async updateAndApproveTransaction(txMeta) {
|
|
this.txStateManager.updateTx(txMeta, 'confTx: user approved transaction')
|
|
await this.approveTransaction(txMeta.id)
|
|
}
|
|
|
|
/**
|
|
sets the tx status to approved
|
|
auto fills the nonce
|
|
signs the transaction
|
|
publishes the transaction
|
|
if any of these steps fails the tx status will be set to failed
|
|
@param {number} txId - the tx's Id
|
|
*/
|
|
async approveTransaction(txId) {
|
|
// TODO: Move this safety out of this function.
|
|
// Since this transaction is async,
|
|
// we need to keep track of what is currently being signed,
|
|
// So that we do not increment nonce + resubmit something
|
|
// that is already being incremented & signed.
|
|
if (this.inProcessOfSigning.has(txId)) {
|
|
return
|
|
}
|
|
this.inProcessOfSigning.add(txId)
|
|
let nonceLock
|
|
try {
|
|
// approve
|
|
this.txStateManager.setTxStatusApproved(txId)
|
|
// get next nonce
|
|
const txMeta = this.txStateManager.getTx(txId)
|
|
const fromAddress = txMeta.txParams.from
|
|
// wait for a nonce
|
|
let { customNonceValue } = txMeta
|
|
customNonceValue = Number(customNonceValue)
|
|
nonceLock = await this.nonceTracker.getNonceLock(fromAddress)
|
|
// add nonce to txParams
|
|
// if txMeta has lastGasPrice then it is a retry at same nonce with higher
|
|
// gas price transaction and their for the nonce should not be calculated
|
|
const nonce = txMeta.lastGasPrice
|
|
? txMeta.txParams.nonce
|
|
: nonceLock.nextNonce
|
|
const customOrNonce =
|
|
customNonceValue === 0 ? customNonceValue : customNonceValue || nonce
|
|
|
|
txMeta.txParams.nonce = addHexPrefix(customOrNonce.toString(16))
|
|
// add nonce debugging information to txMeta
|
|
txMeta.nonceDetails = nonceLock.nonceDetails
|
|
if (customNonceValue) {
|
|
txMeta.nonceDetails.customNonceValue = customNonceValue
|
|
}
|
|
this.txStateManager.updateTx(txMeta, 'transactions#approveTransaction')
|
|
// sign transaction
|
|
const rawTx = await this.signTransaction(txId)
|
|
await this.publishTransaction(txId, rawTx)
|
|
// must set transaction to submitted/failed before releasing lock
|
|
nonceLock.releaseLock()
|
|
} catch (err) {
|
|
// this is try-catch wrapped so that we can guarantee that the nonceLock is released
|
|
try {
|
|
this.txStateManager.setTxStatusFailed(txId, err)
|
|
} catch (err2) {
|
|
log.error(err2)
|
|
}
|
|
// must set transaction to submitted/failed before releasing lock
|
|
if (nonceLock) {
|
|
nonceLock.releaseLock()
|
|
}
|
|
// continue with error chain
|
|
throw err
|
|
} finally {
|
|
this.inProcessOfSigning.delete(txId)
|
|
}
|
|
}
|
|
|
|
/**
|
|
adds the chain id and signs the transaction and set the status to signed
|
|
@param {number} txId - the tx's Id
|
|
@returns {string} rawTx
|
|
*/
|
|
async signTransaction(txId) {
|
|
const txMeta = this.txStateManager.getTx(txId)
|
|
// add network/chain id
|
|
const chainId = this.getChainId()
|
|
const txParams = { ...txMeta.txParams, chainId }
|
|
// sign tx
|
|
const fromAddress = txParams.from
|
|
const ethTx = new Transaction(txParams)
|
|
await this.signEthTx(ethTx, fromAddress)
|
|
|
|
// add r,s,v values for provider request purposes see createMetamaskMiddleware
|
|
// and JSON rpc standard for further explanation
|
|
txMeta.r = ethUtil.bufferToHex(ethTx.r)
|
|
txMeta.s = ethUtil.bufferToHex(ethTx.s)
|
|
txMeta.v = ethUtil.bufferToHex(ethTx.v)
|
|
|
|
this.txStateManager.updateTx(
|
|
txMeta,
|
|
'transactions#signTransaction: add r, s, v values',
|
|
)
|
|
|
|
// set state to signed
|
|
this.txStateManager.setTxStatusSigned(txMeta.id)
|
|
const rawTx = ethUtil.bufferToHex(ethTx.serialize())
|
|
return rawTx
|
|
}
|
|
|
|
/**
|
|
publishes the raw tx and sets the txMeta to submitted
|
|
@param {number} txId - the tx's Id
|
|
@param {string} rawTx - the hex string of the serialized signed transaction
|
|
@returns {Promise<void>}
|
|
*/
|
|
async publishTransaction(txId, rawTx) {
|
|
const txMeta = this.txStateManager.getTx(txId)
|
|
txMeta.rawTx = rawTx
|
|
if (txMeta.transactionCategory === TRANSACTION_CATEGORIES.SWAP) {
|
|
const preTxBalance = await this.query.getBalance(txMeta.txParams.from)
|
|
txMeta.preTxBalance = preTxBalance.toString(16)
|
|
}
|
|
this.txStateManager.updateTx(txMeta, 'transactions#publishTransaction')
|
|
let txHash
|
|
try {
|
|
txHash = await this.query.sendRawTransaction(rawTx)
|
|
} catch (error) {
|
|
if (error.message.toLowerCase().includes('known transaction')) {
|
|
txHash = ethUtil.sha3(addHexPrefix(rawTx)).toString('hex')
|
|
txHash = addHexPrefix(txHash)
|
|
} else {
|
|
throw error
|
|
}
|
|
}
|
|
this.setTxHash(txId, txHash)
|
|
|
|
this.txStateManager.setTxStatusSubmitted(txId)
|
|
}
|
|
|
|
/**
|
|
* Sets the status of the transaction to confirmed and sets the status of nonce duplicates as
|
|
* dropped if the txParams have data it will fetch the txReceipt
|
|
* @param {number} txId - The tx's ID
|
|
* @returns {Promise<void>}
|
|
*/
|
|
async confirmTransaction(txId, txReceipt) {
|
|
// get the txReceipt before marking the transaction confirmed
|
|
// to ensure the receipt is gotten before the ui revives the tx
|
|
const txMeta = this.txStateManager.getTx(txId)
|
|
|
|
if (!txMeta) {
|
|
return
|
|
}
|
|
|
|
try {
|
|
// It seems that sometimes the numerical values being returned from
|
|
// this.query.getTransactionReceipt are BN instances and not strings.
|
|
const gasUsed =
|
|
typeof txReceipt.gasUsed === 'string'
|
|
? txReceipt.gasUsed
|
|
: txReceipt.gasUsed.toString(16)
|
|
|
|
txMeta.txReceipt = {
|
|
...txReceipt,
|
|
gasUsed,
|
|
}
|
|
this.txStateManager.setTxStatusConfirmed(txId)
|
|
this._markNonceDuplicatesDropped(txId)
|
|
|
|
this.txStateManager.updateTx(
|
|
txMeta,
|
|
'transactions#confirmTransaction - add txReceipt',
|
|
)
|
|
|
|
if (txMeta.transactionCategory === TRANSACTION_CATEGORIES.SWAP) {
|
|
const postTxBalance = await this.query.getBalance(txMeta.txParams.from)
|
|
const latestTxMeta = this.txStateManager.getTx(txId)
|
|
|
|
const approvalTxMeta = latestTxMeta.approvalTxId
|
|
? this.txStateManager.getTx(latestTxMeta.approvalTxId)
|
|
: null
|
|
|
|
latestTxMeta.postTxBalance = postTxBalance.toString(16)
|
|
|
|
this.txStateManager.updateTx(
|
|
latestTxMeta,
|
|
'transactions#confirmTransaction - add postTxBalance',
|
|
)
|
|
|
|
this._trackSwapsMetrics(latestTxMeta, approvalTxMeta)
|
|
}
|
|
} catch (err) {
|
|
log.error(err)
|
|
}
|
|
}
|
|
|
|
/**
|
|
Convenience method for the ui thats sets the transaction to rejected
|
|
@param {number} txId - the tx's Id
|
|
@returns {Promise<void>}
|
|
*/
|
|
async cancelTransaction(txId) {
|
|
this.txStateManager.setTxStatusRejected(txId)
|
|
}
|
|
|
|
/**
|
|
Sets the txHas on the txMeta
|
|
@param {number} txId - the tx's Id
|
|
@param {string} txHash - the hash for the txMeta
|
|
*/
|
|
setTxHash(txId, txHash) {
|
|
// Add the tx hash to the persisted meta-tx object
|
|
const txMeta = this.txStateManager.getTx(txId)
|
|
txMeta.hash = txHash
|
|
this.txStateManager.updateTx(txMeta, 'transactions#setTxHash')
|
|
}
|
|
|
|
//
|
|
// PRIVATE METHODS
|
|
//
|
|
/** maps methods for convenience*/
|
|
_mapMethods() {
|
|
/** @returns {Object} the state in transaction controller */
|
|
this.getState = () => this.memStore.getState()
|
|
|
|
/** @returns {string|number} the network number stored in networkStore */
|
|
this.getNetwork = () => this.networkStore.getState()
|
|
|
|
/** @returns {string} the user selected address */
|
|
this.getSelectedAddress = () =>
|
|
this.preferencesStore.getState().selectedAddress
|
|
|
|
/** @returns {Array} transactions whos status is unapproved */
|
|
this.getUnapprovedTxCount = () =>
|
|
Object.keys(this.txStateManager.getUnapprovedTxList()).length
|
|
|
|
/**
|
|
@returns {number} number of transactions that have the status submitted
|
|
@param {string} account - hex prefixed account
|
|
*/
|
|
this.getPendingTxCount = (account) =>
|
|
this.txStateManager.getPendingTransactions(account).length
|
|
|
|
/** see txStateManager */
|
|
this.getFilteredTxList = (opts) =>
|
|
this.txStateManager.getFilteredTxList(opts)
|
|
}
|
|
|
|
// called once on startup
|
|
async _updatePendingTxsAfterFirstBlock() {
|
|
// wait for first block so we know we're ready
|
|
await this.blockTracker.getLatestBlock()
|
|
// get status update for all pending transactions (for the current network)
|
|
await this.pendingTxTracker.updatePendingTxs()
|
|
}
|
|
|
|
/**
|
|
If transaction controller was rebooted with transactions that are uncompleted
|
|
in steps of the transaction signing or user confirmation process it will either
|
|
transition txMetas to a failed state or try to redo those tasks.
|
|
*/
|
|
|
|
_onBootCleanUp() {
|
|
this.txStateManager
|
|
.getFilteredTxList({
|
|
status: TRANSACTION_STATUSES.UNAPPROVED,
|
|
loadingDefaults: true,
|
|
})
|
|
.forEach((tx) => {
|
|
this.addTxGasDefaults(tx)
|
|
.then((txMeta) => {
|
|
txMeta.loadingDefaults = false
|
|
this.txStateManager.updateTx(
|
|
txMeta,
|
|
'transactions: gas estimation for tx on boot',
|
|
)
|
|
})
|
|
.catch((error) => {
|
|
const txMeta = this.txStateManager.getTx(tx.id)
|
|
txMeta.loadingDefaults = false
|
|
this.txStateManager.updateTx(
|
|
txMeta,
|
|
'failed to estimate gas during boot cleanup.',
|
|
)
|
|
this.txStateManager.setTxStatusFailed(txMeta.id, error)
|
|
})
|
|
})
|
|
|
|
this.txStateManager
|
|
.getFilteredTxList({
|
|
status: TRANSACTION_STATUSES.APPROVED,
|
|
})
|
|
.forEach((txMeta) => {
|
|
const txSignError = new Error(
|
|
'Transaction found as "approved" during boot - possibly stuck during signing',
|
|
)
|
|
this.txStateManager.setTxStatusFailed(txMeta.id, txSignError)
|
|
})
|
|
}
|
|
|
|
/**
|
|
is called in constructor applies the listeners for pendingTxTracker txStateManager
|
|
and blockTracker
|
|
*/
|
|
_setupListeners() {
|
|
this.txStateManager.on(
|
|
'tx:status-update',
|
|
this.emit.bind(this, 'tx:status-update'),
|
|
)
|
|
this._setupBlockTrackerListener()
|
|
this.pendingTxTracker.on('tx:warning', (txMeta) => {
|
|
this.txStateManager.updateTx(
|
|
txMeta,
|
|
'transactions/pending-tx-tracker#event: tx:warning',
|
|
)
|
|
})
|
|
this.pendingTxTracker.on(
|
|
'tx:failed',
|
|
this.txStateManager.setTxStatusFailed.bind(this.txStateManager),
|
|
)
|
|
this.pendingTxTracker.on('tx:confirmed', (txId, transactionReceipt) =>
|
|
this.confirmTransaction(txId, transactionReceipt),
|
|
)
|
|
this.pendingTxTracker.on(
|
|
'tx:dropped',
|
|
this.txStateManager.setTxStatusDropped.bind(this.txStateManager),
|
|
)
|
|
this.pendingTxTracker.on('tx:block-update', (txMeta, latestBlockNumber) => {
|
|
if (!txMeta.firstRetryBlockNumber) {
|
|
txMeta.firstRetryBlockNumber = latestBlockNumber
|
|
this.txStateManager.updateTx(
|
|
txMeta,
|
|
'transactions/pending-tx-tracker#event: tx:block-update',
|
|
)
|
|
}
|
|
})
|
|
this.pendingTxTracker.on('tx:retry', (txMeta) => {
|
|
if (!('retryCount' in txMeta)) {
|
|
txMeta.retryCount = 0
|
|
}
|
|
txMeta.retryCount += 1
|
|
this.txStateManager.updateTx(
|
|
txMeta,
|
|
'transactions/pending-tx-tracker#event: tx:retry',
|
|
)
|
|
})
|
|
}
|
|
|
|
/**
|
|
Returns a "type" for a transaction out of the following list: simpleSend, tokenTransfer, tokenApprove,
|
|
contractDeployment, contractMethodCall
|
|
*/
|
|
async _determineTransactionCategory(txParams) {
|
|
const { data, to } = txParams
|
|
let name
|
|
try {
|
|
name = data && hstInterface.parseTransaction({ data }).name
|
|
} catch (error) {
|
|
log.debug('Failed to parse transaction data.', error, data)
|
|
}
|
|
|
|
const tokenMethodName = [
|
|
TRANSACTION_CATEGORIES.TOKEN_METHOD_APPROVE,
|
|
TRANSACTION_CATEGORIES.TOKEN_METHOD_TRANSFER,
|
|
TRANSACTION_CATEGORIES.TOKEN_METHOD_TRANSFER_FROM,
|
|
].find((methodName) => methodName === name && name.toLowerCase())
|
|
|
|
let result
|
|
if (data && tokenMethodName) {
|
|
result = tokenMethodName
|
|
} else if (data && !to) {
|
|
result = TRANSACTION_CATEGORIES.DEPLOY_CONTRACT
|
|
}
|
|
|
|
let code
|
|
if (!result) {
|
|
try {
|
|
code = await this.query.getCode(to)
|
|
} catch (e) {
|
|
code = null
|
|
log.warn(e)
|
|
}
|
|
|
|
const codeIsEmpty = !code || code === '0x' || code === '0x0'
|
|
|
|
result = codeIsEmpty
|
|
? TRANSACTION_CATEGORIES.SENT_ETHER
|
|
: TRANSACTION_CATEGORIES.CONTRACT_INTERACTION
|
|
}
|
|
|
|
return { transactionCategory: result, getCodeResponse: code }
|
|
}
|
|
|
|
/**
|
|
Sets other txMeta statuses to dropped if the txMeta that has been confirmed has other transactions
|
|
in the list have the same nonce
|
|
|
|
@param {number} txId - the txId of the transaction that has been confirmed in a block
|
|
*/
|
|
_markNonceDuplicatesDropped(txId) {
|
|
// get the confirmed transactions nonce and from address
|
|
const txMeta = this.txStateManager.getTx(txId)
|
|
const { nonce, from } = txMeta.txParams
|
|
const sameNonceTxs = this.txStateManager.getFilteredTxList({ nonce, from })
|
|
if (!sameNonceTxs.length) {
|
|
return
|
|
}
|
|
// mark all same nonce transactions as dropped and give i a replacedBy hash
|
|
sameNonceTxs.forEach((otherTxMeta) => {
|
|
if (otherTxMeta.id === txId) {
|
|
return
|
|
}
|
|
otherTxMeta.replacedBy = txMeta.hash
|
|
this.txStateManager.updateTx(
|
|
txMeta,
|
|
'transactions/pending-tx-tracker#event: tx:confirmed reference to confirmed txHash with same nonce',
|
|
)
|
|
this.txStateManager.setTxStatusDropped(otherTxMeta.id)
|
|
})
|
|
}
|
|
|
|
_setupBlockTrackerListener() {
|
|
let listenersAreActive = false
|
|
const latestBlockHandler = this._onLatestBlock.bind(this)
|
|
const { blockTracker, txStateManager } = this
|
|
|
|
txStateManager.on('tx:status-update', updateSubscription)
|
|
updateSubscription()
|
|
|
|
function updateSubscription() {
|
|
const pendingTxs = txStateManager.getPendingTransactions()
|
|
if (!listenersAreActive && pendingTxs.length > 0) {
|
|
blockTracker.on('latest', latestBlockHandler)
|
|
listenersAreActive = true
|
|
} else if (listenersAreActive && !pendingTxs.length) {
|
|
blockTracker.removeListener('latest', latestBlockHandler)
|
|
listenersAreActive = false
|
|
}
|
|
}
|
|
}
|
|
|
|
async _onLatestBlock(blockNumber) {
|
|
try {
|
|
await this.pendingTxTracker.updatePendingTxs()
|
|
} catch (err) {
|
|
log.error(err)
|
|
}
|
|
try {
|
|
await this.pendingTxTracker.resubmitPendingTxs(blockNumber)
|
|
} catch (err) {
|
|
log.error(err)
|
|
}
|
|
}
|
|
|
|
/**
|
|
Updates the memStore in transaction controller
|
|
*/
|
|
_updateMemstore() {
|
|
const unapprovedTxs = this.txStateManager.getUnapprovedTxList()
|
|
const currentNetworkTxList = this.txStateManager.getTxList(
|
|
MAX_MEMSTORE_TX_LIST_SIZE,
|
|
)
|
|
this.memStore.updateState({ unapprovedTxs, currentNetworkTxList })
|
|
}
|
|
|
|
_trackSwapsMetrics(txMeta, approvalTxMeta) {
|
|
if (this._getParticipateInMetrics() && txMeta.swapMetaData) {
|
|
if (txMeta.txReceipt.status === '0x0') {
|
|
this._trackMetaMetricsEvent({
|
|
event: 'Swap Failed',
|
|
sensitiveProperties: { ...txMeta.swapMetaData },
|
|
category: 'swaps',
|
|
})
|
|
} else {
|
|
const tokensReceived = getSwapsTokensReceivedFromTxMeta(
|
|
txMeta.destinationTokenSymbol,
|
|
txMeta,
|
|
txMeta.destinationTokenAddress,
|
|
txMeta.txParams.from,
|
|
txMeta.destinationTokenDecimals,
|
|
approvalTxMeta,
|
|
)
|
|
|
|
const quoteVsExecutionRatio = `${new BigNumber(tokensReceived, 10)
|
|
.div(txMeta.swapMetaData.token_to_amount, 10)
|
|
.times(100)
|
|
.round(2)}%`
|
|
|
|
const estimatedVsUsedGasRatio = `${new BigNumber(
|
|
txMeta.txReceipt.gasUsed,
|
|
16,
|
|
)
|
|
.div(txMeta.swapMetaData.estimated_gas, 10)
|
|
.times(100)
|
|
.round(2)}%`
|
|
|
|
this._trackMetaMetricsEvent({
|
|
event: 'Swap Completed',
|
|
category: 'swaps',
|
|
sensitiveProperties: {
|
|
...txMeta.swapMetaData,
|
|
token_to_amount_received: tokensReceived,
|
|
quote_vs_executionRatio: quoteVsExecutionRatio,
|
|
estimated_vs_used_gasRatio: estimatedVsUsedGasRatio,
|
|
},
|
|
})
|
|
}
|
|
}
|
|
}
|
|
}
|