feat: enable custom formats for server/client DAG (put|get) operations

packages/ipfs-cli/src/daemon.js

@@ -27,7 +27,13 @@ class Daemon {
     }
   }
 
-  async start () {
+  /**
+   * Starts the IPFS HTTP server
+   * @param {object} [opts] - specify advanced configuration
+   * @param {object} [opts.ipld.formats] - IPLD custom formats
+   * @return {Promise<HttpApi>}
+   */
+  async start (opts = {}) {
     log('starting')
 
     const repo = typeof this._options.repo === 'string' || this._options.repo == null
@@ -40,7 +46,7 @@ class Daemon {
 
     // start HTTP servers (if API or Gateway is enabled in options)
     const httpApi = new HttpApi(ipfs, ipfsOpts)
-    this._httpApi = await httpApi.start()
+    this._httpApi = await httpApi.start(opts)
 
     const httpGateway = new HttpGateway(ipfs, ipfsOpts)
     this._httpGateway = await httpGateway.start()

packages/ipfs-http-client/src/dag/get.js

@@ -4,23 +4,32 @@ const dagPB = require('ipld-dag-pb')
 const dagCBOR = require('ipld-dag-cbor')
 const raw = require('ipld-raw')
 const configure = require('../lib/configure')
-
-const resolvers = {
-  'dag-cbor': dagCBOR.resolver,
-  'dag-pb': dagPB.resolver,
-  raw: raw.resolver
-}
+const multicodec = require('multicodec')
 
 module.exports = configure((api, options) => {
   const getBlock = require('../block/get')(options)
   const dagResolve = require('./resolve')(options)
 
+  const formats = {
+    [multicodec.DAG_PB]: dagPB,
+    [multicodec.DAG_CBOR]: dagCBOR,
+    [multicodec.RAW]: raw
+  }
+
+  const ipldOptions = (options && options.ipld) || {}
+  const configuredFormats = (ipldOptions && ipldOptions.formats) || []
+  configuredFormats.forEach(format => {
+    formats[format.codec] = format
+  })
+
   return async (cid, options = {}) => {
     const resolved = await dagResolve(cid, options)
     const block = await getBlock(resolved.cid, options)
-    const dagResolver = resolvers[resolved.cid.codec]
 
-    if (!dagResolver) {
+    const codec = multicodec[resolved.cid.codec.toUpperCase().replace(/-/g, '_')]
+    const format = formats[codec]
+
+    if (!format) {
       throw Object.assign(
         new Error(`Missing IPLD format "${resolved.cid.codec}"`),
         { missingMulticodec: resolved.cid.codec }
@@ -31,6 +40,6 @@ module.exports = configure((api, options) => {
       resolved.remainderPath = '/'
     }
 
-    return dagResolver.resolve(block.data, resolved.remainderPath)
+    return format.resolver.resolve(block.data, resolved.remainderPath)
   }
 })

packages/ipfs-http-server/src/api/resources/dag.js

@@ -203,11 +203,19 @@ exports.put = {
         } else {
           const codec = multicodec[format.toUpperCase().replace(/-/g, '_')]
 
-          if (!IpldFormats[codec]) {
-            throw new Error(`Missing IPLD format "${codec}"`)
+          let ipldFormat = IpldFormats[codec]
+          if (!ipldFormat) {
+            // look at the passed config
+            const ipldOpts = (request.server.app.opts && request.server.app.opts.ipld) || {}
+            if (ipldOpts.formats) {
+              ipldFormat = ipldOpts.formats.find((f) => f.codec === codec)
+            }
           }
 
-          node = await IpldFormats[codec].util.deserialize(data)
+          if (!ipldFormat) {
+            throw new Error(`Missing IPLD format "${codec}"`)
+          }
+          node = await ipldFormat.util.deserialize(data)
         }
 
         return {

packages/ipfs-http-server/src/index.js

@@ -25,15 +25,15 @@ function hapiInfoToMultiaddr (info) {
   return toMultiaddr(uri)
 }
 
-async function serverCreator (serverAddrs, createServer, ipfs, cors) {
+async function serverCreator (serverAddrs, createServer, ipfs, cors, opts) {
   serverAddrs = serverAddrs || []
   // just in case the address is just string
   serverAddrs = Array.isArray(serverAddrs) ? serverAddrs : [serverAddrs]
 
   const servers = []
   for (const address of serverAddrs) {
     const addrParts = address.split('/')
-    const server = await createServer(addrParts[2], addrParts[4], ipfs, cors)
+    const server = await createServer(addrParts[2], addrParts[4], ipfs, cors, opts)
     await server.start()
     server.info.ma = hapiInfoToMultiaddr(server.info)
     servers.push(server)
@@ -49,7 +49,13 @@ class HttpApi {
     this._log.error = debug(LOG_ERROR)
   }
 
-  async start () {
+  /**
+   * Starts the IPFS HTTP server
+   * @param {object} [opts] - specify advanced configuration
+   * @param {object} [opts.ipld.formats] - IPLD custom formats
+   * @return {Promise<HttpApi>}
+   */
+  async start (opts = {}) {
     this._log('starting')
 
     const ipfs = this._ipfs
@@ -63,13 +69,13 @@ class HttpApi {
     this._apiServers = await serverCreator(apiAddrs, this._createApiServer, ipfs, {
       origin: config.API.HTTPHeaders['Access-Control-Allow-Origin'] || [],
       credentials: Boolean(config.API.HTTPHeaders['Access-Control-Allow-Credentials'])
-    })
+    }, opts)
 
     this._log('started')
     return this
   }
 
-  async _createApiServer (host, port, ipfs, cors) {
+  async _createApiServer (host, port, ipfs, cors, opts) {
     cors = {
       ...cors,
       additionalHeaders: ['X-Stream-Output', 'X-Chunked-Output', 'X-Content-Length'],
@@ -95,6 +101,7 @@ class HttpApi {
       compression: false
     })
     server.app.ipfs = ipfs
+    server.app.opts = opts
 
     await server.register({
       plugin: Pino,