refactor: support sync on multiple networks

Author: mvayngrib

lib/actions.js

@@ -1,8 +1,6 @@
 /** @module actions */
 
 const EventEmitter = require('events').EventEmitter
-const pick = require('lodash/pick')
-const extend = require('lodash/extend')
 const debug = require('debug')('tradle:actions')
 const protocol = require('@tradle/protocol')
 const typeforce = require('./typeforce')
@@ -76,7 +74,7 @@ module.exports = function (opts) {
       throw new Error('expected either both prevLink and sealPrevAddress or neither')
     }
 
-    const action = pick(data, WROTE_SEAL_COPY_PROPS)
+    const action = utils.pick(data, WROTE_SEAL_COPY_PROPS)
     action.status = SealStatus.sealed
     action.txId = tx.txId
     action.topic = topics.wroteseal
@@ -170,6 +168,8 @@ module.exports = function (opts) {
 
   function createWatch (watch, cb) {
     typeforce({
+      blockchain: typeforce.String,
+      networkName: typeforce.String,
       address: typeforce.String,
       link: typeforce.String,
       headerHash: typeforce.String,

lib/constants.js

@@ -4,7 +4,7 @@
  * @augments tradle/protocol/lib/constants
  */
 
-const extend = require('xtend/mutable')
+const extend = require('lodash/extend')
 const constants = require('@tradle/constants')
 const { TYPES } = constants
 

lib/dbs/addressBook.js

@@ -9,7 +9,6 @@ const subdown = require('subleveldown')
 const debug = require('debug')('tradle:addressBook')
 const indexer = require('feed-indexer')
 const protocol = require('@tradle/protocol')
-const clone = require('clone')
 // const LiveStream = require('level-live-stream')
 const constants = require('../constants')
 const PERMALINK = constants.PERMALINK
@@ -166,7 +165,7 @@ module.exports = function createAddressBook (opts) {
       const cached = getCachedBy(prop, val)
       if (cached) {
         // return defensive copy
-        return process.nextTick(() => cb(null, clone(cached)))
+        return process.nextTick(() => cb(null, utils.cloneDeep(cached)))
       }
 
       findOneByPropInDB(prop, val, cb)
@@ -223,7 +222,7 @@ module.exports = function createAddressBook (opts) {
       if (remove) cache.del(prop + val)
       else {
         // make defensive copy before storing
-        cache.set(prop + val, clone(identityInfo))
+        cache.set(prop + val, utils.cloneDeep(identityInfo))
       }
     }
   }

lib/dbs/watches.js

@@ -2,7 +2,6 @@
  * @module watchesDB
  */
 
-const extend = require('xtend')
 const collect = require('stream-collector')
 const typeforce = require('../typeforce')
 const subdown = require('subleveldown')

lib/errors.js

@@ -76,3 +76,10 @@ exports.WillNotSend = TypedError({
   property: null,
   value: null
 })
+
+exports.NoBlockchainAdapter = TypedError({
+  type: 'noblockchainadapter',
+  message: `missing blockchain adapter for blockchain "{blockchain}:{networkName}"`,
+  blockchain: null,
+  networkName: null
+})

lib/node.js

@@ -3,8 +3,6 @@
 const util = require('util')
 const EventEmitter = require('events').EventEmitter
 const path = require('path')
-const extend = require('xtend/mutable')
-const clone = require('xtend')
 const reemit = require('re-emitter')
 const map = require('map-stream')
 const mutexify = require('mutexify')
@@ -93,7 +91,8 @@ function Tradle (opts) {
   typeforce({
     network: types.network,
     dir: typeforce.String,
-    blockchain: typeforce.Object,
+    blockchain: typeforce.maybe(types.blockchain),
+    getBlockchainAdapter: typeforce.maybe(typeforce.Function),
     identity: types.identity,
     keeper: types.keeper,
     keys: typeforce.Array,
@@ -109,8 +108,8 @@ function Tradle (opts) {
     // }), opts.merkle)
   }, opts)
 
-  extend(this, DEFAULT_OPTS, opts)
   utils.bindFunctions(this)
+  utils.extend(this, DEFAULT_OPTS, opts)
 
   this.opts = opts
   this._levelOpts = { db: this.leveldown }
@@ -284,6 +283,21 @@ Tradle.prototype._init = function _init () {
   })
 }
 
+/**
+ * Overwritten by constructor opt getBlockchainAdapter
+ * @param  {{ blockchain, networkName }} opts [description]
+ */
+Tradle.prototype.getBlockchainAdapter = function (opts) {
+  if (this.blockchain) {
+    const { blockchain, networkName } = opts
+    if (blockchain === this.network.blockchain && networkName === this.network.name) {
+      return this.blockchain
+    }
+
+    this._debug('missing blockchain adapter', { blockchain, networkName })
+  }
+}
+
 /**
  * Log with a prefix
  * @private
@@ -464,7 +478,7 @@ Tradle.prototype.updateIdentity = function (opts, cb) {
   // })
 
   let { identity, keys } = opts
-  identity = extend(
+  identity = utils.extend(
     protocol.nextVersion(this.identity),
     identity,
     { [VERSION]: (this.identity[VERSION] || 0) + 1 }
@@ -857,9 +871,10 @@ Tradle.prototype._queueSend = function _queueSend (opts, cb) {
 
     self.seals.findOne('link', oLink, function (err, seal) {
       if (!err && seal.txId) {
+        // formatted per tradle.Seal model
         done(null, {
-          blockchain: self.network.blockchain,
-          network: self.network.name,
+          blockchain: seal.blockchain,
+          network: seal.networkName,
           basePubKey: seal.basePubKey.pub,
           link: seal.link,
           headerHash: seal.headerHash,
@@ -906,7 +921,7 @@ Tradle.prototype._queueSend = function _queueSend (opts, cb) {
       }
     })
 
-    const msg = utils.clone(opts.other || {}, meta, base)
+    const msg = utils.extend({}, opts.other || {}, meta, base)
     const seal = results.maybeGetSeal
     if (seal) msg.seal = seal
 
@@ -1100,6 +1115,10 @@ Tradle.prototype._receive = function _receive (msg, from, cb) {
         if (err) return cb(err)
         if (seal) {
           self.watchSeal({
+            chain: {
+              blockchain: seal.blockchain,
+              networkName: seal.network || seal.networkName
+            },
             headerHash: seal.headerHash,
             basePubKey: utils.getSealPubKey(seal)
           })
@@ -1156,6 +1175,8 @@ Tradle.prototype.seal = function seal (opts, cb) {
       // const sealPrevAddress = sealPrevPubKey &&
       //   utils.sealPrevAddress(basePubKey, link, self.networkName)
 
+      const blockchain = network.blockchain
+      const networkName = network.name
       const sealProps = {
         link,
         prevLink: object[PREVLINK],
@@ -1167,8 +1188,8 @@ Tradle.prototype.seal = function seal (opts, cb) {
         sealPubKey,
         sealPrevPubKey,
         amount: opts.amount,
-        blockchain: network.blockchain,
-        networkName: network.name
+        blockchain,
+        networkName
       }
 
       self.actions.writeSeal(sealProps, err => {
@@ -1177,7 +1198,14 @@ Tradle.prototype.seal = function seal (opts, cb) {
         cb(null, sealProps)
       })
 
-      self.watchSeal({ object, basePubKey })
+      self.watchSeal({
+        chain: {
+          blockchain,
+          networkName
+        },
+        object,
+        basePubKey
+      })
     })
   })
 }
@@ -1191,21 +1219,22 @@ Tradle.prototype.seal = function seal (opts, cb) {
  */
 Tradle.prototype.watchNextVersion = function (opts, cb) {
   typeforce({
+    chain: types.blockchainIdentifier,
     link: typeforce.maybe(typeforce.String),
     object: typeforce.maybe(typeforce.Object),
     headerHash: typeforce.maybe(typeforce.String),
     basePubKey: types.chainPubKey
   }, opts)
 
-  let { link, object, headerHash, basePubKey } = opts
+  let { chain, link, object, headerHash, basePubKey } = opts
   if (!headerHash) headerHash = protocol.headerHash(object)
   if (!link) link = utils.hexLink(object)
 
-  const { network } = this
-  const address = utils.sealPrevAddress({ network, basePubKey, headerHash })
+  const address = utils.sealPrevAddress({ network: this.network, basePubKey, headerHash })
   this._watch({
     // the next version's previous is the current version
     // the tx for next version will have a predictable seal based on the current version's link
+    chain,
     link,
     address,
     basePubKey,
@@ -1224,19 +1253,21 @@ Tradle.prototype.watchNextVersion = function (opts, cb) {
  */
 Tradle.prototype.watchSeal = function (opts, cb) {
   typeforce({
+    chain: types.blockchainIdentifier,
     link: typeforce.maybe(typeforce.String),
     object: typeforce.maybe(typeforce.Object),
     headerHash: typeforce.maybe(typeforce.String),
     basePubKey: types.chainPubKey
   }, opts)
 
-  let { link, object, headerHash, basePubKey } = opts
+  let { chain, link, object, headerHash, basePubKey } = opts
   if (!headerHash) headerHash = protocol.headerHash(object)
   if (!link) link = utils.hexLink(object)
 
   const { network } = this
   const address = utils.sealAddress({ network, basePubKey, headerHash })
   this._watch({
+    chain,
     link,
     address,
     basePubKey,
@@ -1249,6 +1280,8 @@ Tradle.prototype.watchSeal = function (opts, cb) {
  * watch an address for a seal for an object's current or next version
  * @private
  * @param  {Object}   opts
+ * @param  {string}   opts.blockchain blockchain to monitor
+ * @param  {string}   opts.networkName blockchain network to monitor
  * @param  {string}   opts.headerHash headerHash to monitor
  * @param  {Object}   opts.basePubKey [sealer's blockchain pubKey]{@link types#chainPubKey}
  * @param  {string}   opts.watchType  [watch type]{@link constants#watchType}
@@ -1259,6 +1292,7 @@ Tradle.prototype._watch = function (opts, cb) {
   const self = this
 
   typeforce({
+    chain: types.blockchainIdentifier,
     link: typeforce.String,
     headerHash: typeforce.String,
     basePubKey: types.chainPubKey,
@@ -1295,6 +1329,7 @@ Tradle.prototype._watch = function (opts, cb) {
   ], function (err) {
     if (err) return cb(err)
 
+    opts = inlineChain(opts)
     self.actions.createWatch(opts, cb)
   })
 }
@@ -1460,3 +1495,10 @@ function getLockId (identifier) {
 
   throw new Error('invalid lock id')
 }
+
+function inlineChain (opts) {
+  opts = utils.clone(opts)
+  utils.extend(opts, opts.chain)
+  delete opts.chain
+  return opts
+}

lib/partial.js

@@ -57,7 +57,7 @@ exports.from = function (object) {
 
 exports.verify = function (partial) {
   const proof = partial.proof.concat(partial.root).map(bufferizeMerkleNode)
-  const opts = utils.clone({ proof }, protocol.DEFAULT_MERKLE_OPTS)
+  const opts = utils.extend({ proof }, protocol.DEFAULT_MERKLE_OPTS)
   const verify = merkleProofs.verifier(opts)
   return partial.leaves.every(node => verify(node))
 }