@helia/ipns 8.2.4 → 9.0.0-9c67dbd4

package/dist/src/constants.d.ts

@@ -0,0 +1,17 @@
+export declare const DEFAULT_LIFETIME_MS: number;
+/**
+ * The default DHT record expiry
+ */
+export declare const DHT_EXPIRY_MS: number;
+/**
+ * How often to run the republish loop
+ */
+export declare const DEFAULT_REPUBLISH_INTERVAL_MS: number;
+/**
+ * Republish IPNS records when the expiry of our provider records is within this
+ * threshold
+ */
+export declare const REPUBLISH_THRESHOLD: number;
+export declare const DEFAULT_TTL_NS: bigint;
+export declare const DEFAULT_REPUBLISH_CONCURRENCY = 5;
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,mBAAmB,QAAY,CAAA;AAE5C;;GAEG;AACH,eAAO,MAAM,aAAa,QAAY,CAAA;AAEtC;;GAEG;AACH,eAAO,MAAM,6BAA6B,QAAO,CAAA;AAEjD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QAAY,CAAA;AAE5C,eAAO,MAAM,cAAc,QAA8B,CAAA;AAEzD,eAAO,MAAM,6BAA6B,IAAI,CAAA"}

package/dist/src/constants.js

@@ -0,0 +1,19 @@
+const MINUTE = 60 * 1000;
+const HOUR = 60 * MINUTE;
+export const DEFAULT_LIFETIME_MS = 48 * HOUR;
+/**
+ * The default DHT record expiry
+ */
+export const DHT_EXPIRY_MS = 48 * HOUR;
+/**
+ * How often to run the republish loop
+ */
+export const DEFAULT_REPUBLISH_INTERVAL_MS = HOUR;
+/**
+ * Republish IPNS records when the expiry of our provider records is within this
+ * threshold
+ */
+export const REPUBLISH_THRESHOLD = 24 * HOUR;
+export const DEFAULT_TTL_NS = BigInt(MINUTE) * 5000000n; // 5 minutes
+export const DEFAULT_REPUBLISH_CONCURRENCY = 5;
+//# sourceMappingURL=constants.js.map

package/dist/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG,EAAE,GAAG,IAAI,CAAA;AACxB,MAAM,IAAI,GAAG,EAAE,GAAG,MAAM,CAAA;AAExB,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,IAAI,CAAA;AAE5C;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,GAAG,IAAI,CAAA;AAEtC;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,IAAI,CAAA;AAEjD;;;GAGG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,IAAI,CAAA;AAE5C,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,QAAU,CAAA,CAAC,YAAY;AAEtE,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAA"}

package/dist/src/errors.d.ts

@@ -1,7 +1,3 @@
-export declare class DNSLinkNotFoundError extends Error {
-    static name: string;
-    constructor(message?: string);
-}
 export declare class RecordsFailedValidationError extends Error {
     static name: string;
     constructor(message?: string);

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

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,oBAAqB,SAAQ,KAAK;IAC7C,MAAM,CAAC,IAAI,SAAyB;gBAEvB,OAAO,SAAsB;CAI3C;AAED,qBAAa,4BAA6B,SAAQ,KAAK;IACrD,MAAM,CAAC,IAAI,SAAiC;gBAE/B,OAAO,SAA8B;CAInD;AAED,qBAAa,+BAAgC,SAAQ,KAAK;IACxD,MAAM,CAAC,IAAI,SAAoC;gBAElC,OAAO,SAAiC;CAItD;AAED,qBAAa,8BAA+B,SAAQ,KAAK;IACvD,MAAM,CAAC,IAAI,SAAmC;gBAEjC,OAAO,SAAgC;CAIrD;AAED,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,SAAsB;gBAEpB,OAAO,SAAkB;CAIvC;AAED,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,SAAsB;gBAEpB,OAAO,SAAkB;CAIvC"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,4BAA6B,SAAQ,KAAK;IACrD,MAAM,CAAC,IAAI,SAAiC;gBAE/B,OAAO,SAA8B;CAInD;AAED,qBAAa,+BAAgC,SAAQ,KAAK;IACxD,MAAM,CAAC,IAAI,SAAoC;gBAElC,OAAO,SAAiC;CAItD;AAED,qBAAa,8BAA+B,SAAQ,KAAK;IACvD,MAAM,CAAC,IAAI,SAAmC;gBAEjC,OAAO,SAAgC;CAIrD;AAED,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,SAAsB;gBAEpB,OAAO,SAAkB;CAIvC;AAED,qBAAa,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,SAAsB;gBAEpB,OAAO,SAAkB;CAIvC"}

package/dist/src/errors.js

@@ -1,10 +1,3 @@
-export class DNSLinkNotFoundError extends Error {
-    static name = 'DNSLinkNotFoundError';
-    constructor(message = 'DNSLink not found') {
-        super(message);
-        this.name = 'DNSLinkNotFoundError';
-    }
-}
 export class RecordsFailedValidationError extends Error {
     static name = 'RecordsFailedValidationError';
     constructor(message = 'Records failed validation') {

package/dist/src/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAC7C,MAAM,CAAC,IAAI,GAAG,sBAAsB,CAAA;IAEpC,YAAa,OAAO,GAAG,mBAAmB;QACxC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAA;IACpC,CAAC;;AAGH,MAAM,OAAO,4BAA6B,SAAQ,KAAK;IACrD,MAAM,CAAC,IAAI,GAAG,8BAA8B,CAAA;IAE5C,YAAa,OAAO,GAAG,2BAA2B;QAChD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,8BAA8B,CAAA;IAC5C,CAAC;;AAGH,MAAM,OAAO,+BAAgC,SAAQ,KAAK;IACxD,MAAM,CAAC,IAAI,GAAG,iCAAiC,CAAA;IAE/C,YAAa,OAAO,GAAG,8BAA8B;QACnD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,iCAAiC,CAAA;IAC/C,CAAC;;AAGH,MAAM,OAAO,8BAA+B,SAAQ,KAAK;IACvD,MAAM,CAAC,IAAI,GAAG,gCAAgC,CAAA;IAE9C,YAAa,OAAO,GAAG,6BAA6B;QAClD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,gCAAgC,CAAA;IAC9C,CAAC;;AAGH,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,GAAG,mBAAmB,CAAA;IAEjC,YAAa,OAAO,GAAG,eAAe;QACpC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAA;IACjC,CAAC;;AAGH,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,GAAG,mBAAmB,CAAA;IAEjC,YAAa,OAAO,GAAG,eAAe;QACpC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAA;IACjC,CAAC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,4BAA6B,SAAQ,KAAK;IACrD,MAAM,CAAC,IAAI,GAAG,8BAA8B,CAAA;IAE5C,YAAa,OAAO,GAAG,2BAA2B;QAChD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,8BAA8B,CAAA;IAC5C,CAAC;;AAGH,MAAM,OAAO,+BAAgC,SAAQ,KAAK;IACxD,MAAM,CAAC,IAAI,GAAG,iCAAiC,CAAA;IAE/C,YAAa,OAAO,GAAG,8BAA8B;QACnD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,iCAAiC,CAAA;IAC/C,CAAC;;AAGH,MAAM,OAAO,8BAA+B,SAAQ,KAAK;IACvD,MAAM,CAAC,IAAI,GAAG,gCAAgC,CAAA;IAE9C,YAAa,OAAO,GAAG,6BAA6B;QAClD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,gCAAgC,CAAA;IAC9C,CAAC;;AAGH,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,GAAG,mBAAmB,CAAA;IAEjC,YAAa,OAAO,GAAG,eAAe;QACpC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAA;IACjC,CAAC;;AAGH,MAAM,OAAO,iBAAkB,SAAQ,KAAK;IAC1C,MAAM,CAAC,IAAI,GAAG,mBAAmB,CAAA;IAEjC,YAAa,OAAO,GAAG,eAAe;QACpC,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAA;IACjC,CAAC"}

package/dist/src/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * @packageDocumentation
  *
- * IPNS operations using a Helia node
+ * [IPNS](https://docs.ipfs.tech/concepts/ipns/) operations using a Helia node
  *
  * @example Getting started
  *
@@ -11,23 +11,19 @@
  * 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)
  * ```
@@ -46,24 +42,18 @@
  * 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
  * ```
  *
@@ -80,9 +70,6 @@
  * 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]))
@@ -92,10 +79,10 @@
  * 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'
  * ```
@@ -121,13 +108,14 @@
  * import { ipns } from '@helia/ipns'
  * import { pubsub } from '@helia/ipns/routing'
  * import { unixfs } from '@helia/unixfs'
- * import { gossipsub } from '@chainsafe/libp2p-gossipsub'
+ * import { floodsub } from '@libp2p/floodsub'
  * import { generateKeyPair } from '@libp2p/crypto/keys'
- * import type { Libp2p, PubSub } from '@libp2p/interface'
+ * import type { PubSub } from '@helia/ipns/routing'
+ * import type { Libp2p } from '@libp2p/interface'
  * import type { DefaultLibp2pServices } from 'helia'
  *
  * const libp2pOptions = libp2pDefaults()
- * libp2pOptions.services.pubsub = gossipsub()
+ * libp2pOptions.services.pubsub = floodsub()
  *
  * const helia = await createHelia<Libp2p<DefaultLibp2pServices & { pubsub: PubSub }>>({
  *   libp2p: libp2pOptions
@@ -138,133 +126,30 @@
  *  ]
  * })
  *
- * // 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)
- * ```
- *
- * @example Using custom DNS over HTTPS resolvers
- *
- * To use custom resolvers, configure Helia's `dns` option:
- *
- * ```TypeScript
- * 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'
- *
- * const node = await createHelia({
- *   dns: dns({
- *     resolvers: {
- *       '.': dnsOverHttps('https://private-dns-server.me/dns-query')
- *     }
- *   })
- * })
- * const name = ipns(node, {
- *  routers: [
- *    helia(node.routing)
- *  ]
- * })
- *
- * const result = name.resolveDNSLink('some-domain-with-dnslink-entry.com')
- * ```
- *
- * @example Resolving a domain with a dnslink entry
- *
- * 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
- * // ;; 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"
- *
- * import { createHelia } from 'helia'
- * import { ipns } from '@helia/ipns'
- *
- * const node = await createHelia()
- * const name = ipns(node)
- *
- * const { answer } = await name.resolveDNSLink('ipfs.io')
- *
- * console.info(answer)
- * // { data: '/ipfs/QmWebsite' }
- * ```
- *
- * @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
- * response which can increase browser bundle sizes.
- *
- * If this is a concern, use the DNS-JSON-Over-HTTPS resolver instead.
- *
- * ```TypeScript
- * import { createHelia } from 'helia'
- * import { ipns } from '@helia/ipns'
- * import { dns } from '@multiformats/dns'
- * import { dnsOverHttps } from '@multiformats/dns/resolvers'
- *
- * const node = await createHelia({
- *   dns: dns({
- *     resolvers: {
- *       '.': dnsOverHttps('https://mozilla.cloudflare-dns.com/dns-query')
- *     }
- *   })
- * })
- * const name = ipns(node)
- *
- * const result = await name.resolveDNSLink('ipfs.io')
- * ```
- *
- * @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.
- *
- * ```TypeScript
- * import { createHelia } from 'helia'
- * import { ipns } from '@helia/ipns'
- * import { dns } from '@multiformats/dns'
- * import { dnsJsonOverHttps } from '@multiformats/dns/resolvers'
- *
- * const node = await createHelia({
- *   dns: dns({
- *     resolvers: {
- *       '.': dnsJsonOverHttps('https://mozilla.cloudflare-dns.com/dns-query')
- *     }
- *   })
- * })
- * const name = ipns(node)
- *
- * const result = await name.resolveDNSLink('ipfs.io')
+ * const result = await name.resolve(publicKey)
  * ```
  *
  * @example Republishing an existing IPNS record
  *
- * The `republishRecord` method allows you to republish an existing IPNS record without
- * needing the private key. This is useful for relay nodes or when you want to extend
- * the availability of a record that was created elsewhere.
+ * It is sometimes useful to be able to republish an existing IPNS record
+ * without needing the private key. This allows you to extend the availability
+ * of a record that was created elsewhere.
  *
  * ```TypeScript
  * import { createHelia } from 'helia'
- * import { ipns } from '@helia/ipns'
+ * import { ipns, ipnsValidator } from '@helia/ipns'
  * import { createDelegatedRoutingV1HttpApiClient } from '@helia/delegated-routing-v1-http-api-client'
  * import { CID } from 'multiformats/cid'
+ * import { multihashToIPNSRoutingKey, marshalIPNSRecord } from 'ipns'
  *
  * const helia = await createHelia()
  * const name = ipns(helia)
@@ -274,27 +159,33 @@
  * const delegatedClient = createDelegatedRoutingV1HttpApiClient('https://delegated-ipfs.dev')
  * const record = await delegatedClient.getIPNS(parsedCid)
  *
- * await name.republishRecord(ipnsName, record)
+ * const routingKey = multihashToIPNSRoutingKey(parsedCid.multihash)
+ * const marshaledRecord = marshalIPNSRecord(record)
+ *
+ * // validate that they key corresponds to the record
+ * await ipnsValidator(routingKey, marshaledRecord)
+ *
+ * // publish record to routing
+ * await Promise.all(
+ *   name.routers.map(async r => {
+ *     await r.put(routingKey, marshaledRecord)
+ *   })
+ * )
  * ```
  */
 import { ipnsValidator } from 'ipns/validator';
 import { CID } from 'multiformats/cid';
 import type { IPNSRouting, IPNSRoutingEvents } from './routing/index.js';
-import type { Routing } from '@helia/interface';
-import type { AbortOptions, ComponentLogger, PrivateKey, PublicKey } from '@libp2p/interface';
-import type { Answer, DNS, ResolveDnsProgressEvents } from '@multiformats/dns';
+import type { Routing, HeliaEvents } from '@helia/interface';
+import type { AbortOptions, ComponentLogger, Libp2p, PeerId, PublicKey, TypedEventEmitter } from '@libp2p/interface';
+import type { Keychain } from '@libp2p/keychain';
 import type { Datastore } from 'interface-datastore';
 import type { IPNSRecord } from 'ipns';
 import type { MultihashDigest } from 'multiformats/hashes/interface';
 import type { ProgressEvent, ProgressOptions } from 'progress-events';
 export type PublishProgressEvents = ProgressEvent<'ipns:publish:start'> | ProgressEvent<'ipns:publish:success', IPNSRecord> | ProgressEvent<'ipns:publish:error', Error>;
 export type ResolveProgressEvents = ProgressEvent<'ipns:resolve:start', unknown> | ProgressEvent<'ipns:resolve:success', IPNSRecord> | ProgressEvent<'ipns:resolve:error', Error>;
-export type RepublishProgressEvents = ProgressEvent<'ipns:republish:start', unknown> | ProgressEvent<'ipns:republish:success', IPNSRecord> | ProgressEvent<'ipns:republish:error', {
-    key?: MultihashDigest<0x00 | 0x12>;
-    record: IPNSRecord;
-    err: Error;
-}>;
-export type ResolveDNSLinkProgressEvents = ResolveProgressEvents | IPNSRoutingEvents | ResolveDnsProgressEvents;
+export type DatastoreProgressEvents = ProgressEvent<'ipns:routing:datastore:put'> | ProgressEvent<'ipns:routing:datastore:get'> | ProgressEvent<'ipns:routing:datastore:list'> | ProgressEvent<'ipns:routing:datastore:error', Error>;
 export interface PublishOptions extends AbortOptions, ProgressOptions<PublishProgressEvents | IPNSRoutingEvents> {
     /**
      * Time duration of the signature validity in ms (default: 48hrs)
@@ -314,6 +205,10 @@ export interface PublishOptions extends AbortOptions, ProgressOptions<PublishPro
      */
     ttl?: number;
 }
+export interface IPNSRecordMetadata {
+    keyName: string;
+    lifetime: number;
+}
 export interface ResolveOptions extends AbortOptions, ProgressOptions<ResolveProgressEvents | IPNSRoutingEvents> {
     /**
      * Do not query the network for the IPNS record
@@ -328,41 +223,6 @@ export interface ResolveOptions extends AbortOptions, ProgressOptions<ResolvePro
      */
     nocache?: boolean;
 }
-export interface ResolveDNSLinkOptions extends AbortOptions, ProgressOptions<ResolveDNSLinkProgressEvents> {
-    /**
-     * Do not query the network for the IPNS record
-     *
-     * @default false
-     */
-    offline?: boolean;
-    /**
-     * Do not use cached DNS entries
-     *
-     * @default false
-     */
-    nocache?: boolean;
-    /**
-     * When resolving DNSLink records that resolve to other DNSLink records, limit
-     * how many times we will recursively resolve them.
-     *
-     * @default 32
-     */
-    maxRecursiveDepth?: number;
-}
-export interface RepublishOptions extends AbortOptions, ProgressOptions<RepublishProgressEvents | IPNSRoutingEvents> {
-    /**
-     * The republish interval in ms (default: 23hrs)
-     */
-    interval?: number;
-}
-export interface RepublishRecordOptions extends AbortOptions, ProgressOptions<RepublishProgressEvents | IPNSRoutingEvents> {
-    /**
-     * Only publish to a local datastore
-     *
-     * @default false
-     */
-    offline?: boolean;
-}
 export interface ResolveResult {
     /**
      * The CID that was resolved
@@ -381,52 +241,100 @@ export interface IPNSResolveResult extends ResolveResult {
      */
     record: IPNSRecord;
 }
-export interface DNSLinkResolveResult extends ResolveResult {
+export interface IPNSPublishResult {
     /**
-     * The resolved record
+     * The published record
      */
-    answer: Answer;
-}
-export interface IPNS {
+    record: IPNSRecord;
     /**
-     * Creates an IPNS record signed by the passed PeerId that will resolve to the passed value
-     *
-     * If the value is a PeerId, a recursive IPNS record will be created.
+     * The public key that was used to publish the record
      */
-    publish(key: PrivateKey, value: CID | PublicKey | MultihashDigest<0x00 | 0x12> | string, options?: PublishOptions): Promise<IPNSRecord>;
+    publicKey: PublicKey;
+}
+export interface IPNS {
     /**
-     * Accepts a public key formatted as a libp2p PeerID and resolves the IPNS record
-     * corresponding to that public key until a value is found
+     * Configured routing subsystems used to publish/resolve IPNS names
      */
-    resolve(key: PublicKey | MultihashDigest<0x00 | 0x12>, options?: ResolveOptions): Promise<IPNSResolveResult>;
+    routers: IPNSRouting[];
     /**
-     * Resolve a CID from a dns-link style IPNS record
+     * Creates and publishes an IPNS record that will resolve the passed value
+     * signed by a key stored in the libp2p keychain under the passed key name.
+     *
+     * It is possible to create a recursive IPNS record by passing:
+     *
+     * - A PeerId,
+     * - A PublicKey
+     * - A CID with the libp2p-key codec and Identity or SHA256 hash algorithms
+     * - A Multihash with the Identity or SHA256 hash algorithms
+     * - A string IPNS key (e.g. `/ipns/Qmfoo`)
+     *
+     * @example
+     *
+     * ```TypeScript
+     * import { createHelia } from 'helia'
+     * import { ipns } from '@helia/ipns'
+     *
+     * const helia = await createHelia()
+     * const name = ipns(helia)
+     *
+     * const result = await name.publish('my-key-name', cid, {
+     *   signal: AbortSignal.timeout(5_000)
+     * })
+     *
+     * console.info(result) // { answer: ... }
+     * ```
      */
-    resolveDNSLink(domain: string, options?: ResolveDNSLinkOptions): Promise<DNSLinkResolveResult>;
+    publish(keyName: string, value: CID | PublicKey | MultihashDigest<0x00 | 0x12> | PeerId | string, options?: PublishOptions): Promise<IPNSPublishResult>;
     /**
-     * Periodically republish all IPNS records found in the datastore
+     * Accepts a libp2p public key, a CID with the libp2p-key codec and either the
+     * identity hash (for Ed25519 and secp256k1 public keys) or a SHA256 hash (for
+     * RSA public keys), or the multihash of a libp2p-key encoded CID, or a
+     * Ed25519, secp256k1 or RSA PeerId and recursively resolves the IPNS record
+     * corresponding to that key until a value is found.
      */
-    republish(options?: RepublishOptions): void;
+    resolve(key: CID<unknown, 0x72, 0x00 | 0x12, 1> | PublicKey | MultihashDigest<0x00 | 0x12> | PeerId, options?: ResolveOptions): Promise<IPNSResolveResult>;
     /**
-     * Republish an existing IPNS record without the private key.
+     * Stop republishing of an IPNS record
      *
-     * Before republishing the record will be validated to ensure it has a valid signature and lifetime(validity) in the future.
-     * The key is a multihash of the public key or a string representation of the PeerID (either base58btc encoded multihash or base36 encoded CID)
+     * This will delete the last signed IPNS record from the datastore, but the
+     * key will remain in the keychain.
+     *
+     * Note that the record may still be resolved by other peers until it expires
+     * or is no longer valid.
      */
-    republishRecord(key: MultihashDigest<0x00 | 0x12> | string, record: IPNSRecord, options?: RepublishRecordOptions): Promise<void>;
+    unpublish(keyName: string, options?: AbortOptions): Promise<void>;
 }
 export type { IPNSRouting } from './routing/index.js';
 export type { IPNSRecord } from 'ipns';
 export interface IPNSComponents {
     datastore: Datastore;
     routing: Routing;
-    dns: DNS;
     logger: ComponentLogger;
+    libp2p: Libp2p<{
+        keychain: Keychain;
+    }>;
+    events: TypedEventEmitter<HeliaEvents>;
 }
 export interface IPNSOptions {
+    /**
+     * Different routing systems for IPNS publishing/resolving
+     */
     routers?: IPNSRouting[];
+    /**
+     * How often to check if published records have expired and need republishing
+     * in ms
+     *
+     * @default 3_600_000
+     */
+    republishInterval?: number;
+    /**
+     * How many IPNS records to republish at once
+     *
+     * @default 5
+     */
+    republishConcurrency?: number;
 }
-export declare function ipns(components: IPNSComponents, { routers }?: IPNSOptions): IPNS;
+export declare function ipns(components: IPNSComponents, options?: IPNSOptions): IPNS;
 export { ipnsValidator, type IPNSRoutingEvents };
 export { ipnsSelector } from 'ipns/selector';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsRG;AAOH,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAG9C,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAQtC,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAExE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAC/C,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAU,UAAU,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AACrG,OAAO,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,wBAAwB,EAAE,MAAM,mBAAmB,CAAA;AAC9E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AAEtC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAYrE,MAAM,MAAM,qBAAqB,GAC/B,aAAa,CAAC,oBAAoB,CAAC,GACnC,aAAa,CAAC,sBAAsB,EAAE,UAAU,CAAC,GACjD,aAAa,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAA;AAE5C,MAAM,MAAM,qBAAqB,GAC/B,aAAa,CAAC,oBAAoB,EAAE,OAAO,CAAC,GAC5C,aAAa,CAAC,sBAAsB,EAAE,UAAU,CAAC,GACjD,aAAa,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAA;AAE5C,MAAM,MAAM,uBAAuB,GACjC,aAAa,CAAC,sBAAsB,EAAE,OAAO,CAAC,GAC9C,aAAa,CAAC,wBAAwB,EAAE,UAAU,CAAC,GACnD,aAAa,CAAC,sBAAsB,EAAE;IAAE,GAAG,CAAC,EAAE,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IAAC,MAAM,EAAE,UAAU,CAAC;IAAC,GAAG,EAAE,KAAK,CAAA;CAAE,CAAC,CAAA;AAE/G,MAAM,MAAM,4BAA4B,GACtC,qBAAqB,GACrB,iBAAiB,GACjB,wBAAwB,CAAA;AAE1B,MAAM,WAAW,cAAe,SAAQ,YAAY,EAAE,eAAe,CAAC,qBAAqB,GAAG,iBAAiB,CAAC;IAC9G;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY,EAAE,eAAe,CAAC,qBAAqB,GAAG,iBAAiB,CAAC;IAC9G;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,qBAAsB,SAAQ,YAAY,EAAE,eAAe,CAAC,4BAA4B,CAAC;IACxG;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY,EAAE,eAAe,CAAC,uBAAuB,GAAG,iBAAiB,CAAC;IAClH;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,sBAAuB,SAAQ,YAAY,EAAE,eAAe,CAAC,uBAAuB,GAAG,iBAAiB,CAAC;IACxH;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,EAAE,GAAG,CAAA;IAER;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;CACnB;AAED,MAAM,WAAW,oBAAqB,SAAQ,aAAa;IACzD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,IAAI;IACnB;;;;OAIG;IACH,OAAO,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,GAAG,SAAS,GAAG,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;IAEvI;;;OAGG;IACH,OAAO,CAAC,GAAG,EAAE,SAAS,GAAG,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAE5G;;OAEG;IACH,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAE9F;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAE3C;;;;;OAKG;IACH,eAAe,CAAC,GAAG,EAAE,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACjI;AAED,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAErD,YAAY,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AAEtC,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,SAAS,CAAA;IACpB,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,GAAG,CAAA;IACR,MAAM,EAAE,eAAe,CAAA;CACxB;AAuTD,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,WAAW,EAAE,CAAA;CACxB;AAED,wBAAgB,IAAI,CAAE,UAAU,EAAE,cAAc,EAAE,EAAE,OAAY,EAAE,GAAE,WAAgB,GAAG,IAAI,CAE1F;AAED,OAAO,EAAE,aAAa,EAAE,KAAK,iBAAiB,EAAE,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8KG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAC9C,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAEtC,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACxE,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC5D,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AACpH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAChD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AACtC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAErE,MAAM,MAAM,qBAAqB,GAC/B,aAAa,CAAC,oBAAoB,CAAC,GACnC,aAAa,CAAC,sBAAsB,EAAE,UAAU,CAAC,GACjD,aAAa,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAA;AAE5C,MAAM,MAAM,qBAAqB,GAC/B,aAAa,CAAC,oBAAoB,EAAE,OAAO,CAAC,GAC5C,aAAa,CAAC,sBAAsB,EAAE,UAAU,CAAC,GACjD,aAAa,CAAC,oBAAoB,EAAE,KAAK,CAAC,CAAA;AAE5C,MAAM,MAAM,uBAAuB,GACjC,aAAa,CAAC,4BAA4B,CAAC,GAC3C,aAAa,CAAC,4BAA4B,CAAC,GAC3C,aAAa,CAAC,6BAA6B,CAAC,GAC5C,aAAa,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAA;AAEtD,MAAM,WAAW,cAAe,SAAQ,YAAY,EAAE,eAAe,CAAC,qBAAqB,GAAG,iBAAiB,CAAC;IAC9G;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,cAAe,SAAQ,YAAY,EAAE,eAAe,CAAC,qBAAqB,GAAG,iBAAiB,CAAC;IAC9G;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,GAAG,EAAE,GAAG,CAAA;IAER;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACtD;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;IAElB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAA;CACrB;AAED,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,OAAO,EAAE,WAAW,EAAE,CAAA;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,SAAS,GAAG,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAEvJ;;;;;;OAMG;IACH,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC,GAAG,SAAS,GAAG,eAAe,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAA;IAE1J;;;;;;;;OAQG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAClE;AAED,YAAY,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAErD,YAAY,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AAEtC,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,SAAS,CAAA;IACpB,OAAO,EAAE,OAAO,CAAA;IAChB,MAAM,EAAE,eAAe,CAAA;IACvB,MAAM,EAAE,MAAM,CAAC;QAAE,QAAQ,EAAE,QAAQ,CAAA;KAAE,CAAC,CAAA;IACtC,MAAM,EAAE,iBAAiB,CAAC,WAAW,CAAC,CAAA;CACvC;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,EAAE,CAAA;IAEvB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAA;CAC9B;AAED,wBAAgB,IAAI,CAAE,UAAU,EAAE,cAAc,EAAE,OAAO,GAAE,WAAgB,GAAG,IAAI,CAEjF;AAED,OAAO,EAAE,aAAa,EAAE,KAAK,iBAAiB,EAAE,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA"}