@enbox/dids 0.0.3 → 0.0.5

package/dist/types/methods/did-dht.d.ts

@@ -1,293 +1,15 @@
-import type { AsymmetricKeyConverter, CryptoApi, Jwk, KeyIdentifier, KeyImporterExporter, KmsExportKeyParams, KmsImportKeyParams, Signer } from '@enbox/crypto';
+import type { AsymmetricKeyConverter, Jwk, KeyIdentifier, KeyImporterExporter, KeyManager, KmsExportKeyParams, KmsImportKeyParams, Signer } from '@enbox/crypto';
 import type { Packet, TxtData } from '@dnsquery/dns-packet';
-import type { DidCreateOptions, DidCreateVerificationMethod, DidRegistrationResult } from './did-method.js';
-import type { DidDocument, DidResolutionOptions, DidResolutionResult, DidService, DidVerificationMethod } from '../types/did-core.js';
-import type { DidMetadata, PortableDid } from '../types/portable-did.js';
+import type { PortableDid } from '../types/portable-did.js';
+import type { DidRegistrationResult } from './did-method.js';
+import type { DidDocument, DidResolutionOptions, DidResolutionResult, DidVerificationMethod } from '../types/did-core.js';
 import { BearerDid } from '../bearer-did.js';
 import { DidMethod } from './did-method.js';
-/**
- * Represents a BEP44 message, which is used for storing and retrieving data in the Mainline DHT
- * network.
- *
- * A BEP44 message is used primarily in the context of the DID DHT method for publishing and
- * resolving DID documents in the DHT network. This type encapsulates the data structure required
- * for such operations in accordance with BEP44.
- *
- * @see {@link https://www.bittorrent.org/beps/bep_0044.html | BEP44}
- */
-export interface Bep44Message {
-    /**
-     * The public key bytes of the Identity Key, which serves as the identifier in the DHT network for
-     * the corresponding BEP44 message.
-     */
-    k: Uint8Array;
-    /**
-     * The sequence number of the message, used to ensure the latest version of the data is retrieved
-     * and updated. It's a monotonically increasing number.
-     */
-    seq: number;
-    /**
-     * The signature of the message, ensuring the authenticity and integrity of the data. It's
-     * computed over the bencoded sequence number and value.
-     */
-    sig: Uint8Array;
-    /**
-     * The actual data being stored or retrieved from the DHT network, typically encoded in a format
-     * suitable for DNS packet representation of a DID Document.
-     */
-    v: Uint8Array;
-}
-/**
- * Options for creating a Decentralized Identifier (DID) using the DID DHT method.
- */
-export interface DidDhtCreateOptions<TKms> extends DidCreateOptions<TKms> {
-    /**
-     * Optionally specify that the DID Subject is also identified by one or more other DIDs or URIs.
-     *
-     * A DID subject can have multiple identifiers for different purposes, or at different times.
-     * The assertion that two or more DIDs (or other types of URI) refer to the same DID subject can
-     * be made using the `alsoKnownAs` property.
-     *
-     * @see {@link https://www.w3.org/TR/did-core/#also-known-as | DID Core Specification, § Also Known As}
-     *
-     * @example
-     * ```ts
-     * const did = await DidDht.create({
-     *  options: {
-     *   alsoKnownAs: 'did:example:123'
-     * };
-     * ```
-     */
-    alsoKnownAs?: string[];
-    /**
-     * Optionally specify which DID (or DIDs) is authorized to make changes to the DID document.
-     *
-     * A DID controller is an entity that is authorized to make changes to a DID document. Typically,
-     * only the DID Subject (i.e., the value of `id` property in the DID document) is authoritative.
-     * However, another DID (or DIDs) can be specified as the DID controller, and when doing so, any
-     * verification methods contained in the DID document for the other DID should be accepted as
-     * authoritative. In other words, proofs created by the controller DID should be considered
-     * equivalent to proofs created by the DID Subject.
-     *
-     * @see {@link https://www.w3.org/TR/did-core/#did-controller | DID Core Specification, § DID Controller}
-     *
-     * @example
-     * ```ts
-     * const did = await DidDht.create({
-     *  options: {
-     *   controller: 'did:example:123'
-     * };
-     * ```
-     */
-    controllers?: string | string[];
-    /**
-     * Optional. The URI of a server involved in executing DID method operations. In the context of
-     * DID creation, the endpoint is expected to be a DID DHT Gateway or Pkarr relay. If not
-     * specified, a default gateway node is used.
-     */
-    gatewayUri?: string;
-    /**
-     * Optional. Determines whether the created DID should be published to the DHT network.
-     *
-     * If set to `true` or omitted, the DID is publicly discoverable. If `false`, the DID is not
-     * published and cannot be resolved by others. By default, newly created DIDs are published.
-     *
-     * @see {@link https://did-dht.com | DID DHT Method Specification}
-     *
-     * @example
-     * ```ts
-     * const did = await DidDht.create({
-     *  options: {
-     *   publish: false
-     * };
-     * ```
-     */
-    publish?: boolean;
-    /**
-     * Optional. An array of service endpoints associated with the DID.
-     *
-     * Services are used in DID documents to express ways of communicating with the DID subject or
-     * associated entities. A service can be any type of service the DID subject wants to advertise,
-     * including decentralized identity management services for further discovery, authentication,
-     * authorization, or interaction.
-     *
-     * @see {@link https://www.w3.org/TR/did-core/#services | DID Core Specification, § Services}
-     *
-     * @example
-     * ```ts
-     * const did = await DidDht.create({
-     *  options: {
-     *   services: [
-     *     {
-     *       id: 'did:dht:i9xkp8ddcbcg8jwq54ox699wuzxyifsqx4jru45zodqu453ksz6y#dwn',
-     *       type: 'DecentralizedWebNode',
-     *       serviceEndpoint: ['https://example.com/dwn1', 'https://example/dwn2']
-     *     }
-     *   ]
-     * };
-     * ```
-     */
-    services?: DidService[];
-    /**
-     * Optionally specify one or more registered DID DHT types to make the DID discovereable.
-     *
-     * Type indexing is an OPTIONAL feature that enables DIDs to become discoverable. DIDs that wish
-     * to be discoverable and resolveable by type can include one or more types when publishing their
-     * DID document to a DID DHT Gateway.
-     *
-     * The registered DID types are published in the {@link https://did-dht.com/registry/index.html#indexed-types | DID DHT Registry}.
-     */
-    types?: (DidDhtRegisteredDidType | keyof typeof DidDhtRegisteredDidType)[];
-    /**
-     * Optional. An array of verification methods to be included in the DID document.
-     *
-     * By default, a newly created DID DHT document will contain a single Ed25519 verification method,
-     * also known as the {@link https://did-dht.com/#term:identity-key | Identity Key}. Additional
-     * verification methods can be added to the DID document using the `verificationMethods` property.
-     *
-     * @see {@link https://www.w3.org/TR/did-core/#verification-methods | DID Core Specification, § Verification Methods}
-     *
-     * @example
-     * ```ts
-     * const did = await DidDht.create({
-     *  options: {
-     *   verificationMethods: [
-     *     {
-     *       algorithm: 'Ed25519',
-     *       purposes: ['authentication', 'assertionMethod']
-     *     },
-     *     {
-     *       algorithm: 'Ed25519',
-     *       id: 'dwn-sig',
-     *       purposes: ['authentication', 'assertionMethod']
-     *     }
-     *   ]
-     * };
-     * ```
-     */
-    verificationMethods?: DidCreateVerificationMethod<TKms>[];
-}
-/**
- * Proof to used to construct the `_prv._did.` DNS record as described in https://did-dht.com/#rotation to link a DID to a previous DID.
- */
-export type PreviousDidProof = {
-    /** The previous DID. */
-    previousDid: string;
-    /** The signature signed using the private Identity Key of the previous DID in Base64URL format. */
-    signature: string;
-};
-/**
- * Represents an optional extension to a DID Document’s DNS packet representation exposed as a
- * type index.
- *
- * Type indexing is an OPTIONAL feature that enables DIDs to become discoverable. DIDs that wish to
- * be discoverable and resolveable by type can include one or more types when publishing their DID
- * document to a DID DHT Gateway.
- *
- * The registered DID types are published in the {@link https://did-dht.com/registry/index.html#indexed-types | DID DHT Registry}.
- */
-export declare enum DidDhtRegisteredDidType {
-    /**
-     * Type 0 is reserved for DIDs that do not wish to associate themselves with a specific type but
-     * wish to make themselves discoverable.
-     */
-    Discoverable = 0,
-    /**
-     * Organization
-     * @see {@link https://schema.org/Organization | schema definition}
-     */
-    Organization = 1,
-    /**
-     * Government Organization
-     * @see {@link https://schema.org/GovernmentOrganization | schema definition}
-     */
-    Government = 2,
-    /**
-     * Corporation
-     * @see {@link https://schema.org/Corporation | schema definition}
-     */
-    Corporation = 3,
-    /**
-     * Corporation
-     * @see {@link https://schema.org/Corporation | schema definition}
-     */
-    LocalBusiness = 4,
-    /**
-     * Software Package
-     * @see {@link https://schema.org/SoftwareSourceCode | schema definition}
-     */
-    SoftwarePackage = 5,
-    /**
-     * Web App
-     * @see {@link https://schema.org/WebApplication | schema definition}
-     */
-    WebApp = 6,
-    /**
-     * Financial Institution
-     * @see {@link https://schema.org/FinancialService | schema definition}
-     */
-    FinancialInstitution = 7
-}
-/**
- * Enumerates the types of keys that can be used in a DID DHT document.
- *
- * The DID DHT method supports various cryptographic key types. These key types are essential for
- * the creation and management of DIDs and their associated cryptographic operations like signing
- * and encryption. The registered key types are published in the DID DHT Registry and each is
- * assigned a unique numerical value for use by client and gateway implementations.
- *
- * The registered key types are published in the {@link https://did-dht.com/registry/index.html#key-type-index | DID DHT Registry}.
- */
-export declare enum DidDhtRegisteredKeyType {
-    /**
-     * Ed25519: A public-key signature system using the EdDSA (Edwards-curve Digital Signature
-     * Algorithm) and Curve25519.
-     */
-    Ed25519 = 0,
-    /**
-     * secp256k1: A cryptographic curve used for digital signatures in a range of decentralized
-     * systems.
-     */
-    secp256k1 = 1,
-    /**
-     * secp256r1: Also known as P-256 or prime256v1, this curve is used for cryptographic operations
-     * and is widely supported in various cryptographic libraries and standards.
-     */
-    secp256r1 = 2,
-    /**
-     * X25519: A public key used for Diffie-Hellman key exchange using Curve25519.
-     */
-    X25519 = 3
-}
-/**
- * Maps {@link https://www.w3.org/TR/did-core/#verification-relationships | DID Core Verification Relationship}
- * values to the corresponding record name in the DNS packet representation of a DHT DID document.
- */
-export declare enum DidDhtVerificationRelationship {
-    /**
-     * Specifies how the DID subject is expected to be authenticated.
-     */
-    authentication = "auth",
-    /**
-     * Specifies how the DID subject is expected to express claims, such as for issuing Verifiable
-     * Credentials.
-     */
-    assertionMethod = "asm",
-    /**
-     * Specifies a mechanism used by the DID subject to delegate a cryptographic capability to another
-     * party
-     */
-    capabilityDelegation = "del",
-    /**
-     * Specifies a verification method used by the DID subject to invoke a cryptographic capability.
-     */
-    capabilityInvocation = "inv",
-    /**
-     * Specifies how an entity can generate encryption material to communicate confidentially with the
-     * DID subject.
-     */
-    keyAgreement = "agm"
-}
+export * from './did-dht-types.js';
+export { pkarrGet, pkarrPut, createBep44PutMessage, parseBep44GetMessage, } from './did-dht-pkarr.js';
+export { AlgorithmToKeyTypeMap, chunkDataIfNeeded, createTxtRecord, DID_DHT_SPECIFICATION_VERSION, DNS_RECORD_TTL, fromDnsPacket, KeyTypeToDefaultAlgorithmMap, parseTxtDataToObject, parseTxtDataToString, PROPERTY_SEPARATOR, toDnsPacket, VALUE_SEPARATOR, } from './did-dht-dns.js';
+export { identifierToIdentityKey, identifierToIdentityKeyBytes, identityKeyToIdentifier, keyConverter, validatePreviousDidProof, } from './did-dht-utils.js';
+import type { Bep44Message, DidDhtCreateOptions, PreviousDidProof } from './did-dht-types.js';
 /**
  * The `DidDht` class provides an implementation of the `did:dht` DID method.
  *
@@ -371,7 +93,7 @@ export declare class DidDht extends DidMethod {
      * @param params.options - Optional parameters that can be specified when creating a new DID.
      * @returns A Promise resolving to a {@link BearerDid} object representing the new DID.
      */
-    static create<TKms extends CryptoApi | undefined = undefined>({ keyManager, options }?: {
+    static create<TKms extends KeyManager | undefined = undefined>({ keyManager, options }?: {
         keyManager?: TKms;
         options?: DidDhtCreateOptions<TKms>;
     }): Promise<BearerDid>;
@@ -402,7 +124,7 @@ export declare class DidDht extends DidMethod {
      *         manager.
      */
     static import({ portableDid, keyManager }: {
-        keyManager?: CryptoApi & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
+        keyManager?: KeyManager & KeyImporterExporter<KmsImportKeyParams, KeyIdentifier, KmsExportKeyParams>;
         portableDid: PortableDid;
     }): Promise<BearerDid>;
     /**
@@ -423,33 +145,10 @@ export declare class DidDht extends DidMethod {
     /**
      * Publishes a DID to the DHT, making it publicly discoverable and resolvable.
      *
-     * This method handles the publication of a DID Document associated with a `did:dht` DID to the
-     * Mainline DHT network. The publication process involves storing the DID Document in Mainline DHT
-     * via a Pkarr relay server.
-     *
-     * @remarks
-     * - This method is typically invoked automatically during the creation of a new DID unless the
-     *   `publish` option is set to `false`.
-     * - For existing, unpublished DIDs, it can be used to publish the DID Document to Mainline DHT.
-     * - The method relies on the specified Pkarr relay server to interface with the DHT network.
-     *
-     * @example
-     * ```ts
-     * // Generate a new DID and keys but explicitly disable publishing.
-     * const did = await DidDht.create({ options: { publish: false } });
-     * // Publish the DID to the DHT.
-     * const registrationResult = await DidDht.publish({ did });
-     * // `registrationResult.didDocumentMetadata.published` is true if the DID was successfully published.
-     * ```
-     *
      * @param params - The parameters for the `publish` operation.
      * @param params.did - The `BearerDid` object representing the DID to be published.
-     * @param params.gatewayUri - Optional. The URI of a server involved in executing DID method
-     *                            operations. In the context of publishing, the endpoint is expected
-     *                            to be a DID DHT Gateway or Pkarr Relay. If not specified, a default
-     *                            gateway node is used.
-     * @returns A promise that resolves to a {@link DidRegistrationResult} object that contains
-     *          the result of registering the DID with a DID DHT Gateway or Pkarr relay.
+     * @param params.gatewayUri - Optional. The URI of a DID DHT Gateway or Pkarr Relay.
+     * @returns A promise that resolves to a {@link DidRegistrationResult} object.
      */
     static publish({ did, gatewayUri }: {
         did: BearerDid;
@@ -458,25 +157,9 @@ export declare class DidDht extends DidMethod {
     /**
      * Resolves a `did:dht` identifier to its corresponding DID document.
      *
-     * This method performs the resolution of a `did:dht` DID, retrieving its DID Document from the
-     * Mainline DHT network. The process involves querying the DHT network via a Pkarr relay server to
-     * retrieve the DID Document that corresponds to the given DID identifier.
-     *
-     * @remarks
-     * - If a `gatewayUri` option is not specified, a default Pkarr relay is used to access the DHT
-     *   network.
-     * - It decodes the DID identifier and retrieves the associated DID Document and metadata.
-     * - In case of resolution failure, appropriate error information is returned.
-     *
-     * @example
-     * ```ts
-     * const resolutionResult = await DidDht.resolve('did:dht:example');
-     * ```
-     *
      * @param didUri - The DID to be resolved.
      * @param options - Optional parameters for resolving the DID. Unused by this DID method.
-     * @returns A Promise resolving to a {@link DidResolutionResult} object representing the result of
-     *          the resolution.
+     * @returns A Promise resolving to a {@link DidResolutionResult} object.
      */
     static resolve(didUri: string, options?: DidResolutionOptions): Promise<DidResolutionResult>;
 }
@@ -485,7 +168,8 @@ export declare class DidDht extends DidMethod {
  * Mainline DHT in support of DID DHT method create, resolve, update, and deactivate operations.
  *
  * This class includes methods for retrieving and publishing DID documents to and from the DHT,
- * using DNS packet encoding and DID DHT Gateway or Pkarr Relay servers.
+ * using DNS packet encoding and DID DHT Gateway or Pkarr Relay servers. Methods delegate to
+ * standalone functions extracted into focused modules.
  */
 export declare class DidDhtDocument {
     /**
@@ -494,8 +178,7 @@ export declare class DidDhtDocument {
      * @param params - The parameters for the get operation.
      * @param params.didUri - The DID URI containing the Identity Key.
      * @param params.gatewayUri - The DID DHT Gateway or Pkarr Relay URI.
-     * @returns A Promise resolving to a {@link DidResolutionResult} object containing the DID
-     *          document and its metadata.
+     * @returns A Promise resolving to a {@link DidResolutionResult} object.
      */
     static get({ didUri, gatewayUri }: {
         didUri: string;
@@ -507,65 +190,28 @@ export declare class DidDhtDocument {
      * @param params - The parameters to use when publishing the DID document to the DHT network.
      * @param params.did - The DID object whose DID document will be published.
      * @param params.gatewayUri - The DID DHT Gateway or Pkarr Relay URI.
-     * @returns A promise that resolves to a {@link DidRegistrationResult} object that contains
-     *          the result of registering the DID with a DID DHT Gateway or Pkarr relay.
+     * @returns A promise that resolves to a {@link DidRegistrationResult} object.
      */
     static put({ did, gatewayUri }: {
         did: BearerDid;
         gatewayUri: string;
     }): Promise<DidRegistrationResult>;
-    /**
-     * Retrieves a signed BEP44 message from a DID DHT Gateway or Pkarr Relay server.
-     *
-     * @see {@link https://github.com/Nuhvi/pkarr/blob/main/design/relays.md | Pkarr Relay design}
-     *
-     * @param params
-     * @param params.gatewayUri - The DID DHT Gateway or Pkarr Relay URI.
-     * @param params.publicKeyBytes - The public key bytes of the Identity Key, z-base-32 encoded.
-     * @returns A promise resolving to a BEP44 message containing the signed DNS packet.
-    */
+    /** Delegates to {@link pkarrGet} from `did-dht-pkarr.js`. */
     private static pkarrGet;
-    /**
-     * Publishes a signed BEP44 message to a DID DHT Gateway or Pkarr Relay server.
-     *
-     * @see {@link https://github.com/Nuhvi/pkarr/blob/main/design/relays.md | Pkarr Relay design}
-     *
-     * @param params - The parameters to use when publishing a signed BEP44 message to a Pkarr relay server.
-     * @param params.gatewayUri - The DID DHT Gateway or Pkarr Relay URI.
-     * @param params.bep44Message - The BEP44 message to be published, containing the signed DNS packet.
-     * @returns A promise resolving to `true` if the message was successfully published, otherwise `false`.
-     */
+    /** Delegates to {@link pkarrPut} from `did-dht-pkarr.js`. */
     private static pkarrPut;
-    /**
-     * Converts a DNS packet to a DID document according to the DID DHT specification.
-     *
-     * @see {@link https://did-dht.com/#dids-as-dns-records | DID DHT Specification, § DIDs as DNS Records}
-     *
-     * @param params - The parameters to use when converting a DNS packet to a DID document.
-     * @param params.didUri - The DID URI of the DID document.
-     * @param params.dnsPacket - The DNS packet to convert to a DID document.
-     * @returns A Promise resolving to a {@link DidResolutionResult} object containing the DID
-     *          document and its metadata.
-     */
-    static fromDnsPacket({ didUri, dnsPacket }: {
+    /** Delegates to {@link fromDnsPacket} from `did-dht-dns.js`. */
+    static fromDnsPacket(params: {
         didUri: string;
         dnsPacket: Packet;
     }): Promise<DidResolutionResult>;
-    /**
-     * Converts a DID document to a DNS packet according to the DID DHT specification.
-     *
-     * @see {@link https://did-dht.com/#dids-as-dns-records | DID DHT Specification, § DIDs as DNS Records}
-     *
-     * @param params - The parameters to use when converting a DID document to a DNS packet.
-     * @param params.didDocument - The DID document to convert to a DNS packet.
-     * @param params.didMetadata - The DID metadata to include in the DNS packet.
-     * @param params.authoritativeGatewayUris - The URIs of the Authoritative Gateways to generate NS records from.
-     * @param params.previousDidProof - The signature proof that this DID is linked to the given previous DID.
-     * @returns A promise that resolves to a DNS packet.
-     */
-    static toDnsPacket({ didDocument, didMetadata, authoritativeGatewayUris, previousDidProof }: {
+    /** Delegates to {@link toDnsPacket} from `did-dht-dns.js`. */
+    static toDnsPacket(params: {
         didDocument: DidDocument;
-        didMetadata: DidMetadata;
+        didMetadata: {
+            published?: boolean;
+            types?: (number | string)[];
+        };
         authoritativeGatewayUris?: string[];
         previousDidProof?: PreviousDidProof;
     }): Promise<Packet>;
@@ -579,104 +225,43 @@ export declare class DidDhtDocument {
 }
 /**
  * The `DidDhtUtils` class provides utility functions to support operations in the DID DHT method.
- * This includes functions for creating and parsing BEP44 messages, handling identity keys, and
- * converting between different formats and representations.
+ * Methods delegate to standalone functions extracted into focused modules for backward compatibility.
  */
 export declare class DidDhtUtils {
-    /**
-     * Creates a BEP44 put message, which is used to publish a DID document to the DHT network.
-     *
-     * @param params - The parameters to use when creating the BEP44 put message
-     * @param params.dnsPacket - The DNS packet to encode in the BEP44 message.
-     * @param params.publicKeyBytes - The public key bytes of the Identity Key.
-     * @param params.signer - Signer that can sign and verify data using the Identity Key.
-     * @returns A promise that resolves to a BEP44 put message.
-     */
-    static createBep44PutMessage({ dnsPacket, publicKeyBytes, signer }: {
+    /** Delegates to {@link createBep44PutMessage} from `did-dht-pkarr.js`. */
+    static createBep44PutMessage(params: {
         dnsPacket: Packet;
         publicKeyBytes: Uint8Array;
         signer: Signer;
     }): Promise<Bep44Message>;
-    /**
-     * Converts a DID URI to a JSON Web Key (JWK) representing the Identity Key.
-     *
-     * @param params - The parameters to use for the conversion.
-     * @param params.didUri - The DID URI containing the Identity Key.
-     * @returns A promise that resolves to a JWK representing the Identity Key.
-     */
-    static identifierToIdentityKey({ didUri }: {
+    /** Delegates to {@link identifierToIdentityKey} from `did-dht-utils.js`. */
+    static identifierToIdentityKey(params: {
         didUri: string;
     }): Promise<Jwk>;
-    /**
-     * Converts a DID URI to the byte array representation of the Identity Key.
-     *
-     * @param params - The parameters to use for the conversion.
-     * @param params.didUri - The DID URI containing the Identity Key.
-     * @returns A byte array representation of the Identity Key.
-     */
-    static identifierToIdentityKeyBytes({ didUri }: {
+    /** Delegates to {@link identifierToIdentityKeyBytes} from `did-dht-utils.js`. */
+    static identifierToIdentityKeyBytes(params: {
         didUri: string;
     }): Uint8Array;
-    /**
-     * Encodes a DID DHT Identity Key into a DID identifier.
-     *
-     * This method first z-base-32 encodes the Identity Key. The resulting string is prefixed with
-     * `did:dht:` to form the DID identifier.
-     *
-     * @param params - The parameters to use for the conversion.
-     * @param params.identityKey The Identity Key from which the DID identifier is computed.
-     * @returns A promise that resolves to a string containing the DID identifier.
-     */
-    static identityKeyToIdentifier({ identityKey }: {
+    /** Delegates to {@link identityKeyToIdentifier} from `did-dht-utils.js`. */
+    static identityKeyToIdentifier(params: {
         identityKey: Jwk;
     }): Promise<string>;
-    /**
-     * Returns the appropriate key converter for the specified cryptographic curve.
-     *
-     * @param curve - The cryptographic curve to use for the key conversion.
-     * @returns An `AsymmetricKeyConverter` for the specified curve.
-     */
+    /** Delegates to {@link keyConverter} from `did-dht-utils.js`. */
     static keyConverter(curve: string): AsymmetricKeyConverter;
-    /**
-     * Parses and verifies a BEP44 Get message, converting it to a DNS packet.
-     *
-     * @param params - The parameters to use when verifying and parsing the BEP44 Get response message.
-     * @param params.bep44Message - The BEP44 message to verify and parse.
-     * @returns A promise that resolves to a DNS packet.
-     */
-    static parseBep44GetMessage({ bep44Message }: {
+    /** Delegates to {@link parseBep44GetMessage} from `did-dht-pkarr.js`. */
+    static parseBep44GetMessage(params: {
         bep44Message: Bep44Message;
     }): Promise<Packet>;
-    /**
-     * Decodes and parses the data value of a DNS TXT record into a key-value object.
-     *
-     * @param txtData - The data value of a DNS TXT record.
-     * @returns An object containing the key/value pairs of the TXT record data.
-     */
+    /** Delegates to {@link parseTxtDataToObject} from `did-dht-dns.js`. */
     static parseTxtDataToObject(txtData: TxtData): Record<string, string>;
-    /**
-     * Decodes and parses the data value of a DNS TXT record into a string.
-     *
-     * @param txtData - The data value of a DNS TXT record.
-     * @returns A string representation of the TXT record data.
-     */
+    /** Delegates to {@link parseTxtDataToString} from `did-dht-dns.js`. */
     static parseTxtDataToString(txtData: TxtData): string;
-    /**
-     * Validates the proof of previous DID given.
-     *
-     * @param params - The parameters to validate the previous DID proof.
-     * @param params.newDid - The new DID that the previous DID is linking to.
-     * @param params.previousDidProof - The proof of the previous DID, containing the previous DID and signature signed by the previous DID.
-     */
-    static validatePreviousDidProof({ newDid, previousDidProof }: {
+    /** Delegates to {@link validatePreviousDidProof} from `did-dht-utils.js`. */
+    static validatePreviousDidProof(params: {
         newDid: string;
         previousDidProof: PreviousDidProof;
     }): Promise<void>;
-    /**
-     * Splits a string into chunks of length 255 if the string exceeds length 255.
-     * @param data - The string to split into chunks.
-     * @returns The original string if its length is less than or equal to 255, otherwise an array of chunked strings.
-     */
+    /** Delegates to {@link chunkDataIfNeeded} from `did-dht-dns.js`. */
     static chunkDataIfNeeded(data: string): string | string[];
 }
 //# sourceMappingURL=did-dht.d.ts.map

package/dist/types/methods/did-dht.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"did-dht.d.ts","sourceRoot":"","sources":["../../../src/methods/did-dht.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,sBAAsB,EACtB,SAAS,EACT,GAAG,EACH,aAAa,EACb,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,MAAM,EACP,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,MAAM,EAA2B,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAOrF,OAAO,KAAK,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC5G,OAAO,KAAK,EACV,WAAW,EACX,oBAAoB,EACpB,mBAAmB,EACnB,UAAU,EACV,qBAAqB,EACtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEzE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAM5C;;;;;;;;;GASG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,CAAC,EAAE,UAAU,CAAC;IAEd;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,GAAG,EAAE,UAAU,CAAC;IAEhB;;;OAGG;IACH,CAAC,EAAE,UAAU,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,IAAI,CAAE,SAAQ,gBAAgB,CAAC,IAAI,CAAC;IACvE;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IAEvB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAEhC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IAExB;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,CAAC,uBAAuB,GAAG,MAAM,OAAO,uBAAuB,CAAC,EAAE,CAAC;IAE3E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,mBAAmB,CAAC,EAAE,2BAA2B,CAAC,IAAI,CAAC,EAAE,CAAC;CAC3D;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,wBAAwB;IACxB,WAAW,EAAE,MAAM,CAAC;IAEpB,mGAAmG;IACnG,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAqDF;;;;;;;;;GASG;AACH,oBAAY,uBAAuB;IACjC;;;OAGG;IACH,YAAY,IAAI;IAEhB;;;OAGG;IACH,YAAY,IAAI;IAEhB;;;OAGG;IACH,UAAU,IAAI;IAEd;;;OAGG;IACH,WAAW,IAAI;IAEf;;;OAGG;IACH,aAAa,IAAI;IAEjB;;;OAGG;IACH,eAAe,IAAI;IAEnB;;;OAGG;IACH,MAAM,IAAI;IAEV;;;OAGG;IACH,oBAAoB,IAAI;CACzB;AAED;;;;;;;;;GASG;AACH,oBAAY,uBAAuB;IACjC;;;OAGG;IACH,OAAO,IAAI;IAEX;;;OAGG;IACH,SAAS,IAAI;IAEb;;;OAGG;IACH,SAAS,IAAI;IAEb;;OAEG;IACH,MAAM,IAAI;CACX;AAED;;;GAGG;AACH,oBAAY,8BAA8B;IACxC;;OAEG;IACH,cAAc,SAAS;IAEvB;;;OAGG;IACH,eAAe,QAAQ;IAEvB;;;OAGG;IACH,oBAAoB,QAAQ;IAE5B;;OAEG;IACH,oBAAoB,QAAQ;IAE5B;;;OAGG;IACH,YAAY,QAAQ;CACrB;AA0BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,qBAAa,MAAO,SAAQ,SAAS;IAEnC;;OAEG;IACH,OAAc,UAAU,SAAS;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,MAAM,CAAC,IAAI,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EAAE,EACzE,UAAkC,EAClC,OAAY,EACb,GAAE;QACD,UAAU,CAAC,EAAE,IAAI,CAAC;QAClB,OAAO,CAAC,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;KAChC,GAAG,OAAO,CAAC,SAAS,CAAC;IA6G3B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,MAAM,CAAC,EAAE,WAAW,EAAE,UAAkC,EAAE,EAAE;QAC9E,UAAU,CAAC,EAAE,SAAS,GAAG,mBAAmB,CAAC,kBAAkB,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAC;QACpG,WAAW,EAAE,WAAW,CAAC;KAC1B,GAAG,OAAO,CAAC,SAAS,CAAC;IAiBtB;;;;;;;;;;OAUG;WACiB,gBAAgB,CAAC,EAAE,WAAW,EAAE,QAAe,EAAE,EAAE;QACrE,WAAW,EAAE,WAAW,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAoBlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACiB,OAAO,CAAC,EAAE,GAAG,EAAE,UAAgC,EAAE,EAAE;QACrE,GAAG,EAAE,SAAS,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAMlC;;;;;;;;;;;;;;;;;;;;;;OAsBG;WACiB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAgC9G;AAED;;;;;;GAMG;AACH,qBAAa,cAAc;IACzB;;;;;;;;OAQG;WACiB,GAAG,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE;QAC9C,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAmBhC;;;;;;;;OAQG;WACiB,GAAG,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE;QAC3C,GAAG,EAAE,SAAS,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA+BlC;;;;;;;;;MASE;mBACmB,QAAQ;IAkD7B;;;;;;;;;OASG;mBACkB,QAAQ;IAiC7B;;;;;;;;;;OAUG;WACiB,aAAa,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE;QACvD,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IA2JhC;;;;;;;;;;;OAWG;WACiB,WAAW,CAAC,EAAE,WAAW,EAAE,WAAW,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,EAAE;QACxG,WAAW,EAAE,WAAW,CAAC;QACzB,WAAW,EAAE,WAAW,CAAC;QACzB,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;QACpC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;KACrC,GAAG,OAAO,CAAC,MAAM,CAAC;IA4LnB;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAGlC;AAED;;;;GAIG;AACH,qBAAa,WAAW;IACtB;;;;;;;;OAQG;WACiB,qBAAqB,CAAC,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,EAAE,EAAE;QAC7E,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,UAAU,CAAC;QAC3B,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,YAAY,CAAC;IAwB3B;;;;;;OAMG;WACiB,uBAAuB,CAAC,EAAE,MAAM,EAAE,EAAE;QACtD,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,OAAO,CAAC,GAAG,CAAC;IAUhB;;;;;;OAMG;WACW,4BAA4B,CAAC,EAAE,MAAM,EAAE,EAAE;QACrD,MAAM,EAAE,MAAM,CAAA;KACf,GAAG,UAAU;IA6Bd;;;;;;;;;OASG;WACiB,uBAAuB,CAAC,EAAE,WAAW,EAAE,EAAE;QAC3D,WAAW,EAAE,GAAG,CAAA;KACjB,GAAG,OAAO,CAAC,MAAM,CAAC;IAUnB;;;;;OAKG;WACW,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB;IAqCjE;;;;;;OAMG;WACiB,oBAAoB,CAAC,EAAE,YAAY,EAAE,EAAE;QACzD,YAAY,EAAE,YAAY,CAAC;KAC5B,GAAG,OAAO,CAAC,MAAM,CAAC;IAqBnB;;;;;OAKG;WACW,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAQ5E;;;;;OAKG;WACW,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IAY5D;;;;;;OAMG;WACiB,wBAAwB,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAAE;QACzE,MAAM,EAAE,MAAM,CAAC;QACf,gBAAgB,EAAE,gBAAgB,CAAC;KACpC,GAAG,OAAO,CAAC,IAAI,CAAC;IAWjB;;;;OAIG;WACW,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE;CAajE"}
+{"version":3,"file":"did-dht.d.ts","sourceRoot":"","sources":["../../../src/methods/did-dht.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,sBAAsB,EACtB,GAAG,EACH,aAAa,EACb,mBAAmB,EACnB,UAAU,EACV,kBAAkB,EAClB,kBAAkB,EAClB,MAAM,EACP,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAI5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAA+B,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC1F,OAAO,KAAK,EACV,WAAW,EACX,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAM5C,cAAc,oBAAoB,CAAC;AAGnC,OAAO,EACL,QAAQ,EACR,QAAQ,EACR,qBAAqB,EACrB,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,eAAe,EACf,6BAA6B,EAC7B,cAAc,EACd,aAAa,EACb,4BAA4B,EAC5B,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,WAAW,EACX,eAAe,GAChB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACL,uBAAuB,EACvB,4BAA4B,EAC5B,uBAAuB,EACvB,YAAY,EACZ,wBAAwB,GACzB,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EAAE,YAAY,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAgC9F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,qBAAa,MAAO,SAAQ,SAAS;IAEnC;;OAEG;IACH,OAAc,UAAU,SAAS;IAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;WACiB,MAAM,CAAC,IAAI,SAAS,UAAU,GAAG,SAAS,GAAG,SAAS,EAAE,EAC1E,UAAkC,EAClC,OAAY,EACb,GAAE;QACD,UAAU,CAAC,EAAE,IAAI,CAAC;QAClB,OAAO,CAAC,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;KAChC,GAAG,OAAO,CAAC,SAAS,CAAC;IA6G3B;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;WACiB,MAAM,CAAC,EAAE,WAAW,EAAE,UAAkC,EAAE,EAAE;QAC9E,UAAU,CAAC,EAAE,UAAU,GAAG,mBAAmB,CAAC,kBAAkB,EAAE,aAAa,EAAE,kBAAkB,CAAC,CAAC;QACrG,WAAW,EAAE,WAAW,CAAC;KAC1B,GAAG,OAAO,CAAC,SAAS,CAAC;IAiBtB;;;;;;;;;;OAUG;WACiB,gBAAgB,CAAC,EAAE,WAAW,EAAE,QAAe,EAAE,EAAE;QACrE,WAAW,EAAE,WAAW,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAoBlC;;;;;;;OAOG;WACiB,OAAO,CAAC,EAAE,GAAG,EAAE,UAAgC,EAAE,EAAE;QACrE,GAAG,EAAE,SAAS,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAMlC;;;;;;OAMG;WACiB,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAgC9G;AAED;;;;;;;GAOG;AACH,qBAAa,cAAc;IACzB;;;;;;;OAOG;WACiB,GAAG,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE;QAC9C,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAmBhC;;;;;;;OAOG;WACiB,GAAG,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE;QAC3C,GAAG,EAAE,SAAS,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IA+BlC,6DAA6D;mBACxC,QAAQ;IAO7B,6DAA6D;mBACxC,QAAQ;IAO7B,gEAAgE;WAC5C,aAAa,CAAC,MAAM,EAAE;QACxC,MAAM,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAIhC,8DAA8D;WAC1C,WAAW,CAAC,MAAM,EAAE;QACtC,WAAW,EAAE,WAAW,CAAC;QACzB,WAAW,EAAE;YAAE,SAAS,CAAC,EAAE,OAAO,CAAC;YAAC,KAAK,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;SAAE,CAAC;QAClE,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;QACpC,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;KACrC,GAAG,OAAO,CAAC,MAAM,CAAC;IAInB;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAGlC;AAED;;;GAGG;AACH,qBAAa,WAAW;IACtB,0EAA0E;WACtD,qBAAqB,CAAC,MAAM,EAAE;QAChD,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,UAAU,CAAC;QAC3B,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,YAAY,CAAC;IAIzB,4EAA4E;WACxD,uBAAuB,CAAC,MAAM,EAAE;QAClD,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhB,iFAAiF;WACnE,4BAA4B,CAAC,MAAM,EAAE;QACjD,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,UAAU;IAId,4EAA4E;WACxD,uBAAuB,CAAC,MAAM,EAAE;QAClD,WAAW,EAAE,GAAG,CAAC;KAClB,GAAG,OAAO,CAAC,MAAM,CAAC;IAInB,iEAAiE;WACnD,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB;IAIjE,yEAAyE;WACrD,oBAAoB,CAAC,MAAM,EAAE;QAC/C,YAAY,EAAE,YAAY,CAAC;KAC5B,GAAG,OAAO,CAAC,MAAM,CAAC;IAInB,uEAAuE;WACzD,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAI5E,uEAAuE;WACzD,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IAI5D,6EAA6E;WACzD,wBAAwB,CAAC,MAAM,EAAE;QACnD,MAAM,EAAE,MAAM,CAAC;QACf,gBAAgB,EAAE,gBAAgB,CAAC;KACpC,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjB,oEAAoE;WACtD,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE;CAGjE"}