Merge branch 'main' into feat/bun-run

ipfs-examples · Oct 24, 2024 · 0f6f0a3 · 0f6f0a3
2 parents 2a9ed6d + 880b2ce
commit 0f6f0a3
Show file tree

Hide file tree

Showing 27 changed files with 110 additions and 66 deletions.
diff --git a/examples/helia-101/101-basics.js b/examples/helia-101/101-basics.js
@@ -1,14 +1,23 @@
 /* eslint-disable no-console */
 
+import { createHeliaHTTP } from '@helia/http'
 import { unixfs } from '@helia/unixfs'
-import { createHelia } from 'helia'
 
 // create a Helia node
-const helia = await createHelia()
+const helia = await createHeliaHTTP()
 
 // create a filesystem on top of Helia, in this case it's UnixFS
 const fs = unixfs(helia)
 
+// add a file and wrap in a directory
+const readmeCid = await fs.addFile({
+  path: './README.md'
+}, {
+  wrapWithDirectory: true
+})
+
+console.log('Added README.md file:', readmeCid.toString())
+
 // we will use this TextEncoder to turn strings into Uint8Arrays
 const encoder = new TextEncoder()
 

diff --git a/examples/helia-101/301-networking.js b/examples/helia-101/301-networking.js
@@ -29,7 +29,7 @@ async function createNode () {
     transports: [
       tcp()
     ],
-    connectionEncryption: [
+    connectionEncrypters: [
       noise()
     ],
     streamMuxers: [
@@ -63,7 +63,7 @@ const node2 = await createNode()
 
 // connect them together
 const multiaddrs = node2.libp2p.getMultiaddrs()
-await node1.libp2p.dial(multiaddrs[0])
+await node1.libp2p.dial(multiaddrs)
 
 // create a filesystem on top of Helia, in this case it's UnixFS
 const fs = unixfs(node1)

diff --git a/examples/helia-101/README.md b/examples/helia-101/README.md
@@ -25,7 +25,7 @@
 - [Getting Started](#getting-started)
   - [Prerequisites](#prerequisites)
   - [Installation](#installation)
-  - [Running examples](#running-examples)
+  - [Running Examples](#running-examples)
 - [Usage](#usage)
   - [101 - Basics](#101---basics)
   - [201 - Storage](#201---storage)
@@ -206,7 +206,7 @@ const libp2p = await createLibp2p({
   transports: [
     webSockets()
   ],
-  connectionEncryption: [
+  connectionEncrypters: [
     noise()
   ],
   streamMuxers: [

diff --git a/examples/helia-101/package.json b/examples/helia-101/package.json
@@ -12,16 +12,17 @@
     "test": "test-node-example test/*"
   },
   "dependencies": {
-    "@chainsafe/libp2p-noise": "^15.0.0",
-    "@chainsafe/libp2p-yamux": "^6.0.1",
-    "@helia/unixfs": "^3.0.0",
-    "@libp2p/bootstrap": "^10.0.12",
-    "@libp2p/identify": "^1.0.14",
-    "@libp2p/tcp": "^9.0.12",
-    "blockstore-core": "^4.1.0",
-    "datastore-core": "^9.1.1",
-    "helia": "^4.0.1",
-    "libp2p": "^1.2.0"
+    "@chainsafe/libp2p-noise": "^16.0.0",
+    "@chainsafe/libp2p-yamux": "^7.0.1",
+    "@helia/http": "^2.0.0",
+    "@helia/unixfs": "^4.0.0",
+    "@libp2p/bootstrap": "^11.0.7",
+    "@libp2p/identify": "^3.0.7",
+    "@libp2p/tcp": "^10.0.8",
+    "blockstore-core": "^5.0.2",
+    "datastore-core": "^10.0.2",
+    "helia": "^5.0.0",
+    "libp2p": "^2.1.6"
   },
   "devDependencies": {
     "test-ipfs-example": "^1.3.0"

diff --git a/examples/helia-browser-verified-fetch/.github/pull_request_template.md b/examples/helia-browser-verified-fetch/.github/pull_request_template.md
@@ -0,0 +1,17 @@
+# ⚠️ IMPORTANT ⚠️
+
+# Please do not create a Pull Request for this repository
+
+The contents of this repository are automatically synced from the parent [Helia Examples Project](https://github.com/ipfs-examples/helia-examples) so any changes made to the standalone repository will be lost after the next sync.
+
+Please open a PR against [IPFS Examples](https://github.com/ipfs-examples/helia-examples) instead.
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the [Helia Examples Project](https://github.com/ipfs-examples/helia-examples)
+2. Create your Feature Branch (`git checkout -b feature/amazing-example`)
+3. Commit your Changes (`git commit -a -m 'feat: add some amazing example'`)
+4. Push to the Branch (`git push origin feature/amazing-example`)
+5. Open a Pull Request
diff --git a/examples/helia-browser-verified-fetch/.github/workflows/sync.yml b/examples/helia-browser-verified-fetch/.github/workflows/sync.yml
@@ -0,0 +1,19 @@
+name: pull
+
+on:
+  workflow_dispatch
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Pull from another repository
+        uses: ipfs-examples/actions-pull-directory-from-repo@main
+        with:
+          source-repo: ipfs-examples/helia-examples
+          source-folder-path: examples/${{ github.event.repository.name }}
+          source-branch: main
+          target-branch: main
+          git-username: github-actions
+          git-email: [email protected]
diff --git a/examples/helia-browser-verified-fetch/README.md b/examples/helia-browser-verified-fetch/README.md
@@ -12,8 +12,6 @@
   <a href="https://helia.io/modules/helia.html">Explore the docs</a>
   ·
   <a href="https://stackblitz.com/github/ipfs-examples/helia-examples/tree/main/examples/helia-browser-verified-fetch">View in Dev Environment</a>
-  .
-  <a href="https://verified-fetch.vercel.app/">View Demo</a>
   ·
   <a href="https://github.com/ipfs-examples/helia-examples/issues">Report Bug</a>
   ·

diff --git a/examples/helia-browser-verified-fetch/package.json b/examples/helia-browser-verified-fetch/package.json
@@ -2,6 +2,7 @@
   "name": "helia-browser-verified-fetch",
   "private": true,
   "version": "0.0.0",
+  "description": "Browser Verified Retrieval with @helia/verified-fetch",
   "type": "module",
   "scripts": {
     "clean": "rimraf ./dist",
@@ -12,7 +13,7 @@
     "test": "vite build -c ./test/vite.config.js && test-browser-example test"
   },
   "dependencies": {
-    "@helia/verified-fetch": "^1.3.2",
+    "@helia/verified-fetch": "^1.5.0",
     "@sgtpooki/file-type": "^1.0.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"

diff --git a/examples/helia-cjs/package.json b/examples/helia-cjs/package.json
@@ -12,8 +12,8 @@
     "test": "test-node-example test/*"
   },
   "dependencies": {
-    "@helia/unixfs": "^3.0.0",
-    "helia": "^4.0.1"
+    "@helia/unixfs": "^4.0.0",
+    "helia": "^5.0.0"
   },
   "devDependencies": {
     "test-ipfs-example": "^1.0.0"

diff --git a/examples/helia-create-car/package.json b/examples/helia-create-car/package.json
@@ -13,14 +13,14 @@
     "test": "npm run build && test-browser-example test"
   },
   "dependencies": {
-    "@helia/car": "^3.0.0",
-    "@helia/unixfs": "^3.0.0",
+    "@helia/car": "^4.0.0",
+    "@helia/unixfs": "^4.0.0",
     "@ipld/car": "^5.1.1",
-    "helia": "^4.0.1",
+    "helia": "^5.0.0",
     "prop-types": "^15.8.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rimraf": "^5.0.0"
+    "rimraf": "^6.0.1"
   },
   "devDependencies": {
     "@playwright/test": "^1.31.2",

diff --git a/examples/helia-electron/package.json b/examples/helia-electron/package.json
@@ -16,10 +16,10 @@
     "test": "xvfb-maybe test-node-example test/*"
   },
   "dependencies": {
-    "helia": "^4.0.1"
+    "helia": "^5.0.0"
   },
   "devDependencies": {
-    "electron": "^29.1.4",
+    "electron": "^32.1.2",
     "electron-rebuild": "^3.1.1",
     "test-ipfs-example": "^1.0.0",
     "xvfb-maybe": "^0.2.1"

diff --git a/examples/helia-esbuild/package.json b/examples/helia-esbuild/package.json
@@ -15,16 +15,16 @@
   },
   "browserslist": "last 1 Chrome version",
   "dependencies": {
-    "@helia/unixfs": "^3.0.0",
-    "helia": "^4.0.1"
+    "@helia/unixfs": "^4.0.0",
+    "helia": "^5.0.0"
   },
   "devDependencies": {
     "@babel/core": "^7.14.8",
     "@playwright/test": "^1.12.3",
-    "esbuild": "^0.20.0",
+    "esbuild": "^0.24.0",
     "playwright": "^1.12.3",
     "process": "^0.11.10",
-    "rimraf": "^5.0.0",
+    "rimraf": "^6.0.1",
     "test-ipfs-example": "^1.0.0"
   }
 }
diff --git a/examples/helia-jest-typescript/package.json b/examples/helia-jest-typescript/package.json
@@ -8,7 +8,7 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest"
   },
   "dependencies": {
-    "helia": "^4.0.1"
+    "helia": "^5.0.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.2",

diff --git a/examples/helia-jest/package.json b/examples/helia-jest/package.json
@@ -8,7 +8,7 @@
     "test": "NODE_OPTIONS=--experimental-vm-modules jest"
   },
   "dependencies": {
-    "helia": "^4.0.1"
+    "helia": "^5.0.0"
   },
   "devDependencies": {
     "jest": "^29.6.2"

diff --git a/examples/helia-lan-discovery/package.json b/examples/helia-lan-discovery/package.json
@@ -12,8 +12,8 @@
     "test2": "npm run client & npm run server"
   },
   "dependencies": {
-    "@helia/dag-cbor": "^3.0.0",
-    "helia": "^4.0.1",
+    "@helia/dag-cbor": "^4.0.0",
+    "helia": "^5.0.0",
     "it-length-prefixed-stream": "^1.1.6",
     "multiformats": "^13.0.1"
   }

diff --git a/examples/helia-nestjs/package.json b/examples/helia-nestjs/package.json
@@ -22,27 +22,27 @@
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
-    "helia": "^4.0.1",
+    "helia": "^5.0.0",
     "reflect-metadata": "^0.2.1",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
     "@nestjs/cli": "^10.0.0",
     "@nestjs/schematics": "^10.0.0",
     "@nestjs/testing": "^10.0.0",
-    "@types/express": "^4.17.17",
+    "@types/express": "^5.0.0",
     "@types/jest": "^29.5.2",
-    "@types/node": "^20.3.1",
+    "@types/node": "^22.7.4",
     "@types/supertest": "^6.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
     "eslint": "^8.42.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.0",
     "jest": "^29.5.0",
     "prettier": "^3.0.0",
     "source-map-support": "^0.5.21",
-    "supertest": "^6.3.3",
+    "supertest": "^7.0.0",
     "ts-jest": "^29.1.0",
     "ts-loader": "^9.4.3",
     "ts-node": "^10.9.1",

diff --git a/examples/helia-nestjs/tsconfig-check.aegir.json b/examples/helia-nestjs/tsconfig-check.aegir.json
diff --git a/examples/helia-nextjs/package.json b/examples/helia-nextjs/package.json
@@ -14,7 +14,7 @@
     "test": "npm run build && test-browser-example test"
   },
   "dependencies": {
-    "helia": "^4.0.1",
+    "helia": "^5.0.0",
     "next": "^14.1.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
@@ -25,7 +25,7 @@
     "eslint-config-next": "^14.1.0",
     "interface-datastore": "^8.2.0",
     "playwright": "^1.32.1",
-    "rimraf": "^5.0.0",
+    "rimraf": "^6.0.1",
     "test-ipfs-example": "^1.0.0"
   }
 }
diff --git a/examples/helia-parcel/package.json b/examples/helia-parcel/package.json
@@ -16,16 +16,16 @@
   },
   "browserslist": "last 1 Chrome version",
   "dependencies": {
-    "@helia/unixfs": "^3.0.0",
-    "helia": "^4.0.1"
+    "@helia/unixfs": "^4.0.0",
+    "helia": "^5.0.0"
   },
   "devDependencies": {
     "@babel/core": "^7.14.8",
     "@playwright/test": "^1.12.3",
     "parcel": "^2.9.1",
     "playwright": "^1.12.3",
     "process": "^0.11.10",
-    "rimraf": "^5.0.0",
+    "rimraf": "^6.0.1",
     "test-ipfs-example": "^1.0.0"
   },
   "@parcel/resolver-default": {

diff --git a/examples/helia-script-tag/package.json b/examples/helia-script-tag/package.json
@@ -19,7 +19,7 @@
     "@playwright/test": "^1.12.3",
     "playwright": "^1.12.3",
     "process": "^0.11.10",
-    "rimraf": "^5.0.0",
+    "rimraf": "^6.0.1",
     "test-ipfs-example": "^1.0.0",
     "vite": "^5.0.11"
   }

diff --git a/examples/helia-ts-node/package.json b/examples/helia-ts-node/package.json
@@ -9,7 +9,7 @@
     "test": "cross-env NODE_OPTIONS=\"--loader=ts-node/esm\" test-node-example test/*"
   },
   "dependencies": {
-    "helia": "^4.0.1"
+    "helia": "^5.0.0"
   },
   "devDependencies": {
     "cross-env": "^7.0.3",

diff --git a/examples/helia-typescript/package.json b/examples/helia-typescript/package.json
@@ -12,7 +12,7 @@
     "test": "npm run build && test-node-example test/*"
   },
   "dependencies": {
-    "helia": "^4.0.1"
+    "helia": "^5.0.0"
   },
   "devDependencies": {
     "test-ipfs-example": "^1.0.0",

diff --git a/examples/helia-vite/package.json b/examples/helia-vite/package.json
@@ -13,12 +13,12 @@
     "test": "npm run build && test-browser-example test"
   },
   "dependencies": {
-    "@helia/unixfs": "^3.0.0",
-    "helia": "^4.0.1",
+    "@helia/unixfs": "^4.0.0",
+    "helia": "^5.0.0",
     "prop-types": "^15.8.1",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "rimraf": "^5.0.0"
+    "rimraf": "^6.0.1"
   },
   "devDependencies": {
     "@playwright/test": "^1.31.2",

diff --git a/examples/helia-vue/README.md b/examples/helia-vue/README.md
@@ -67,7 +67,7 @@ Now open your browser at `http://localhost:5173`
 
 ## Usage
 
-In this example, you will find a boilerplate you can use to guide yourself into creating a react+vite app with helia, this provides a pattern to reuse the same client across components with the context API and suggests how to integrate it with custom hooks
+In this example, you will find a boilerplate you can use to guide yourself into creating a Vue+Vite app with Helia. This provides a pattern to reuse the same client across components using Vue's provide/inject feature and suggests how to integrate it with Vue composables.
 
 You should see the following:
 
@@ -112,4 +112,4 @@ Read the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of
 
 [cid]: https://docs.ipfs.tech/concepts/content-addressing  "Content Identifier"
 [Uint8Array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
-[libp2p]: https://libp2p.io
+[libp2p]: https://libp2p.io
diff --git a/examples/helia-vue/package.json b/examples/helia-vue/package.json
@@ -13,14 +13,14 @@
     "test": "npm run build && test-browser-example test"
   },
   "dependencies": {
-    "@helia/unixfs": "^3.0.0",
-    "helia": "^4.0.1",
+    "@helia/unixfs": "^4.0.0",
+    "helia": "^5.0.0",
     "it-all": "^3.0.1",
     "vue": "^3.2.47"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^5.0.3",
-    "rimraf": "^5.0.0",
+    "rimraf": "^6.0.1",
     "test-ipfs-example": "^1.0.0",
     "vite": "^5.0.11"
   }