feat: ipns over pubsub

Author: vasco-santos

README.md

@@ -304,6 +304,7 @@ Configure remote preload nodes. The remote will preload content added on this no
 Enable and configure experimental features.
 
 - `pubsub` (boolean): Enable libp2p pub-sub. (Default: `false`)
+- `ipnsPubsub` (boolean): Enable pub-sub on IPNS. (Default: `false`)
 - `sharding` (boolean): Enable directory sharding. Directories that have many child objects will be represented by multiple DAG nodes instead of just one. It can improve lookup performance when a directory has several thousand files or more. (Default: `false`)
 - `dht` (boolean): Enable KadDHT. **This is currently not interoperable with `go-ipfs`.**
 
@@ -554,6 +555,9 @@ The core API is grouped into several areas:
 - [name](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/NAME.md)
   - [`ipfs.name.publish(value, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/NAME.md#namepublish)
   - [`ipfs.name.resolve(value, [options], [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/NAME.md#nameresolve)
+  - [`ipfs.name.pubsub.cancel(arg, [callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/NAME.md#namepubsubcancel)
+  - [`ipfs.name.pubsub.state([callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/NAME.md#namepubsubstate)
+  - [`ipfs.name.pubsub.subs([callback])`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/NAME.md#namepubsubsubs)
 
 #### Crypto and Key Management
 

package.json

@@ -72,7 +72,7 @@
     "form-data": "^2.3.2",
     "hat": "0.0.3",
     "interface-ipfs-core": "~0.78.0",
-    "ipfsd-ctl": "~0.39.1",
+    "ipfsd-ctl": "~0.39.2",
     "mocha": "^5.2.0",
     "ncp": "^2.0.0",
     "nexpect": "~0.5.0",
@@ -86,13 +86,16 @@
   "dependencies": {
     "@nodeutils/defaults-deep": "^1.1.0",
     "async": "^2.6.1",
+    "base32.js": "~0.1.0",
     "big.js": "^5.1.2",
     "binary-querystring": "~0.1.2",
     "bl": "^2.0.1",
     "boom": "^7.2.0",
     "bs58": "^4.0.1",
     "byteman": "^1.3.5",
     "cids": "~0.5.3",
+    "datastore-core": "~0.4.0",
+    "datastore-pubsub": "~0.0.2",
     "debug": "^3.1.0",
     "err-code": "^1.1.2",
     "file-type": "^8.1.0",

src/cli/commands/daemon.js

@@ -25,6 +25,10 @@ module.exports = {
         type: 'boolean',
         default: false
       })
+      .option('enable-namesys-pubsub', {
+        type: 'boolean',
+        default: false
+      })
   },
 
   handler (argv) {

src/cli/commands/name/pubsub.js

@@ -0,0 +1,18 @@
+'use strict'
+
+/*
+Manage and inspect the state of the IPNS pubsub resolver.
+Note: this command is experimental and subject to change as the system is refined.
+*/
+module.exports = {
+  command: 'pubsub',
+
+  description: 'IPNS pubsub management.',
+
+  builder (yargs) {
+    return yargs.commandDir('pubsub')
+  },
+
+  handler (argv) {
+  }
+}

src/cli/commands/name/pubsub/cancel.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const print = require('../../../utils').print
+
+module.exports = {
+  command: 'cancel <name>',
+
+  describe: 'Cancel a name subscription.',
+
+  handler (argv) {
+    argv.ipfs.name.pubsub.cancel(argv.name, (err, result) => {
+      if (err) {
+        throw err
+      } else {
+        print(result.canceled ? 'canceled' : 'no subscription')
+      }
+    })
+  }
+}

src/cli/commands/name/pubsub/state.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const print = require('../../../utils').print
+
+module.exports = {
+  command: 'state',
+
+  describe: 'Query the state of IPNS pubsub.',
+
+  handler (argv) {
+    argv.ipfs.name.pubsub.state((err, result) => {
+      if (err) {
+        throw err
+      } else {
+        print(result.enabled ? 'enabled' : 'disabled')
+      }
+    })
+  }
+}

src/cli/commands/name/pubsub/subs.js

@@ -0,0 +1,21 @@
+'use strict'
+
+const print = require('../../../utils').print
+
+module.exports = {
+  command: 'subs',
+
+  describe: 'Show current name subscriptions.',
+
+  handler (argv) {
+    argv.ipfs.name.pubsub.subs((err, result) => {
+      if (err) {
+        throw err
+      } else {
+        result.strings.forEach((s) => {
+          print(s)
+        })
+      }
+    })
+  }
+}

src/core/components/init.js

@@ -7,6 +7,9 @@ const promisify = require('promisify-es6')
 const defaultConfig = require('../runtime/config-nodejs.js')
 const Keychain = require('libp2p-keychain')
 
+const IPNS = require('../ipns')
+const OfflineDatastore = require('../ipns/routing/offline-datastore')
+
 const addDefaultAssets = require('./init-assets')
 
 module.exports = function init (self) {
@@ -103,6 +106,13 @@ module.exports = function init (self) {
           cb(null, true)
         }
       },
+      // Setup offline routing for IPNS. This is primarily used for offline ipns modifications, such as the initializeKeyspace feature.
+      (_, cb) => {
+        const offlineDatastore = new OfflineDatastore(self._repo)
+
+        self._ipns = new IPNS(offlineDatastore, self)
+        cb(null, true)
+      },
       // add empty unixfs dir object (go-ipfs assumes this exists)
       (_, cb) => {
         if (opts.emptyRepo) {

src/core/components/libp2p.js

@@ -45,7 +45,7 @@ module.exports = function libp2p (self) {
               },
               EXPERIMENTAL: {
                 dht: get(opts.options, 'EXPERIMENTAL.dht', false),
-                pubsub: get(opts.options, 'EXPERIMENTAL.pubsub', false)
+                pubsub: get(opts.options, 'EXPERIMENTAL.pubsub', false) || get(opts.options, 'EXPERIMENTAL.ipnsPubsub', false)
               }
             },
             connectionManager: get(opts.options, 'connectionManager',

src/core/components/name-pubsub.js

@@ -0,0 +1,60 @@
+'use strict'
+
+const debug = require('debug')
+const errcode = require('err-code')
+const promisify = require('promisify-es6')
+
+const log = debug('jsipfs:name-pubsub')
+log.error = debug('jsipfs:name-pubsub:error')
+
+const isNamePubsubEnabled = (node) => (
+  node._options.EXPERIMENTAL.ipnsPubsub && node._libp2pNode._floodSub
+)
+
+module.exports = function namePubsub (self) {
+  return {
+    /**
+     * Query the state of IPNS pubsub.
+     *
+     * @returns {Promise|void}
+     */
+    state: promisify((callback) => {
+      callback(null, {
+        enabled: Boolean(isNamePubsubEnabled(self))
+      })
+    }),
+    /**
+     * Cancel a name subscription.
+     *
+     * @param {String} name subscription name.
+     * @param {function(Error)} [callback]
+     * @returns {Promise|void}
+     */
+    cancel: promisify((name, callback) => {
+      if (!isNamePubsubEnabled(self)) {
+        const errMsg = 'IPNS pubsub subsystem is not enabled'
+
+        log.error(errMsg)
+        return callback(errcode(errMsg, 'ERR_IPNS_PS_NOT_ENABLED'))
+      }
+
+      self._ipns.pubsub.cancel(name, callback)
+    }),
+    /**
+     * Show current name subscriptions.
+     *
+     * @param {function(Error)} [callback]
+     * @returns {Promise|void}
+     */
+    subs: promisify((callback) => {
+      if (!isNamePubsubEnabled(self)) {
+        const errMsg = 'IPNS pubsub subsystem is not enabled'
+
+        log.error(errMsg)
+        return callback(errcode(errMsg, 'ERR_IPNS_PS_NOT_ENABLED'))
+      }
+
+      self._ipns.pubsub.getSubscriptions(callback)
+    })
+  }
+}