@bitpay-labs/bitcore-wallet-service 11.5.2

package/test/model/wallet.test.ts

@@ -0,0 +1,191 @@
+'use strict';
+
+import * as chai from 'chai';
+import 'chai/register-should';
+import { IWallet, Wallet } from '../../src/lib/model/wallet';
+
+const should = chai.should();
+
+describe('Wallet', function() {
+  describe('#create', function() {
+    const createOpts = {
+      id: 'id',
+      name: 'name',
+      coin: 'btc',
+      chain: 'btc',
+      network: 'livenet',
+      pubKey: 'pubKey',
+      singleAddress: false,
+      derivationStrategy: 'BIP45',
+      addressType: 'P2SH'
+    };
+    it('will throw with an invalid string argument for "m" or "n"', function() {
+      (function() {
+        Wallet.create({ ...createOpts,
+          m: '2' as any,
+          n: 2
+        });
+      }).should.throw('Variable should be a Number.');
+      (function() {
+        Wallet.create({ ...createOpts,
+          m: 2,
+          n: '2' as any
+        });
+      }).should.throw('Variable should be a Number.');
+    });
+  });
+
+  describe('#fromObj', function() {
+    it('will throw with an invalid string argument for "m" or "n"', function() {
+      (function() {
+        Wallet.fromObj({ ...testWallet,
+          m: '2' as any,
+          n: 2
+        });
+      }).should.throw('Variable should be a Number.');
+      (function() {
+        Wallet.fromObj({ ...testWallet,
+          m: 2,
+          n: '2' as any
+        });
+      }).should.throw('Variable should be a Number.');
+    });
+    it('read a wallet', function() {
+      const w = Wallet.fromObj(testWallet);
+      w.isComplete().should.be.true;
+    });
+  });
+  describe('#createAddress', function() {
+    it('create an address', function() {
+      const w = Wallet.fromObj(testWallet);
+      const a = w.createAddress(false);
+      a.address.should.equal('3HPJYvQZuTVY6pPBz17fFVz2YPoMBVT34i');
+      a.path.should.equal('m/2147483647/0/0');
+      a.createdOn.should.be.above(1);
+    });
+  });
+
+  describe('#createBEKeys', function() {
+    it('create BE keys based on xPubkeys', function() {
+      const w = Wallet.fromObj(testWallet);
+      const a = w.updateBEKeys();
+      w.beAuthPrivateKey2.should.be.equal('7272c172cf48c6306153aa9d7eaa5397bbf71b076a41deaf43e4a194fc76212c');
+    });
+
+    it('key should change depending on the network', function() {
+      const t = JSON.parse(JSON.stringify(testWallet));
+      t.network = 'testnet';
+      const w = Wallet.fromObj(t);
+      const a = w.updateBEKeys();
+      w.beAuthPrivateKey2.should.be.equal('de469a81d1df982765044c65ab3cedae0edebaca6a17e29e9addbe71b0cec6e5');
+    });
+
+    it('key should depend on xpubs', function() {
+      const t = JSON.parse(JSON.stringify(testWallet));
+      t.copayers[0].xPubKey = 'xpub661MyMwAqRbcF3Q3BRNic47PusMzQbG3TDmxKJJT2k7vGLg7STrmdfYporfSgmCefUkLDnaQrMrVZf9knKBR9bYkwQxCaEpK611mZV8VNkN';
+      const w = Wallet.fromObj(t);
+      const a = w.updateBEKeys();
+      w.beAuthPrivateKey2.should.be.equal('16c34ae1b6b6176fb7972204d7aed37494a65878d58928ea8a1331b9995aa7a3');
+    });
+  });
+});
+
+
+const testWallet: IWallet = {
+  addressManager: {
+    receiveAddressIndex: 0,
+    changeAddressIndex: 0,
+    copayerIndex: 2147483647,
+    version: 1,
+    derivationStrategy: 'BIP45',
+    skippedPaths: []
+  },
+  createdOn: 1422904188,
+  id: '123',
+  name: '123 wallet',
+  coin: 'btc',
+  chain: 'btc',
+  network: 'livenet',
+  m: 2,
+  n: 3,
+  status: 'complete',
+  publicKeyRing: [{
+    xPubKey: 'xpub661MyMwAqRbcFLRkhYzK8eQdoywNHJVsJCMQNDoMks5bZymuMcyDgYfnVQYq2Q9npnVmdTAthYGc3N3uxm5sEdnTpSqBc4YYTAhNnoSxCm9',
+    requestPubKey: '03814ac7decf64321a3c6967bfb746112fdb5b583531cd512cc3787eaf578947dc'
+  }, {
+    xPubKey: 'xpub661MyMwAqRbcEzHgVwwxoXksq21rRNsJsn7AFy4VD4PzsEmjjWwsyEiTjsdQviXbqZ5yHVWJR8zFUDgUKkq4R97su3UyNo36Z8hSaCPrv6o',
+    requestPubKey: '03fc086d2bd8b6507b1909b24c198c946e68775d745492ea4ca70adfce7be92a60'
+  }, {
+    xPubKey: 'xpub661MyMwAqRbcFXUfkjfSaRwxJbAPpzNUvTiNFjgZwDJ8sZuhyodkP24L4LvsrgThYAAwKkVVSSmL7Ts7o9EHEHPB3EE89roAra7njoSeiMd',
+    requestPubKey: '0246c30040eda1e36e02629ae8cd2a845fcfa947239c4c703f7ea7550d39cfb43a'
+  }],
+  copayers: [{
+    addressManager: {
+      receiveAddressIndex: 0,
+      changeAddressIndex: 0,
+      copayerIndex: 0,
+      version: 1,
+      derivationStrategy: 'BIP45',
+      skippedPaths: []
+    },
+    createdOn: 1422904189,
+    id: '1',
+    name: 'copayer 1',
+    xPubKey: 'xpub661MyMwAqRbcFLRkhYzK8eQdoywNHJVsJCMQNDoMks5bZymuMcyDgYfnVQYq2Q9npnVmdTAthYGc3N3uxm5sEdnTpSqBc4YYTAhNnoSxCm9',
+    requestPubKey: '03814ac7decf64321a3c6967bfb746112fdb5b583531cd512cc3787eaf578947dc',
+    signature: '30440220192ae7345d980f45f908bd63ccad60ce04270d07b91f1a9d92424a07a38af85202201591f0f71dd4e79d9206d2306862e6b8375e13a62c193953d768e884b6fb5a46',
+    version: 1,
+    requestPubKeys: [],
+    coin: 'btc',
+    walletId: '123',
+    customData: null,
+  }, {
+    addressManager: {
+      receiveAddressIndex: 0,
+      changeAddressIndex: 0,
+      copayerIndex: 1,
+      version: 1,
+      derivationStrategy: 'BIP45',
+      skippedPaths: []
+    },
+    createdOn: 1422904189,
+    id: '2',
+    name: 'copayer 2',
+    xPubKey: 'xpub661MyMwAqRbcEzHgVwwxoXksq21rRNsJsn7AFy4VD4PzsEmjjWwsyEiTjsdQviXbqZ5yHVWJR8zFUDgUKkq4R97su3UyNo36Z8hSaCPrv6o',
+    requestPubKey: '03fc086d2bd8b6507b1909b24c198c946e68775d745492ea4ca70adfce7be92a60',
+    signature: '30440220134d13139323ba16ff26471c415035679ee18b2281bf85550ccdf6a370899153022066ef56ff97091b9be7dede8e40f50a3a8aad8205f2e3d8e194f39c20f3d15c62',
+    version: 1,
+    requestPubKeys: [],
+    coin: 'btc',
+    walletId: '123',
+    customData: null,
+  }, {
+    addressManager: {
+      receiveAddressIndex: 0,
+      changeAddressIndex: 0,
+      copayerIndex: 2,
+      version: 1,
+      derivationStrategy: 'BIP45',
+      skippedPaths: []
+    },
+    createdOn: 1422904189,
+    id: '3',
+    name: 'copayer 3',
+    xPubKey: 'xpub661MyMwAqRbcFXUfkjfSaRwxJbAPpzNUvTiNFjgZwDJ8sZuhyodkP24L4LvsrgThYAAwKkVVSSmL7Ts7o9EHEHPB3EE89roAra7njoSeiMd',
+    requestPubKey: '0246c30040eda1e36e02629ae8cd2a845fcfa947239c4c703f7ea7550d39cfb43a',
+    signature: '304402207a4e7067d823a98fa634f9c9d991b8c42cd0f82da24f686992acf96cdeb5e387022021ceba729bf763fc8e4277f6851fc2b856a82a22b35f20d2eeb23d99c5f5a41c',
+    version: 1,
+    requestPubKeys: [],
+    coin: 'btc',
+    walletId: '123',
+    customData: null,
+  }],
+  version: '1.0.0',
+  pubKey: '{"x":"6092daeed8ecb2212869395770e956ffc9bf453f803e700f64ffa70c97a00d80","y":"ba5e7082351115af6f8a9eb218979c7ed1f8aa94214f627ae624ab00048b8650","compressed":true}',
+  isTestnet: false,
+  singleAddress: false,
+  beRegistered: false,
+  addressIndex: 0,
+  addressType: 'P2SH',
+  derivationStrategy: 'BIP45',
+};

package/test/storage.test.ts

@@ -0,0 +1,430 @@
+'use strict';
+
+import * as chai from 'chai';
+import 'chai/register-should';
+import mongodb from 'mongodb';
+import util from 'util';
+import { Storage } from '../src/lib/storage';
+import * as Model from '../src/lib/model';
+import config from './test-config';
+import helpers from './integration/helpers';
+
+const should = chai.should();
+
+describe('Storage', function() {
+  let client, storage;
+  before(function(done) {
+    mongodb.MongoClient.connect(config.mongoDb.uri, { useUnifiedTopology: true }, function(err, inclient) {
+      if (err) throw err;
+      client = inclient;
+      const db1 = client.db(config.mongoDb.dbname);
+      storage = new Storage({
+        db: db1,
+      });
+      done();
+    });
+  });
+  beforeEach(function(done) {
+    if (!client) return done();
+    const db1 = client.db(config.mongoDb.dbname);
+    db1.dropDatabase(function(err) {
+      return done();
+    });
+  });
+
+  describe('Store & fetch wallet', function() {
+    it('should correctly store and fetch wallet', function(done) {
+      const wallet = Model.Wallet.create({
+        id: '123',
+        name: 'my wallet',
+        m: 2,
+        n: 3,
+        coin: 'btc',
+        chain: 'btc',
+        network: 'livenet',
+        pubKey: '',
+        singleAddress: false,
+        derivationStrategy: 'BIP45',
+        addressType: 'P2SH',
+      });
+      should.exist(wallet);
+      storage.storeWallet(wallet, function(err) {
+        should.not.exist(err);
+        storage.fetchWallet('123', function(err, w) {
+          should.not.exist(err);
+          should.exist(w);
+          w.id.should.equal(wallet.id);
+          w.name.should.equal(wallet.name);
+          w.m.should.equal(wallet.m);
+          w.n.should.equal(wallet.n);
+          done();
+        });
+      });
+    });
+    it('should not return error if wallet not found', function(done) {
+      storage.fetchWallet('123', function(err, w) {
+        should.not.exist(err);
+        should.not.exist(w);
+        done();
+      });
+    });
+  });
+
+  describe('Copayer lookup', function() {
+    it('should correctly store and fetch copayer lookup', function(done) {
+      const wallet = Model.Wallet.create({
+        id: '123',
+        name: 'my wallet',
+        m: 2,
+        n: 3,
+        coin: 'btc',
+        chain: 'btc',
+        network: 'livenet',
+        pubKey: '',
+        singleAddress: false,
+        derivationStrategy: 'BIP45',
+        addressType: 'P2SH',
+      });
+      for (let i = 0; i < 3; i++) {
+        const copayer = Model.Copayer.create({
+          coin: 'btc',
+          name: 'copayer ' + i,
+          xPubKey: 'xPubKey ' + i,
+          requestPubKey: 'requestPubKey ' + i,
+          signature: 'xxx',
+        });
+        wallet.addCopayer(copayer);
+      }
+
+      should.exist(wallet);
+      storage.storeWalletAndUpdateCopayersLookup(wallet, function(err) {
+        should.not.exist(err);
+        storage.fetchCopayerLookup(wallet.copayers[1].id, function(err, lookup) {
+          should.not.exist(err);
+          should.exist(lookup);
+          lookup.walletId.should.equal('123');
+          lookup.requestPubKeys[0].key.should.equal('requestPubKey 1');
+          lookup.requestPubKeys[0].signature.should.equal('xxx');
+          done();
+        });
+      });
+    });
+    it('should not return error if copayer not found', function(done) {
+      storage.fetchCopayerLookup('2', function(err, lookup) {
+        should.not.exist(err);
+        should.not.exist(lookup);
+        done();
+      });
+    });
+  });
+
+  describe.skip('Advertisements', function() {
+    // not yet implemented
+  });
+
+  describe('Transaction proposals', function() {
+    let wallet, proposals;
+
+    beforeEach(async function() {
+      wallet = Model.Wallet.create({
+        id: '123',
+        name: 'my wallet',
+        m: 2,
+        n: 3,
+        coin: 'btc',
+        chain: 'btc',
+        network: 'livenet',
+        pubKey: '',
+        singleAddress: false,
+        derivationStrategy: 'BIP45',
+        addressType: 'P2SH',
+      });
+      for (let i = 0; i < 3; i++) {
+        const copayer = Model.Copayer.create({
+          coin: 'btc',
+          name: 'copayer ' + i,
+          xPubKey: 'xPubKey ' + i,
+          requestPubKey: 'requestPubKey ' + i,
+          signature: 'signarture ' + i,
+        });
+        wallet.addCopayer(copayer);
+      }
+      should.exist(wallet);
+      await util.promisify(storage.storeWalletAndUpdateCopayersLookup).call(storage, wallet);
+
+      proposals = [];
+      for (let i = 0; i < 4; i++) {
+        const tx = Model.TxProposal.create({
+          walletId: '123',
+          coin: 'btc',
+          network: 'livenet',
+          outputs: [{
+            toAddress: '18PzpUFkFZE8zKWUPvfykkTxmB9oMR8qP7',
+            amount: i + 100,
+          }],
+          feePerKb: 100e2,
+          creatorId: wallet.copayers[0].id,
+        });
+        if (i % 2 == 0) {
+          tx.status = 'pending';
+          tx.isPending().should.be.true;
+        } else {
+          tx.status = 'rejected';
+          tx.isPending().should.be.false;
+        }
+        tx.txid = 'txid' + i;
+        proposals.push(tx);
+      }
+      for (const tx of proposals) {
+        await util.promisify(storage.storeTx).call(storage, '123', tx);
+      }
+    });
+    it('should fetch tx', function(done) {
+      storage.fetchTx('123', proposals[0].id, function(err, tx) {
+        should.not.exist(err);
+        should.exist(tx);
+        tx.id.should.equal(proposals[0].id);
+        tx.walletId.should.equal(proposals[0].walletId);
+        tx.creatorName.should.equal('copayer 0');
+        done();
+      });
+    });
+    it('should fetch tx by hash', function(done) {
+      storage.fetchTxByHash('txid0', function(err, tx) {
+        should.not.exist(err);
+        should.exist(tx);
+        tx.id.should.equal(proposals[0].id);
+        tx.walletId.should.equal(proposals[0].walletId);
+        tx.creatorName.should.equal('copayer 0');
+        done();
+      });
+    });
+
+    it('should fetch all pending txs', function(done) {
+      storage.fetchPendingTxs('123', function(err, txs) {
+        should.not.exist(err);
+        should.exist(txs);
+        txs.length.should.equal(2);
+        txs.sort((a, b) => a.amount - b.amount);
+        txs[0].amount.should.equal(100);
+        txs[1].amount.should.equal(102);
+        done();
+      });
+    });
+    it('should remove tx', function(done) {
+      storage.removeTx('123', proposals[0].id, function(err) {
+        should.not.exist(err);
+        storage.fetchTx('123', proposals[0].id, function(err, tx) {
+          should.not.exist(err);
+          should.not.exist(tx);
+          storage.fetchTxs('123', {}, function(err, txs) {
+            should.not.exist(err);
+            should.exist(txs);
+            txs.length.should.equal(3);
+            txs.some(tx => tx.id === proposals[0].id).should.be.false;
+            done();
+          });
+        });
+      });
+    });
+  });
+  describe('History Cache v8', () => {
+    it('should fail is TX does not have blochchain height', (done) => {
+      const tipIndex = 80; // current cache tip
+      const items = [{ txid: '1234' }]; // a single tx.
+      const updateHeight = 1000;
+      storage.storeTxHistoryCacheV8('xx', tipIndex, items, updateHeight, (err) => {
+        err.toString().should.contain('missing blockheight');
+        done();
+      });
+    });
+
+
+    it('should store a single tx on the cache and update status correctly', (done) => {
+      const tipIndex = 80; // current cache tip
+      const items = [{ txid: '1234', blockheight: 800 }]; // a single tx.
+      const updateHeight = 1000;
+      storage.storeTxHistoryCacheV8('xx', tipIndex, items, updateHeight, (err) => {
+        should.not.exist(err);
+        storage.getTxHistoryCacheStatusV8('xx', (err, inCacheStatus) => {
+          should.not.exist(err);
+          inCacheStatus.tipIndex.should.equal(81);
+          inCacheStatus.tipTxId.should.equal('1234');
+          inCacheStatus.tipHeight.should.equal(800);
+          inCacheStatus.updatedHeight.should.equal(1000);
+          done();
+        });
+      });
+    });
+
+
+    it('should store a 5 txs on the cache and update status correctly', (done) => {
+      const tipIndex = 80; // current cache tip
+      const items = [
+        { txid: '1234', blockheight: 803 },    // <=== Latests
+        { txid: '1235', blockheight: 802 },
+        { txid: '1236', blockheight: 801 },
+        { txid: '1237', blockheight: 801 },
+        { txid: '1238', blockheight: 800 },
+      ];
+      const updateHeight = 1000;
+      storage.storeTxHistoryCacheV8('xx', tipIndex, items, updateHeight, (err) => {
+        should.not.exist(err);
+        storage.getTxHistoryCacheStatusV8('xx', (err, inCacheStatus) => {
+          should.not.exist(err);
+          inCacheStatus.tipIndex.should.equal(85);
+          inCacheStatus.tipTxId.should.equal('1234');
+          inCacheStatus.tipHeight.should.equal(803);
+          inCacheStatus.updatedHeight.should.equal(1000);
+          done();
+        });
+      });
+    });
+
+    it('should prevent to store txs on wrong order', (done) => {
+      const tipIndex = 80; // current cache tip
+      const items = [
+        { txid: '1234', blockheight: 803 },    // <=== Latests
+        { txid: '1235', blockheight: 802 },
+        { txid: '1236', blockheight: 801 },
+        { txid: '1237', blockheight: 801 },
+        { txid: '1238', blockheight: 800 },
+      ];
+      const updateHeight = 1000;
+      storage.storeTxHistoryCacheV8('xx', tipIndex, items.reverse(), updateHeight, (err) => {
+        err.toString().should.contain('wrong order');
+        done();
+      });
+    });
+
+    it('should store a 100 txs on the cache and update status correctly', (done) => {
+      const tipIndex = 80; // current cache tip
+      const items = helpers.createTxsV8(101, 1000);
+
+      // this is done by _normalizeV8TxHistory
+      for (const x of items) {
+        x.blockheight = x.height;
+      }
+
+      // remove unconfirmed
+      items.shift();
+
+      const updateHeight = 50000;
+      storage.storeTxHistoryCacheV8('xx', tipIndex, items, updateHeight, (err) => {
+        should.not.exist(err);
+        storage.getTxHistoryCacheStatusV8('xx', (err, inCacheStatus) => {
+          should.not.exist(err);
+          inCacheStatus.tipIndex.should.equal(80 + 100);
+          inCacheStatus.tipTxId.should.equal('txid1');
+          inCacheStatus.tipHeight.should.equal(1000);
+          inCacheStatus.updatedHeight.should.equal(updateHeight);
+          done();
+        });
+      });
+    });
+
+    it('should store a 1tx on the cache and retreive them correctly', (done) => {
+      const tipIndex = 80; // current cache tip
+      const items = [{ txid: '1234', blockheight: 800, amount: 100 }]; // a single tx.
+      const updateHeight = 1000;
+
+      storage.storeTxHistoryCacheV8('xx', tipIndex, items, updateHeight, (err) => {
+        should.not.exist(err);
+        storage.getTxHistoryCacheV8('xx', 0, 5, (err, txs) => {
+          should.not.exist(err);
+          txs.length.should.equal(1);
+          txs[0].blockheight.should.equal(800);
+          done();
+        });
+      });
+    });
+
+    it('should clear all cache on deregistration', (done) => {
+      const tipIndex = 80; // current cache tip
+      const items = [{ txid: '1234', blockheight: 800, amount: 100 }]; // a single tx.
+      const updateHeight = 1000;
+
+      storage.storeTxHistoryCacheV8('xx', tipIndex, items, updateHeight, (err) => {
+        should.not.exist(err);
+        storage.deregisterWallet('xx', (err) => {
+          should.not.exist(err);
+          storage.getTxHistoryCacheV8('xx', 0, 5, (err, txs) => {
+            should.not.exist(err);
+            txs.length.should.equal(0);
+            done();
+          });
+        });
+      });
+    });
+
+
+
+    it('should store a 5 txs on the cache and retreive them correctly', (done) => {
+      const tipIndex = 80; // current cache tip
+      const items = [
+        { txid: '1234', blockheight: 803 },    // <=== Latests
+        { txid: '1235', blockheight: 802 },
+        { txid: '1236', blockheight: 801 },
+        { txid: '1237', blockheight: 800 },
+        { txid: '1238', blockheight: 800 },
+      ];
+      const updateHeight = 1000;
+      storage.storeTxHistoryCacheV8('xx', tipIndex, items, updateHeight, (err) => {
+        should.not.exist(err);
+        storage.getTxHistoryCacheV8('xx', 0, 5, (err, txs) => {
+          should.not.exist(err);
+          txs.length.should.equal(5);
+          txs[0].blockheight.should.equal(803);
+          txs[4].blockheight.should.equal(800);
+          txs[4].txid.should.equal('1238'); // should preserve order
+          done();
+        });
+      });
+    });
+
+
+    it('should store a 10 txs on the cache and retreive them correctly', (done) => {
+      const tipIndex = 80; // current cache tip
+      const items = [
+        { txid: '1234', blockheight: 803 },    // <=== Latests
+        { txid: '1235', blockheight: 802 },
+        { txid: '1236', blockheight: 801 },
+        { txid: '1237', blockheight: 800 },
+        { txid: '1238', blockheight: 800 },
+      ];
+      let updateHeight = 1000;
+      storage.storeTxHistoryCacheV8('xx', tipIndex, items, updateHeight, (err) => {
+        should.not.exist(err);
+
+        // time passes
+        updateHeight = 2000;
+        const items2 = [
+          { txid: '124', blockheight: 1803 },    // <=== Latests
+          { txid: '125', blockheight: 1802 },
+          { txid: '126', blockheight: 1801 },
+          { txid: '127', blockheight: 1800 },
+          { txid: '128', blockheight: 1800 },
+        ];
+
+        storage.getTxHistoryCacheStatusV8('xx', (err, inCacheStatus) => {
+          should.not.exist(err);
+          inCacheStatus.tipIndex.should.equal(85);
+          storage.storeTxHistoryCacheV8('xx', inCacheStatus.tipIndex, items2, updateHeight, (err) => {
+            should.not.exist(err);
+
+            storage.getTxHistoryCacheV8('xx', 0, 100, (err, txs) => {
+              should.not.exist(err);
+              txs.length.should.equal(10);
+              txs[0].blockheight.should.equal(1803);
+              txs[9].blockheight.should.equal(800);
+              txs[9].txid.should.equal('1238'); // should preserve order
+              done();
+            });
+          });
+        });
+      });
+    });
+
+
+  });
+});

package/test/test-config.ts

@@ -0,0 +1,12 @@
+const host = process.env.DB_HOST || 'localhost';
+const port = process.env.DB_PORT || '27017';
+const dbname = 'bws_test';
+
+export const config = {
+  mongoDb: {
+    uri: `mongodb://${host}:${port}/${dbname}`,
+    dbname,
+  },
+};
+
+export default config;