feat: transaction sync state persistance

docs/_sidebar.md

@@ -64,7 +64,6 @@
         - [`.announce()`](storage/announce.md)
         - [`.calculateDuffBalance()`](storage/calculateDuffBalance.md)
         - [`.clearAll()`](storage/clearAll.md)
-        - [`.configure()`](storage/configure.md)
         - [`.createChain()`](storage/createChain.md)
         - [`.createWallet()`](storage/createWallet.md)
         - [`.getStore()`](storage/getStore.md)

fixtures/walletStore.json

@@ -9,7 +9,8 @@
               "m/44'/1'/0'": {
                 "label": null,
                 "path": "m/44'/1'/0'",
-                "network": "testnet"
+                "network": "testnet",
+                "blockHeight": 0
               }
             },
             "network":"testnet",

src/CONSTANTS.js

@@ -61,7 +61,6 @@ const CONSTANTS = {
       'getTotalBalance',
       'broadcastTransaction',
       'importTransactions',
-      'importBlockHeader',
       'getAddress',
       'fetchStatus',
       'getPlugin',

src/adapters/AbstractAdapter.js

@@ -0,0 +1,15 @@
+/**
+ * @abstract
+ */
+class AbstractAdapter {
+  constructor(adapter) {
+    this.isConfig = false;
+    this.adapter = adapter;
+  }
+
+  config() {
+    this.isConfig = true;
+  }
+}
+
+module.exports = AbstractAdapter;

src/adapters/Adapter.d.ts

@@ -0,0 +1,7 @@
+export declare interface Adapter {
+    config()
+
+    setItem(key, item): Promise<any>
+
+    getItem(key): Promise<any>
+}

src/adapters/InMemoryAdapter/InMemoryAdapter.js

@@ -0,0 +1,18 @@
+const logger = require('../../logger');
+const AbstractAdapter = require('../AbstractAdapter');
+
+/**
+ * @implements {Adapter}
+ */
+class InMemoryAdapter extends AbstractAdapter {
+  constructor() {
+    super();
+    logger.warn('Using InMemoryAdapter. Data will not persist.');
+    this.keys = {};
+  }
+}
+
+InMemoryAdapter.prototype.setItem = require('./methods/setItem');
+InMemoryAdapter.prototype.getItem = require('./methods/getItem');
+
+module.exports = InMemoryAdapter;

src/adapters/InMemoryAdapter/InMemoryAdapter.spec.js

@@ -0,0 +1,20 @@
+const { expect } = require('chai');
+const InMemoryAdapter = require('./InMemoryAdapter');
+
+const inMemoryAdapter = new InMemoryAdapter();
+
+describe('Adapter - InMemoryAdapter', function suite() {
+  this.timeout(10000);
+  it('should provide a config method', () => {
+    expect(inMemoryAdapter.config).to.exist;
+  });
+  it('should set an item', () => {
+    const item = { item: 'item' };
+    inMemoryAdapter.setItem('foo', item);
+    expect(inMemoryAdapter.setItem('foo', item)).to.deep.equal(item);
+  });
+  it('should get an item', () => {
+    const item = { item: 'item' };
+    expect(inMemoryAdapter.getItem('foo')).to.deep.equal(item);
+  });
+});

src/adapters/InMemoryAdapter/methods/getItem.js

@@ -0,0 +1,3 @@
+module.exports = function getItem(key) {
+  return this.keys[key] || null;
+};

src/adapters/InMemoryAdapter/methods/setItem.js

@@ -0,0 +1,4 @@
+module.exports = function setItem(key, item) {
+  this.keys[key] = item;
+  return item;
+};

src/adapters/LocalForageAdapter/LocalForageAdapter.js

@@ -0,0 +1,16 @@
+const AbstractAdapter = require('../AbstractAdapter');
+
+/**
+ * @implements {Adapter}
+ */
+class LocalForageAdapter extends AbstractAdapter {
+  constructor(adapter) {
+    super();
+    this.adapter = adapter;
+  }
+}
+
+LocalForageAdapter.prototype.setItem = require('./methods/setItem');
+LocalForageAdapter.prototype.getItem = require('./methods/getItem');
+
+module.exports = LocalForageAdapter;

src/adapters/LocalForageAdapter/methods/getItem.js

@@ -0,0 +1,3 @@
+module.exports = async function getItem(key) {
+  return this.adapter.getItem(key);
+};

src/adapters/LocalForageAdapter/methods/setItem.js

@@ -0,0 +1,3 @@
+module.exports = async function setItem(key, value) {
+  return this.adapter.setItem(key, value);
+};

src/adapters/NodeForageAdapter/NodeForageAdapter.js

@@ -0,0 +1,16 @@
+const AbstractAdapter = require('../AbstractAdapter');
+
+/**
+ * @implements {Adapter}
+ */
+class NodeForageAdapter extends AbstractAdapter {
+  constructor(adapter) {
+    super();
+    this.adapter = adapter;
+  }
+}
+
+NodeForageAdapter.prototype.setItem = require('./methods/setItem');
+NodeForageAdapter.prototype.getItem = require('./methods/getItem');
+
+module.exports = NodeForageAdapter;

src/adapters/NodeForageAdapter/methods/getItem.js

@@ -0,0 +1,3 @@
+module.exports = async function getItem(key) {
+  return this.adapter.getItem(key);
+};

src/adapters/NodeForageAdapter/methods/setItem.js

@@ -0,0 +1,3 @@
+module.exports = async function setItem(key, value) {
+  return this.adapter.setItem(key, value);
+};

src/adapters/createAdapter.js

@@ -0,0 +1,28 @@
+const InMemoryAdapter = require('./InMemoryAdapter/InMemoryAdapter');
+const LocalForageAdapter = require('./LocalForageAdapter/LocalForageAdapter');
+const NodeForageAdapter = require('./NodeForageAdapter/NodeForageAdapter');
+
+const SUPPORTED_ADAPTERS = {
+  LocalForage: 'LocalForage',
+  NodeForage: 'NodeForage',
+};
+/**
+ *
+ * @param {{adapter, name}} options
+ * @returns {Adapter}
+ */
+function createAdapter(options) {
+  if (options && options.name && options.adapter) {
+    switch (options.name) {
+      case SUPPORTED_ADAPTERS.NodeForage:
+        return new NodeForageAdapter(options.adapter);
+      case SUPPORTED_ADAPTERS.LocalForage:
+        return new LocalForageAdapter(options.adapter);
+      default:
+        return new InMemoryAdapter();
+    }
+  }
+  return new InMemoryAdapter();
+}
+
+module.exports = createAdapter;

src/plugins/Workers/TransactionSyncStreamWorker/TransactionSyncStreamWorker.js

@@ -22,7 +22,6 @@ class TransactionSyncStreamWorker extends Worker {
       gapLimit: 10,
       dependencies: [
         'importTransactions',
-        'importBlockHeader',
         'importInstantLock',
         'storage',
         'transport',
@@ -264,7 +263,9 @@ class TransactionSyncStreamWorker extends Worker {
 
 TransactionSyncStreamWorker.prototype.getAddressesToSync = require('./methods/getAddressesToSync');
 TransactionSyncStreamWorker.prototype.getBestBlockHeightFromTransport = require('./methods/getBestBlockHeight');
+TransactionSyncStreamWorker.prototype.setLastSyncedBlockHash = require('./methods/setLastSyncedBlockHash');
 TransactionSyncStreamWorker.prototype.setLastSyncedBlockHeight = require('./methods/setLastSyncedBlockHeight');
+TransactionSyncStreamWorker.prototype.getLastSyncedBlockHash = require('./methods/getLastSyncedBlockHash');
 TransactionSyncStreamWorker.prototype.getLastSyncedBlockHeight = require('./methods/getLastSyncedBlockHeight');
 TransactionSyncStreamWorker.prototype.startHistoricalSync = require('./methods/startHistoricalSync');
 TransactionSyncStreamWorker.prototype.handleTransactionFromStream = require('./methods/handleTransactionFromStream');

src/plugins/Workers/TransactionSyncStreamWorker/methods/getLastSyncedBlockHash.js

@@ -0,0 +1,15 @@
+const { WALLET_TYPES } = require('../../../../CONSTANTS');
+/**
+ * Return last synced block height
+ * @return {number}
+ */
+module.exports = function getLastSyncedBlockHeight() {
+  const { walletId } = this;
+  const accountsStore = this.storage.store.wallets[walletId].accounts;
+
+  const { blockHash } = (this.walletType === WALLET_TYPES.SINGLE_ADDRESS)
+    ? accountsStore[this.index.toString()]
+    : accountsStore[this.BIP44PATH.toString()];
+
+  return blockHash;
+};

src/plugins/Workers/TransactionSyncStreamWorker/methods/setLastSyncedBlockHash.js

@@ -0,0 +1,21 @@
+const { WALLET_TYPES } = require('../../../../CONSTANTS');
+
+/**
+ * Set last synced block hash
+ *
+ * @param  {string} hash
+ * @return {string}
+ */
+module.exports = function setLastSyncedBlockHash(hash) {
+  const { walletId } = this;
+  const accountsStore = this.storage.store.wallets[walletId].accounts;
+
+  const accountStore = (this.walletType === WALLET_TYPES.SINGLE_ADDRESS)
+    ? accountsStore[this.index.toString()]
+    : accountsStore[this.BIP44PATH.toString()];
+
+  accountStore.blockHash = hash;
+
+  this.storage.store.lastModified = +new Date();
+  return accountStore.blockHash;
+};

src/plugins/Workers/TransactionSyncStreamWorker/methods/setLastSyncedBlockHeight.js

@@ -16,5 +16,6 @@ module.exports = function setLastSyncedBlockHeight(blockHeight) {
 
   accountStore.blockHeight = blockHeight;
 
+  this.storage.store.lastModified = +new Date();
   return accountStore.blockHeight;
 };