feat!: update helia to v3 and multiformats to v13 (#167)

Updates all deps and fixes linting errors.

Renames the `dht` routing to `libp2p` since it's used any and all configured libp2p Content Routers instead of the low-level DHT interface for several releases now.

BREAKING CHANGE: uses multiformats v13 and helia v3, renames `dht` routing to `libp2p`

.github/dependabot.yml

@@ -5,7 +5,7 @@ updates:
   schedule:
     interval: daily
     time: "10:00"
-  open-pull-requests-limit: 10
+  open-pull-requests-limit: 20
   commit-message:
     prefix: "deps"
     prefix-development: "deps(dev)"

.github/workflows/js-test-and-release.yml

@@ -9,7 +9,9 @@ on:
 
 permissions:
   contents: write
+  id-token: write
   packages: write
+  pull-requests: write
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event_name == 'push' && github.sha || github.ref }}

.github/workflows/semantic-pull-request.yml

@@ -0,0 +1,12 @@
+name: Semantic PR
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    uses: pl-strflt/.github/.github/workflows/[email protected]

.github/workflows/stale.yml

@@ -0,0 +1,13 @@
+name: Close and mark stale issue
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  stale:
+    uses: pl-strflt/.github/.github/workflows/[email protected]

.gitignore

@@ -7,6 +7,3 @@ node_modules
 package-lock.json
 yarn.lock
 .vscode
-.env
-.envrc
-.tool-versions

README.md

@@ -13,30 +13,23 @@
 
 > An implementation of IPNS for Helia
 
-## Table of contents <!-- omit in toc -->
-
-- [Structure](#structure)
-- [API Docs](#api-docs)
-- [License](#license)
-- [Contribute](#contribute)
-
-## Structure
+# Packages
 
 - [`/packages/interop`](./packages/interop) Interop tests for @helia/ipns
 - [`/packages/ipns`](./packages/ipns) An implementation of IPNS for Helia
 
-## API Docs
+# API Docs
 
 - <https://ipfs.github.io/helia-ipns>
 
-## License
+# License
 
 Licensed under either of
 
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribute
+# Contribute
 
 Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-ipns/issues).
 

package.json

@@ -11,6 +11,10 @@
   "bugs": {
     "url": "https://github.com/ipfs/helia-ipns/issues"
   },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "keywords": [
     "ipfs"
   ],
@@ -36,7 +40,7 @@
     "docs:no-publish": "NODE_OPTIONS=--max_old_space_size=8192 aegir docs --publish false -- --exclude packages/interop"
   },
   "devDependencies": {
-    "aegir": "^41.1.14",
+    "aegir": "^42.0.1",
     "npm-run-all": "^4.1.5"
   },
   "type": "module",

packages/interop/README.md

@@ -13,35 +13,14 @@
 
 > Interop tests for @helia/ipns
 
-## Table of contents <!-- omit in toc -->
-
-- [Install](#install)
-  - [Browser `<script>` tag](#browser-script-tag)
-- [License](#license)
-- [Contribute](#contribute)
-
-## Install
-
-```console
-$ npm i @helia/ipns-interop
-```
-
-### Browser `<script>` tag
-
-Loading this module through a script tag will make it's exports available as `HeliaIpnsInterop` in the global namespace.
-
-```html
-<script src="https://unpkg.com/@helia/ipns-interop/dist/index.min.js"></script>
-```
-
-## License
+# License
 
 Licensed under either of
 
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribute
+# Contribute
 
 Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-ipns/issues).
 

packages/interop/package.json

@@ -3,14 +3,18 @@
   "version": "0.0.0",
   "description": "Interop tests for @helia/ipns",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/ipfs/helia-ipns/tree/master/packages/interop#readme",
+  "homepage": "https://github.com/ipfs/helia-ipns/tree/main/packages/interop#readme",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ipfs/helia-ipns.git"
   },
   "bugs": {
     "url": "https://github.com/ipfs/helia-ipns/issues"
   },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "keywords": [
     "IPFS"
   ],
@@ -49,32 +53,34 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "devDependencies": {
-    "@chainsafe/libp2p-gossipsub": "^10.1.0",
-    "@chainsafe/libp2p-noise": "^13.0.0",
-    "@chainsafe/libp2p-yamux": "^5.0.0",
-    "@helia/interface": "^2.0.0",
+    "@chainsafe/libp2p-gossipsub": "^11.0.1",
+    "@chainsafe/libp2p-noise": "^14.1.0",
+    "@chainsafe/libp2p-yamux": "^6.0.1",
+    "@helia/interface": "^3.0.0",
     "@helia/ipns": "^3.0.0",
-    "@libp2p/interface": "^0.1.2",
-    "@libp2p/kad-dht": "^10.0.4",
-    "@libp2p/peer-id": "^3.0.2",
-    "@libp2p/peer-id-factory": "^3.0.3",
-    "@libp2p/tcp": "^8.0.4",
-    "@libp2p/websockets": "^7.0.4",
-    "aegir": "^41.1.14",
+    "@libp2p/identify": "^1.0.9",
+    "@libp2p/interface": "^1.1.1",
+    "@libp2p/kad-dht": "^12.0.2",
+    "@libp2p/keychain": "^4.0.5",
+    "@libp2p/peer-id": "^4.0.4",
+    "@libp2p/peer-id-factory": "^4.0.3",
+    "@libp2p/tcp": "^9.0.10",
+    "@libp2p/websockets": "^8.0.10",
+    "aegir": "^42.0.1",
     "blockstore-core": "^4.0.1",
     "datastore-core": "^9.0.3",
-    "helia": "^2.0.1",
+    "helia": "^3.0.0",
     "ipfsd-ctl": "^13.0.0",
-    "ipns": "^7.0.1",
+    "ipns": "^8.0.0",
     "it-all": "^3.0.2",
     "it-last": "^3.0.1",
     "it-map": "^3.0.3",
-    "kubo": "^0.24.0",
+    "kubo": "^0.25.0",
     "kubo-rpc-client": "^3.0.0",
-    "libp2p": "^0.46.6",
+    "libp2p": "^1.1.1",
     "merge-options": "^3.0.4",
-    "multiformats": "^12.0.1",
-    "uint8arrays": "^4.0.3",
+    "multiformats": "^13.0.0",
+    "uint8arrays": "^5.0.1",
     "wherearewe": "^2.0.1"
   },
   "browser": {

packages/interop/test/fixtures/create-helia.ts

@@ -6,10 +6,10 @@ import { MemoryDatastore } from 'datastore-core'
 import { createHelia } from 'helia'
 import { createLibp2p, type Libp2pOptions } from 'libp2p'
 import type { Helia } from '@helia/interface'
+import type { Identify } from '@libp2p/identify'
 import type { Libp2p } from '@libp2p/interface'
-import type { IdentifyService } from 'libp2p/identify'
 
-export async function createHeliaNode <T extends { identify: IdentifyService }> (config: Libp2pOptions<T> = {}): Promise<Helia<Libp2p<T>>> {
+export async function createHeliaNode <T extends { identify: Identify }> (config: Libp2pOptions<T> = {}): Promise<Helia<Libp2p<T>>> {
   const blockstore = new MemoryBlockstore()
   const datastore = new MemoryDatastore()
 

packages/interop/test/fixtures/create-peer-ids.ts

@@ -3,7 +3,7 @@ import map from 'it-map'
 import { sha256 } from 'multiformats/hashes/sha2'
 import { compare as uint8ArrayCompare } from 'uint8arrays/compare'
 import { xor as uint8ArrayXor } from 'uint8arrays/xor'
-import type { PeerId } from '@libp2p/interface/peer-id'
+import type { PeerId } from '@libp2p/interface'
 
 /**
  * Sort peers by distance to the KadID of the passed buffer

packages/interop/test/fixtures/key-types.ts

@@ -1,4 +1,4 @@
-import type { PeerIdType } from '@libp2p/interface/peer-id'
+import type { PeerIdType } from '@libp2p/interface'
 
 export const keyTypes: PeerIdType[] = [
   'Ed25519',

packages/interop/test/dht.spec.ts → packages/interop/test/libp2p.spec.ts

@@ -1,14 +1,16 @@
 /* eslint-env mocha */
 
 import { ipns } from '@helia/ipns'
-import { dht } from '@helia/ipns/routing'
-import { kadDHT, type DualKadDHT } from '@libp2p/kad-dht'
+import { libp2p } from '@helia/ipns/routing'
+import { identify } from '@libp2p/identify'
+import { kadDHT, removePublicAddressesMapper, type KadDHT } from '@libp2p/kad-dht'
+import { keychain, type Keychain } from '@libp2p/keychain'
+import { peerIdFromString } from '@libp2p/peer-id'
 import { createEd25519PeerId, createRSAPeerId, createSecp256k1PeerId } from '@libp2p/peer-id-factory'
 import { expect } from 'aegir/chai'
 import { ipnsSelector } from 'ipns/selector'
 import { ipnsValidator } from 'ipns/validator'
 import last from 'it-last'
-import { identifyService } from 'libp2p/identify'
 import { CID } from 'multiformats/cid'
 import * as raw from 'multiformats/codecs/raw'
 import { sha256 } from 'multiformats/hashes/sha2'
@@ -23,13 +25,12 @@ import { keyTypes } from './fixtures/key-types.js'
 import { waitFor } from './fixtures/wait-for.js'
 import type { Helia } from '@helia/interface'
 import type { IPNS } from '@helia/ipns'
-import type { Libp2p } from '@libp2p/interface'
+import type { Libp2p, PeerId } from '@libp2p/interface'
 import type { Controller } from 'ipfsd-ctl'
-import type { PeerId } from 'kubo-rpc-client/dist/src/types.js'
 
 keyTypes.forEach(type => {
-  describe(`dht routing with ${type} keys`, () => {
-    let helia: Helia<Libp2p<{ dht: DualKadDHT }>>
+  describe(`libp2p routing with ${type} keys`, () => {
+    let helia: Helia<Libp2p<{ dht: KadDHT, keychain: Keychain }>>
     let kubo: Controller
     let name: IPNS
 
@@ -51,7 +52,7 @@ keyTypes.forEach(type => {
 
       helia = await createHeliaNode({
         services: {
-          identify: identifyService(),
+          identify: identify(),
           dht: kadDHT({
             validators: {
               ipns: ipnsValidator
@@ -60,8 +61,14 @@ keyTypes.forEach(type => {
               ipns: ipnsSelector
             },
             // skips waiting for the initial self-query to find peers
-            allowQueryWithZeroPeers: true
-          })
+            allowQueryWithZeroPeers: true,
+
+            // use lan-only mode
+            protocol: '/ipfs/lan/kad/1.0.0',
+            peerInfoMapper: removePublicAddressesMapper,
+            clientMode: false
+          }),
+          keychain: keychain()
         }
       })
       kubo = await createKuboNode()
@@ -83,10 +90,10 @@ keyTypes.forEach(type => {
 
         const [closest] = await sortClosestPeers(routingKey, [
           helia.libp2p.peerId,
-          kubo.peer.id
+          peerIdFromString(kubo.peer.id.toString())
         ])
 
-        if (resolver === 'kubo' && closest.equals(kubo.peer.id)) {
+        if (resolver === 'kubo' && closest.equals(peerIdFromString(kubo.peer.id.toString()))) {
           break
         }
 
@@ -102,7 +109,7 @@ keyTypes.forEach(type => {
       await waitFor(async () => {
         let found = false
 
-        for await (const event of helia.libp2p.services.dht.findPeer(kubo.peer.id)) {
+        for await (const event of helia.libp2p.services.dht.findPeer(peerIdFromString(kubo.peer.id.toString()))) {
           if (event.name === 'FINAL_PEER') {
             found = true
           }
@@ -118,6 +125,7 @@ keyTypes.forEach(type => {
       await waitFor(async () => {
         let found = false
 
+        // @ts-expect-error kubo deps are out of date
         for await (const event of kubo.api.dht.findPeer(helia.libp2p.peerId)) {
           if (event.name === 'FINAL_PEER') {
             found = true
@@ -133,7 +141,7 @@ keyTypes.forEach(type => {
 
       name = ipns(helia, {
         routers: [
-          dht(helia)
+          libp2p(helia)
         ]
       })
     }
@@ -152,11 +160,11 @@ keyTypes.forEach(type => {
       await createNodes('kubo')
 
       const keyName = 'my-ipns-key'
-      await helia.libp2p.keychain.importPeer(keyName, key)
+      await helia.libp2p.services.keychain.importPeer(keyName, key)
 
       await name.publish(key, value)
 
-      const resolved = await last(kubo.api.name.resolve(key))
+      const resolved = await last(kubo.api.name.resolve(key.toString()))
 
       if (resolved == null) {
         throw new Error('kubo failed to resolve name')