tx manager as package
This commit is contained in:
Alexey
parent
90ed6cbe91
commit
17d48f9508
@ -21,14 +21,15 @@
|
||||
"gas-price-oracle": "^0.1.5",
|
||||
"ioredis": "^4.14.1",
|
||||
"node-fetch": "^2.6.0",
|
||||
"snarkjs": "git+https://github.com/tornadocash/snarkjs.git#869181cfaf7526fe8972073d31655493a04326d5",
|
||||
"tornado-cash-anonymity-mining": "git+https://github.com/tornadocash/tornado-anonymity-mining.git#e3ae8b98b14eb7fee7cb8c93221920a20b1e0cd8",
|
||||
"tx-manager": "git+https://github.com/tornadocash/tx-manager.git#df118be318b007e597e157504d105dfa3e6322a1",
|
||||
"uuid": "^8.3.0",
|
||||
"web3": "^1.3.0",
|
||||
"web3-core-promievent": "^1.3.0",
|
||||
"web3-utils": "^1.2.2",
|
||||
"why-is-node-running": "^2.2.0",
|
||||
"snarkjs": "git+https://github.com/tornadocash/snarkjs.git#869181cfaf7526fe8972073d31655493a04326d5",
|
||||
"websnark": "git+https://github.com/tornadocash/websnark.git#86a526718cd6f6f5d31bdb1fe26a9ec8819f633e"
|
||||
"websnark": "git+https://github.com/tornadocash/websnark.git#86a526718cd6f6f5d31bdb1fe26a9ec8819f633e",
|
||||
"why-is-node-running": "^2.2.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"chai": "^4.2.0",
|
||||
|
||||
372
src/TxManager.js
372
src/TxManager.js
@ -1,372 +0,0 @@
|
||||
const Web3 = require('web3')
|
||||
const { Mutex } = require('async-mutex')
|
||||
const { GasPriceOracle } = require('gas-price-oracle')
|
||||
const { toWei, toHex, toBN, BN, fromWei } = require('web3-utils')
|
||||
const PromiEvent = require('web3-core-promievent')
|
||||
const { sleep, when } = require('./utils')
|
||||
|
||||
const nonceErrors = [
|
||||
'Returned error: Transaction nonce is too low. Try incrementing the nonce.',
|
||||
'Returned error: nonce too low',
|
||||
]
|
||||
|
||||
const gasPriceErrors = [
|
||||
'Returned error: Transaction gas price supplied is too low. There is another transaction with same nonce in the queue. Try increasing the gas price or incrementing the nonce.',
|
||||
'Returned error: replacement transaction underpriced',
|
||||
/Returned error: Transaction gas price \d+wei is too low. There is another transaction with same nonce in the queue with gas price: \d+wei. Try increasing the gas price or incrementing the nonce./,
|
||||
]
|
||||
|
||||
const sameTxErrors = ['Returned error: Transaction with the same hash was already imported.']
|
||||
|
||||
const defaultConfig = {
|
||||
MAX_RETRIES: 10,
|
||||
GAS_BUMP_PERCENTAGE: 5,
|
||||
MIN_GWEI_BUMP: 1,
|
||||
GAS_BUMP_INTERVAL: 1000 * 60 * 5,
|
||||
MAX_GAS_PRICE: 1000,
|
||||
POLL_INTERVAL: 5000,
|
||||
CONFIRMATIONS: 8,
|
||||
}
|
||||
|
||||
class TxManager {
|
||||
constructor({ privateKey, rpcUrl, broadcastNodes = [], config = {} }) {
|
||||
this.config = Object.assign({ ...defaultConfig }, config)
|
||||
this._privateKey = '0x' + privateKey
|
||||
this._web3 = new Web3(rpcUrl)
|
||||
this._broadcastNodes = broadcastNodes
|
||||
this.address = this._web3.eth.accounts.privateKeyToAccount(this._privateKey).address
|
||||
this._web3.eth.accounts.wallet.add(this._privateKey)
|
||||
this._web3.eth.defaultAccount = this.address
|
||||
this._gasPriceOracle = new GasPriceOracle({ defaultRpc: rpcUrl })
|
||||
this._mutex = new Mutex()
|
||||
this._nonce = null
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates Transaction class instance.
|
||||
*
|
||||
* @param tx Transaction to send
|
||||
*/
|
||||
createTx(tx) {
|
||||
return new Transaction(tx, this)
|
||||
}
|
||||
}
|
||||
|
||||
class Transaction {
|
||||
constructor(tx, manager) {
|
||||
Object.assign(this, manager)
|
||||
this.manager = manager
|
||||
this.tx = tx
|
||||
this._promise = PromiEvent()
|
||||
this._emitter = this._promise.eventEmitter
|
||||
this.executed = false
|
||||
this.retries = 0
|
||||
this.currentTxHash = null
|
||||
// store all submitted hashes to catch cases when an old tx is mined
|
||||
this.hashes = []
|
||||
}
|
||||
|
||||
/**
|
||||
* Submits the transaction to Ethereum network. Resolves when tx gets enough confirmations.
|
||||
* Emits progress events.
|
||||
*/
|
||||
send() {
|
||||
if (this.executed) {
|
||||
throw new Error('The transaction was already executed')
|
||||
}
|
||||
this.executed = true
|
||||
this._execute().then(this._promise.resolve).catch(this._promise.reject)
|
||||
return this._emitter
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces a pending tx.
|
||||
*
|
||||
* @param tx Transaction to send
|
||||
*/
|
||||
async replace(tx) {
|
||||
// todo throw error if the current transaction is mined already
|
||||
console.log('Replacing current transaction')
|
||||
if (!this.executed) {
|
||||
// Tx was not executed yet, just replace it
|
||||
this.tx = tx
|
||||
return
|
||||
}
|
||||
if (!tx.gas) {
|
||||
tx.gas = await this._web3.eth.estimateGas(tx)
|
||||
}
|
||||
tx.nonce = this.tx.nonce // can be different from `this.manager._nonce`
|
||||
tx.gasPrice = Math.max(this.tx.gasPrice, tx.gasPrice || 0) // start no less than current tx gas price
|
||||
|
||||
this.tx = tx
|
||||
this._increaseGasPrice()
|
||||
await this._send()
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancels a pending tx.
|
||||
*/
|
||||
cancel() {
|
||||
console.log('Canceling the transaction')
|
||||
return this.replace({
|
||||
from: this.address,
|
||||
to: this.address,
|
||||
value: 0,
|
||||
gas: 21000,
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the transaction. Acquires global mutex for transaction duration
|
||||
*
|
||||
* @returns {Promise<TransactionReceipt>}
|
||||
* @private
|
||||
*/
|
||||
async _execute() {
|
||||
const release = await this.manager._mutex.acquire()
|
||||
try {
|
||||
await this._prepare()
|
||||
await this._send()
|
||||
const receipt = this._waitForConfirmations()
|
||||
// we could have bumped nonce during execution, so get the latest one + 1
|
||||
this.manager._nonce = this.tx.nonce + 1
|
||||
return receipt
|
||||
} finally {
|
||||
release()
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepare first transaction before submitting it. Inits `gas`, `gasPrice`, `nonce`
|
||||
*
|
||||
* @returns {Promise<void>}
|
||||
* @private
|
||||
*/
|
||||
async _prepare() {
|
||||
const gas = await this._web3.eth.estimateGas(this.tx)
|
||||
if (!this.tx.gas) {
|
||||
this.tx.gas = gas
|
||||
}
|
||||
if (!this.tx.gasPrice) {
|
||||
this.tx.gasPrice = await this._getGasPrice('fast')
|
||||
}
|
||||
if (!this.manager._nonce) {
|
||||
this.manager._nonce = await this._web3.eth.getTransactionCount(this.address, 'latest')
|
||||
}
|
||||
this.tx.nonce = this.manager._nonce
|
||||
}
|
||||
|
||||
/**
|
||||
* Send the current transaction
|
||||
*
|
||||
* @returns {Promise}
|
||||
* @private
|
||||
*/
|
||||
async _send() {
|
||||
// todo throw is we attempt to send a tx that attempts to replace already mined tx
|
||||
const signedTx = await this._web3.eth.accounts.signTransaction(this.tx, this._privateKey)
|
||||
this.submitTimestamp = Date.now()
|
||||
this.tx.hash = signedTx.transactionHash
|
||||
this.hashes.push(signedTx.transactionHash)
|
||||
|
||||
try {
|
||||
await this._broadcast(signedTx.rawTransaction)
|
||||
} catch (e) {
|
||||
return this._handleSendError(e)
|
||||
}
|
||||
|
||||
this._emitter.emit('transactionHash', signedTx.transactionHash)
|
||||
console.log(`Broadcasted transaction ${signedTx.transactionHash}`)
|
||||
}
|
||||
|
||||
/**
|
||||
* A loop that waits until the current transaction is mined and gets enough confirmations
|
||||
*
|
||||
* @returns {Promise<TransactionReceipt>} The transaction receipt
|
||||
* @private
|
||||
*/
|
||||
async _waitForConfirmations() {
|
||||
// eslint-disable-next-line no-constant-condition
|
||||
while (true) {
|
||||
// We are already waiting on certain tx hash
|
||||
if (this.currentTxHash) {
|
||||
const receipt = await this._web3.eth.getTransactionReceipt(this.currentTxHash)
|
||||
|
||||
if (!receipt) {
|
||||
// We were waiting for some tx but it disappeared
|
||||
// Erase the hash and start over
|
||||
this.currentTxHash = null
|
||||
continue
|
||||
}
|
||||
|
||||
const currentBlock = await this._web3.eth.getBlockNumber()
|
||||
const confirmations = Math.max(0, currentBlock - receipt.blockNumber)
|
||||
// todo don't emit repeating confirmation count
|
||||
this._emitter.emit('confirmations', confirmations)
|
||||
if (confirmations >= this.config.CONFIRMATIONS) {
|
||||
// Tx is mined and has enough confirmations
|
||||
return receipt
|
||||
}
|
||||
|
||||
// Tx is mined but doesn't have enough confirmations yet, keep waiting
|
||||
await sleep(this.config.POLL_INTERVAL)
|
||||
continue
|
||||
}
|
||||
|
||||
// Tx is still pending
|
||||
if ((await this._getLastNonce()) <= this.tx.nonce) {
|
||||
// todo optionally run estimateGas on each iteration and cancel the transaction if it fails
|
||||
|
||||
// We were waiting too long, increase gas price and resubmit
|
||||
if (Date.now() - this.submitTimestamp >= this.config.GAS_BUMP_INTERVAL) {
|
||||
if (this._increaseGasPrice()) {
|
||||
console.log('Resubmitting with higher gas price')
|
||||
await this._send()
|
||||
continue
|
||||
}
|
||||
}
|
||||
// Tx is still pending, keep waiting
|
||||
await sleep(this.config.POLL_INTERVAL)
|
||||
continue
|
||||
}
|
||||
|
||||
let receipt = await this._getReceipts()
|
||||
|
||||
// There is a mined tx with current nonce, but it's not one of ours
|
||||
// Probably other tx submitted by other process/client
|
||||
if (!receipt) {
|
||||
console.log("Can't find our transaction receipt, retrying a few times")
|
||||
// Give node a few more attempts to respond with our receipt
|
||||
let retries = 5
|
||||
while (!receipt && retries--) {
|
||||
await sleep(1000)
|
||||
receipt = await this._getReceipts()
|
||||
}
|
||||
|
||||
// Receipt was not found after a few retries
|
||||
// Resubmit our tx
|
||||
if (!receipt) {
|
||||
console.log(
|
||||
'There is a mined tx with our nonce but unknown tx hash, resubmitting with tx with increased nonce',
|
||||
)
|
||||
this.tx.nonce++
|
||||
// todo drop gas price to original value?
|
||||
await this._send()
|
||||
continue
|
||||
}
|
||||
}
|
||||
|
||||
console.log('Mined. Start waiting for confirmations...')
|
||||
this._emitter.emit('mined', receipt)
|
||||
this.currentTxHash = receipt.transactionHash
|
||||
}
|
||||
}
|
||||
|
||||
async _getReceipts() {
|
||||
for (const hash of this.hashes.reverse()) {
|
||||
const receipt = await this._web3.eth.getTransactionReceipt(hash)
|
||||
if (receipt) {
|
||||
return receipt
|
||||
}
|
||||
}
|
||||
return null
|
||||
}
|
||||
|
||||
/**
|
||||
* Broadcasts tx to multiple nodes, waits for tx hash only on main node
|
||||
*/
|
||||
_broadcast(rawTx) {
|
||||
const main = this._web3.eth.sendSignedTransaction(rawTx)
|
||||
for (const node of this._broadcastNodes) {
|
||||
try {
|
||||
new Web3(node).eth.sendSignedTransaction(rawTx)
|
||||
} catch (e) {
|
||||
console.log(`Failed to send transaction to node ${node}: ${e}`)
|
||||
}
|
||||
}
|
||||
return when(main, 'transactionHash')
|
||||
}
|
||||
|
||||
_handleSendError(e) {
|
||||
console.log('Got error', e)
|
||||
|
||||
// nonce is too low, trying to increase and resubmit
|
||||
if (this._hasError(e.message, nonceErrors)) {
|
||||
console.log(`Nonce ${this.tx.nonce} is too low, increasing and retrying`)
|
||||
if (this.retries <= this.config.MAX_RETRIES) {
|
||||
this.tx.nonce++
|
||||
this.retries++
|
||||
return this._send()
|
||||
}
|
||||
}
|
||||
|
||||
// there is already a pending tx with higher gas price, trying to bump and resubmit
|
||||
if (this._hasError(e.message, gasPriceErrors)) {
|
||||
console.log(`Gas price ${fromWei(this.tx.gasPrice, 'gwei')} gwei is too low, increasing and retrying`)
|
||||
this._increaseGasPrice()
|
||||
return this._send()
|
||||
}
|
||||
|
||||
if (this._hasError(e.message, sameTxErrors)) {
|
||||
console.log('Same transaction is already in mempool, skipping submit')
|
||||
return // do nothing
|
||||
}
|
||||
|
||||
throw new Error(`Send error: ${e.message}`)
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether error message is contained in errors array
|
||||
*
|
||||
* @param message The message to look up
|
||||
* @param {Array<string|RegExp>} errors Array with errors. Errors can be either string or regexp.
|
||||
* @returns {boolean} Returns true if error message is present in the `errors` array
|
||||
* @private
|
||||
*/
|
||||
_hasError(message, errors) {
|
||||
return errors.find((e) => (typeof e === 'string' ? e === message : message.match(e))) !== undefined
|
||||
}
|
||||
|
||||
_increaseGasPrice() {
|
||||
const minGweiBump = toBN(toWei(this.config.MIN_GWEI_BUMP.toString(), 'Gwei'))
|
||||
const oldGasPrice = toBN(this.tx.gasPrice)
|
||||
const newGasPrice = BN.max(
|
||||
oldGasPrice.mul(toBN(100 + this.config.GAS_BUMP_PERCENTAGE)).div(toBN(100)),
|
||||
oldGasPrice.add(minGweiBump),
|
||||
)
|
||||
const maxGasPrice = toBN(toWei(this.config.MAX_GAS_PRICE.toString(), 'gwei'))
|
||||
if (toBN(this.tx.gasPrice).eq(maxGasPrice)) {
|
||||
console.log('Already at max gas price, not bumping')
|
||||
return false
|
||||
}
|
||||
this.tx.gasPrice = toHex(BN.min(newGasPrice, maxGasPrice))
|
||||
console.log(`Increasing gas price to ${fromWei(this.tx.gasPrice, 'gwei')} gwei`)
|
||||
return true
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetches gas price from the oracle
|
||||
*
|
||||
* @param {'instant'|'fast'|'normal'|'slow'} type
|
||||
* @returns {Promise<string>} A hex string representing gas price in wei
|
||||
* @private
|
||||
*/
|
||||
async _getGasPrice(type) {
|
||||
const gasPrices = await this._gasPriceOracle.gasPrices()
|
||||
const result = gasPrices[type].toString()
|
||||
console.log(`${type} gas price is now ${result} gwei`)
|
||||
return toHex(toWei(gasPrices[type].toString(), 'gwei'))
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets current nonce for the current account, ignoring any pending transactions
|
||||
*
|
||||
* @returns {Promise<number>}
|
||||
* @private
|
||||
*/
|
||||
_getLastNonce() {
|
||||
return this._web3.eth.getTransactionCount(this.address, 'latest')
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = TxManager
|
||||
@ -10,6 +10,7 @@ const contract = new web3.eth.Contract(require('../abis/mining.abi.json'), miner
|
||||
|
||||
let tree, eventSubscription, blockSubscription
|
||||
|
||||
// todo handle the situation when we have two rewards in one block
|
||||
async function fetchEvents(from = 0, to = 'latest') {
|
||||
const events = await contract.getPastEvents('NewAccount', {
|
||||
fromBlock: from,
|
||||
|
||||
@ -10,8 +10,8 @@ const miningABI = require('../abis/mining.abi.json')
|
||||
const swapABI = require('../abis/swap.abi.json')
|
||||
const { queue } = require('./queue')
|
||||
const { poseidonHash2 } = require('./utils')
|
||||
const { rpcUrl, redisUrl, privateKey, updateConfig, swapAddress, rewardAccount, minerAddress } = require('../config')
|
||||
const TxManager = require('./TxManager')
|
||||
const { rpcUrl, redisUrl, privateKey, updateConfig, swapAddress, minerAddress } = require('../config')
|
||||
const { TxManager } = require('tx-manager')
|
||||
const { Controller } = require('tornado-cash-anonymity-mining')
|
||||
|
||||
let web3
|
||||
@ -32,16 +32,17 @@ async function fetchTree() {
|
||||
|
||||
if (currentTx && currentJob && ['miningReward', 'miningWithdraw'].includes(currentJob.data.type)) {
|
||||
const { proof, args } = currentJob.data.data
|
||||
if (args.account.inputRoot === tree.root()) { // todo check type
|
||||
if (toBN(args.account.inputRoot).eq(toBN(tree.root()))) {
|
||||
return
|
||||
}
|
||||
|
||||
const update = await controller.treeUpdate(args.account.outputCommitment, tree)
|
||||
|
||||
const instance = new web3.eth.Contract(tornadoABI, minerAddress)
|
||||
const data = currentJob.data.type === 'miningReward' ?
|
||||
instance.methods.reward(proof, args, update.proof, update.args).encodeABI() :
|
||||
instance.methods.withdraw(proof, args, update.proof, update.args).encodeABI()
|
||||
const data =
|
||||
currentJob.data.type === 'miningReward'
|
||||
? instance.methods.reward(proof, args, update.proof, update.args).encodeABI()
|
||||
: instance.methods.withdraw(proof, args, update.proof, update.args).encodeABI()
|
||||
currentTx = await currentTx.replace({
|
||||
to: minerAddress,
|
||||
data,
|
||||
|
||||
12
yarn.lock
12
yarn.lock
@ -3913,6 +3913,16 @@ tweetnacl@^1.0.0:
|
||||
resolved "https://registry.yarnpkg.com/tweetnacl/-/tweetnacl-1.0.3.tgz#ac0af71680458d8a6378d0d0d050ab1407d35596"
|
||||
integrity sha512-6rt+RN7aOi1nGMyC4Xa5DdYiukl2UWCbcJft7YhxReBGQD7OAM8Pbxw6YMo4r2diNEA8FEmu32YOn9rhaiE5yw==
|
||||
|
||||
"tx-manager@git+https://github.com/tornadocash/tx-manager.git#df118be318b007e597e157504d105dfa3e6322a1":
|
||||
version "0.1.0"
|
||||
resolved "git+https://github.com/tornadocash/tx-manager.git#df118be318b007e597e157504d105dfa3e6322a1"
|
||||
dependencies:
|
||||
async-mutex "^0.2.4"
|
||||
gas-price-oracle "^0.1.5"
|
||||
web3 "^1.3.0"
|
||||
web3-core-promievent "^1.3.0"
|
||||
web3-utils "^1.3.0"
|
||||
|
||||
type-check@~0.3.2:
|
||||
version "0.3.2"
|
||||
resolved "https://registry.yarnpkg.com/type-check/-/type-check-0.3.2.tgz#5884cab512cf1d355e3fb784f30804b2b520db72"
|
||||
@ -4294,7 +4304,7 @@ web3-shh@1.3.0:
|
||||
web3-core-subscriptions "1.3.0"
|
||||
web3-net "1.3.0"
|
||||
|
||||
web3-utils@1.3.0, web3-utils@^1.2.2:
|
||||
web3-utils@1.3.0, web3-utils@^1.2.2, web3-utils@^1.3.0:
|
||||
version "1.3.0"
|
||||
resolved "https://registry.yarnpkg.com/web3-utils/-/web3-utils-1.3.0.tgz#5bac16e5e0ec9fe7bdcfadb621655e8aa3cf14e1"
|
||||
integrity sha512-2mS5axFCbkhicmoDRuJeuo0TVGQDgC2sPi/5dblfVC+PMtX0efrb8Xlttv/eGkq7X4E83Pds34FH98TP2WOUZA==
|
||||
|
||||
Loading…
Reference in New Issue
Block a user