feat!: KeyChainStore, ChainStore, WalletStore and path registration feature

fixtures/chains/testnet/blockheaders.json

@@ -0,0 +1,12 @@
+[
+  {
+    "height": 600000,
+    "blockheader": "00000020a69faca490012f4371e4bd40a40167809e6fe1b03c9c5dcb7df247f2fa000000b4b8c2d4a78fb35e50a4eda0bd3a5b9b32f4d739b28a4266f24775b3b79d5b61c73275610e04021ea74d0000",
+    "hash":"000000de786e659950e0f27681faf1a91871d15de264d0b769cb5941c1d807c3"
+  },
+  {
+    "height": 610000,
+    "blockheader": "00000020af5155e1f8d5b60fb247ac9bb8badbdce1fa72302336c7daab53585caf0000006d495b9629989ac3699d528956b1f617fb51a199ef4277c3f45f4606aba8e461d1c78a61210b011e94ef0000",
+    "hash":"00000094d124cfb68d6d59ffaec9f7d63965cb894855684e23a586274b49708f"
+  }
+]

fixtures/chains/testnet/transactions.json

@@ -0,0 +1,14 @@
+[
+  {
+    "blockHash": "000000b2537d9b3468e02dc6f49fb8bbb5c9d8b77895df1e76816fbad5555d7d",
+    "transaction": "02000000019583d226737edfad682cc1f0297f688bfca4c0046062ed3e88fa47dd47eab2b2010000006a473044022021550232cc659fa412deb2ea98956faf9ff0efea3a04029bb63022f6809105ce0220230a3f955a3ee7563f5b006342d8db940f3b29f4e312701bf51720575c7a7a8a012103f3d2b2ddfe6ffad2b8fc1708f2eafadfed36bf31a05dfa04b1fc176526475b0ffeffffff02a003d806000000001976a91464220a1c12690ec26d837b3be0a2e3588bb4b79188ac4c5bc92b250000001976a9143e89746b9aa52703ab784bc0df467b160406ffb988acb56b0900",
+    "height": 617398,
+    "isInstantLocked": true,
+    "isChainLocked": true
+  },
+  {
+    "transaction": "0200000001c7d66bb85e0069c221b44b07f49f52cc4f2e54f70e14430b94888327763a66a9010000006b483045022100da5b319f73e6adfee751f33308f5a8c1fceeab2683e15e132d79053b3118639602204262022fb85f88d9802649a289a1134b678efcf708faaeae8f101e8eab785054012102bc626898b49f31f5194de7bc68004401639a20cfa82e4c2eac9684a91fc47a57feffffff0270f2f605000000001976a91464220a1c12690ec26d837b3be0a2e3588bb4b79188ac912e250c250000001976a91415e1edb5c5d9e67d0e36f94343b3eff26bb76d1088ac266e0900",
+    "blockHash":"0000005c81a683007e86e75c76b4b2feca229f806702ca92953562f2ae628ce7",
+    "height": 618023
+  }
+]

fixtures/wallets/c922713eac.json

@@ -0,0 +1,97 @@
+{
+  "walletId": "c922713eac",
+  "state": {
+    "mnemonic": null,
+    "paths": {
+      "m/44'/1'/0'": {
+        "path": "m/44'/1'/0'",
+        "addresses": {
+          "m/0/0": "ycRqwWy2pNzwNumX79MmRyvQYVpy6w3AeX",
+          "m/0/1": "ycuRYGdNudwRxKNDQBqHDW7aGbJU6uqhXo",
+          "m/0/2": "yfNFUv1vfx3EVyVGtfZNXqvFR7HLP5MGRq",
+          "m/0/3": "yjDWQWhNixjKLMjzmXxWqLdJUEcgyjQh1o",
+          "m/0/4": "ygCCNzQM2Uj7Dfyi6sxPGBmRY6hqHGEFP9",
+          "m/0/5": "yX5c33WWgLacu7Z1hnBTLKPSXbbGt4BFNt",
+          "m/0/6": "yYeyVQqiejQsFmkQjtbcigLLPVGJKHxQBL",
+          "m/0/7": "yTFXnvNARXGPNL1ZKFHyVah3xY6JxzQaPD",
+          "m/0/8": "yNGpfTzZkJNhEQUk6Wj1VdS8RUVpq6qA2g",
+          "m/0/9": "ySW43fHX7uTEjJWjozu3EF3bsXywFoo1gf",
+          "m/0/10": "yM3LdfhFcMQBQoECRrh2WZwy6c8xnsA1rq",
+          "m/0/11": "ybDdvzUVYvqSPnvdzqgQo1ictZxTjoNTeY",
+          "m/0/12": "yZLvsg1LuC1q9xa1FqNoKWKHZJTLb1Rs5U",
+          "m/0/13": "yeGtNDLgTEfSYtYK84kXwvHXwRu3AQprku",
+          "m/0/14": "yPBq6vmEXnz2FtHVztLHD9HPQf8FMbnRPr",
+          "m/0/15": "yjcBeyf1r8EkjNFXGgX4NmNQEwk4NNH4Dp",
+          "m/0/16": "ySCxSmKAfjo8fk15TCM9chiS1dAQfJ54z2",
+          "m/0/17": "ySBWPfBDnN2iWKt4uRoFaVPGDoRDQpo5i1",
+          "m/0/18": "yXMhEgMKAknAUTNR31nYr4uSP7GMpmCgsm",
+          "m/0/19": "yf9Zudcaof9c3KrdPVz3r7YPZJ1U2ECbXE",
+          "m/1/0": "yXwFx2jAMxxntn421z9PsdzytmHRJGjyU4",
+          "m/1/1": "yTDBgBUYbPq2XWkrnEWXTZGDcvbPxH1chY",
+          "m/1/2": "yexVh4ARXbi7ZCUEEGEDde63t91N5e6kfC",
+          "m/1/3": "ydVc6fZz46csMbAea6xtd1AmW3Zohk9DX5",
+          "m/1/4": "yWvR7rm6s28SePpVi24AX1pNcBoTubsEcC",
+          "m/1/5": "yb4yiJrSTstkTrm4Ah9cfkyYmbC3H2TPoS",
+          "m/1/6": "yb5dJVhq2pi68Qm1ZfzUsux9fCqPdw5GuM",
+          "m/1/7": "yeSJLf7xsfenJwmwAb28suXpHLwd8bgc2K",
+          "m/1/8": "yTqDebXPzENywmQiciNjn6U5Hkv7uBYvgm",
+          "m/1/9": "yegUezShAWzyZfM8WVSj5yzaKzVTRQC9n7",
+          "m/1/10": "ydtkdeeX8NfAR7thLnzDPwrsiZ7c3a7bVL",
+          "m/1/11": "yUk83srvLCbpjkiYTpcPpftjGroSeYdHTF",
+          "m/1/12": "yScDono7QjZPqNJo27eCsrNwUAXFdTLK9P",
+          "m/1/13": "yZBYJEqmt8rE57unfDRseXBLkdCyfDF9VX",
+          "m/1/14": "yhhkAYqLNJQyu5XNAT61b2b8Qo7k5Uib1b",
+          "m/1/15": "yZoLgZuUEmFANWFA8PE2zNVH1Yaz9fciGT",
+          "m/1/16": "yZQVV3EaLpAehKMpPiGy7w3NRmgKD7xJX1",
+          "m/1/17": "yQ7SV5m46ck1fVQrJinvA982aBAUv3TCq2",
+          "m/1/18": "yaaw9BZ16eoXv4RAGBA9qbSrjvTTbqbUKq",
+          "m/1/19": "yjbLQQkP5tZ3aZ734vFXscFG14vDPnE1rx",
+          "m/0/20": "yYqmE6MCitNpgyL7iRdNheG2ZP4bNCxoMV",
+          "m/1/20": "yQpSjWKF6HabXAMizRvMETDd6EbQixXQZ7",
+          "m/1/21": "yNi1fiMR554w6MehxFoESXwUHk3v6AJELy",
+          "m/1/22": "yVRRAWki91bieh6eAYjwZZpJLcgmY14D79",
+          "m/1/23": "yf3NLNnFSnZQuQEFHrAU3Kzdip3AfNXBy3",
+          "m/1/24": "yTpUMFdpe2WnMz9cjJp3jcDR4G6gXjW5jh",
+          "m/1/25": "yjPgE4RimwUGZFJpDZjANyioWd1SbZpcaS",
+          "m/1/26": "ygjDcpfLxzs8pweCQ6Ty8GioNDTgfQX3GQ",
+          "m/1/27": "yUFchfQMACPyoy6HtqNRv8gjEYKvjd3Wd6",
+          "m/1/28": "yj1oiPUjyo2RLvpbyigfb7pLiX1piritz1",
+          "m/1/29": "ycGhUD69dS2V18LFy4qrfYhG1qJ8JnVvX7",
+          "m/1/30": "yj6f6KLsQHFoVCUmfbpjSGmdqnB3j9NouZ",
+          "m/1/31": "ycA6K1bW4nxYH8UBvYaXpxmdnMoXPQxp8L",
+          "m/1/32": "yPx12VyoeVLhMCVDiwK7Js7zDWNtNbq8JV",
+          "m/1/33": "yMSpVBXff6XoLMwmP7N4nX4Mjo21ewkYkE",
+          "m/1/34": "yVoywf8fK8VtPEiLyx6zknqWBjE4izUXvD",
+          "m/1/35": "yU4Xor7Y8XjXFNYmVebqKeaCPqDmKNxbYd",
+          "m/1/36": "yiE7vzjGNseTtEwtXZTmjcf99hfwLziJPq",
+          "m/1/37": "yLmXE68Kq8UrK42QjyNWi8gFqf1ihd3UiW",
+          "m/1/38": "yQnUHRyB768tawz3iLDs5VVLYg5dGEJYQi",
+          "m/1/39": "yMEnFG5TBqEZXYXTg3PhENtZgGbwhw6qbX",
+          "m/1/40": "ybPPRHGDK6HUjAapixJaHjpFrBP7p1eNHX",
+          "m/1/41": "yeKckmFWSPq4ZgxrKtqgWLfspT5YSuinAw",
+          "m/1/42": "yX5fXtxaF5Umi3wkCvFCCbYjQniex8YfZb",
+          "m/1/43": "yYXYNLd3pwDnZMo8VvFZWtuTaW97yMBtvh",
+          "m/1/44": "yPxjUsH2X9SFnpXt4ke7boWdVJb1jLRU2U",
+          "m/1/45": "yPaJs6aVAxsSsjsaeoWEEf1KWNJHA4osTX",
+          "m/1/46": "yRtTcfySvuZHmnyTGnSVFJiuXQLAMtA8Zp",
+          "m/1/47": "yWniGBz9g5WzC8SNw2Yz6rTiw8gXCwviHH",
+          "m/1/48": "yTBBLUse991FY17xVQxTW6gELhDPLTbrfg",
+          "m/1/49": "yW8ZcyB43XEaNb1rC3vU8B787pCFd5A92G",
+          "m/1/50": "yZFMjHZLcw8VLZSfBDamfaowiespUADi8x",
+          "m/1/51": "yS4CoPF6Bb6vZAorsTQGddhdqzUNA4NQkq",
+          "m/1/52": "yeKFhYBcoDB5BFQVatGEY6xAWWgyAH2znL",
+          "m/1/53": "yVtwa9msBFy3s5YW4zpKaRFEAS3CK5h1sd",
+          "m/1/54": "ySdqTcWTqRHJBwsymifjg4j6hBTUtrhjCo",
+          "m/1/55": "yXgzDeQ6Fa3gzthByHYeiwyVKYzDov7EtR",
+          "m/1/56": "yZVUpv1RfnH4gTiTtuarXVpAcK1h9irJ7q",
+          "m/1/57": "yS4osisWi5dpSmUZFav56Uxj4Uhc3i7RaL",
+          "m/1/58": "ygAb2f6gztLoPdZrma8BRjm3MtNGZFrUbX",
+          "m/1/59": "ygukA9r4bM3CDS1gkFfTfVNozC7c5FvnGj"
+        }
+      }
+    },
+    "identities": {
+      "0": "D8oTFRQqiKcLEYXZBUVLsM9jBctq7YcM7MAXXT9GJesK"
+    }
+  }
+}

src/CONSTANTS.js

@@ -46,7 +46,9 @@ const CONSTANTS = {
     PRIVATEKEY: 'privateKey',
     // TODO: DEPRECATE.
     SINGLE_ADDRESS: 'single_address',
+    // TODO: DEPRECATE.
     HDWALLET: 'hdwallet',
+    HDPRIVATE: 'hdprivate',
     HDPUBLIC: 'hdpublic',
   },
   // List of account function and properties that can be injected in a plugin
@@ -79,7 +81,6 @@ const CONSTANTS = {
     ],
     UNSAFE_PROPERTIES: [
       'storage',
-      'keyChain',
       'identities',
     ],
     SAFE_PROPERTIES: [

src/EVENTS.js

@@ -10,6 +10,7 @@ module.exports = {
   TRANSACTION: 'transaction',
   BLOCKHEADER: 'blockheader',
   FETCHED_ADDRESS: 'FETCHED/ADDRESS',
+  UPDATED_ADDRESS: 'UPDATED/ADDRESS',
   ERROR_UPDATE_ADDRESS: 'ERROR/UPDATE_ADDRESS',
   FETCHED_TRANSACTION: 'FETCHED/TRANSACTION',
   FETCHED_UNCONFIRMED_TRANSACTION: 'FETCHED/UNCONFIRMED_TRANSACTION',

src/errors/InjectionToPluginUnallowed.js

@@ -1,8 +1,8 @@
 const WalletLibError = require('./WalletLibError');
 
 class InjectionToPluginUnallowed extends WalletLibError {
-  constructor(pluginName) {
-    super(`Injection of plugin : ${pluginName} Unallowed`);
+  constructor(currentPluginName, injectingPluginName) {
+    super(`Injection of plugin : ${injectingPluginName} into ${currentPluginName} not allowed`);
   }
 }
 

src/index.d.ts

@@ -4,7 +4,11 @@
 import { Account } from "./types/Account/Account";
 import { Wallet } from "./types/Wallet/Wallet";
 import { Identities } from "./types/Identities/Identities";
+import { IdentitiesStore } from "./types/IdentitiesStore/IdentitiesStore";
 import { KeyChain } from "./types/KeyChain/KeyChain";
+import { KeyChainStore } from "./types/KeyChainStore/KeyChainStore";
+import { Storage } from "./types/Storage/Storage";
+import { ChainStore } from "./types/ChainStore/ChainStore";
 import CONSTANTS from "./CONSTANTS";
 import EVENTS from "./EVENTS";
 import utils from "./utils";
@@ -13,8 +17,11 @@ import plugins from "./plugins";
 export {
     Account,
     Wallet,
+    ChainStore,
     KeyChain,
+    KeyChainStore,
     Identities,
+    IdentitiesStore,
     EVENTS,
     CONSTANTS,
     utils,

src/index.js

@@ -2,20 +2,28 @@
 // polyfill included here. Making it work with webpack is rather tricky, so it is used as per
 // documentation: https://github.com/YuzuJS/setImmediate#usage
 require('setimmediate');
-const Wallet = require('./types/Wallet/Wallet');
 const Account = require('./types/Account/Account');
+const ChainStore = require('./types/ChainStore/ChainStore');
 const Identities = require('./types/Identities/Identities');
 const KeyChain = require('./types/KeyChain/KeyChain');
+const KeyChainStore = require('./types/KeyChainStore/KeyChainStore');
+const Storage = require('./types/Storage/Storage');
+const Wallet = require('./types/Wallet/Wallet');
+const WalletStore = require('./types/WalletStore/WalletStore');
 const EVENTS = require('./EVENTS');
 const CONSTANTS = require('./CONSTANTS');
 const utils = require('./utils');
 const plugins = require('./plugins');
 
 module.exports = {
-  Wallet,
   Account,
+  ChainStore,
   Identities,
   KeyChain,
+  KeyChainStore,
+  Storage,
+  Wallet,
+  WalletStore,
   EVENTS,
   CONSTANTS,
   utils,

src/plugins/Plugins/ChainPlugin.js

@@ -33,15 +33,18 @@ class ChainPlugin extends StandardPlugin {
    */
   async execBlockListener() {
     const self = this;
-    const { network } = this.storage.store.wallets[this.walletId];
+    const { network } = this.storage.application;
+    const chainStore = this.storage.getChainStore(network);
+
+    // const { network } = this.storage.store.wallets[this.walletId];
 
     if (!this.isSubscribedToBlocks) {
       self.transport.on(EVENTS.BLOCK, async (ev) => {
         // const { network } = self.storage.store.wallets[self.walletId];
         const { payload: block } = ev;
         this.parentEvents.emit(EVENTS.BLOCK, { type: EVENTS.BLOCK, payload: block });
         // We do not announce BLOCKHEADER as this is done by Storage
-        await self.storage.importBlockHeader(block.header);
+        await chainStore.importBlockHeader(block.header);
       });
       self.transport.on(EVENTS.BLOCKHEIGHT_CHANGED, async (ev) => {
         const { payload: blockheight } = ev;
@@ -50,7 +53,7 @@ class ChainPlugin extends StandardPlugin {
           type: EVENTS.BLOCKHEIGHT_CHANGED, payload: blockheight,
         });
 
-        this.storage.store.chains[network.toString()].blockHeight = blockheight;
+        chainStore.state.blockHeight = blockheight;
         logger.debug(`ChainPlugin - setting chain blockheight ${blockheight}`);
       });
       await self.transport.subscribeToBlocks();
@@ -69,20 +72,20 @@ class ChainPlugin extends StandardPlugin {
       return false;
     }
 
+    const { network } = this.storage.application;
+    const chainStore = this.storage.getChainStore(network);
     const { chain: { blocksCount: blocks }, network: { fee: { relay } } } = res;
 
-    const { network } = this.storage.store.wallets[this.walletId];
-
     logger.debug('ChainPlugin - Setting up starting blockHeight', blocks);
 
-    this.storage.store.chains[network.toString()].blockHeight = blocks;
+    chainStore.state.blockHeight = blocks;
 
     if (relay) {
-      this.storage.store.chains[network.toString()].fees.minRelay = dashToDuffs(relay);
+      chainStore.state.fees.minRelay = dashToDuffs(relay);
     }
 
     const bestBlock = await this.transport.getBlockHeaderByHeight(blocks);
-    await this.storage.importBlockHeader(bestBlock);
+    await chainStore.importBlockHeader(bestBlock);
 
     return true;
   }

src/plugins/StandardPlugin.js

@@ -63,7 +63,7 @@ class StandardPlugin extends EventEmitter {
       // this.parentEvents = {on:obj.on, emit:obj.emit};
       this.parentEvents = obj;
     } else {
-      this.emit('error', new InjectionToPluginUnallowed(name), {
+      this.emit('error', new InjectionToPluginUnallowed(this.name, name), {
         type: 'plugin',
         pluginType: 'plugin',
         pluginName: this.name,

src/plugins/Workers/IdentitySyncWorker.js

@@ -26,7 +26,8 @@ class IdentitySyncWorker extends Worker {
   }
 
   async execute() {
-    const indexedIds = await this.storage.getIndexedIdentityIds(this.walletId);
+    const walletStore = this.storage.getWalletStore(this.walletId);
+    const indexedIds = await walletStore.getIndexedIdentityIds();
 
     // Add gaps to empty indices
     const unusedIndices = [];
@@ -98,11 +99,12 @@ class IdentitySyncWorker extends Worker {
       logger.silly(`IdentitySyncWorker - got ${Identifier.from(fetchedId)} at ${index}`);
 
       // eslint-disable-next-line no-await-in-loop
-      await this.storage.insertIdentityIdAtIndex(
-        this.walletId,
-        Identifier.from(fetchedId).toString(),
-        index,
-      );
+      await this.storage
+        .getWalletStore(this.walletId)
+        .insertIdentityIdAtIndex(
+          Identifier.from(fetchedId).toString(),
+          index,
+        );
     }
 
     logger.silly('IdentitySyncWorker - sync finished');

src/plugins/Workers/TransactionSyncStreamWorker/TransactionSyncStreamWorker.js

@@ -25,6 +25,7 @@ class TransactionSyncStreamWorker extends Worker {
         'importBlockHeader',
         'importInstantLock',
         'storage',
+        'keyChainStore',
         'transport',
         'walletId',
         'getAddress',
@@ -49,12 +50,11 @@ class TransactionSyncStreamWorker extends Worker {
    * @param {string[]} addressList
    * @param {string} network
    */
-  static filterWalletTransactions(transactions, addressList, network) {
+  static filterAddressesTransactions(transactions, addressList, network) {
     const spentOutputs = [];
     const unspentOutputs = [];
     const filteredTransactions = transactions.filter((tx) => {
       let isWalletTransaction = false;
-
       tx.inputs.forEach((input) => {
         if (input.script) {
           const addr = input.script.toAddress(network).toString();
@@ -124,7 +124,6 @@ class TransactionSyncStreamWorker extends Worker {
         .getMessagesList()
         .map((instantSendLock) => new InstantLock(Buffer.from(instantSendLock)));
     }
-
     return walletTransactions;
   }
 
@@ -135,11 +134,11 @@ class TransactionSyncStreamWorker extends Worker {
     const {
       skipSynchronizationBeforeHeight,
       skipSynchronization,
-    } = (this.storage.store.syncOptions || {});
+    } = (this.storage.application.syncOptions || {});
 
     if (skipSynchronization) {
       logger.debug('TransactionSyncStreamWorker - Wallet created from a new mnemonic. Sync from the best block height.');
-      const bestBlockHeight = this.storage.store.chains[this.network.toString()].blockHeight;
+      const bestBlockHeight = this.storage.getChainStore(this.network.toString()).blockHeight;
       this.setLastSyncedBlockHeight(bestBlockHeight);
       return;
     }
@@ -238,25 +237,15 @@ class TransactionSyncStreamWorker extends Worker {
   }
 
   setLastSyncedBlockHash(hash) {
-    const { walletId } = this;
-    const accountsStore = this.storage.store.wallets[walletId].accounts;
+    const applicationStore = this.storage.application;
 
-    const accountStore = ([WALLET_TYPES.HDWALLET, WALLET_TYPES.HDPUBLIC].includes(this.walletType))
-      ? accountsStore[this.BIP44PATH.toString()]
-      : accountsStore[this.index.toString()];
+    applicationStore.blockHash = hash;
 
-    accountStore.blockHash = hash;
-
-    return accountStore.blockHash;
+    return applicationStore.blockHash;
   }
 
   getLastSyncedBlockHash() {
-    const { walletId } = this;
-    const accountsStore = this.storage.store.wallets[walletId].accounts;
-
-    const { blockHash } = ([WALLET_TYPES.HDWALLET, WALLET_TYPES.HDPUBLIC].includes(this.walletType))
-      ? accountsStore[this.BIP44PATH.toString()]
-      : accountsStore[this.index.toString()];
+    const { blockHash } = this.storage.application;
 
     return blockHash;
   }

src/plugins/Workers/TransactionSyncStreamWorker/handlers/onStreamError.js

@@ -2,6 +2,7 @@ const logger = require('../../../../logger');
 
 function onStreamError(error, reject) {
   logger.silly('TransactionSyncStreamWorker - end stream on error');
+  logger.silly(error.message);
   reject(error);
 }
 module.exports = onStreamError;