feat: upgrade to [email protected]

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?" }
 }
 ```

package-lock.json

@@ -17,8 +17,10 @@
     "async": "^2.6.1",
     "cids": "^0.7.1",
     "highlight.js": "^9.12.0",
-    "ipfs": "^0.39.0",
+    "ipfs": "^0.41.0",
     "ipfs-css": "^0.6.0",
+    "it-all": "^1.0.1",
+    "it-concat": "^1.0.0",
     "meta-marked": "^0.4.2",
     "monaco-editor": "^0.6.1",
     "new-github-issue-url": "^0.2.1",

package.json

@@ -107,6 +107,7 @@
 import Vue from 'vue'
 import CID from 'cids'
 import pTimeout from 'p-timeout'
+import all from 'it-all'
 import newGithubIssueUrl from 'new-github-issue-url'
 
 import { getTutorialByUrl, isTutorialPassed, getLesson } from '../utils/tutorials'
@@ -404,7 +405,7 @@ export default {
       } else {
         const ipfs = this.IPFSPromise.then(IPFS => {
           this.ipfsConstructor = IPFS
-          return new IPFS({ repo: Math.random().toString() })
+          return IPFS.create({ repo: Math.random().toString() })
         })
         return ipfs
       }
@@ -413,14 +414,14 @@ export default {
       // create a sample file for the user to read from, acessible at this CID:
       // QmWCscor6qWPdx53zEQmZvQvuWQYxx1ARRCXwYVE4s9wzJ
       /* eslint-disable no-new */
-      return ipfs.add(this.ipfsConstructor.Buffer.from('You did it!'))
+      return all(ipfs.add(this.ipfsConstructor.Buffer.from('You did it!')))
     },
     createTree: function (ipfs) {
       // create a sample directory for the user to read from, acessible at these CIDs:
       // top-level directory: QmcmnUvVV31txDfAddgAaNcNKbrtC2rC9FvkJphNWyM7gy
       // `fun` directory: QmPT14mWCteuybfrfvqas2L2oin1Y2NCbwzTh9cc33GM1r
       /* eslint-disable no-new */
-      return ipfs.add([
+      return all(ipfs.add([
         {
           content: this.ipfsConstructor.Buffer.from('¯\\_(ツ)_/¯'),
           path: 'shrug.txt'
@@ -433,7 +434,7 @@ export default {
           content: this.ipfsConstructor.Buffer.from('You did it!'),
           path: 'fun/success.txt'
         }
-      ], { wrapWithDirectory: true })
+      ], { wrapWithDirectory: true }))
     },
     resetCode: function () {
       // TRACK? User chose to reset code

src/components/Lesson.vue

@@ -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/01.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/0002-basics/02.js

@@ -1,15 +1,15 @@
-const validate = async (result, ipfs) => {
-  const correctHash = 'QmUNLLsPACCz1vLxQVkXqqLX5R1X345qqfHbsf67hvA3Nn'
+import utils from '../utils'
 
+const validate = async (result, ipfs) => {
   if (!result) {
     return { fail: 'Oops! You forgot to return a result :(' }
-  } 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?" }
-  } else if (!!result && result.hash === 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 hash (CID) even though it doesn't have contents yet. Every empty IPFS node has this exact same hash, because their non-existent contents are identical!",
-      log: result
+      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!",
+      log: utils.format.ipfsObject(result)
     }
   }
 }

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

@@ -21,7 +21,7 @@ await ipfs.files.stat('/stuff')
 
 This method returns an object with some essential data about our file or directory:
 
-* **hash** (a string with the cryptographic hash)
+* **cid** (the CID object)
 * **size** (an integer with the file or directory size in Bytes)
 * **cumulativeSize** (an integer with the size of the DAGNodes making up the file in Bytes)
 * **type** (a string that can be either `directory` or `file`)

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

@@ -1,3 +1,7 @@
+import all from 'it-all'
+
+import utils from '../utils'
+
 const validate = async (result, ipfs) => {
   // Validation will be done by matching filenames between the
   // uploadedFiles array and the files in IPFS and ensuring that the type of each
@@ -27,8 +31,7 @@ const validate = async (result, ipfs) => {
 
   let uploadedFiles = window.uploadedFiles || []
 
-  let ipfsFiles = await ipfs.files.ls('/', { long: true })
-  let log = JSON.stringify(ipfsFiles, null, 2)
+  let ipfsFiles = await all(ipfs.files.ls('/'))
 
   let uploadedFilenames = uploadedFiles.map(file => file.name.toString()).sort()
   let ipfsFilenames = ipfsFiles.map(file => file.name.toString()).sort()
@@ -39,7 +42,7 @@ const validate = async (result, ipfs) => {
     return {
       success: 'Success! You did it!',
       logDesc: 'This is the data that is now in your root directory in IPFS:',
-      log: log
+      log: ipfsFiles.map(utils.format.ipfsObject)
     }
   }
 

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

@@ -1,4 +1,6 @@
-Let's see `files.ls` in action! List the contents of your root directory ( `/` ). Be sure to use the `{ long: true }` option to ensure you can see all of the details about the files you've uploaded.
+Let's see `files.ls` in action! List the contents of your root directory ( `/` ).
 
 _Note: We've already included the code for adding your files to MFS, so you can
 focus on listing the contents of your directory._
+
+**Hint**: Don't forget that `files.ls` returns an Async Iterable, so don't forget to either use the `for await...of` loop or the `it-all` package to return the result.