addressing FTB-017 Federators retry failed transactions

Author: mauri-rsk

federator/package.json

@@ -14,7 +14,7 @@
   "scripts": {
     "start": "node ./src/main.js",
     "test": "jest --detectOpenHandles test/",
-    "integrationTest": "rm -rf ./db/* && node ./integrationTest/integrationTest.js",
+    "integrationTest": "rm ./db/lastBlock.txt --force && rm ./db/side-fed/lastBlock.txt --force && node ./integrationTest/integrationTest.js",
     "integrationHeartbeatTest": "rm -rf ./db/* && node ./integrationTest/integrationHeartbeatTest.js && rm heartbeat.log",
     "clean": "rm -rf ./db/*"
   },

federator/src/lib/Federator.js

@@ -24,6 +24,7 @@ module.exports = class Federator {
 
         this.transactionSender = new TransactionSender(this.sideWeb3, this.logger, this.config);
         this.lastBlockPath = `${config.storagePath || __dirname}/lastBlock.txt`;
+        this.revertedTxnsPath = `${config.storagePath || __dirname}/revertedTxns.json`;
         this.bridgeFactory = new BridgeFactory(this.config, this.logger, Web3);
         this.federationFactory = new FederationFactory(this.config, this.logger, Web3);
         this.allowTokensFactory = new AllowTokensFactory(this.config, this.logger, Web3);
@@ -228,7 +229,8 @@ module.exports = class Federator {
                             log.logIndex,
                             decimals,
                             granularity,
-                            typeId
+                            typeId,
+                            transactionId
                         );
                     } else {
                         this.logger.debug(`Block: ${log.blockHash} Tx: ${log.transactionHash} token: ${symbol}  has already been voted by us`);
@@ -257,8 +259,9 @@ module.exports = class Federator {
         logIndex,
         decimals,
         granularity,
-        typeId)
-    {
+        typeId,
+        txId
+    ) {
         try {
 
             const transactionSender = new TransactionSender(this.sideWeb3, this.logger, this.config);
@@ -278,7 +281,37 @@ module.exports = class Federator {
                 typeId
             }).encodeABI();
 
-            await transactionSender.sendTransaction(fedContract.getAddress(), txData, 0, this.config.privateKey);
+            let revertedTxns = JSON.parse(fs.readFileSync(this.revertedTxnsPath, 'utf8'));
+            this.logger.info(`read these transactions from reverted transactions file`, revertedTxns);
+
+            let receipt;
+            if (revertedTxns[txId]) {
+                this.logger.info(`Skipping Voting Transfer ${txId} since it's marked as reverted.`, revertedTxns[txId])
+            } else {
+                receipt = await transactionSender.sendTransaction(fedContract.getAddress(), txData, 0, this.config.privateKey);
+            }
+
+            if(receipt && receipt.status == false) {
+                this._saveRevertedTxns(
+                    this.revertedTxnsPath,
+                    JSON.stringify({
+                        ...revertedTxns,
+                        [txId]: {
+                            originalTokenAddress: tokenAddress,
+                            sender,
+                            receiver,
+                            amount,
+                            symbol,
+                            blockHash,
+                            transactionHash,
+                            logIndex,
+                            decimals,
+                            granularity
+                        }
+                    })
+                )
+            }
+
             return true;
         } catch (err) {
             throw new CustomError(`Exception Voting tx:${transactionHash} block: ${blockHash} token ${symbol}`, err);
@@ -290,4 +323,10 @@ module.exports = class Federator {
             fs.writeFileSync(path, value.toString());
         }
     }
+
+    _saveRevertedTxns(path, value) {
+        if (value) {
+            fs.writeFileSync(path, value.toString());
+        }
+    }
 }

federator/src/lib/TransactionSender.js

@@ -194,24 +194,23 @@ module.exports = class TransactionSender {
                 receipt = await this.client.eth.sendTransaction(rawTx).once('transactionHash', hash => txHash = hash);
             }
             if(receipt.status == 1) {
-                this.logger.info(`Transaction Successful chain:${chainId} txHash:${receipt.transactionHash} blockNumber:${receipt.blockNumber}`);
-                return receipt;
+                this.logger.info(`Transaction Successful txHash:${receipt.transactionHash} blockNumber:${receipt.blockNumber}`);
+            } else {
+                error = 'Transaction Receipt Status Failed';
+                errorInfo = receipt;
+                this.logger.error(error, errorInfo);
+                this.logger.error('RawTx that failed', rawTx);
             }
-            error = `Transaction Receipt Status Failed chain:${chainId}`;
-            errorInfo = receipt;
+
+            return receipt;
+
         } catch(err) {
             if (err.message.indexOf('it might still be mined') > 0) {
                 this.logger.warn(`Transaction was not mined within 750 seconds, please make sure your transaction was properly sent. Be aware that
                 it might still be mined. Chain:${chainId} transactionHash:${txHash}`);
                 fs.appendFileSync(this.manuallyCheck, `chain:${chainId} transactionHash:${txHash} to:${to} data:${data}\n`);
                 return { transactionHash: txHash };
             }
-            error = `Send Signed Transaction to chain:${chainId} Failed TxHash:${txHash}`;
-            errorInfo = err;
         }
-        this.logger.error(error, errorInfo);
-        this.logger.error('RawTx that failed', rawTx);
-        throw new CustomError(`Transaction Failed: ${error} ${stack}`, errorInfo);
     }
-
 }