@helia/ipns 8.2.4 → 9.0.0-d9051cdc

package/src/routing/local-store.ts

@@ -1,96 +1,18 @@
-import { Record } from '@libp2p/kad-dht'
-import { Key } from 'interface-datastore'
-import { CustomProgressEvent } from 'progress-events'
-import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
-import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
-import type { GetOptions, PutOptions } from '../routing/index.js'
-import type { AbortOptions } from '@libp2p/interface'
-import type { Datastore } from 'interface-datastore'
-import type { ProgressEvent } from 'progress-events'
-
-function dhtRoutingKey (key: Uint8Array): Key {
-  return new Key('/dht/record/' + uint8ArrayToString(key, 'base32'), false)
-}
-
-export type DatastoreProgressEvents =
-  ProgressEvent<'ipns:routing:datastore:put'> |
-  ProgressEvent<'ipns:routing:datastore:get'> |
-  ProgressEvent<'ipns:routing:datastore:error', Error>
-
-export interface GetResult {
-  record: Uint8Array
-  created: Date
-}
-
-export interface LocalStore {
-  put(routingKey: Uint8Array, marshaledRecord: Uint8Array, options?: PutOptions): Promise<void>
-  get(routingKey: Uint8Array, options?: GetOptions): Promise<GetResult>
-  has(routingKey: Uint8Array, options?: AbortOptions): Promise<boolean>
-  delete(routingKey: Uint8Array, options?: AbortOptions): Promise<void>
-}
+import type { LocalStore } from '../local-store.ts'
+import type { IPNSRouting, PutOptions, GetOptions } from './index.ts'
 
 /**
- * Returns an IPNSRouting implementation that reads/writes IPNS records to the
- * datastore as DHT records. This lets us publish IPNS records offline then
- * serve them to the network later in response to DHT queries.
+ * Returns an IPNSRouting implementation that reads/writes to the local store
  */
-export function localStore (datastore: Datastore): LocalStore {
+export function localStoreRouting (localStore: LocalStore): IPNSRouting {
   return {
-    async put (routingKey: Uint8Array, marshalledRecord: Uint8Array, options: PutOptions = {}) {
-      try {
-        const key = dhtRoutingKey(routingKey)
-
-        // don't overwrite existing, identical records as this will affect the
-        // TTL
-        try {
-          const existingBuf = await datastore.get(key)
-          const existingRecord = Record.deserialize(existingBuf)
-
-          if (uint8ArrayEquals(existingRecord.value, marshalledRecord)) {
-            return
-          }
-        } catch (err: any) {
-          if (err.name !== 'NotFoundError') {
-            throw err
-          }
-        }
-
-        // Marshal to libp2p record as the DHT does
-        const record = new Record(routingKey, marshalledRecord, new Date())
-
-        options.onProgress?.(new CustomProgressEvent('ipns:routing:datastore:put'))
-        await datastore.put(key, record.serialize(), options)
-      } catch (err: any) {
-        options.onProgress?.(new CustomProgressEvent<Error>('ipns:routing:datastore:error', err))
-        throw err
-      }
+    async put (routingKey: Uint8Array, marshaledRecord: Uint8Array, options?: PutOptions): Promise<void> {
+      await localStore.put(routingKey, marshaledRecord, options)
     },
-    async get (routingKey: Uint8Array, options: GetOptions = {}): Promise<GetResult> {
-      try {
-        const key = dhtRoutingKey(routingKey)
-
-        options.onProgress?.(new CustomProgressEvent('ipns:routing:datastore:get'))
-        const buf = await datastore.get(key, options)
+    async get (routingKey: Uint8Array, options?: GetOptions): Promise<Uint8Array> {
+      const { record } = await localStore.get(routingKey, options)
 
-        // Unmarshal libp2p record as the DHT does
-        const record = Record.deserialize(buf)
-
-        return {
-          record: record.value,
-          created: record.timeReceived
-        }
-      } catch (err: any) {
-        options.onProgress?.(new CustomProgressEvent<Error>('ipns:routing:datastore:error', err))
-        throw err
-      }
-    },
-    async has (routingKey: Uint8Array, options: AbortOptions = {}): Promise<boolean> {
-      const key = dhtRoutingKey(routingKey)
-      return datastore.has(key, options)
-    },
-    async delete (routingKey, options): Promise<void> {
-      const key = dhtRoutingKey(routingKey)
-      return datastore.delete(key, options)
+      return record
     }
   }
 }

package/src/routing/pubsub.ts

@@ -8,18 +8,42 @@ import { equals as uint8ArrayEquals } from 'uint8arrays/equals'
 import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string'
 import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
 import { InvalidTopicError } from '../errors.js'
-import { localStore } from './local-store.js'
+import { localStore } from '../local-store.js'
 import type { GetOptions, IPNSRouting, PutOptions } from './index.js'
-import type { LocalStore } from './local-store.js'
-import type { PeerId, Message, PublishResult, PubSub, PublicKey } from '@libp2p/interface'
+import type { LocalStore } from '../local-store.js'
+import type { PeerId, PublicKey, TypedEventTarget, ComponentLogger } from '@libp2p/interface'
 import type { Datastore } from 'interface-datastore'
 import type { MultihashDigest } from 'multiformats/hashes/interface'
 import type { ProgressEvent } from 'progress-events'
 
 const log = logger('helia:ipns:routing:pubsub')
 
+export interface Message {
+  type: 'signed' | 'unsigned'
+  from: PeerId
+  topic: string
+  data: Uint8Array
+}
+
+export interface PubSubEvents {
+  message: CustomEvent<Message>
+}
+
+export interface PublishResult {
+  recipients: PeerId[]
+}
+
+export interface PubSub extends TypedEventTarget<PubSubEvents> {
+  subscribe(topic: string): void
+  unsubscribe(topic: string): void
+  publish(topic: string, message: Uint8Array): Promise<PublishResult>
+  getTopics(): string[]
+  getSubscribers(topic: string): PeerId[]
+}
+
 export interface PubsubRoutingComponents {
   datastore: Datastore
+  logger: ComponentLogger
   libp2p: {
     peerId: PeerId
     services: {
@@ -41,7 +65,7 @@ class PubSubRouting implements IPNSRouting {
 
   constructor (components: PubsubRoutingComponents) {
     this.subscriptions = []
-    this.localStore = localStore(components.datastore)
+    this.localStore = localStore(components.datastore, components.logger.forComponent('helia:ipns:local-store'))
     this.peerId = components.libp2p.peerId
     this.pubsub = components.libp2p.services.pubsub
 

package/src/utils.ts

@@ -1,5 +1,12 @@
+import { InvalidParametersError } from '@libp2p/interface'
+import { Key } from 'interface-datastore'
+import { toString as uint8ArrayToString } from 'uint8arrays/to-string'
+import { DHT_EXPIRY_MS, REPUBLISH_THRESHOLD } from './constants.ts'
+import type { IPNSRecord } from 'ipns'
+import type { CID } from 'multiformats/cid'
 import type { MultihashDigest } from 'multiformats/hashes/interface'
 
+export const LIBP2P_KEY_CODEC = 0x72
 export const IDENTITY_CODEC = 0x0
 export const SHA2_256_CODEC = 0x12
 
@@ -8,3 +15,66 @@ export const IPNS_STRING_PREFIX = '/ipns/'
 export function isCodec <T extends number> (digest: MultihashDigest, codec: T): digest is MultihashDigest<T> {
   return digest.code === codec
 }
+
+export const DHT_RECORD_PREFIX = '/dht/record/'
+export const IPNS_METADATA_PREFIX = '/ipns/metadata/'
+
+export function dhtRoutingKey (key: Uint8Array): Key {
+  return new Key(DHT_RECORD_PREFIX + uint8ArrayToString(key, 'base32'), false)
+}
+
+/**
+ * Calculate the datastore key for IPNS record metadata
+ *
+ * @param key - The DHT routing key for the IPNS record as defined in
+ * https://specs.ipfs.tech/ipns/ipns-record/#routing-record
+ *
+ * @example
+ *
+ * ```ts
+ * const key = multihashToIPNSRoutingKey(privKey.publicKey.toMultihash())
+ * const metadataKey = ipnsMetadataKey(key)
+ * ```
+ * @returns The local storage key for IPNS record metadata
+ */
+export function ipnsMetadataKey (key: Uint8Array): Key {
+  return new Key(IPNS_METADATA_PREFIX + uint8ArrayToString(key, 'base32'), false)
+}
+
+export function shouldRepublish (ipnsRecord: IPNSRecord, created: Date): boolean {
+  const now = Date.now()
+  const dhtExpiry = created.getTime() + DHT_EXPIRY_MS
+  const recordExpiry = new Date(ipnsRecord.validity).getTime()
+
+  // If the DHT expiry is within the threshold, republish it
+  if (dhtExpiry - now < REPUBLISH_THRESHOLD) {
+    return true
+  }
+
+  // If the record expiry (based on validity/lifetime) is within the threshold, republish it
+  if (recordExpiry - now < REPUBLISH_THRESHOLD) {
+    return true
+  }
+
+  return false
+}
+
+function isCID (obj?: any): obj is CID {
+  return obj?.asCID === obj
+}
+
+export function isLibp2pCID (obj?: any): obj is CID<unknown, 0x72, 0x00 | 0x12, 1> {
+  if (!isCID(obj)) {
+    return false
+  }
+
+  if (obj.code !== LIBP2P_KEY_CODEC) {
+    throw new InvalidParametersError(`CID codec ${obj.code} was not libp2p-key`)
+  }
+
+  if (obj.multihash.code !== IDENTITY_CODEC && obj.multihash.code !== SHA2_256_CODEC) {
+    throw new InvalidParametersError(`Multihash algorithm codec ${obj.multihash.code} was not Identity or SHA256 hash`)
+  }
+
+  return true
+}

package/dist/src/dnslink.d.ts

@@ -1,9 +0,0 @@
-import type { ResolveDNSLinkOptions } from './index.js';
-import type { Logger } from '@libp2p/interface';
-import type { Answer, DNS } from '@multiformats/dns';
-export interface DNSLinkResult {
-    answer: Answer;
-    value: string;
-}
-export declare function resolveDNSLink(domain: string, dns: DNS, log: Logger, options?: ResolveDNSLinkOptions): Promise<DNSLinkResult>;
-//# sourceMappingURL=dnslink.d.ts.map

package/dist/src/dnslink.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"dnslink.d.ts","sourceRoot":"","sources":["../../src/dnslink.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AACvD,OAAO,KAAK,EAAE,MAAM,EAAU,MAAM,mBAAmB,CAAA;AACvD,OAAO,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AAIpD,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;CACd;AAkJD,wBAAsB,cAAc,CAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B,GAAG,OAAO,CAAC,aAAa,CAAC,CAExI"}

package/dist/src/dnslink.js

@@ -1,138 +0,0 @@
-import {} from '@libp2p/interface';
-import { peerIdFromCID, peerIdFromString } from '@libp2p/peer-id';
-import { RecordType } from '@multiformats/dns';
-import { CID } from 'multiformats/cid';
-import { DNSLinkNotFoundError } from './errors.js';
-const MAX_RECURSIVE_DEPTH = 32;
-async function recursiveResolveDnslink(domain, depth, dns, log, options = {}) {
-    if (depth === 0) {
-        throw new Error('recursion limit exceeded');
-    }
-    log('query %s for TXT and CNAME records', domain);
-    const txtRecordsResponse = await dns.query(domain, {
-        ...options,
-        types: [
-            RecordType.TXT
-        ]
-    });
-    // sort the TXT records to ensure deterministic processing
-    const txtRecords = (txtRecordsResponse?.Answer ?? [])
-        .sort((a, b) => a.data.localeCompare(b.data));
-    log('found %d TXT records for %s', txtRecords.length, domain);
-    for (const answer of txtRecords) {
-        try {
-            let result = answer.data;
-            // strip leading and trailing " characters
-            if (result.startsWith('"') && result.endsWith('"')) {
-                result = result.substring(1, result.length - 1);
-            }
-            if (!result.startsWith('dnslink=')) {
-                // invalid record?
-                continue;
-            }
-            log('%s TXT %s', answer.name, result);
-            result = result.replace('dnslink=', '');
-            // result is now a `/ipfs/<cid>` or `/ipns/<cid>` string
-            const [, protocol, domainOrCID, ...rest] = result.split('/'); // e.g. ["", "ipfs", "<cid>"]
-            if (protocol === 'ipfs') {
-                try {
-                    const cid = CID.parse(domainOrCID);
-                    // if the result is a CID, we've reached the end of the recursion
-                    return {
-                        value: `/ipfs/${cid}${rest.length > 0 ? `/${rest.join('/')}` : ''}`,
-                        answer
-                    };
-                }
-                catch { }
-            }
-            else if (protocol === 'ipns') {
-                try {
-                    let peerId;
-                    // eslint-disable-next-line max-depth
-                    if (domainOrCID.charAt(0) === '1' || domainOrCID.charAt(0) === 'Q') {
-                        peerId = peerIdFromString(domainOrCID);
-                    }
-                    else {
-                        // try parsing as a CID
-                        peerId = peerIdFromCID(CID.parse(domainOrCID));
-                    }
-                    // if the result is a PeerId, we've reached the end of the recursion
-                    return {
-                        value: `/ipns/${peerId}${rest.length > 0 ? `/${rest.join('/')}` : ''}`,
-                        answer
-                    };
-                }
-                catch { }
-                // if the result was another IPNS domain, try to follow it
-                return await recursiveResolveDomain(domainOrCID, depth - 1, dns, log, options);
-            }
-            else if (protocol === 'dnslink') {
-                // if the result was another DNSLink domain, try to follow it
-                return await recursiveResolveDomain(domainOrCID, depth - 1, dns, log, options);
-            }
-            else {
-                log('unknown protocol "%s" in DNSLink record for domain: %s', protocol, domain);
-                continue;
-            }
-        }
-        catch (err) {
-            log.error('could not parse DNS link record for domain %s, %s', domain, answer.data, err);
-        }
-    }
-    // no dnslink records found, try CNAMEs
-    log('no DNSLink records found for %s, falling back to CNAME', domain);
-    const cnameRecordsResponse = await dns.query(domain, {
-        ...options,
-        types: [
-            RecordType.CNAME
-        ]
-    });
-    // sort the CNAME records to ensure deterministic processing
-    const cnameRecords = (cnameRecordsResponse?.Answer ?? [])
-        .sort((a, b) => a.data.localeCompare(b.data));
-    log('found %d CNAME records for %s', cnameRecords.length, domain);
-    for (const cname of cnameRecords) {
-        try {
-            return await recursiveResolveDomain(cname.data, depth - 1, dns, log, options);
-        }
-        catch (err) {
-            log.error('domain %s cname %s had no DNSLink records', domain, cname.data, err);
-        }
-    }
-    throw new DNSLinkNotFoundError(`No DNSLink records found for domain: ${domain}`);
-}
-async function recursiveResolveDomain(domain, depth, dns, log, options = {}) {
-    if (depth === 0) {
-        throw new Error('recursion limit exceeded');
-    }
-    // the DNSLink spec says records MUST be stored on the `_dnslink.` subdomain
-    // so start looking for records there, we will fall back to the bare domain
-    // if none are found
-    if (!domain.startsWith('_dnslink.')) {
-        domain = `_dnslink.${domain}`;
-    }
-    try {
-        return await recursiveResolveDnslink(domain, depth, dns, log, options);
-    }
-    catch (err) {
-        // If the code is not ENOTFOUND or ERR_DNSLINK_NOT_FOUND or ENODATA then throw the error
-        if (err.code !== 'ENOTFOUND' && err.code !== 'ENODATA' && err.name !== 'DNSLinkNotFoundError' && err.name !== 'NotFoundError') {
-            throw err;
-        }
-        if (domain.startsWith('_dnslink.')) {
-            // The supplied domain contains a _dnslink component
-            // Check the non-_dnslink domain
-            domain = domain.replace('_dnslink.', '');
-        }
-        else {
-            // Check the _dnslink subdomain
-            domain = `_dnslink.${domain}`;
-        }
-        // If this throws then we propagate the error
-        return recursiveResolveDnslink(domain, depth, dns, log, options);
-    }
-}
-export async function resolveDNSLink(domain, dns, log, options = {}) {
-    return recursiveResolveDomain(domain, options.maxRecursiveDepth ?? MAX_RECURSIVE_DEPTH, dns, log, options);
-}
-//# sourceMappingURL=dnslink.js.map

package/dist/src/dnslink.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"dnslink.js","sourceRoot":"","sources":["../../src/dnslink.ts"],"names":[],"mappings":"AAAA,OAAO,EAAG,MAAM,mBAAmB,CAAA;AACnC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAKlD,MAAM,mBAAmB,GAAG,EAAE,CAAA;AAO9B,KAAK,UAAU,uBAAuB,CAAE,MAAc,EAAE,KAAa,EAAE,GAAQ,EAAE,GAAW,EAAE,UAAiC,EAAE;IAC/H,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC7C,CAAC;IAED,GAAG,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAA;IACjD,MAAM,kBAAkB,GAAG,MAAM,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE;QACjD,GAAG,OAAO;QACV,KAAK,EAAE;YACL,UAAU,CAAC,GAAG;SACf;KACF,CAAC,CAAA;IAEF,0DAA0D;IAC1D,MAAM,UAAU,GAAG,CAAC,kBAAkB,EAAE,MAAM,IAAI,EAAE,CAAC;SAClD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;IAE/C,GAAG,CAAC,6BAA6B,EAAE,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAE7D,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE,CAAC;QAChC,IAAI,CAAC;YACH,IAAI,MAAM,GAAG,MAAM,CAAC,IAAI,CAAA;YAExB,0CAA0C;YAC1C,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnD,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;YACjD,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBACnC,kBAAkB;gBAClB,SAAQ;YACV,CAAC;YAED,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YAErC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;YAEvC,wDAAwD;YACxD,MAAM,CAAC,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA,CAAC,6BAA6B;YAE1F,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;gBACxB,IAAI,CAAC;oBACH,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;oBAElC,iEAAiE;oBACjE,OAAO;wBACL,KAAK,EAAE,SAAS,GAAG,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;wBACnE,MAAM;qBACP,CAAA;gBACH,CAAC;gBAAC,MAAM,CAAC,CAAA,CAAC;YACZ,CAAC;iBAAM,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;gBAC/B,IAAI,CAAC;oBACH,IAAI,MAAc,CAAA;oBAElB,qCAAqC;oBACrC,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;wBACnE,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAA;oBACxC,CAAC;yBAAM,CAAC;wBACN,uBAAuB;wBACvB,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAA;oBAChD,CAAC;oBAED,oEAAoE;oBACpE,OAAO;wBACL,KAAK,EAAE,SAAS,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;wBACtE,MAAM;qBACP,CAAA;gBACH,CAAC;gBAAC,MAAM,CAAC,CAAA,CAAC;gBAEV,0DAA0D;gBAC1D,OAAO,MAAM,sBAAsB,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;YAChF,CAAC;iBAAM,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAClC,6DAA6D;gBAC7D,OAAO,MAAM,sBAAsB,CAAC,WAAW,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;YAChF,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,wDAAwD,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAA;gBAC/E,SAAQ;YACV,CAAC;QACH,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,GAAG,CAAC,KAAK,CAAC,mDAAmD,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QAC1F,CAAC;IACH,CAAC;IAED,uCAAuC;IACvC,GAAG,CAAC,wDAAwD,EAAE,MAAM,CAAC,CAAA;IAErE,MAAM,oBAAoB,GAAG,MAAM,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE;QACnD,GAAG,OAAO;QACV,KAAK,EAAE;YACL,UAAU,CAAC,KAAK;SACjB;KACF,CAAC,CAAA;IAEF,4DAA4D;IAC5D,MAAM,YAAY,GAAG,CAAC,oBAAoB,EAAE,MAAM,IAAI,EAAE,CAAC;SACtD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;IAE/C,GAAG,CAAC,+BAA+B,EAAE,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAEjE,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;QACjC,IAAI,CAAC;YACH,OAAO,MAAM,sBAAsB,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;QAC/E,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,GAAG,CAAC,KAAK,CAAC,2CAA2C,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;QACjF,CAAC;IACH,CAAC;IAED,MAAM,IAAI,oBAAoB,CAAC,wCAAwC,MAAM,EAAE,CAAC,CAAA;AAClF,CAAC;AAED,KAAK,UAAU,sBAAsB,CAAE,MAAc,EAAE,KAAa,EAAE,GAAQ,EAAE,GAAW,EAAE,UAAiC,EAAE;IAC9H,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC7C,CAAC;IAED,4EAA4E;IAC5E,2EAA2E;IAC3E,oBAAoB;IACpB,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;QACpC,MAAM,GAAG,YAAY,MAAM,EAAE,CAAA;IAC/B,CAAC;IAED,IAAI,CAAC;QACH,OAAO,MAAM,uBAAuB,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;IACxE,CAAC;IAAC,OAAO,GAAQ,EAAE,CAAC;QAClB,wFAAwF;QACxF,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,sBAAsB,IAAI,GAAG,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;YAC9H,MAAM,GAAG,CAAA;QACX,CAAC;QAED,IAAI,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YACnC,oDAAoD;YACpD,gCAAgC;YAChC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;QAC1C,CAAC;aAAM,CAAC;YACN,+BAA+B;YAC/B,MAAM,GAAG,YAAY,MAAM,EAAE,CAAA;QAC/B,CAAC;QAED,6CAA6C;QAC7C,OAAO,uBAAuB,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;IAClE,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAAE,MAAc,EAAE,GAAQ,EAAE,GAAW,EAAE,UAAiC,EAAE;IAC9G,OAAO,sBAAsB,CAAC,MAAM,EAAE,OAAO,CAAC,iBAAiB,IAAI,mBAAmB,EAAE,GAAG,EAAE,GAAG,EAAE,OAAO,CAAC,CAAA;AAC5G,CAAC"}

package/dist/typedoc-urls.json

@@ -1,48 +0,0 @@
-{
-  "DNSLinkResolveResult": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.DNSLinkResolveResult.html",
-  ".:DNSLinkResolveResult": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.DNSLinkResolveResult.html",
-  "IPNS": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.IPNS.html",
-  ".:IPNS": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.IPNS.html",
-  "IPNSComponents": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.IPNSComponents.html",
-  ".:IPNSComponents": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.IPNSComponents.html",
-  "IPNSOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.IPNSOptions.html",
-  ".:IPNSOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.IPNSOptions.html",
-  "IPNSResolveResult": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.IPNSResolveResult.html",
-  ".:IPNSResolveResult": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.IPNSResolveResult.html",
-  "PublishOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.PublishOptions.html",
-  ".:PublishOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.PublishOptions.html",
-  "RepublishOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.RepublishOptions.html",
-  ".:RepublishOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.RepublishOptions.html",
-  "RepublishRecordOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.RepublishRecordOptions.html",
-  ".:RepublishRecordOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.RepublishRecordOptions.html",
-  "ResolveDNSLinkOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.ResolveDNSLinkOptions.html",
-  ".:ResolveDNSLinkOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.ResolveDNSLinkOptions.html",
-  "ResolveOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.ResolveOptions.html",
-  ".:ResolveOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.ResolveOptions.html",
-  "ResolveResult": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.ResolveResult.html",
-  ".:ResolveResult": "https://ipfs.github.io/helia/interfaces/_helia_ipns.index.ResolveResult.html",
-  "PublishProgressEvents": "https://ipfs.github.io/helia/types/_helia_ipns.index.PublishProgressEvents.html",
-  ".:PublishProgressEvents": "https://ipfs.github.io/helia/types/_helia_ipns.index.PublishProgressEvents.html",
-  "RepublishProgressEvents": "https://ipfs.github.io/helia/types/_helia_ipns.index.RepublishProgressEvents.html",
-  ".:RepublishProgressEvents": "https://ipfs.github.io/helia/types/_helia_ipns.index.RepublishProgressEvents.html",
-  "ResolveDNSLinkProgressEvents": "https://ipfs.github.io/helia/types/_helia_ipns.index.ResolveDNSLinkProgressEvents.html",
-  ".:ResolveDNSLinkProgressEvents": "https://ipfs.github.io/helia/types/_helia_ipns.index.ResolveDNSLinkProgressEvents.html",
-  "ResolveProgressEvents": "https://ipfs.github.io/helia/types/_helia_ipns.index.ResolveProgressEvents.html",
-  ".:ResolveProgressEvents": "https://ipfs.github.io/helia/types/_helia_ipns.index.ResolveProgressEvents.html",
-  "ipns": "https://ipfs.github.io/helia/functions/_helia_ipns.index.ipns.html",
-  ".:ipns": "https://ipfs.github.io/helia/functions/_helia_ipns.index.ipns.html",
-  "GetOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.routing.GetOptions.html",
-  "./routing:GetOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.routing.GetOptions.html",
-  "IPNSRouting": "https://ipfs.github.io/helia/interfaces/_helia_ipns.routing.IPNSRouting.html",
-  "./routing:IPNSRouting": "https://ipfs.github.io/helia/interfaces/_helia_ipns.routing.IPNSRouting.html",
-  "PubsubRoutingComponents": "https://ipfs.github.io/helia/interfaces/_helia_ipns.routing.PubsubRoutingComponents.html",
-  "PutOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.routing.PutOptions.html",
-  "./routing:PutOptions": "https://ipfs.github.io/helia/interfaces/_helia_ipns.routing.PutOptions.html",
-  "DatastoreProgressEvents": "https://ipfs.github.io/helia/types/_helia_ipns.routing.DatastoreProgressEvents.html",
-  "HeliaRoutingProgressEvents": "https://ipfs.github.io/helia/types/_helia_ipns.routing.HeliaRoutingProgressEvents.html",
-  "IPNSRoutingEvents": "https://ipfs.github.io/helia/types/_helia_ipns.routing.IPNSRoutingEvents.html",
-  "./routing:IPNSRoutingEvents": "https://ipfs.github.io/helia/types/_helia_ipns.routing.IPNSRoutingEvents.html",
-  "PubSubProgressEvents": "https://ipfs.github.io/helia/types/_helia_ipns.routing.PubSubProgressEvents.html",
-  "helia": "https://ipfs.github.io/helia/functions/_helia_ipns.routing.helia.html",
-  "pubsub": "https://ipfs.github.io/helia/functions/_helia_ipns.routing.pubsub.html"
-}

package/src/dnslink.ts

@@ -1,163 +0,0 @@
-import { } from '@libp2p/interface'
-import { peerIdFromCID, peerIdFromString } from '@libp2p/peer-id'
-import { RecordType } from '@multiformats/dns'
-import { CID } from 'multiformats/cid'
-import { DNSLinkNotFoundError } from './errors.js'
-import type { ResolveDNSLinkOptions } from './index.js'
-import type { Logger, PeerId } from '@libp2p/interface'
-import type { Answer, DNS } from '@multiformats/dns'
-
-const MAX_RECURSIVE_DEPTH = 32
-
-export interface DNSLinkResult {
-  answer: Answer
-  value: string
-}
-
-async function recursiveResolveDnslink (domain: string, depth: number, dns: DNS, log: Logger, options: ResolveDNSLinkOptions = {}): Promise<DNSLinkResult> {
-  if (depth === 0) {
-    throw new Error('recursion limit exceeded')
-  }
-
-  log('query %s for TXT and CNAME records', domain)
-  const txtRecordsResponse = await dns.query(domain, {
-    ...options,
-    types: [
-      RecordType.TXT
-    ]
-  })
-
-  // sort the TXT records to ensure deterministic processing
-  const txtRecords = (txtRecordsResponse?.Answer ?? [])
-    .sort((a, b) => a.data.localeCompare(b.data))
-
-  log('found %d TXT records for %s', txtRecords.length, domain)
-
-  for (const answer of txtRecords) {
-    try {
-      let result = answer.data
-
-      // strip leading and trailing " characters
-      if (result.startsWith('"') && result.endsWith('"')) {
-        result = result.substring(1, result.length - 1)
-      }
-
-      if (!result.startsWith('dnslink=')) {
-        // invalid record?
-        continue
-      }
-
-      log('%s TXT %s', answer.name, result)
-
-      result = result.replace('dnslink=', '')
-
-      // result is now a `/ipfs/<cid>` or `/ipns/<cid>` string
-      const [, protocol, domainOrCID, ...rest] = result.split('/') // e.g. ["", "ipfs", "<cid>"]
-
-      if (protocol === 'ipfs') {
-        try {
-          const cid = CID.parse(domainOrCID)
-
-          // if the result is a CID, we've reached the end of the recursion
-          return {
-            value: `/ipfs/${cid}${rest.length > 0 ? `/${rest.join('/')}` : ''}`,
-            answer
-          }
-        } catch {}
-      } else if (protocol === 'ipns') {
-        try {
-          let peerId: PeerId
-
-          // eslint-disable-next-line max-depth
-          if (domainOrCID.charAt(0) === '1' || domainOrCID.charAt(0) === 'Q') {
-            peerId = peerIdFromString(domainOrCID)
-          } else {
-            // try parsing as a CID
-            peerId = peerIdFromCID(CID.parse(domainOrCID))
-          }
-
-          // if the result is a PeerId, we've reached the end of the recursion
-          return {
-            value: `/ipns/${peerId}${rest.length > 0 ? `/${rest.join('/')}` : ''}`,
-            answer
-          }
-        } catch {}
-
-        // if the result was another IPNS domain, try to follow it
-        return await recursiveResolveDomain(domainOrCID, depth - 1, dns, log, options)
-      } else if (protocol === 'dnslink') {
-        // if the result was another DNSLink domain, try to follow it
-        return await recursiveResolveDomain(domainOrCID, depth - 1, dns, log, options)
-      } else {
-        log('unknown protocol "%s" in DNSLink record for domain: %s', protocol, domain)
-        continue
-      }
-    } catch (err: any) {
-      log.error('could not parse DNS link record for domain %s, %s', domain, answer.data, err)
-    }
-  }
-
-  // no dnslink records found, try CNAMEs
-  log('no DNSLink records found for %s, falling back to CNAME', domain)
-
-  const cnameRecordsResponse = await dns.query(domain, {
-    ...options,
-    types: [
-      RecordType.CNAME
-    ]
-  })
-
-  // sort the CNAME records to ensure deterministic processing
-  const cnameRecords = (cnameRecordsResponse?.Answer ?? [])
-    .sort((a, b) => a.data.localeCompare(b.data))
-
-  log('found %d CNAME records for %s', cnameRecords.length, domain)
-
-  for (const cname of cnameRecords) {
-    try {
-      return await recursiveResolveDomain(cname.data, depth - 1, dns, log, options)
-    } catch (err: any) {
-      log.error('domain %s cname %s had no DNSLink records', domain, cname.data, err)
-    }
-  }
-
-  throw new DNSLinkNotFoundError(`No DNSLink records found for domain: ${domain}`)
-}
-
-async function recursiveResolveDomain (domain: string, depth: number, dns: DNS, log: Logger, options: ResolveDNSLinkOptions = {}): Promise<DNSLinkResult> {
-  if (depth === 0) {
-    throw new Error('recursion limit exceeded')
-  }
-
-  // the DNSLink spec says records MUST be stored on the `_dnslink.` subdomain
-  // so start looking for records there, we will fall back to the bare domain
-  // if none are found
-  if (!domain.startsWith('_dnslink.')) {
-    domain = `_dnslink.${domain}`
-  }
-
-  try {
-    return await recursiveResolveDnslink(domain, depth, dns, log, options)
-  } catch (err: any) {
-    // If the code is not ENOTFOUND or ERR_DNSLINK_NOT_FOUND or ENODATA then throw the error
-    if (err.code !== 'ENOTFOUND' && err.code !== 'ENODATA' && err.name !== 'DNSLinkNotFoundError' && err.name !== 'NotFoundError') {
-      throw err
-    }
-
-    if (domain.startsWith('_dnslink.')) {
-      // The supplied domain contains a _dnslink component
-      // Check the non-_dnslink domain
-      domain = domain.replace('_dnslink.', '')
-    } else {
-      // Check the _dnslink subdomain
-      domain = `_dnslink.${domain}`
-    }
-
-    // If this throws then we propagate the error
-    return recursiveResolveDnslink(domain, depth, dns, log, options)
-  }
-}
-
-export async function resolveDNSLink (domain: string, dns: DNS, log: Logger, options: ResolveDNSLinkOptions = {}): Promise<DNSLinkResult> {
-  return recursiveResolveDomain(domain, options.maxRecursiveDepth ?? MAX_RECURSIVE_DEPTH, dns, log, options)
-}