refactor!: extract fetch to separate module (#2223)

BREAKING CHANGE: imports from `libp2p/fetch` should be updated to `@libp2p/fetch`

Author: achingbrain

.release-please.json

@@ -23,6 +23,7 @@
     "packages/peer-store": {},
     "packages/protocol-autonat": {},
     "packages/protocol-dcutr": {},
+    "packages/protocol-fetch": {},
     "packages/protocol-identify": {},
     "packages/protocol-perf": {},
     "packages/protocol-ping": {},

doc/migrations/v0.46-v1.0.0.md

@@ -9,6 +9,7 @@ A migration guide for refactoring your application code from libp2p `v0.46` to `
 - [Ping](#ping)
 - [Identify](#identify)
 - [DCUtR](#dcutr)
+- [Fetch](#fetch)
 - [KeyChain](#keychain)
 - [UPnPNat](#upnpnat)
 - [Plaintext](#plaintext)
@@ -117,7 +118,7 @@ import { dcutrService } from 'libp2p/dcutr'
 
 const node = await createLibp2p({
   services: {
-    identify: dcutrService()
+    dcutr: dcutrService()
   }
 })
 ```
@@ -135,6 +136,36 @@ const node = await createLibp2p({
 })
 ```
 
+## Fetch
+
+The Fetch service is now published in its own package.
+
+**Before**
+
+```ts
+import { createLibp2p } from 'libp2p'
+import { fetchService } from 'libp2p/fetch'
+
+const node = await createLibp2p({
+  services: {
+    fetch: fetchService()
+  }
+})
+```
+
+**After**
+
+```ts
+import { createLibp2p } from 'libp2p'
+import { fetch } from '@libp2p/fetch'
+
+const node = await createLibp2p({
+  services: {
+    fetch: fetch()
+  }
+})
+```
+
 ## KeyChain
 
 The KeyChain object is no longer included on Libp2p and must be instantiated explicitly if desired.

packages/libp2p/.aegir.js

@@ -18,7 +18,6 @@ export default {
       const { plaintext } = await import('@libp2p/plaintext')
       const { circuitRelayServer, circuitRelayTransport } = await import('@libp2p/circuit-relay-v2')
       const { identify } = await import('@libp2p/identify')
-      const { fetchService } = await import('./dist/src/fetch/index.js')
 
       const peerId = await createEd25519PeerId()
       const libp2p = await createLibp2p({
@@ -46,7 +45,6 @@ export default {
         ],
         services: {
           identify: identify(),
-          fetch: fetchService(),
           relay: circuitRelayServer({
             reservations: {
               maxReservations: Infinity

packages/libp2p/README.md

@@ -28,6 +28,20 @@
 
 > JavaScript implementation of libp2p, a modular peer to peer network stack
 
+# About
+
+Use the `createLibp2p` function to create a libp2p node.
+
+## Example
+
+```typescript
+import { createLibp2p } from 'libp2p'
+
+const node = await createLibp2p({
+  // ...other options
+})
+```
+
 # Project status
 
 We've come a long way, but this project is still in Alpha, lots of development is happening, API might change, beware of the Dragons 🐉..

packages/libp2p/package.json

@@ -21,22 +21,6 @@
   ],
   "type": "module",
   "types": "./dist/src/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "*",
-        "dist/*",
-        "dist/src/*",
-        "dist/src/*/index"
-      ],
-      "src/*": [
-        "*",
-        "dist/*",
-        "dist/src/*",
-        "dist/src/*/index"
-      ]
-    }
-  },
   "files": [
     "src",
     "dist",
@@ -47,10 +31,6 @@
     ".": {
       "types": "./dist/src/index.d.ts",
       "import": "./dist/src/index.js"
-    },
-    "./fetch": {
-      "types": "./dist/src/fetch/index.d.ts",
-      "import": "./dist/src/fetch/index.js"
     }
   },
   "eslintConfig": {
@@ -71,12 +51,6 @@
     "dep-check": "aegir dep-check",
     "prepublishOnly": "node scripts/update-version.js && npm run build",
     "build": "aegir build",
-    "generate": "run-s generate:proto:*",
-    "generate:proto:circuit-relay": "protons ./src/circuit-relay/pb/index.proto",
-    "generate:proto:dcutr": "protons ./src/dcutr/pb/message.proto",
-    "generate:proto:fetch": "protons ./src/fetch/pb/proto.proto",
-    "generate:proto:identify": "protons ./src/identify/pb/message.proto",
-    "generate:proto:plaintext": "protons ./src/insecure/pb/proto.proto",
     "test": "aegir test",
     "test:node": "aegir test -t node -f \"./dist/test/**/*.{node,spec}.js\" --cov",
     "test:chrome": "aegir test -t browser -f \"./dist/test/**/*.spec.js\" --cov",
@@ -108,7 +82,6 @@
     "it-drain": "^3.0.2",
     "it-filter": "^3.0.1",
     "it-first": "^3.0.1",
-    "it-length-prefixed": "^9.0.1",
     "it-map": "^3.0.3",
     "it-merge": "^3.0.0",
     "it-pipe": "^3.0.1",
@@ -118,7 +91,6 @@
     "p-defer": "^4.0.0",
     "p-queue": "^7.3.4",
     "private-ip": "^3.0.0",
-    "protons-runtime": "^5.0.0",
     "rate-limiter-flexible": "^3.0.0",
     "uint8arraylist": "^2.4.3",
     "uint8arrays": "^4.0.6"
@@ -145,11 +117,9 @@
     "execa": "^8.0.1",
     "go-libp2p": "^1.1.1",
     "it-pushable": "^3.2.0",
-    "npm-run-all": "^4.1.5",
     "p-event": "^6.0.0",
     "p-times": "^4.0.0",
     "p-wait-for": "^5.0.2",
-    "protons": "^7.0.2",
     "sinon": "^17.0.0",
     "sinon-ts": "^2.0.0"
   },