fix: 0004/10 lesson update

Author: zebateira

DEVELOPING_TUTORIALS.md

@@ -377,7 +377,7 @@ If the object returned by your `validate` function has the property `fail`, the
 You may (optionally) use [markdown formatting](https://guides.github.com/features/mastering-markdown/) in your `fail` or `success` messages. For example, the following validation code:
 
 ```js
-} else if (result && !result.hash) {
+} else if (result && !result.cid) {
   return { fail: "That result doesn't look right. Are you sure you ran the `stat` method on your empty root directory?" }
 }
 ```

src/tutorials/0002-basics/01.js

@@ -9,8 +9,7 @@ const validate = async (result, ipfs) => {
     return { fail: 'Did not return a valid CID instance.' }
   }
 
-  const hash = 'bafyreicaoyussrycqolu4k2iaxleu2uakjlq57tuxq3djxn4wnyfp4yk3y'
-  if (result.toString() === hash) {
+  if (result.toString() === 'bafyreicaoyussrycqolu4k2iaxleu2uakjlq57tuxq3djxn4wnyfp4yk3y') {
     return { success: 'Everything works!' }
   } else {
     const obj = await ipfs.dag.get(result)

src/tutorials/0002-basics/02.js

@@ -9,8 +9,7 @@ const validate = async (result, ipfs) => {
     return { fail: 'Did not return a valid CID instance.' }
   }
 
-  const correctHash = 'bafyreibmdfd7c5db4kls4ty57zljfhqv36gi43l6txl44pi423wwmeskwy'
-  if (result.toString() === correctHash) {
+  if (result.toString() === 'bafyreibmdfd7c5db4kls4ty57zljfhqv36gi43l6txl44pi423wwmeskwy') {
     return { success: 'Everything works!' }
   } else {
     return { fail: `Your function returned a CID, but it doesn't have the right contents. Be sure to \`put\` an object with \`bar\` as the named link and \`cid\` as its value.` }

src/tutorials/0004-mutable-file-system/02.js

@@ -1,13 +1,11 @@
 import utils from '../utils'
 
 const validate = async (result, ipfs) => {
-  const correctHash = 'QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn'
-
   if (!result) {
     return { fail: 'Oops! You forgot to return a result :(' }
   } else if (!!result & !result.cid) {
     return { fail: "That result doesn't look right. Are you sure you ran the `stat` method on your empty root directory?" }
-  } else if (!!result && result.cid.toString() === correctHash) {
+  } else if (!!result && result.cid.toString() === 'QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn') {
     return {
       success: 'Success! You did it!',
       logDesc: "Here's the status of your root directory ( `/` ). Notice that it has a CID even though it doesn't have contents yet. Every empty IPFS node has this exact same CID, because their non-existent contents are identical!",

src/tutorials/0004-mutable-file-system/06.js

@@ -35,7 +35,7 @@ const code = `/* global ipfs */
 const run = async (files) => {
   // this code adds your uploaded files to IPFS
   await Promise.all(files.map(f => ipfs.files.write('/' + f.name, f, { create: true })))
-  const rootDirectoryContents = await ipfs.files.ls('/')
+  const rootDirectoryContents = await all(ipfs.files.ls('/'))
 
   const directoryStatus = // your code goes here
 

src/tutorials/0004-mutable-file-system/07.js

@@ -27,16 +27,16 @@ const validate = async (result, ipfs) => {
 
   /** CHECK FOR CORRECT /SOME/STUFF DIRECTORY **/
 
-  // Correct directory hash
-  const someStuffHash = 'QmVneuc3suf78aVdvFY3BW9HoiEfNxD7WB5zu1f9fbun3D' // /some/stuff/
-  // Common incorrect directory hashes
-  const emptyDirectoryHash = 'QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn' // empty /some/ OR /stuff/ directory
-  const stuffSomeHash = 'QmXHDGVf4VnHws1tNyEcyVKjHrtv927xceAG9RmBWMw8cf' // /stuff/some/
-
-  // Check whether array contains certain directory hash & certain directory name
-  function contains (certainHash, certainName) {
+  // Correct directory CID
+  const someStuffCID = 'QmVneuc3suf78aVdvFY3BW9HoiEfNxD7WB5zu1f9fbun3D' // /some/stuff/
+  // Common incorrect directory CIDs
+  const emptyDirectoryCID = 'QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn' // empty /some/ OR /stuff/ directory
+  const stuffSomeCID = 'QmXHDGVf4VnHws1tNyEcyVKjHrtv927xceAG9RmBWMw8cf' // /stuff/some/
+
+  // Check whether array contains certain directory CID & certain directory name
+  function contains (cid, name) {
     if (Array.isArray(result)) {
-      return result.some(file => (file.cid && file.cid.toString() === certainHash) && (file.name === certainName))
+      return result.some(file => (file.cid && file.cid.toString() === cid) && (file.name === name))
     }
   }
 
@@ -94,26 +94,26 @@ const validate = async (result, ipfs) => {
       logDesc: "Here's what's in your root directory:",
       log: ipfsFilesInRoot.map(utils.format.ipfsObject)
     }
-  } else if (contains(stuffSomeHash, 'stuff')) {
+  } else if (contains(stuffSomeCID, 'stuff')) {
     // created /stuff/some instead of /some/stuff
     return { fail: 'Uh oh. Looks like you created /stuff/some instead of `/some/stuff`.' }
-  } else if (contains(emptyDirectoryHash, 'stuff')) {
+  } else if (contains(emptyDirectoryCID, 'stuff')) {
     // created /stuff instead of /some/stuff.
     return { fail: 'Uh oh. Looks like you created /stuff instead of `/some/stuff`.' }
-  } else if (contains(emptyDirectoryHash, 'some')) {
+  } else if (contains(emptyDirectoryCID, 'some')) {
     // created /some instead of /some/stuff
     return { fail: 'Uh oh. Looks like you created /some instead of `/some/stuff`.' }
-  } else if (!contains(someStuffHash, 'some')) {
+  } else if (!contains(someStuffCID, 'some')) {
     // didn't create empty some/stuff
     return { fail: 'Uh oh. Looks like your directory doesn\'t contain an empty `/some/stuff/` directory.' }
-  } else if (contains(someStuffHash, 'some') && !contentsMatch) {
+  } else if (contains(someStuffCID, 'some') && !contentsMatch) {
     // created empty /some/stuff but other files are wrong (messed up write method)
     return {
       fail: 'Hmmm. You created a `/some/stuff` directory but something else is wrong. Did you accidentally edit the default `write` code so your other files weren\'t all added?',
       logDesc: "Here's what was returned by `ls` in your root directory.",
       log: ipfsFilesInRoot.map(utils.format.ipfsObject)
     }
-  } else if (contains(someStuffHash, 'some') && contentsMatch) {
+  } else if (contains(someStuffCID, 'some') && contentsMatch) {
     // filenames match and created empty some/stuff
     return {
       success: 'Success! Check out your directory contents below.',

src/tutorials/0004-mutable-file-system/09.js

@@ -38,12 +38,12 @@ const validate = async (result, ipfs) => {
   incorrectFilenames.push('QmWCscor6qWPdx53zEQmZvQvuWQYxx1ARRCXwYVE4s9wzJ')
   incorrectFilenames.sort()
 
-  // check for a file with hash QmWCscor6qWPdx53zEQmZvQvuWQYxx1ARRCXwYVE4s9wzJ
-  const someStuffHashes = someStuffFiles.map(file => file.cid.toString())
-  const someFileHasRightHash = someStuffHashes.includes('QmWCscor6qWPdx53zEQmZvQvuWQYxx1ARRCXwYVE4s9wzJ')
+  // check for a file with CID QmWCscor6qWPdx53zEQmZvQvuWQYxx1ARRCXwYVE4s9wzJ
+  const someStuffCIDs = someStuffFiles.map(file => file.cid.toString())
+  const someFileHasRightCID = someStuffCIDs.includes('QmWCscor6qWPdx53zEQmZvQvuWQYxx1ARRCXwYVE4s9wzJ')
 
   const returnedCorrectFilenames = JSON.stringify(correctFilenames) === JSON.stringify(someStuffFilenames)
-  const returnedHashAsFilename = JSON.stringify(incorrectFilenames) === JSON.stringify(someStuffFilenames)
+  const returnedCIDAsFilename = JSON.stringify(incorrectFilenames) === JSON.stringify(someStuffFilenames)
 
   const log = someStuffFiles.map(utils.format.ipfsObject)
 
@@ -53,10 +53,10 @@ const validate = async (result, ipfs) => {
       logDesc: "Did you get the desination path wrong in your `files.cp` command? Here's what's in your `/some/stuff` directory now:",
       log
     }
-  } else if (someFileHasRightHash && returnedHashAsFilename) {
+  } else if (someFileHasRightCID && returnedCIDAsFilename) {
     return {
       fail: 'You forgot to specify a filename.',
-      logDesc: 'Check out the contents of your `/some/stuff` directory. You successfully copied the file but forgot to give it a name, so IPFS set its name equal to its hash. Try adding a filename to your destination path.',
+      logDesc: 'Check out the contents of your `/some/stuff` directory. You successfully copied the file but forgot to give it a name, so IPFS set its name equal to its CID. Try adding a filename to your destination path.',
       log
     }
   } else if (!returnedCorrectFilenames) {
@@ -65,13 +65,13 @@ const validate = async (result, ipfs) => {
       logDesc: "Here's what's in your `/some/stuff` directory:",
       log
     }
-  } else if (returnedCorrectFilenames && !someFileHasRightHash) {
+  } else if (returnedCorrectFilenames && !someFileHasRightCID) {
     return {
-      fail: 'That new file has the wrong hash.',
-      logDesc: "Check out the contents of your `/some/stuff` directory. You created a file called `success.txt` but it doesn't have the hash we're looking for.",
+      fail: 'That new file has the wrong CID.',
+      logDesc: "Check out the contents of your `/some/stuff` directory. You created a file called `success.txt` but it doesn't have the CID we're looking for.",
       log
     }
-  } else if (returnedCorrectFilenames && someFileHasRightHash) {
+  } else if (returnedCorrectFilenames && someFileHasRightCID) {
     return {
       success: 'Success! You did it!',
       logDesc: 'This is the data that is now in your `/some/stuff` directory in IPFS:',

src/tutorials/0004-mutable-file-system/09.md

@@ -38,7 +38,7 @@ await ipfs.files.cp('/source-directory', '/destination-directory')
 await ipfs.files.cp('/ipfs/QmWGeRAEgtsHW3ec7U4qW2CyVy7eA2mFRVbk1nb24jFyks', '/destination-directory')
 ```
 
-*Gotcha!* If you copy a file from an IPFS path without explicitly assigning it a filename, IPFS will set its `name` property equal to its `hash`. To specify a more friendly filename, you'll need to append it to the destination path like so:
+*Gotcha!* If you copy a file from an IPFS path without explicitly assigning it a filename, IPFS will set its `name` property equal to its `CID`. To specify a more friendly filename, you'll need to append it to the destination path like so:
 ```js
 await ipfs.files.cp('/ipfs/QmWGeRAEgtsHW3ec7U4qW2CyVy7eA2mFRVbk1nb24jFyks', '/destination-directory/fab-file.txt')
 ```

src/tutorials/0004-mutable-file-system/10.js

@@ -23,15 +23,16 @@ const validate = async (result, ipfs) => {
 }
 
 const code = `/* global ipfs */
+const all = require('it-all')
 
 const run = async (files) => {
   await Promise.all(files.map(f => ipfs.files.write('/' + f.name, f, { create: true })))
   await ipfs.files.mkdir('/some/stuff', { parents: true })
-  let rootDirectoryContents = await ipfs.files.ls('/', { long: true })
+  let rootDirectoryContents = await all(ipfs.files.ls('/'))
   const filepathsToMove = rootDirectoryContents.filter(file => file.type === 0).map(file => '/' + file.name)
   await ipfs.files.mv(filepathsToMove, '/some/stuff')
   await ipfs.files.cp('/ipfs/QmWCscor6qWPdx53zEQmZvQvuWQYxx1ARRCXwYVE4s9wzJ', '/some/stuff/success.txt')
-  let someStuffDirectoryContents = await ipfs.files.ls('/some/stuff', { long: true })
+  let someStuffDirectoryContents = await all(ipfs.files.ls('/some/stuff'))
 
   let secretMessage = // your code goes here
 
@@ -42,24 +43,31 @@ return run
 `
 
 const solution = `/* global ipfs */
+const all = require('it-all')
+const concat = require('it-concat')
 
 const run = async (files) => {
   await Promise.all(files.map(f => ipfs.files.write('/' + f.name, f, { create: true })))
   await ipfs.files.mkdir('/some/stuff', { parents: true })
-  let rootDirectoryContents = await ipfs.files.ls('/', { long: true })
+  let rootDirectoryContents = await all(ipfs.files.ls('/'))
   const filepathsToMove = rootDirectoryContents.filter(file => file.type === 0).map(file => '/' + file.name)
   await ipfs.files.mv(filepathsToMove, '/some/stuff')
   await ipfs.files.cp('/ipfs/QmWCscor6qWPdx53zEQmZvQvuWQYxx1ARRCXwYVE4s9wzJ', '/some/stuff/success.txt')
-  let someStuffDirectoryContents = await ipfs.files.ls('/some/stuff', { long: true })
+  let someStuffDirectoryContents = await all(ipfs.files.ls('/some/stuff'))
 
-  let secretMessage = (await ipfs.files.read('/some/stuff/success.txt')).toString('utf8')
+  let secretMessage = (await concat(ipfs.files.read('/some/stuff/success.txt'))).toString('utf8')
 
   return secretMessage
 }
 
 return run
 `
 
+const modules = {
+  'it-all': require('it-all'),
+  'it-concat': require('it-concat')
+}
+
 const options = {
   overrideErrors: true,
   createTestFile: true
@@ -69,5 +77,6 @@ export default {
   validate,
   code,
   solution,
+  modules,
   options
 }

src/tutorials/0004-mutable-file-system/11.js

@@ -1,15 +1,19 @@
+import all from 'it-all'
+
+import utils from '../utils'
+
 const validate = async (result, ipfs) => {
-  const rootDirectoryContents = await ipfs.files.ls('/', { long: true })
+  const rootDirectoryContents = await all(ipfs.files.ls('/'))
   const rootDirectoryStatus = await ipfs.files.stat('/')
-  const rootIsEmpty = rootDirectoryStatus.hash === 'QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn'
+  const rootIsEmpty = rootDirectoryStatus.cid && rootDirectoryStatus.cid.toString() === 'QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn'
 
   let rootContainsSome = rootDirectoryContents.length === 1 && rootDirectoryContents[0].name === 'some'
   let someContainsStuff = null
   let someIsEmpty = null
   let someDirectoryContents = null
 
   if (rootContainsSome) {
-    someDirectoryContents = await ipfs.files.ls('/some', { long: true })
+    someDirectoryContents = await all(ipfs.files.ls('/some'))
     someContainsStuff = someDirectoryContents.length === 1 && someDirectoryContents[0].name === 'stuff'
     someIsEmpty = someDirectoryContents.length === 0
   }
@@ -21,7 +25,7 @@ const validate = async (result, ipfs) => {
       fail: 'Oops! You tried to remove a non-empty directory and it didn\'t work because you forgot to use `{ recursive: true }`.',
       overrideError: true
     }
-  } else if (!rootDirectoryStatus.hash) {
+  } else if (!rootDirectoryStatus.cid) {
     return { fail: 'Your root directory doesn\'t look right. Are you sure you ran the `files.rm` method on your `/some` directory with the option `{ recursive: true }`?' }
   } else if (result instanceof Error && result.message === 'Cannot delete root') {
     return {
@@ -42,57 +46,61 @@ const validate = async (result, ipfs) => {
     return {
       fail: 'Your root directory isn\'t empty. Are you sure you ran the `files.rm` method on your `/some` directory with the option `{ recursive: true }`?',
       logDesc: 'Here are the current contents of your root directory:',
-      log: JSON.stringify(rootDirectoryContents, null, 2)
+      log: rootDirectoryContents.map(utils.format.ipfsObject)
     }
   } else if (rootIsEmpty) {
     return {
       success: 'Success! You\'ve completed this series of lessons!',
       logDesc: "Your function returned an empty array (`[]`) as there is no content in your root directory. Its status (`stat`) is shown below. Note that we're back to exactly the same CID we started with!",
-      log: JSON.stringify(rootDirectoryStatus, null, 2)
+      log: utils.format.ipfsObject(rootDirectoryStatus)
     }
   }
 }
 
 const code = `/* global ipfs */
+const all = require('it-all')
 
 const run = async (files) => {
   await Promise.all(files.map(f => ipfs.files.write('/' + f.name, f, { create: true })))
   await ipfs.files.mkdir('/some/stuff', { parents: true })
-  let rootDirectoryContents = await ipfs.files.ls('/', { long: true })
+  let rootDirectoryContents = await all(ipfs.files.ls('/'))
   const filepathsToMove = rootDirectoryContents.filter(file => file.type === 0).map(file => '/' + file.name)
   await ipfs.files.mv(filepathsToMove, '/some/stuff')
   await ipfs.files.cp('/ipfs/QmWCscor6qWPdx53zEQmZvQvuWQYxx1ARRCXwYVE4s9wzJ', '/some/stuff/success.txt')
-  let someStuffDirectoryContents = await ipfs.files.ls('/some/stuff', { long: true })
+  let someStuffDirectoryContents = await all(ipfs.files.ls('/some/stuff'))
 
   // Your code goes here
 
-  let finalRootDirectoryContents = await ipfs.files.ls('/', { long: true })
+  let finalRootDirectoryContents = await all(ipfs.files.ls('/'))
   return finalRootDirectoryContents
 }
 
 return run
 `
 
 const solution = `/* global ipfs */
+const all = require('it-all')
 
 const run = async (files) => {
   await Promise.all(files.map(f => ipfs.files.write('/' + f.name, f, { create: true })))
   await ipfs.files.mkdir('/some/stuff', { parents: true })
-  let rootDirectoryContents = await ipfs.files.ls('/', { long: true })
+  let rootDirectoryContents = await all(ipfs.files.ls('/'))
   const filepathsToMove = rootDirectoryContents.filter(file => file.type === 0).map(file => '/' + file.name)
   await ipfs.files.mv(filepathsToMove, '/some/stuff')
   await ipfs.files.cp('/ipfs/QmWCscor6qWPdx53zEQmZvQvuWQYxx1ARRCXwYVE4s9wzJ', '/some/stuff/success.txt')
-  let someStuffDirectoryContents = await ipfs.files.ls('/some/stuff', { long: true })
+  let someStuffDirectoryContents = await all(ipfs.files.ls('/some/stuff'))
 
   await ipfs.files.rm('/some', { recursive: true })
 
-  let finalRootDirectoryContents = await ipfs.files.ls('/', { long: true })
+  let finalRootDirectoryContents = await all(ipfs.files.ls('/'))
   return finalRootDirectoryContents
 }
 
 return run
 `
 
+const modules = { 'it-all': require('it-all') }
+
 const options = {
   overrideErrors: true,
   createTestFile: true
@@ -102,5 +110,6 @@ export default {
   validate,
   code,
   solution,
+  modules,
   options
 }

src/tutorials/0005-regular-files-api/06.md

@@ -23,7 +23,7 @@ The `ls` method in the Regular Files API returns an array of objects, one for ea
 
 ```javascript
 {
-  "hash": string,
+  "cid": Object,
   "path": string,
   "name": string,
   "depth": number,

src/tutorials/0005-regular-files-api/08.md

@@ -13,7 +13,7 @@ The result is an array of objects, one per file or directory, with the following
 
 ```javascript
 {
-    hash: string,
+    cid: Object,
     name: string,
     path: string,
     depth: number,