feat!: add ipns reproviding/republishing

.github/dictionary.txt

@@ -1 +1,2 @@
 dont
+fleek

packages/interface/src/index.ts

@@ -17,7 +17,7 @@
 import type { Blocks } from './blocks.js'
 import type { Pins } from './pins.js'
 import type { Routing } from './routing.js'
-import type { AbortOptions, ComponentLogger, Libp2p, Metrics } from '@libp2p/interface'
+import type { AbortOptions, ComponentLogger, Libp2p, Metrics, TypedEventEmitter } from '@libp2p/interface'
 import type { DNS } from '@multiformats/dns'
 import type { Datastore } from 'interface-datastore'
 import type { Await } from 'interface-store'
@@ -54,6 +54,11 @@ export interface Helia<T extends Libp2p = Libp2p> {
    */
   datastore: Datastore
 
+  /**
+   * Event emitter for Helia start and stop events
+   */
+  events: TypedEventEmitter<HeliaEvents<T>>
+
   /**
    * Pinning operations for blocks in the blockstore
    */
@@ -119,6 +124,30 @@ export interface GCOptions extends AbortOptions, ProgressOptions<GcEvents> {
 
 }
 
+export interface HeliaEvents<T extends Libp2p = Libp2p> {
+  /**
+   * This event notifies listeners that the node has started
+   *
+   * ```TypeScript
+   * helia.addEventListener('start', (event) => {
+   *   console.info(event.detail.libp2p.isStarted()) // true
+   * })
+   * ```
+   */
+  start: CustomEvent<Helia<T>>
+
+  /**
+   * This event notifies listeners that the node has stopped
+   *
+   * ```TypeScript
+   * helia.addEventListener('stop', (event) => {
+   *   console.info(event.detail.libp2p.isStarted()) // false
+   * })
+   * ```
+   */
+  stop: CustomEvent<Helia<T>>
+}
+
 export * from './blocks.js'
 export * from './errors.js'
 export * from './pins.js'

packages/interop/src/ipns-pubsub.spec.ts

@@ -71,6 +71,8 @@ keyTypes.filter(keyType => keyType !== 'RSA').forEach(keyType => {
       const cid = CID.createV1(raw.code, digest)
 
       const privateKey = await generateKeyPair('Ed25519')
+      const keyName = 'my-ipns-key'
+      await helia.libp2p.services.keychain.importKey(keyName, privateKey)
 
       // first call to pubsub resolver will fail but we should trigger
       // subscribing pubsub for updates
@@ -103,7 +105,7 @@ keyTypes.filter(keyType => keyType !== 'RSA').forEach(keyType => {
       })
 
       // publish should now succeed
-      await name.publish(privateKey, cid)
+      await name.publish(keyName, cid)
 
       // kubo should now be able to resolve IPNS name instantly
       const resolved = await last(kubo.api.name.resolve(privateKey.publicKey.toString(), {

packages/interop/src/ipns.spec.ts

@@ -125,8 +125,9 @@ keyTypes.forEach(type => {
       await createNodes('kubo')
 
       const privateKey = await generateKeyPair('Ed25519')
-
-      await name.publish(privateKey, value)
+      const keyName = 'my-ipns-key'
+      await helia.libp2p.services.keychain.importKey(keyName, privateKey)
+      await name.publish(keyName, value)
 
       const resolved = await last(kubo.api.name.resolve(privateKey.publicKey.toString()))
 

packages/ipns/README.md

@@ -40,23 +40,19 @@ With IPNSRouting routers:
 import { createHelia } from 'helia'
 import { ipns } from '@helia/ipns'
 import { unixfs } from '@helia/unixfs'
-import { generateKeyPair } from '@libp2p/crypto/keys'
 
 const helia = await createHelia()
 const name = ipns(helia)
 
-// create a keypair to publish an IPNS name
-const privateKey = await generateKeyPair('Ed25519')
-
 // store some data to publish
 const fs = unixfs(helia)
 const cid = await fs.addBytes(Uint8Array.from([0, 1, 2, 3, 4]))
 
 // publish the name
-await name.publish(privateKey, cid)
+const { publicKey } = await name.publish('key-1', cid)
 
 // resolve the name
-const result = await name.resolve(privateKey.publicKey)
+const result = await name.resolve(publicKey)
 
 console.info(result.cid, result.path)
 ```
@@ -75,24 +71,18 @@ import { generateKeyPair } from '@libp2p/crypto/keys'
 const helia = await createHelia()
 const name = ipns(helia)
 
-// create a keypair to publish an IPNS name
-const privateKey = await generateKeyPair('Ed25519')
-
 // store some data to publish
 const fs = unixfs(helia)
 const cid = await fs.addBytes(Uint8Array.from([0, 1, 2, 3, 4]))
 
 // publish the name
-await name.publish(privateKey, cid)
-
-// create another keypair to re-publish the original record
-const recursivePrivateKey = await generateKeyPair('Ed25519')
+const { publicKey } = await name.publish('key-1', cid)
 
 // publish the recursive name
-await name.publish(recursivePrivateKey, privateKey.publicKey)
+const { publicKey: recursivePublicKey } = await name.publish('key-2', publicKey)
 
 // resolve the name recursively - it resolves until a CID is found
-const result = await name.resolve(recursivePrivateKey.publicKey)
+const result = await name.resolve(recursivePublicKey)
 console.info(result.cid.toString() === cid.toString()) // true
 ```
 
@@ -109,9 +99,6 @@ import { generateKeyPair } from '@libp2p/crypto/keys'
 const helia = await createHelia()
 const name = ipns(helia)
 
-// create a keypair to publish an IPNS name
-const privateKey = await generateKeyPair('Ed25519')
-
 // store some data to publish
 const fs = unixfs(helia)
 const fileCid = await fs.addBytes(Uint8Array.from([0, 1, 2, 3, 4]))
@@ -121,10 +108,10 @@ const dirCid = await fs.addDirectory()
 const finalDirCid = await fs.cp(fileCid, dirCid, '/foo.txt')
 
 // publish the name
-await name.publish(privateKey, `/ipfs/${finalDirCid}/foo.txt`)
+const { publicKey } = await name.publish('key-1', `/ipfs/${finalDirCid}/foo.txt`)
 
 // resolve the name
-const result = await name.resolve(privateKey.publicKey)
+const result = await name.resolve(publicKey)
 
 console.info(result.cid, result.path) // QmFoo.. 'foo.txt'
 ```
@@ -167,18 +154,16 @@ const name = ipns(helia, {
  ]
 })
 
-// create a keypair to publish an IPNS name
-const privateKey = await generateKeyPair('Ed25519')
 
 // store some data to publish
 const fs = unixfs(helia)
 const cid = await fs.addBytes(Uint8Array.from([0, 1, 2, 3, 4]))
 
 // publish the name
-await name.publish(privateKey, cid)
+const { publicKey } = await name.publish('key-1', cid)
 
 // resolve the name
-const result = await name.resolve(privateKey.publicKey)
+const result = await name.resolve(publicKey)
 ```
 
 ## Example - Using custom DNS over HTTPS resolvers
@@ -190,20 +175,17 @@ import { createHelia } from 'helia'
 import { ipns } from '@helia/ipns'
 import { dns } from '@multiformats/dns'
 import { dnsOverHttps } from '@multiformats/dns/resolvers'
-import { helia } from '@helia/ipns/routing'
+import type { DefaultLibp2pServices } from 'helia'
+import type { Libp2p } from '@libp2p/interface'
 
-const node = await createHelia({
+const node = await createHelia<Libp2p<DefaultLibp2pServices>>({
   dns: dns({
     resolvers: {
       '.': dnsOverHttps('https://private-dns-server.me/dns-query')
     }
   })
 })
-const name = ipns(node, {
- routers: [
-   helia(node.routing)
- ]
-})
+const name = ipns(node)
 
 const result = name.resolveDNSLink('some-domain-with-dnslink-entry.com')
 ```
@@ -215,23 +197,21 @@ Calling `resolveDNSLink` with the `@helia/ipns` instance:
 ```TypeScript
 // resolve a CID from a TXT record in a DNS zone file, using the default
 // resolver for the current platform eg:
-// > dig _dnslink.ipfs.io TXT
+// > dig _dnslink.ipfs.tech TXT
 // ;; ANSWER SECTION:
-// _dnslink.ipfs.io.          60     IN      TXT     "dnslink=/ipns/website.ipfs.io"
-// > dig _dnslink.website.ipfs.io TXT
-// ;; ANSWER SECTION:
-// _dnslink.website.ipfs.io.  60     IN      TXT     "dnslink=/ipfs/QmWebsite"
+// _dnslink.ipfs.tech. 60 IN CNAME _dnslink.ipfs-tech.on.fleek.co.
+// _dnslink.ipfs-tech.on.fleek.co. 120 IN TXT "dnslink=/ipfs/bafybe..."
 
 import { createHelia } from 'helia'
 import { ipns } from '@helia/ipns'
 
 const node = await createHelia()
 const name = ipns(node)
 
-const { answer } = await name.resolveDNSLink('ipfs.io')
+const { answer } = await name.resolveDNSLink('blog.ipfs.tech')
 
 console.info(answer)
-// { data: '/ipfs/QmWebsite' }
+// { data: '/ipfs/bafybe...' }
 ```
 
 ## Example - Using DNS-Over-HTTPS
@@ -247,8 +227,10 @@ import { createHelia } from 'helia'
 import { ipns } from '@helia/ipns'
 import { dns } from '@multiformats/dns'
 import { dnsOverHttps } from '@multiformats/dns/resolvers'
+import type { DefaultLibp2pServices } from 'helia'
+import type { Libp2p } from '@libp2p/interface'
 
-const node = await createHelia({
+const node = await createHelia<Libp2p<DefaultLibp2pServices>>({
   dns: dns({
     resolvers: {
       '.': dnsOverHttps('https://mozilla.cloudflare-dns.com/dns-query')
@@ -257,7 +239,7 @@ const node = await createHelia({
 })
 const name = ipns(node)
 
-const result = await name.resolveDNSLink('ipfs.io')
+const result = await name.resolveDNSLink('blog.ipfs.tech')
 ```
 
 ## Example - Using DNS-JSON-Over-HTTPS
@@ -270,8 +252,10 @@ import { createHelia } from 'helia'
 import { ipns } from '@helia/ipns'
 import { dns } from '@multiformats/dns'
 import { dnsJsonOverHttps } from '@multiformats/dns/resolvers'
+import type { DefaultLibp2pServices } from 'helia'
+import type { Libp2p } from '@libp2p/interface'
 
-const node = await createHelia({
+const node = await createHelia<Libp2p<DefaultLibp2pServices>>({
   dns: dns({
     resolvers: {
       '.': dnsJsonOverHttps('https://mozilla.cloudflare-dns.com/dns-query')
@@ -280,7 +264,7 @@ const node = await createHelia({
 })
 const name = ipns(node)
 
-const result = await name.resolveDNSLink('ipfs.io')
+const result = await name.resolveDNSLink('blog.ipfs.tech')
 ```
 
 ## Example - Republishing an existing IPNS record

packages/ipns/package.json

@@ -70,6 +70,7 @@
     "doc-check": "aegir doc-check",
     "build": "aegir build",
     "docs": "aegir docs",
+    "generate": "protons ./src/pb/metadata.proto",
     "test": "aegir test",
     "test:chrome": "aegir test -t browser --cov",
     "test:chrome-webworker": "aegir test -t webworker",
@@ -79,24 +80,30 @@
     "test:electron-main": "aegir test -t electron-main"
   },
   "dependencies": {
+    "@libp2p/crypto": "^5.1.7",
     "@helia/interface": "^5.4.0",
     "@libp2p/interface": "^2.2.1",
     "@libp2p/kad-dht": "^15.0.2",
+    "@libp2p/keychain": "^5.2.8",
     "@libp2p/logger": "^5.1.4",
     "@libp2p/peer-id": "^5.1.0",
+    "@libp2p/utils": "^6.7.1",
     "@multiformats/dns": "^1.0.6",
+    "helia": "^5.4.2",
     "interface-datastore": "^8.3.1",
     "ipns": "^10.0.0",
     "multiformats": "^13.3.1",
     "progress-events": "^1.0.1",
+    "protons-runtime": "^5.5.0",
+    "uint8arraylist": "^2.4.8",
     "uint8arrays": "^5.1.0"
   },
   "devDependencies": {
-    "@libp2p/crypto": "^5.0.7",
     "@types/dns-packet": "^5.6.5",
     "aegir": "^47.0.7",
     "datastore-core": "^10.0.2",
     "it-drain": "^3.0.7",
+    "protons": "^7.6.1",
     "sinon": "^20.0.0",
     "sinon-ts": "^2.0.0"
   },