@helia/ipns 3.0.0 → 4.0.0

package/src/index.ts

@@ -3,26 +3,27 @@
  *
  * IPNS operations using a Helia node
  *
- * @example
+ * @example Using libp2p and pubsub routers
  *
  * With {@link IPNSRouting} routers:
  *
  * ```typescript
  * import { createHelia } from 'helia'
- * import { dht, pubsub } from '@helia/ipns/routing'
+ * import { ipns } from '@helia/ipns'
+ * import { libp2p, pubsub } from '@helia/ipns/routing'
  * import { unixfs } from '@helia/unixfs'
  *
  * const helia = await createHelia()
  * const name = ipns(helia, {
  *  routers: [
- *    dht(helia),
+ *    libp2p(helia),
  *    pubsub(helia)
  *  ]
  * })
  *
  * // create a public key to publish as an IPNS name
- * const keyInfo = await helia.libp2p.keychain.createKey('my-key')
- * const peerId = await helia.libp2p.keychain.exportPeerId(keyInfo.name)
+ * const keyInfo = await helia.libp2p.services.keychain.createKey('my-key')
+ * const peerId = await helia.libp2p.services.keychain.exportPeerId(keyInfo.name)
  *
  * // store some data to publish
  * const fs = unixfs(helia)
@@ -35,14 +36,15 @@
  * const cid = name.resolve(peerId)
  * ```
  *
- * @example
+ * @example Using custom DNS over HTTPS resolvers
  *
  * With default {@link DNSResolver} resolvers:
  *
  * ```typescript
  * import { createHelia } from 'helia'
- * import { dht, pubsub } from '@helia/ipns/routing'
+ * import { ipns } from '@helia/ipns'
  * import { unixfs } from '@helia/unixfs'
+ * import { dnsOverHttps } from '@helia/ipns/dns-resolvers'
  *
  * const helia = await createHelia()
  * const name = ipns(helia, {
@@ -54,7 +56,7 @@
  * const cid = name.resolveDns('some-domain-with-dnslink-entry.com')
  * ```
  *
- * @example
+ * @example Resolving a domain with a dnslink entry
  *
  * Calling `resolveDns` with the `@helia/ipns` instance:
  *
@@ -74,7 +76,7 @@
  * // QmWebsite
  * ```
  *
- * @example
+ * @example Using DNS-Over-HTTPS
  *
  * This example uses the Mozilla provided RFC 1035 DNS over HTTPS service. This
  * uses binary DNS records so requires extra dependencies to process the
@@ -93,7 +95,7 @@
  * })
  * ```
  *
- * @example
+ * @example Using DNS-JSON-Over-HTTPS
  *
  * DNS-JSON-Over-HTTPS resolvers use the RFC 8427 `application/dns-json` and can
  * result in a smaller browser bundle due to the response being plain JSON.
@@ -110,7 +112,7 @@
  * ```
  */
 
-import { CodeError } from '@libp2p/interface/errors'
+import { CodeError } from '@libp2p/interface'
 import { logger } from '@libp2p/logger'
 import { peerIdFromString } from '@libp2p/peer-id'
 import { create, marshal, peerIdToRoutingKey, unmarshal } from 'ipns'
@@ -122,8 +124,7 @@ import { defaultResolver } from './dns-resolvers/default.js'
 import { localStore, type LocalStore } from './routing/local-store.js'
 import type { IPNSRouting, IPNSRoutingEvents } from './routing/index.js'
 import type { DNSResponse } from './utils/dns.js'
-import type { AbortOptions } from '@libp2p/interface'
-import type { PeerId } from '@libp2p/interface/peer-id'
+import type { AbortOptions, PeerId } from '@libp2p/interface'
 import type { Datastore } from 'interface-datastore'
 import type { IPNSRecord } from 'ipns'
 import type { ProgressEvent, ProgressOptions } from 'progress-events'
@@ -223,7 +224,7 @@ export interface IPNS {
   /**
    * Creates an IPNS record signed by the passed PeerId that will resolve to the passed value
    *
-   * If the valid is a PeerId, a recursive IPNS record will be created.
+   * If the value is a PeerId, a recursive IPNS record will be created.
    */
   publish(key: PeerId, value: CID | PeerId, options?: PublishOptions): Promise<IPNSRecord>
 

package/src/routing/index.ts

@@ -1,4 +1,4 @@
-import type { DHTProgressEvents } from './dht.js'
+import type { Libp2pContentRoutingProgressEvents } from './libp2p.js'
 import type { DatastoreProgressEvents } from './local-store.js'
 import type { PubSubProgressEvents } from './pubsub.js'
 import type { AbortOptions } from '@libp2p/interface'
@@ -19,8 +19,8 @@ export interface IPNSRouting {
 
 export type IPNSRoutingEvents =
   DatastoreProgressEvents |
-  DHTProgressEvents |
+  Libp2pContentRoutingProgressEvents |
   PubSubProgressEvents
 
-export { dht } from './dht.js'
+export { libp2p } from './libp2p.js'
 export { pubsub } from './pubsub.js'

package/src/routing/{dht.ts → libp2p.ts}

@@ -1,21 +1,21 @@
 import { CustomProgressEvent, type ProgressEvent } from 'progress-events'
 import type { GetOptions, PutOptions } from './index.js'
 import type { IPNSRouting } from '../index.js'
-import type { ContentRouting } from '@libp2p/interface/content-routing'
+import type { ContentRouting } from '@libp2p/interface'
 
-export interface DHTRoutingComponents {
+export interface Libp2pContentRoutingComponents {
   libp2p: {
     contentRouting: ContentRouting
   }
 }
 
-export type DHTProgressEvents =
-  ProgressEvent<'ipns:routing:dht:error', Error>
+export type Libp2pContentRoutingProgressEvents =
+  ProgressEvent<'ipns:routing:libp2p:error', Error>
 
-export class DHTRouting implements IPNSRouting {
+export class Libp2pContentRouting implements IPNSRouting {
   private readonly contentRouting: ContentRouting
 
-  constructor (components: DHTRoutingComponents) {
+  constructor (components: Libp2pContentRoutingComponents) {
     this.contentRouting = components.libp2p.contentRouting
   }
 
@@ -23,7 +23,7 @@ export class DHTRouting implements IPNSRouting {
     try {
       await this.contentRouting.put(routingKey, marshaledRecord, options)
     } catch (err: any) {
-      options.onProgress?.(new CustomProgressEvent<Error>('ipns:routing:dht:error', err))
+      options.onProgress?.(new CustomProgressEvent<Error>('ipns:routing:libp2p:error', err))
     }
   }
 
@@ -31,13 +31,17 @@ export class DHTRouting implements IPNSRouting {
     try {
       return await this.contentRouting.get(routingKey, options)
     } catch (err: any) {
-      options.onProgress?.(new CustomProgressEvent<Error>('ipns:routing:dht:error', err))
+      options.onProgress?.(new CustomProgressEvent<Error>('ipns:routing:libp2p:error', err))
     }
 
     throw new Error('Not found')
   }
 }
 
-export function dht (components: DHTRoutingComponents): IPNSRouting {
-  return new DHTRouting(components)
+/**
+ * The libp2p routing uses any available Content Routers configured on the
+ * passed libp2p node. This could be KadDHT, HTTP API Delegated Routing, etc.
+ */
+export function libp2p (components: Libp2pContentRoutingComponents): IPNSRouting {
+  return new Libp2pContentRouting(components)
 }

package/src/routing/pubsub.ts

@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interface/errors'
+import { CodeError } from '@libp2p/interface'
 import { logger } from '@libp2p/logger'
 import { peerIdToRoutingKey } from 'ipns'
 import { ipnsSelector } from 'ipns/selector'
@@ -9,8 +9,7 @@ import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
 import { localStore, type LocalStore } from './local-store.js'
 import type { GetOptions, IPNSRouting, PutOptions } from './index.js'
-import type { PeerId } from '@libp2p/interface/peer-id'
-import type { Message, PublishResult, PubSub } from '@libp2p/interface/pubsub'
+import type { PeerId, Message, PublishResult, PubSub } from '@libp2p/interface'
 import type { Datastore } from 'interface-datastore'
 
 const log = logger('helia:ipns:routing:pubsub')
@@ -30,14 +29,6 @@ export type PubSubProgressEvents =
   ProgressEvent<'ipns:pubsub:subscribe', { topic: string }> |
   ProgressEvent<'ipns:pubsub:error', Error>
 
-/**
- * This IPNS routing receives IPNS record updates via dedicated
- * pubsub topic.
- *
- * Note we must first be subscribed to the topic in order to receive
- * updated records, so the first call to `.get` should be expected
- * to fail!
- */
 class PubSubRouting implements IPNSRouting {
   private subscriptions: string[]
   private readonly localStore: LocalStore
@@ -192,6 +183,14 @@ function topicToKey (topic: string): Uint8Array {
   return uint8ArrayFromString(key, 'base64url')
 }
 
+/**
+ * This IPNS routing receives IPNS record updates via dedicated
+ * pubsub topic.
+ *
+ * Note we must first be subscribed to the topic in order to receive
+ * updated records, so the first call to `.get` should be expected
+ * to fail!
+ */
 export function pubsub (components: PubsubRoutingComponents): IPNSRouting {
   return new PubSubRouting(components)
 }

package/src/utils/dns.ts

@@ -1,4 +1,4 @@
-import { CodeError } from '@libp2p/interface/errors'
+import { CodeError } from '@libp2p/interface'
 import * as isIPFS from 'is-ipfs'
 import type { DNSResolver, ResolveDnsLinkOptions } from '../index.js'
 

package/dist/src/routing/dht.d.ts

@@ -1,18 +0,0 @@
-import { type ProgressEvent } from 'progress-events';
-import type { GetOptions, PutOptions } from './index.js';
-import type { IPNSRouting } from '../index.js';
-import type { ContentRouting } from '@libp2p/interface/content-routing';
-export interface DHTRoutingComponents {
-    libp2p: {
-        contentRouting: ContentRouting;
-    };
-}
-export type DHTProgressEvents = ProgressEvent<'ipns:routing:dht:error', Error>;
-export declare class DHTRouting implements IPNSRouting {
-    private readonly contentRouting;
-    constructor(components: DHTRoutingComponents);
-    put(routingKey: Uint8Array, marshaledRecord: Uint8Array, options?: PutOptions): Promise<void>;
-    get(routingKey: Uint8Array, options?: GetOptions): Promise<Uint8Array>;
-}
-export declare function dht(components: DHTRoutingComponents): IPNSRouting;
-//# sourceMappingURL=dht.d.ts.map

package/dist/src/routing/dht.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"dht.d.ts","sourceRoot":"","sources":["../../../src/routing/dht.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACzE,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACxD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAA;AAEvE,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE;QACN,cAAc,EAAE,cAAc,CAAA;KAC/B,CAAA;CACF;AAED,MAAM,MAAM,iBAAiB,GAC3B,aAAa,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAA;AAEhD,qBAAa,UAAW,YAAW,WAAW;IAC5C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAgB;gBAElC,UAAU,EAAE,oBAAoB;IAIvC,GAAG,CAAE,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,UAAU,EAAE,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAQlG,GAAG,CAAE,UAAU,EAAE,UAAU,EAAE,OAAO,GAAE,UAAe,GAAG,OAAO,CAAC,UAAU,CAAC;CASlF;AAED,wBAAgB,GAAG,CAAE,UAAU,EAAE,oBAAoB,GAAG,WAAW,CAElE"}

package/dist/src/routing/dht.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"dht.js","sourceRoot":"","sources":["../../../src/routing/dht.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAsB,MAAM,iBAAiB,CAAA;AAczE,MAAM,OAAO,UAAU;IACJ,cAAc,CAAgB;IAE/C,YAAa,UAAgC;QAC3C,IAAI,CAAC,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAA;IACxD,CAAC;IAED,KAAK,CAAC,GAAG,CAAE,UAAsB,EAAE,eAA2B,EAAE,UAAsB,EAAE;QACtF,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,eAAe,EAAE,OAAO,CAAC,CAAA;QACrE,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAQ,wBAAwB,EAAE,GAAG,CAAC,CAAC,CAAA;QACrF,CAAC;IACH,CAAC;IAED,KAAK,CAAC,GAAG,CAAE,UAAsB,EAAE,UAAsB,EAAE;QACzD,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAA;QAC3D,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,OAAO,CAAC,UAAU,EAAE,CAAC,IAAI,mBAAmB,CAAQ,wBAAwB,EAAE,GAAG,CAAC,CAAC,CAAA;QACrF,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAA;IAC9B,CAAC;CACF;AAED,MAAM,UAAU,GAAG,CAAE,UAAgC;IACnD,OAAO,IAAI,UAAU,CAAC,UAAU,CAAC,CAAA;AACnC,CAAC"}