fix: update for v0.10 DAG API, demonstrate BLOCK vs DAG

Ref: ipfs/js-ipfs#3917

Author: rvagg

examples/custom-ipld-formats/daemon-node.js

@@ -36,18 +36,24 @@ async function main () {
     hello: 'world'
   }
 
-  const cid = await client.dag.put(data, {
+  // we cannot use the DAG API to put a custom codec unless that codec is on
+  // the server and can handle our input data, but the BLOCK API accepts our
+  // encoded bytes and "format"
+  const encoded = codec.encode(data)
+  const cid = await client.block.put(encoded, {
     format: 'dag-test',
-    hashAlg: 'sha2-256'
+    mhtype: 'sha2-256'
   })
 
-  console.info(`Put ${JSON.stringify(data)} = CID(${cid})`)
+  console.info(`BLOCK Put ${JSON.stringify(data)} = CID(${cid})`)
 
-  const {
-    value
-  } = await client.dag.get(cid)
+  // as with PUT, we can't use the DAG API to get the block unless the server
+  // knows how about the codec, instead we use the BLOCK API to get the raw
+  // bytes and decode it locally
+  const bytes = await client.block.get(cid)
+  const value = codec.decode(bytes)
 
-  console.info(`Get CID(${cid}) = ${JSON.stringify(value)}`)
+  console.info(`BLOCK Get CID(${cid}) = ${JSON.stringify(value)}`)
 
   await daemon.stop()
 }

examples/custom-ipld-formats/in-process-node.js

@@ -25,18 +25,44 @@ async function main () {
     hello: 'world'
   }
 
-  const cid = await node.dag.put(data, {
-    format: 'dag-test',
-    hashAlg: 'sha2-256'
-  })
+  // we can use the DAG API for an in-process IPFS since we're adding the codec
+  // directly into IPFS which will do the encoding and decoding
+  const dagApi = async () => {
+    const cid = await node.dag.put(data, {
+      storeCodec: 'dag-test',
+      hashAlg: 'sha2-256'
+    })
+
+    console.info(`DAG Put ${JSON.stringify(data)} = CID(${cid})`)
+
+    const {
+      value
+    } = await node.dag.get(cid)
+
+    console.info(`DAG Get CID(${cid}) = ${JSON.stringify(value)}`)
+  }
+
+  // alternatively we can use the codec directly and put the encoded bytes
+  // into IPFS using the BLOCK API and then decode with the codec from the
+  // bytes fetched from IPFS
+  const blockApi = async () => {
+    const encoded = codec.encode(data)
+    const cid = await node.block.put(encoded, {
+      format: 'dag-test',
+      mhtype: 'sha2-256',
+      version: 1
+    })
 
-  console.info(`Put ${JSON.stringify(data)} = CID(${cid})`)
+    console.info(`BLOCK Put ${JSON.stringify(data)} = CID(${cid})`)
 
-  const {
-    value
-  } = await node.dag.get(cid)
+    const bytes = await node.block.get(cid)
+    const value = codec.decode(bytes)
+
+    console.info(`BLOCK Get CID(${cid}) = ${JSON.stringify(value)}`)
+  }
 
-  console.info(`Get CID(${cid}) = ${JSON.stringify(value)}`)
+  await dagApi()
+  await blockApi()
 
   await node.stop()
 }

examples/custom-ipld-formats/tests/test.js

@@ -1,18 +1,21 @@
 'use strict'
 
 const path = require('path')
-const { node } = require('test-util-ipfs-example');
+const { node } = require('test-util-ipfs-example')
 
 const testInProcessNode = async () => {
   await node.waitForOutput(
-    'Put {"hello":"world"} = CID(bagn7ofysecj2eolrvekol2wl6cuneukuzwrqtq6by4x3xgiu2r6gb46lnakyq)\n' +
-    'Get CID(bagn7ofysecj2eolrvekol2wl6cuneukuzwrqtq6by4x3xgiu2r6gb46lnakyq) = {"hello":"world"}', 'node', [path.resolve(__dirname, '../in-process-node.js')])
+    'DAG Put {"hello":"world"} = CID(bagn7ofysecj2eolrvekol2wl6cuneukuzwrqtq6by4x3xgiu2r6gb46lnakyq)\n' +
+    'DAG Get CID(bagn7ofysecj2eolrvekol2wl6cuneukuzwrqtq6by4x3xgiu2r6gb46lnakyq) = {"hello":"world"}\n' +
+    'BLOCK Put {"hello":"world"} = CID(bagn7ofysecj2eolrvekol2wl6cuneukuzwrqtq6by4x3xgiu2r6gb46lnakyq)\n' +
+    'BLOCK Get CID(bagn7ofysecj2eolrvekol2wl6cuneukuzwrqtq6by4x3xgiu2r6gb46lnakyq) = {"hello":"world"}',
+    'node', [path.resolve(__dirname, '../in-process-node.js')])
 }
 
 const testDaemonNode = async () => {
   await node.waitForOutput(
-    'Put {"hello":"world"} = CID(bagn7ofysecj2eolrvekol2wl6cuneukuzwrqtq6by4x3xgiu2r6gb46lnakyq)\n' +
-    'Get CID(bagn7ofysecj2eolrvekol2wl6cuneukuzwrqtq6by4x3xgiu2r6gb46lnakyq) = {"hello":"world"}', 'node', [path.resolve(__dirname, '../daemon-node.js')])
+    'BLOCK Put {"hello":"world"} = CID(bagn7ofysecj2eolrvekol2wl6cuneukuzwrqtq6by4x3xgiu2r6gb46lnakyq)\n' +
+    'BLOCK Get CID(bagn7ofysecj2eolrvekol2wl6cuneukuzwrqtq6by4x3xgiu2r6gb46lnakyq) = {"hello":"world"}', 'node', [path.resolve(__dirname, '../daemon-node.js')])
 }
 
 async function test () {
@@ -23,4 +26,4 @@ async function test () {
   await testDaemonNode()
 }
 
-test();
+test()