iso-did/dist/src/atp.d.ts

Isomorphic did core and did key tooling

/**
 * @param {Object} options
 * @param {import('did-resolver').ParsedDID} options.parsed
 * @param {AbortSignal} [options.signal]
 */
export function resolveDNS(options: {
    parsed: import("did-resolver").ParsedDID;
    signal?: AbortSignal | undefined;
}): Promise<any>;
/**
 * @param {Object} options
 * @param {import('did-resolver').ParsedDID} options.parsed
 * @param {AbortSignal} [options.signal]
 */
export function resolveHttp(options: {
    parsed: import("did-resolver").ParsedDID;
    signal?: AbortSignal | undefined;
}): Promise<string | undefined>;
/**
 * @param {Object} options
 * @param {import('did-resolver').ParsedDID} options.parsed
 */
export function resolvePlcDid(options: {
    parsed: import("did-resolver").ParsedDID;
}): Promise<string | undefined>;
/**
 * Resolves a did:atp DID, attempting resolution via DNS, well-known, and then falling back to did:plc or did:web.
 *
 * @param {object} options - Options for resolving the DID.
 * @param {string} options.directory - The directory to use for resolving did:plc DIDs.
 * @param {import('did-resolver').ParsedDID} options.parsed - The parsed DID object.
 * @param {import('did-resolver').DIDResolutionOptions} options.options - Options for the DID resolver.
 * @returns {Promise<import('did-resolver').DIDResolutionResult>} - A promise that resolves to the DID resolution result.
 *
 * @example
 * ```ts twoslash
 * // @filename: index.ts
 * import { resolve } from 'iso-did/atp'
 * import { parse } from 'iso-did'
 *
 * async function example() {
 *   const didResolutionResult = await resolve({
 *     directory: 'https://plc.directory',
 *     parsed: parse('did:atp:retr0.id'),
 *     options: {}
 *   })
 *
 *   console.log(didResolutionResult.didDocument?.id)
 *   // => did:plc:vwzwgnygau7ed7b7wt5ux7y2
 * }
 * ```
 */
export function resolve(options: {
    directory: string;
    parsed: import("did-resolver").ParsedDID;
    options: import("did-resolver").DIDResolutionOptions;
}): Promise<import("did-resolver").DIDResolutionResult>;
/**
 * Creates a DID resolver for `did:atp` method.
 *
 * This resolver uses either DNS or well-known endpoints to resolve the DID,
 * eventually resolving to a `did:plc` DID.
 *
 * @param {string} [directory=DIRECTORY] - The directory to use for resolving `did:plc` DIDs.
 * @returns {import('did-resolver').DIDResolver} A DID resolver for `did:atp` method.
 *
 * @example
 * ```ts twoslash
 * import { createDidAtpResolver } from 'iso-did/atp'
 * import { resolve } from 'iso-did'
 *
 * const didDocument = await resolve('did:atp:retr0.id', {
 *   resolvers: {
 *     atp: createDidAtpResolver('https://plc.directory')
 *   },
 *   cache: true
 * })
 * console.log(didDocument)
 * ```
 */
export function createAtpResolver(directory?: string): import("did-resolver").DIDResolver;
//# sourceMappingURL=atp.d.ts.map