wallet rbf: do not violate rule 6

bcoin-org · Sep 22, 2023 · 5f472ad · 5f472ad
1 parent 4d97480
commit 5f472ad
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 3 deletions.
diff --git a/lib/wallet/wallet.js b/lib/wallet/wallet.js
@@ -1309,7 +1309,7 @@ class Wallet extends EventEmitter {
 
   async bumpTXFee(hash, rate, sign, passphrase) {
     assert((rate >>> 0) === rate, 'Rate must be a number.');
-    assert(rate >= this.network.minRelay, 'Provided fee rate is too low.');
+    assert(rate >= this.network.minRelay, 'Fee rate is below minimum.');
 
     const wtx = await this.getTX(hash);
 
@@ -1415,14 +1415,36 @@ class Wallet extends EventEmitter {
         });
     }
 
-    if (!sign)
+    const oldRate = tx.getRate(view);
+
+    if (!sign) {
+      // Estimate final fee after signing for rule 6 check
+      const estSize =
+        await mtx.estimateSize(this.getAccountByAddress.bind(this));
+      const fee = mtx.getFee();
+      const estRate = policy.getRate(estSize, fee);
+
+      if (estRate <= oldRate) {
+        throw new Error(`Provided fee rate of ${rate} s/kvB results in ` +
+                        `insufficient estimated total fee rate (${estRate}) ` +
+                        `to replace original (${oldRate})`);
+      }
+
       return mtx.toTX();
+    }
 
     await this.sign(mtx, passphrase);
 
     if (!mtx.isSigned())
       throw new Error('Replacement TX could not be fully signed.');
 
+    const newRate = mtx.getRate();
+    if (newRate <= oldRate) {
+      throw new Error(`Provided fee rate of ${rate} s/kvB results in ` +
+                      `insufficient total fee rate (${newRate}) ` +
+                      `to replace original (${oldRate})`);
+    }
+
     const ntx = mtx.toTX();
 
     this.logger.debug(

diff --git a/test/wallet-rbf-test.js b/test/wallet-rbf-test.js
@@ -182,7 +182,7 @@ describe('Wallet RBF', function () {
       // Try a fee rate below minRelay (1000)
       await alice.bumpTXFee(tx.hash(), 999 /* satoshis per kvB */, true, null);
     }, {
-      message: 'Provided fee rate is too low.'
+      message: 'Fee rate is below minimum.'
     });
     await node.rpc.generateToAddress([1, aliceReceive]);
   });
@@ -217,4 +217,40 @@ describe('Wallet RBF', function () {
 
     await node.rpc.generateToAddress([1, aliceReceive]);
   });
+
+  it('should not violate rule 6 signed or unsigned', async () => {
+    const coins = await alice.getCoins();
+    let coin;
+    for (coin of coins) {
+      if (!coin.coinbase)
+        break;
+    }
+    const mtx = new MTX();
+    mtx.addCoin(coin);
+    mtx.addOutput(bobReceive, coin.value - 200);
+    mtx.inputs[0].sequence = 0xfffffffd;
+    await alice.sign(mtx);
+    const tx = mtx.toTX();
+    assert.strictEqual(tx.inputs.length, 1);
+    assert.strictEqual(tx.outputs.length, 1);
+    await alice.wdb.addTX(tx);
+    await alice.wdb.send(tx);
+    await forEvent(node.mempool, 'tx');
+
+    // Do not sign, estimate fee rate
+    await assert.rejects(async () => {
+      await alice.bumpTXFee(tx.hash(), 1000 /* satoshis per kvB */, false, null);
+    }, {
+      message: /^Provided fee rate of 1000 s\/kvB results in insufficient estimated total fee rate/
+    });
+
+    // Do sign, then check fee rate
+    await assert.rejects(async () => {
+      await alice.bumpTXFee(tx.hash(), 1000 /* satoshis per kvB */, true, null);
+    }, {
+      message: /^Provided fee rate of 1000 s\/kvB results in insufficient total fee rate/
+    });
+
+    await node.rpc.generateToAddress([1, aliceReceive]);
+  });
 });