chore: use new createNode() and createLink() from dag-pb

Author: rvagg

packages/ipfs-unixfs-exporter/package.json

@@ -58,7 +58,7 @@
   },
   "dependencies": {
     "@ipld/dag-cbor": "^6.0.4",
-    "@ipld/dag-pb": "^2.0.2",
+    "@ipld/dag-pb": "^2.1.0",
     "err-code": "^3.0.1",
     "hamt-sharding": "^2.0.0",
     "interface-blockstore": "^0.0.5",

packages/ipfs-unixfs-exporter/test/exporter-sharded.spec.js

@@ -238,25 +238,17 @@ describe('exporter sharded', function () {
   it('exports a file from a sharded directory inside a regular directory inside a sharded directory', async () => {
     const dirCid = await createShard(15)
 
-    const nodeBlockBuf = dagPb.encode({
-      Data: new UnixFS({ type: 'directory' }).marshal(),
-      Links: [{
-        Name: 'shard',
-        Tsize: 5,
-        Hash: dirCid
-      }]
-    })
+    const nodeBlock = dagPb.createNode(
+      new UnixFS({ type: 'directory' }).marshal(),
+      [dagPb.createLink('shard', 5, dirCid)])
+    const nodeBlockBuf = dagPb.encode(nodeBlock)
     const nodeBlockCid = CID.createV0(await sha256.digest(nodeBlockBuf))
     await block.put(nodeBlockCid, nodeBlockBuf)
 
-    const shardNodeBuf = dagPb.encode({
-      Data: new UnixFS({ type: 'hamt-sharded-directory' }).marshal(),
-      Links: [{
-        Name: '75normal-dir',
-        Tsize: nodeBlockBuf.length,
-        Hash: nodeBlockCid
-      }]
-    })
+    const sharedNode = dagPb.createNode(
+      new UnixFS({ type: 'hamt-sharded-directory' }).marshal(),
+      [dagPb.createLink('75normal-dir', nodeBlockBuf.length, nodeBlockCid)])
+    const shardNodeBuf = dagPb.encode(sharedNode)
     const shardNodeCid = CID.createV0(await sha256.digest(shardNodeBuf))
     await block.put(shardNodeCid, shardNodeBuf)
 

packages/ipfs-unixfs-exporter/test/exporter.spec.js

@@ -56,10 +56,7 @@ describe('exporter', () => {
       type: options.type,
       data: options.content
     })
-    const node = {
-      Data: file.marshal(),
-      Links: options.links
-    }
+    const node = dagPb.createNode(file.marshal(), options.links)
     const buf = dagPb.encode(node)
     const cid = CID.createV0(await sha256.digest(buf))
     await block.put(cid, buf)
@@ -147,19 +144,10 @@ describe('exporter', () => {
       const leaf = UnixFS.unmarshal(child.node.Data)
 
       file.addBlockSize(leaf.fileSize())
-
-      links.push({
-        Name: '',
-        Tsize: child.node.Data != null ? child.node.Data.length : 0,
-        Hash: child.cid
-      })
-    }
-
-    const node = {
-      Data: file.marshal(),
-      Links: links
+      links.push(dagPb.createLink('', child.node.Data != null ? child.node.Data.length : 0, child.cid))
     }
 
+    const node = dagPb.createNode(file.marshal(), links)
     const nodeBlock = dagPb.encode(node)
     const nodeCid = CID.createV0(await sha256.digest(nodeBlock))
     await block.put(nodeCid, nodeBlock)
@@ -265,19 +253,13 @@ describe('exporter', () => {
       type: 'raw',
       data: content.slice(0, 5)
     })
-    const chunkNode1 = {
-      Data: chunk1.marshal(),
-      Links: []
-    }
+    const chunkNode1 = dagPb.createNode(chunk1.marshal())
     const chunkBlock1 = dagPb.encode(chunkNode1)
     const chunkCid1 = CID.createV0(await sha256.digest(chunkBlock1))
     await block.put(chunkCid1, chunkBlock1)
 
     const chunk2 = new UnixFS({ type: 'raw', data: content.slice(5) })
-    const chunkNode2 = {
-      Data: chunk2.marshal(),
-      Links: []
-    }
+    const chunkNode2 = dagPb.createNode(chunk2.marshal())
     const chunkBlock2 = dagPb.encode(chunkNode2)
     const chunkCid2 = CID.createV0(await sha256.digest(chunkBlock2))
     await block.put(chunkCid2, chunkBlock2)
@@ -288,18 +270,9 @@ describe('exporter', () => {
     file.addBlockSize(5)
     file.addBlockSize(5)
 
-    const fileNode = dagPb.prepare({
-      Data: file.marshal(),
-      Links: [{
-        Name: '',
-        Tsize: chunkNode1.Data != null ? chunkNode1.Data.length : 0,
-        Hash: chunkCid1.toV0()
-      }, {
-        Name: '',
-        Tsize: chunkNode2.Data != null ? chunkNode2.Data.length : 0,
-        Hash: chunkCid2.toV0()
-      }]
-    })
+    const fileNode = dagPb.createNode(file.marshal(), [
+      dagPb.createLink('', chunkNode1.Data != null ? chunkNode1.Data.length : 0, chunkCid1.toV0()),
+      dagPb.createLink('', chunkNode2.Data != null ? chunkNode2.Data.length : 0, chunkCid2.toV0())])
     const fileBlock = dagPb.encode(fileNode)
     const fileCid = CID.createV0(await sha256.digest(fileBlock))
     await block.put(fileCid, fileBlock)
@@ -321,11 +294,7 @@ describe('exporter', () => {
     const chunk = await dagPut({ content: uint8ArrayConcat(await all(randomBytes(100))) })
     const result = await dagPut({
       content: uint8ArrayConcat(await all(randomBytes(100))),
-      links: [{
-        Name: '',
-        Tsize: chunk.node.Data != null ? chunk.node.Data.length : 0,
-        Hash: chunk.cid
-      }]
+      links: [dagPb.createLink('', chunk.node.Data != null ? chunk.node.Data.length : 0, chunk.cid)]
     })
 
     if (!result.file.data) {
@@ -1013,10 +982,7 @@ describe('exporter', () => {
   })
 
   it('errors we export a non-unixfs dag-pb node', async () => {
-    const dagpbBlock = dagPb.encode({
-      Data: Uint8Array.from([0, 1, 2, 3, 4]),
-      Links: []
-    })
+    const dagpbBlock = dagPb.encode(dagPb.createNode(Uint8Array.from([0, 1, 2, 3, 4])))
     const dagpbCid = CID.createV0(await sha256.digest(dagpbBlock))
     await block.put(dagpbCid, dagpbBlock)
 
@@ -1037,14 +1003,8 @@ describe('exporter', () => {
     })
     file.addBlockSize(100)
 
-    const dagpbBuffer = dagPb.encode({
-      Data: file.marshal(),
-      Links: [{
-        Name: '',
-        Tsize: cborBlock.length,
-        Hash: cborCid
-      }]
-    })
+    const dagpbBuffer = dagPb.encode(dagPb.createNode(file.marshal(),
+      [dagPb.createLink('', cborBlock.length, cborCid)]))
     const dagpbCid = CID.createV0(await sha256.digest(dagpbBuffer))
     await block.put(dagpbCid, dagpbBuffer)
 

packages/ipfs-unixfs-importer/package.json

@@ -47,7 +47,7 @@
     "util": "^0.12.3"
   },
   "dependencies": {
-    "@ipld/dag-pb": "^2.0.2",
+    "@ipld/dag-pb": "^2.1.0",
     "bl": "^5.0.0",
     "err-code": "^3.0.1",
     "hamt-sharding": "^2.0.0",

packages/ipfs-unixfs-importer/src/dag-builder/dir.js

@@ -2,7 +2,7 @@
 
 const { UnixFS } = require('ipfs-unixfs')
 const persist = require('../utils/persist')
-const { encode, prepare } = require('@ipld/dag-pb')
+const { encode, createNode } = require('@ipld/dag-pb')
 
 /**
  * @typedef {import('../types').Directory} Directory
@@ -18,7 +18,7 @@ const dirBuilder = async (item, blockstore, options) => {
     mode: item.mode
   })
 
-  const buffer = encode(prepare({ Data: unixfs.marshal() }))
+  const buffer = encode(createNode(unixfs.marshal()))
   const cid = await persist(buffer, blockstore, options)
   const path = item.path
 

packages/ipfs-unixfs-importer/src/dag-builder/file/buffer-importer.js

@@ -37,10 +37,7 @@ async function * bufferImporter (file, block, options) {
           mode: file.mode
         })
 
-        buffer = dagPb.encode({
-          Data: unixfs.marshal(),
-          Links: []
-        })
+        buffer = dagPb.encode(dagPb.createNode(unixfs.marshal()))
       }
 
       return {

packages/ipfs-unixfs-importer/src/dag-builder/file/index.js

@@ -3,7 +3,7 @@
 const errCode = require('err-code')
 const { UnixFS } = require('ipfs-unixfs')
 const persist = require('../../utils/persist')
-const { encode, prepare } = require('@ipld/dag-pb')
+const { encode, createNode, createLink } = require('@ipld/dag-pb')
 const parallelBatch = require('it-parallel-batch')
 const rawCodec = require('multiformats/codecs/raw')
 const dagPb = require('@ipld/dag-pb')
@@ -87,7 +87,7 @@ const reduce = (file, blockstore, options) => {
           data: buffer
         })
 
-        buffer = encode(prepare({ Data: leaf.unixfs.marshal() }))
+        buffer = encode(createNode(leaf.unixfs.marshal()))
 
         // // TODO vmx 2021-03-26: This is what the original code does, it checks
         // // the multihash of the original leaf node and uses then the same
@@ -148,12 +148,7 @@ const reduce = (file, blockstore, options) => {
         if (leaf.cid.code === rawCodec.code) {
           // node is a leaf buffer
           f.addBlockSize(leaf.size)
-
-          return {
-            Name: '',
-            Tsize: leaf.size,
-            Hash: leaf.cid
-          }
+          return createLink('', leaf.size, leaf.cid)
         }
 
         if (!leaf.unixfs || !leaf.unixfs.data) {
@@ -164,25 +159,18 @@ const reduce = (file, blockstore, options) => {
           f.addBlockSize(leaf.unixfs.data.length)
         }
 
-        return {
-          Name: '',
-          Tsize: leaf.size,
-          Hash: leaf.cid
-        }
+        return createLink('', leaf.size, leaf.cid)
       })
 
-    const node = {
-      Data: f.marshal(),
-      Links: links
-    }
-    const buffer = encode(prepare(node))
+    const node = createNode(f.marshal(), links)
+    const buffer = encode(node)
     const cid = await persist(buffer, blockstore, options)
 
     return {
       cid,
       path: file.path,
       unixfs: f,
-      size: buffer.length + node.Links.reduce((acc, curr) => acc + curr.Tsize, 0)
+      size: buffer.length + node.Links.reduce((acc, curr) => acc + (curr.Tsize || 0), 0)
     }
   }
 

packages/ipfs-unixfs-importer/src/dir-flat.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { encode, prepare } = require('@ipld/dag-pb')
+const { encode, createNode, createLink } = require('@ipld/dag-pb')
 const { UnixFS } = require('ipfs-unixfs')
 const Dir = require('./dir')
 const persist = require('./utils/persist')
@@ -90,11 +90,7 @@ class DirFlat extends Dir {
       }
 
       if (child.size != null && child.cid) {
-        links.push({
-          Name: children[i],
-          Tsize: child.size,
-          Hash: child.cid
-        })
+        links.push(createLink(children[i], child.size, child.cid))
       }
     }
 
@@ -105,8 +101,8 @@ class DirFlat extends Dir {
     })
 
     /** @type {PBNode} */
-    const node = { Data: unixfs.marshal(), Links: links }
-    const buffer = encode(prepare(node))
+    const node = createNode(unixfs.marshal(), links)
+    const buffer = encode(node)
     const cid = await persist(buffer, block, this.options)
     const size = buffer.length + node.Links.reduce(
       /**

packages/ipfs-unixfs-importer/src/dir-sharded.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { encode, prepare } = require('@ipld/dag-pb')
+const { encode, createNode, createLink } = require('@ipld/dag-pb')
 const { UnixFS } = require('ipfs-unixfs')
 const Dir = require('./dir')
 const persist = require('./utils/persist')
@@ -116,11 +116,7 @@ async function * flush (bucket, blockstore, shardRoot, options) {
         throw new Error('Could not flush sharded directory, no subshard found')
       }
 
-      links.push({
-        Name: labelPrefix,
-        Tsize: shard.size,
-        Hash: shard.cid
-      })
+      links.push(createLink(labelPrefix, shard.size, shard.cid))
       childrenSize += shard.size
     } else if (typeof child.value.flush === 'function') {
       const dir = child.value
@@ -133,12 +129,7 @@ async function * flush (bucket, blockstore, shardRoot, options) {
       }
 
       const label = labelPrefix + child.key
-      links.push({
-        Name: label,
-        Tsize: flushedDir.size,
-        Hash: flushedDir.cid
-      })
-
+      links.push(createLink(label, flushedDir.size, flushedDir.cid))
       childrenSize += flushedDir.size
     } else {
       const value = child.value
@@ -150,11 +141,7 @@ async function * flush (bucket, blockstore, shardRoot, options) {
       const label = labelPrefix + child.key
       const size = value.size
 
-      links.push({
-        Name: label,
-        Tsize: size,
-        Hash: value.cid
-      })
+      links.push(createLink(label, size, value.cid))
       childrenSize += size
     }
   }
@@ -171,11 +158,8 @@ async function * flush (bucket, blockstore, shardRoot, options) {
     mode: shardRoot && shardRoot.mode
   })
 
-  const node = {
-    Data: dir.marshal(),
-    Links: links
-  }
-  const buffer = encode(prepare(node))
+  const node = createNode(dir.marshal(), links)
+  const buffer = encode(node)
   const cid = await persist(buffer, blockstore, options)
   const size = buffer.length + childrenSize