chore: update project config, licenses and readme files (#2848)

Updates licenses to include the full apache license so GitHub detects it properly. Update tsconfig cross-project references and dependency versions.
libp2p · Nov 28, 2024 · 49e4540 · 49e4540
1 parent 671bc47
commit 49e4540
Show file tree

Hide file tree

Showing 199 changed files with 8,703 additions and 826 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,17 +1,37 @@
 version: 2
 updates:
 - package-ecosystem: npm
-  directory: "/"
+  directories:
+    - "/"
+    - "/benchmarks/*"
+    - "/docs/*"
+    - "/examples/*"
+    - "/interop/*"
+    - "/packages/*"
   schedule:
     interval: daily
     time: "10:00"
   open-pull-requests-limit: 20
   commit-message:
     prefix: "deps"
-    prefix-development: "deps(dev)"
+    prefix-development: "chore"
+  groups:
+    helia-deps: # group all deps that should be updated when Helia deps need updated
+      patterns:
+        - "*helia*"
+        - "*libp2p*"
+        - "*multiformats*"
+    store-deps: # group all blockstore and datastore updates (interface & impl)
+      patterns:
+        - "*blockstore*"
+        - "*datastore*"
+    kubo-deps: # group kubo, kubo-rpc-client, and ipfsd-ctl updates
+      patterns:
+        - "*kubo*"
+        - "ipfsd-ctl"
 - package-ecosystem: "github-actions"
   directory: "/"
   schedule:
     interval: "weekly"
   commit-message:
-    prefix: ci
+    prefix: chore
diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml
@@ -17,7 +17,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
 
   test-examples:
     name: Test example ${{ matrix.example.name }}
@@ -120,6 +120,6 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
       - run: npx playwright install-deps
       - run: npx xvfb-maybe aegir test-dependant ${{ matrix.example.repo }} --deps ${{ join(matrix.example.deps, ',') }}
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -22,7 +22,7 @@ jobs:
     - uses: actions/setup-node@v4
       with:
         node-version: lts/*
-    - uses: ipfs/aegir/actions/cache-node-modules@master
+    - uses: ipfs/aegir/actions/cache-node-modules@main
       with:
         directories: ${{ env.CACHE_DIRS }}
 
@@ -34,7 +34,7 @@ jobs:
     - uses: actions/setup-node@v4
       with:
         node-version: lts/*
-    - uses: ipfs/aegir/actions/cache-node-modules@master
+    - uses: ipfs/aegir/actions/cache-node-modules@main
       with:
         directories: ${{ env.CACHE_DIRS }}
     - run: npm run --if-present lint
@@ -54,7 +54,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
         with:
           directories: ${{ env.CACHE_DIRS }}
       - run: npm run --if-present test:node
@@ -72,7 +72,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
         with:
           directories: ${{ env.CACHE_DIRS }}
       - run: npm run --if-present test:chrome
@@ -90,7 +90,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
         with:
           directories: ${{ env.CACHE_DIRS }}
       - run: npm run --if-present test:chrome-webworker
@@ -108,7 +108,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
         with:
           directories: ${{ env.CACHE_DIRS }}
       - run: npm run --if-present test:firefox
@@ -126,7 +126,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
         with:
           directories: ${{ env.CACHE_DIRS }}
       - run: npm run --if-present test:firefox-webworker
@@ -144,7 +144,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
         with:
           directories: ${{ env.CACHE_DIRS }}
       # https://github.com/actions/runner-images/issues/9733#issuecomment-2074590278
@@ -167,7 +167,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
         with:
           directories: ${{ env.CACHE_DIRS }}
       - run: npx xvfb-maybe npm run --if-present test:electron-main
@@ -185,7 +185,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
         with:
           directories: ${{ env.CACHE_DIRS }}
       - run: npx xvfb-maybe npm run --if-present test:electron-renderer
@@ -203,7 +203,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
         with:
           directories: ${{ env.CACHE_DIRS }}
       - run: npm run test:interop -- --bail
@@ -216,7 +216,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: lts/*
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
         with:
          directories: ${{ env.CACHE_DIRS }}
       - name: Build images
@@ -269,10 +269,10 @@ jobs:
         with:
           node-version: lts/*
           registry-url: 'https://registry.npmjs.org'
-      - uses: ipfs/aegir/actions/cache-node-modules@master
+      - uses: ipfs/aegir/actions/cache-node-modules@main
         with:
           directories: ${{ env.CACHE_DIRS }}
-      - uses: ipfs/aegir/actions/docker-login@master
+      - uses: ipfs/aegir/actions/docker-login@main
         with:
           docker-token: ${{ secrets.DOCKER_TOKEN }}
           docker-username: ${{ secrets.DOCKER_USERNAME }}

diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -2,38 +2,18 @@
   <a href="https://libp2p.io"><img width="250" src="https://github.com/libp2p/js-libp2p/blob/main/img/libp2p.png?raw=true" alt="libp2p hex logo" /></a>
 </h1>
 
-<h3 align="center">The JavaScript implementation of the libp2p Networking Stack.</h3>
-
-<p align="center">
-  <a href="http://protocol.ai"><img src="https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square" /></a>
-  <a href="http://libp2p.io/"><img src="https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square" /></a>
-  <a href="http://webchat.freenode.net/?channels=%23libp2p"><img src="https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square" /></a>
-  <a href="https://matrix.to/#/#libp2p-implementers:ipfs.io"><img src="https://img.shields.io/badge/matrix-%23libp2p--implementers%3Aipfs.io-blue.svg?style=flat-square" /> </a>
-  <a href="https://discord.gg/ipfs"><img src="https://img.shields.io/discord/806902334369824788?color=blueviolet&label=discord&style=flat-square" /></a>
-  <a href="https://discuss.libp2p.io"><img src="https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg" /></a>
-  <a href="https://www.npmjs.com/package/libp2p"><img src="https://img.shields.io/npm/dm/libp2p.svg" /></a>
-  <a href="https://www.jsdelivr.com/package/npm/libp2p"><img src="https://data.jsdelivr.com/v1/package/npm/libp2p/badge"/></a>
-</p>
-
-<p align="center">
-  <a href="https://github.com/libp2p/js-libp2p/actions?query=branch%3Amain+workflow%3ACI+"><img src="https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=main&label=ci&style=flat-square" /></a>
-  <a href="https://codecov.io/gh/libp2p/js-libp2p"><img src="https://img.shields.io/codecov/c/github/libp2p/js-libp2p/main.svg?style=flat-square"></a>
-  <br>
-  <a href="https://github.com/feross/standard"><img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square"></a>
-  <a href="https://github.com/RichardLitt/standard-readme"><img src="https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square" /></a>
-  <a href=""><img src="https://img.shields.io/badge/npm-%3E%3D7.0.0-orange.svg?style=flat-square" /></a>
-  <a href=""><img src="https://img.shields.io/badge/Node.js-%3E%3D15.0.0-orange.svg?style=flat-square" /></a>
-  <br>
-</p>
-
-# js-libp2p-monorepo <!-- omit in toc -->
+<h3 align="center">The JavaScript implementation of the libp2p Networking Stack</h3>
 
 [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![npm](https://img.shields.io/npm/dm/libp2p.svg)](https://www.npmjs.com/package/libp2p)
 [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
+[![Matrix](https://img.shields.io/badge/matrix-%23libp2p--implementers%3Aipfs.io-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![Discord](https://img.shields.io/discord/806902334369824788?color=blueviolet&label=discord&style=flat-squaree)](https://discord.com/invite/Ae4TbahHaT)
 [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
 [![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amain)
 
-> JavaScript implementation of libp2p, a modular peer to peer network stack
+> [!NOTE]
+> Are you tring to upgrade libp2p to the latest version?  Check out the [migrations guides](https://github.com/libp2p/js-libp2p/tree/main/doc/migrations) for any changes you need to make.
 
 ### Project status
 
@@ -43,29 +23,8 @@ The documentation in the main branch may contain changes from a pre-release.
 
 If you are looking for the documentation of the latest release, you can view the latest release on [**npm**](https://www.npmjs.com/package/libp2p), or select the tag in github that matches the version you are looking for.
 
-**Want to get started?** Check our [GETTING\_STARTED.md](https://github.com/libp2p/js-libp2p/blob/main/doc/GETTING_STARTED.md) guide and [examples](https://github.com/libp2p/js-libp2p-examples).
-
-**Want to update libp2p in your project?** Check our [migrations folder](https://github.com/libp2p/js-libp2p/tree/main/doc/migrations).
-
-## Table of contents <!-- omit in toc -->
-
-- [Background](#background)
-- [Roadmap](#roadmap)
-- [Install](#install)
-- [Usage](#usage)
-  - [Configuration](#configuration)
-  - [Limits](#limits)
-  - [Getting started](#getting-started)
-  - [Tutorials and Examples](#tutorials-and-examples)
-- [Structure](#structure)
-- [Development](#development)
-  - [Tests](#tests)
-    - [Run unit tests](#run-unit-tests)
-  - [Packages](#packages)
-- [Used by](#used-by)
-- [Contribute](#contribute)
-- [API Docs](#api-docs)
-- [License](#license)
+> [!TIP]
+> Just tring to figure out what this is all about? Check our [GETTING\_STARTED.md](https://github.com/libp2p/js-libp2p/blob/main/doc/GETTING_STARTED.md) guide and [examples](https://github.com/libp2p/js-libp2p-examples).
 
 ## Background
 

diff --git a/doc/package.json b/doc/package.json
@@ -24,7 +24,7 @@
     "doc-check": "aegir doc-check"
   },
   "devDependencies": {
-    "aegir": "^44.0.1"
+    "aegir": "^45.0.5"
   },
   "private": true
 }
diff --git a/doc/tsconfig.json b/doc/tsconfig.json
@@ -2,22 +2,5 @@
   "extends": "aegir/src/config/tsconfig.aegir.json",
   "compilerOptions": {
     "outDir": "dist"
-  },
-  "references": [
-    {
-      "path": "../packages/interface"
-    },
-    {
-      "path": "../packages/libp2p"
-    },
-    {
-      "path": "../packages/metrics-prometheus"
-    },
-    {
-      "path": "../packages/stream-multiplexer-mplex"
-    },
-    {
-      "path": "../packages/transport-tcp"
-    }
-  ]
+  }
 }
diff --git a/interop/package.json b/interop/package.json
@@ -19,21 +19,21 @@
   },
   "devDependencies": {
     "@chainsafe/libp2p-noise": "^16.0.0",
-    "@chainsafe/libp2p-yamux": "^7.0.0",
-    "@libp2p/circuit-relay-v2": "^3.0.0",
-    "@libp2p/interface": "^2.0.0",
-    "@libp2p/identify": "^3.0.0",
-    "@libp2p/mplex": "^11.0.0",
-    "@libp2p/ping": "^2.0.0",
-    "@libp2p/tcp": "^10.0.0",
-    "@libp2p/webrtc": "^5.0.0",
-    "@libp2p/websockets": "^9.0.0",
-    "@libp2p/webtransport": "^5.0.0",
-    "@multiformats/multiaddr": "^12.2.3",
-    "aegir": "^44.0.1",
-    "libp2p": "^2.0.0",
+    "@chainsafe/libp2p-yamux": "^7.0.1",
+    "@libp2p/circuit-relay-v2": "^3.1.3",
+    "@libp2p/interface": "^2.2.1",
+    "@libp2p/identify": "^3.0.12",
+    "@libp2p/mplex": "^11.0.13",
+    "@libp2p/ping": "^2.0.12",
+    "@libp2p/tcp": "^10.0.13",
+    "@libp2p/webrtc": "^5.0.19",
+    "@libp2p/websockets": "^9.0.13",
+    "@libp2p/webtransport": "^5.0.18",
+    "@multiformats/multiaddr": "^12.3.3",
+    "aegir": "^45.0.5",
+    "libp2p": "^2.3.1",
     "p-event": "^6.0.1",
-    "redis": "^4.6.14"
+    "redis": "^4.7.0"
   },
   "browser": {
     "@libp2p/tcp": false

diff --git a/package.json b/package.json
@@ -36,7 +36,7 @@
     "docs:no-publish": "aegir docs --publish false -- --exclude interop --exclude doc"
   },
   "devDependencies": {
-    "aegir": "^44.0.1",
+    "aegir": "^45.0.5",
     "npm-run-all": "^4.1.5"
   },
   "eslintConfig": {
@@ -49,8 +49,5 @@
     "doc",
     "interop",
     "packages/*"
-  ],
-  "overrides": {
-    "protons-runtime": "^5.5.0"
-  }
+  ]
 }
diff --git a/packages/auto-tls/LICENSE b/packages/auto-tls/LICENSE