test: Turbo Blinds Documentation Tests

lib/primitives/mtx.js

@@ -100,15 +100,21 @@ class MTX extends TX {
   }
 
   /**
-   * Clone the transaction. Note that
-   * this will not carry over the view.
+   * Clone the transaction and it's input coins.
    * @returns {MTX}
    */
 
   inject(mtx) {
     assert(mtx instanceof this.constructor);
     super.inject(mtx);
     this.changeIndex = mtx.changeIndex;
+
+    // CoinView has other properties like UndoCoins and BitView
+    // that an MTX doesn't care about. We just want a copy of the
+    // coins spent by the MTX.
+    for (const [key, value] of mtx.view.map.entries())
+      this.view.map.set(key, value);
+
     return this;
   }
 
@@ -158,11 +164,19 @@ class MTX extends TX {
   addCoin(coin) {
     assert(coin instanceof Coin, 'Cannot add non-coin.');
 
-    const input = Input.fromCoin(coin);
+    // Avoid duplicate inputs
+    for (const input of this.inputs) {
+      const {hash, index} = input.prevout;
+      if (hash.equals(coin.hash) && index === coin.index) {
+        this.view.addCoin(coin);
+        return input;
+      }
+    }
 
+    // Coin represents a new input.
+    const input = Input.fromCoin(coin);
     this.inputs.push(input);
     this.view.addCoin(coin);
-
     return input;
   }
 
@@ -1122,12 +1136,31 @@ class MTX extends TX {
     assert(options, 'Options are required.');
     assert(options.changeAddress, 'Change address is required.');
 
+    // Ensure backward compatibility with the old API:
+    // Inputs to MTX were added with mtx.addOutpoint() and then later
+    // CoinSelector.fund() was expected to match those outpoints with coins
+    // from the wallet. The problem with this is that when CoinSelector
+    // initialized, it wiped out all the inputs, including some that may have
+    // already been signed outside the wallet for custom scripts or CoinJoins.
+    // With the new API, mtx.addCoin() can be used to either fund existing
+    // (pre-signed) inputs OR add new "preferred" inputs for covenants.
+    // The logic below was moved here from CoinSelector.fund() in case
+    // the old method was used and "preferred" coins are not yet in the view.
+    for (const input of this.inputs) {
+      const {prevout} = input;
+      if (this.view.hasEntry(prevout))
+        continue;
+
+      for (const coin of coins) {
+        if (prevout.hash.equals(coin.hash) && prevout.index === coin.index) {
+          this.view.addCoin(coin);
+        }
+      }
+    }
+
     // Select necessary coins.
     const select = await this.selectCoins(coins, options);
 
-    // Make sure we empty the input array.
-    this.inputs.length = 0;
-
     // Add coins to transaction.
     for (const coin of select.chosen)
       this.addCoin(coin);
@@ -1585,7 +1618,6 @@ class CoinSelector {
     this.chosen = [];
     this.change = 0;
     this.fee = CoinSelector.MIN_FEE;
-    this.tx.inputs.length = 0;
 
     switch (this.selection) {
       case 'all':
@@ -1688,33 +1720,6 @@ class CoinSelector {
    */
 
   fund() {
-    // Ensure all preferred inputs first.
-    if (this.inputs.size > 0) {
-      const coins = [];
-
-      for (let i = 0; i < this.inputs.size; i++)
-        coins.push(null);
-
-      for (const coin of this.coins) {
-        const {hash, index} = coin;
-        const key = Outpoint.toKey(hash, index);
-        const i = this.inputs.get(key);
-
-        if (i != null) {
-          coins[i] = coin;
-          this.inputs.delete(key);
-        }
-      }
-
-      if (this.inputs.size > 0)
-        throw new Error('Could not resolve preferred inputs.');
-
-      for (const coin of coins) {
-        this.tx.addCoin(coin);
-        this.chosen.push(coin);
-      }
-    }
-
     if (this.isFull())
       return;
 

lib/wallet/wallet.js

@@ -38,7 +38,6 @@ const {types} = rules;
 const {Mnemonic} = HD;
 const {BufferSet} = require('buffer-map');
 const Coin = require('../primitives/coin');
-const Outpoint = require('../primitives/outpoint');
 
 /*
  * Constants
@@ -1839,7 +1838,7 @@ class Wallet extends EventEmitter {
     output.covenant.pushHash(nameHash);
     output.covenant.pushU32(height);
     output.covenant.pushHash(nonce);
-    reveal.addOutpoint(Outpoint.fromTX(bid, bidOuputIndex));
+    reveal.addCoin(bidCoin);
     reveal.outputs.push(output);
 
     await this.fill(reveal, { ...options, coins: coins });
@@ -1926,7 +1925,7 @@ class Wallet extends EventEmitter {
       output.covenant.pushU32(ns.height);
       output.covenant.pushHash(nonce);
 
-      mtx.addOutpoint(prevout);
+      mtx.addCoin(coin);
       mtx.outputs.push(output);
     }
 
@@ -2051,7 +2050,7 @@ class Wallet extends EventEmitter {
       output.covenant.pushU32(ns.height);
       output.covenant.pushHash(nonce);
 
-      mtx.addOutpoint(prevout);
+      mtx.addCoin(coin);
       mtx.outputs.push(output);
     }
 
@@ -2176,7 +2175,7 @@ class Wallet extends EventEmitter {
       if (coin.height < ns.height)
         continue;
 
-      mtx.addOutpoint(prevout);
+      mtx.addCoin(coin);
 
       const output = new Output();
       output.address = coin.address;
@@ -2298,7 +2297,7 @@ class Wallet extends EventEmitter {
       if (coin.height < ns.height)
         continue;
 
-      mtx.addOutpoint(prevout);
+      mtx.addCoin(coin);
 
       const output = new Output();
       output.address = coin.address;
@@ -2444,7 +2443,7 @@ class Wallet extends EventEmitter {
     output.covenant.pushHash(await this.wdb.getRenewalBlock());
 
     const mtx = new MTX();
-    mtx.addOutpoint(ns.owner);
+    mtx.addCoin(coin);
     mtx.outputs.push(output);
 
     return mtx;
@@ -2524,7 +2523,7 @@ class Wallet extends EventEmitter {
     output.covenant.push(raw);
 
     const mtx = new MTX();
-    mtx.addOutpoint(ns.owner);
+    mtx.addCoin(coin);
     mtx.outputs.push(output);
 
     return mtx;
@@ -2663,7 +2662,7 @@ class Wallet extends EventEmitter {
     output.covenant.pushHash(await this.wdb.getRenewalBlock());
 
     const mtx = new MTX();
-    mtx.addOutpoint(ns.owner);
+    mtx.addCoin(coin);
     mtx.outputs.push(output);
 
     return mtx;
@@ -2797,7 +2796,7 @@ class Wallet extends EventEmitter {
     output.covenant.push(address.hash);
 
     const mtx = new MTX();
-    mtx.addOutpoint(ns.owner);
+    mtx.addCoin(coin);
     mtx.outputs.push(output);
 
     return mtx;
@@ -2933,7 +2932,7 @@ class Wallet extends EventEmitter {
     output.covenant.push(EMPTY);
 
     const mtx = new MTX();
-    mtx.addOutpoint(ns.owner);
+    mtx.addCoin(coin);
     mtx.outputs.push(output);
 
     return mtx;
@@ -3077,7 +3076,7 @@ class Wallet extends EventEmitter {
     output.covenant.pushHash(await this.wdb.getRenewalBlock());
 
     const mtx = new MTX();
-    mtx.addOutpoint(ns.owner);
+    mtx.addCoin(coin);
     mtx.outputs.push(output);
 
     return mtx;
@@ -3208,7 +3207,7 @@ class Wallet extends EventEmitter {
     output.covenant.pushU32(ns.height);
 
     const mtx = new MTX();
-    mtx.addOutpoint(ns.owner);
+    mtx.addCoin(coin);
     mtx.outputs.push(output);
 
     return mtx;

test/interactive-swap-test.js

@@ -208,11 +208,12 @@ describe('Interactive name swap', function() {
 
     // Bob should verify all the data in the MTX to ensure everything is valid,
     // but this is the minimum.
-    const input0 = mtx.input(0).clone(); // copy input with Alice's signature
-    const coinEntry = await node.chain.db.readCoin(input0.prevout);
+    const coinEntry = await node.chain.db.readCoin(mtx.input(0).prevout);
     assert(coinEntry); // ensures that coin exists and is still unspent
 
-    const coin = coinEntry.toCoin(input0.prevout);
+    const coin = coinEntry.toCoin(mtx.input(0).prevout);
+    mtx.addCoin(coin);
+
     assert(coin.covenant.type === types.TRANSFER);
     const addr = new Address({
       version: coin.covenant.items[2].readInt8(),
@@ -221,17 +222,7 @@ describe('Interactive name swap', function() {
     assert.deepStrictEqual(addr, bobReceive); // transfer is to Bob's address
 
     // Fund the TX.
-    // The hsd wallet is not designed to handle partially-signed TXs
-    // or coins from outside the wallet, so a little hacking is needed.
-    const changeAddress = await bob.changeAddress();
-    const rate = await wdb.estimateFee();
-    const coins = await bob.getSmartCoins();
-    // Add the external coin to the coin selector so we don't fail assertions
-    coins.push(coin);
-    await mtx.fund(coins, {changeAddress, rate});
-    // The funding mechanism starts by wiping out existing inputs
-    // which for us includes Alice's signature. Replace it from our backup.
-    mtx.inputs[0].inject(input0);
+    await bob.fund(mtx);
 
     // Rearrange outputs.
     // Since we added a change output, the SINGELREVERSE is now broken:

test/mtx-test.js

@@ -9,6 +9,8 @@ const bio = require('bufio');
 const CoinView = require('../lib/coins/coinview');
 const WalletCoinView = require('../lib/wallet/walletcoinview');
 const MTX = require('../lib/primitives/mtx');
+const Address = require('../lib/primitives/address');
+const Coin = require('../lib/primitives/coin');
 const Path = require('../lib/wallet/path');
 const common = require('./util/common');
 
@@ -62,4 +64,59 @@ describe('MTX', function() {
     assert.ok(view instanceof CoinView);
     assert.deepStrictEqual(got, want);
   });
+
+  it('should clone MTX including view', () => {
+    const coin1 = new Coin({
+      version: 1,
+      value: 1000001,
+      hash: Buffer.alloc(32, 0x01),
+      index: 1
+    });
+
+    const coin1alt = new Coin({
+      version: 1,
+      value: 9999999,
+      hash: Buffer.alloc(32, 0x01),
+      index: 1
+    });
+
+    const coin2 = new Coin({
+      version: 1,
+      value: 2000002,
+      hash: Buffer.alloc(32, 0x02),
+      index: 2
+    });
+
+    const addr = new Address({
+      version: 0,
+      hash: Buffer.alloc(20, 0xdb)
+    });
+
+    const value = coin1.value + coin2.value;
+
+    const mtx1 = new MTX();
+    mtx1.addCoin(coin1);
+    mtx1.addCoin(coin2);
+    mtx1.addOutput(addr, value);
+
+    // Verify clone including view
+    const mtx2 = mtx1.clone();
+    assert.deepStrictEqual(mtx1.toJSON(), mtx2.toJSON());
+    assert.strictEqual(mtx1.getInputValue(), mtx2.getInputValue());
+    assert.strictEqual(mtx1.view.map.size, 2);
+    assert.strictEqual(mtx2.view.map.size, 2);
+
+    // Sanity check: verify deep clone by modifying original data
+    mtx1.view.remove(coin1.hash);
+    assert.notDeepStrictEqual(mtx1.toJSON(), mtx2.toJSON());
+    assert.notDeepStrictEqual(mtx1.getInputValue(), mtx2.getInputValue());
+    assert.strictEqual(mtx1.view.map.size, 1);
+    assert.strictEqual(mtx2.view.map.size, 2);
+
+    mtx1.view.addCoin(coin1alt);
+    assert.notDeepStrictEqual(mtx1.toJSON(), mtx2.toJSON());
+    assert.notStrictEqual(mtx1.getInputValue(), mtx2.getInputValue());
+    assert.strictEqual(mtx1.view.map.size, 2);
+    assert.strictEqual(mtx2.view.map.size, 2);
+  });
 });