import * as Bytes from './Bytes.js';
import * as Errors from './Errors.js';
import * as Hex from './Hex.js';
/**
 * Incremental hash state.
 *
 * A hasher accepts any number of chunks. Calling `digest` or `digestInto`
 * consumes the state. Call `clone` before finalizing to branch from the same
 * prefix.
 */
export type Hasher = {
    /** Creates an independent copy of the current state. */
    clone(): Hasher;
    /** Destroys the state. Calling `destroy` more than once has no effect. */
    destroy(): void;
    /** Finalizes the digest and consumes the state. */
    digest<as extends 'Hex' | 'Bytes' = 'Hex'>(options?: Hasher.DigestOptions<as>): Hasher.DigestReturnType<as>;
    /**
     * Finalizes into the start of `output` and consumes the state.
     *
     * `output` may be larger than the digest. Bytes after the digest are left
     * unchanged.
     */
    digestInto(output: Bytes.Bytes): void;
    /** Absorbs a message chunk. */
    update(value: Hex.Hex | Bytes.Bytes): Hasher;
};
export declare namespace Hasher {
    /** Options for `Hasher.digest`. */
    type DigestOptions<as extends 'Hex' | 'Bytes' = 'Hex'> = {
        /** The return type. @default 'Hex' */
        as?: as | 'Hex' | 'Bytes' | undefined;
    };
    /** Return type for `Hasher.digest`. */
    type DigestReturnType<as extends 'Hex' | 'Bytes' = 'Hex'> = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never);
    /** Errors thrown by an incremental hash state. */
    type ErrorType = HasherDestroyedError | InvalidDigestSizeError | Bytes.from.ErrorType | Hex.fromBytes.ErrorType | Errors.GlobalErrorType;
}
/**
 * Creates an incremental BLAKE3 hasher.
 *
 * The installed Engine provider is captured when this function is called.
 *
 * @example
 * ```ts twoslash
 * import { Hash } from 'ox'
 *
 * const hash = Hash.createBlake3()
 * hash.update('0xdead')
 * hash.update('0xbeef')
 * hash.digest()
 * // @log: '0x53147f3ce49ed4f60dfa5b9654c36ba6103c11f5737df3dabd4cbd296c4161bd'
 * ```
 *
 * @returns An incremental BLAKE3 hasher.
 */
export declare function createBlake3(): Hasher;
export declare namespace createBlake3 {
    type ErrorType = Hasher.ErrorType;
}
/**
 * Creates an incremental HMAC-SHA256 hasher.
 *
 * The installed Engine provider is captured when this function is called.
 *
 * @example
 * ```ts twoslash
 * import { Hash, Hex } from 'ox'
 *
 * const hash = Hash.createHmac256(Hex.fromString('key'))
 * hash.update('0xdead')
 * hash.update('0xbeef')
 * hash.digest()
 * ```
 *
 * @param key - HMAC key.
 * @returns An incremental HMAC-SHA256 hasher.
 */
export declare function createHmac256(key: Hex.Hex | Bytes.Bytes): Hasher;
export declare namespace createHmac256 {
    type ErrorType = Hasher.ErrorType;
}
/**
 * Creates an incremental Keccak256 hasher.
 *
 * The installed Engine provider is captured when this function is called.
 *
 * @example
 * ```ts twoslash
 * import { Hash } from 'ox'
 *
 * const hash = Hash.createKeccak256()
 * hash.update('0xdead')
 * hash.update('0xbeef')
 * hash.digest()
 * // @log: '0xd4fd4e189132273036449fc9e11198c739161b4c0116a9a2dccdfa1c492006f1'
 * ```
 *
 * @returns An incremental Keccak256 hasher.
 */
export declare function createKeccak256(): Hasher;
export declare namespace createKeccak256 {
    type ErrorType = Hasher.ErrorType;
}
/**
 * Creates an incremental RIPEMD-160 hasher.
 *
 * The installed Engine provider is captured when this function is called.
 *
 * @example
 * ```ts twoslash
 * import { Hash } from 'ox'
 *
 * const hash = Hash.createRipemd160()
 * hash.update('0xdead')
 * hash.update('0xbeef')
 * hash.digest()
 * // @log: '0x226821c2f5423e11fe9af68bd285c249db2e4b5a'
 * ```
 *
 * @returns An incremental RIPEMD-160 hasher.
 */
export declare function createRipemd160(): Hasher;
export declare namespace createRipemd160 {
    type ErrorType = Hasher.ErrorType;
}
/**
 * Creates an incremental SHA-256 hasher.
 *
 * The installed Engine provider is captured when this function is called.
 *
 * @example
 * ```ts twoslash
 * import { Hash } from 'ox'
 *
 * const hash = Hash.createSha256()
 * hash.update('0xdead')
 * hash.update('0xbeef')
 * hash.digest()
 * // @log: '0x5f78c33274e43fa9de5659265c1d917e25c03722dcb0b8d27db8d5feaa813953'
 * ```
 *
 * @returns An incremental SHA-256 hasher.
 */
export declare function createSha256(): Hasher;
export declare namespace createSha256 {
    type ErrorType = Hasher.ErrorType;
}
/**
 * Calculates the [BLAKE3](https://github.com/BLAKE3-team/BLAKE3) hash of a {@link ox#Bytes.Bytes} or {@link ox#Hex.Hex} value.
 *
 * Backed by `blake3` from [`@noble/hashes`](https://github.com/paulmillr/noble-hashes), an audited & minimal JS hashing library, unless another implementation is installed with {@link ox#Engine.set}.
 *
 * @example
 * ```ts twoslash
 * import { Hash } from 'ox'
 *
 * Hash.blake3('0xdeadbeef')
 * // @log: '0x53147f3ce49ed4f60dfa5b9654c36ba6103c11f5737df3dabd4cbd296c4161bd'
 * ```
 *
 * @example
 * ### Configure Return Type
 *
 * ```ts twoslash
 * import { Hash } from 'ox'
 *
 * Hash.blake3('0xdeadbeef', { as: 'Bytes' })
 * // @log: Uint8Array [...]
 * ```
 *
 * @param value - {@link ox#Bytes.Bytes} or {@link ox#Hex.Hex} value.
 * @param options - Options.
 * @returns BLAKE3 hash.
 */
export declare function blake3<value extends Hex.Hex | Bytes.Bytes, as extends 'Hex' | 'Bytes' = (value extends Hex.Hex ? 'Hex' : never) | (value extends Bytes.Bytes ? 'Bytes' : never)>(value: value | Hex.Hex | Bytes.Bytes, options?: blake3.Options<as>): blake3.ReturnType<as>;
export declare namespace blake3 {
    type Options<as extends 'Hex' | 'Bytes' = 'Hex' | 'Bytes'> = {
        /** The return type. Defaults to the input format. */
        as?: as | 'Hex' | 'Bytes' | undefined;
    };
    type ReturnType<as extends 'Hex' | 'Bytes' = 'Hex' | 'Bytes'> = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never);
    type ErrorType = Bytes.from.ErrorType | Hex.fromBytes.ErrorType | Errors.GlobalErrorType;
}
/**
 * Calculates the [Keccak256](https://en.wikipedia.org/wiki/SHA-3) hash of a {@link ox#Bytes.Bytes} or {@link ox#Hex.Hex} value.
 *
 * Backed by `keccak_256` from [`@noble/hashes`](https://github.com/paulmillr/noble-hashes), an audited & minimal JS hashing library, unless another implementation is installed with {@link ox#Engine.set}.
 *
 * @example
 * ```ts twoslash
 * import { Hash } from 'ox'
 *
 * Hash.keccak256('0xdeadbeef')
 * // @log: '0xd4fd4e189132273036449fc9e11198c739161b4c0116a9a2dccdfa1c492006f1'
 * ```
 *
 * @example
 * ### Calculate Hash of a String
 *
 * ```ts twoslash
 * import { Hash, Hex } from 'ox'
 *
 * Hash.keccak256(Hex.fromString('hello world'))
 * // @log: '0x3ea2f1d0abf3fc66cf29eebb70cbd4e7fe762ef8a09bcc06c8edf641230afec0'
 * ```
 *
 * @example
 * ### Configure Return Type
 *
 * ```ts twoslash
 * import { Hash } from 'ox'
 *
 * Hash.keccak256('0xdeadbeef', { as: 'Bytes' })
 * // @log: Uint8Array [...]
 * ```
 *
 * @param value - {@link ox#Bytes.Bytes} or {@link ox#Hex.Hex} value.
 * @param options - Options.
 * @returns Keccak256 hash.
 */
export declare function keccak256<value extends Hex.Hex | Bytes.Bytes, as extends 'Hex' | 'Bytes' = (value extends Hex.Hex ? 'Hex' : never) | (value extends Bytes.Bytes ? 'Bytes' : never)>(value: value | Hex.Hex | Bytes.Bytes, options?: keccak256.Options<as>): keccak256.ReturnType<as>;
export declare namespace keccak256 {
    type Options<as extends 'Hex' | 'Bytes' = 'Hex' | 'Bytes'> = {
        /** The return type. @default 'Hex' */
        as?: as | 'Hex' | 'Bytes' | undefined;
    };
    type ReturnType<as extends 'Hex' | 'Bytes' = 'Hex' | 'Bytes'> = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never);
    type ErrorType = Bytes.from.ErrorType | Hex.fromBytes.ErrorType | Errors.GlobalErrorType;
}
/**
 * Calculates the [HMAC-SHA256](https://en.wikipedia.org/wiki/HMAC) of a {@link ox#Bytes.Bytes} or {@link ox#Hex.Hex} value.
 *
 * Backed by `hmac` from [`@noble/hashes`](https://github.com/paulmillr/noble-hashes), an audited & minimal JS hashing library, unless another implementation is installed with {@link ox#Engine.set}.
 *
 * @example
 * ```ts twoslash
 * import { Hash, Hex } from 'ox'
 *
 * Hash.hmac256(Hex.fromString('key'), '0xdeadbeef')
 * // @log: '0x...'
 * ```
 *
 * @example
 * ### Configure Return Type
 *
 * ```ts twoslash
 * import { Hash, Hex } from 'ox'
 *
 * Hash.hmac256(Hex.fromString('key'), '0xdeadbeef', {
 *   as: 'Bytes'
 * })
 * // @log: Uint8Array [...]
 * ```
 *
 * @param key - {@link ox#Bytes.Bytes} or {@link ox#Hex.Hex} key.
 * @param value - {@link ox#Bytes.Bytes} or {@link ox#Hex.Hex} value.
 * @param options - Options.
 * @returns HMAC-SHA256 hash.
 */
export declare function hmac256<value extends Hex.Hex | Bytes.Bytes, as extends 'Hex' | 'Bytes' = (value extends Hex.Hex ? 'Hex' : never) | (value extends Bytes.Bytes ? 'Bytes' : never)>(key: Hex.Hex | Bytes.Bytes, value: value | Hex.Hex | Bytes.Bytes, options?: hmac256.Options<as>): hmac256.ReturnType<as>;
export declare namespace hmac256 {
    type Options<as extends 'Hex' | 'Bytes' = 'Hex' | 'Bytes'> = {
        /** The return type. @default 'Hex' */
        as?: as | 'Hex' | 'Bytes' | undefined;
    };
    type ReturnType<as extends 'Hex' | 'Bytes' = 'Hex' | 'Bytes'> = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never);
    type ErrorType = Bytes.from.ErrorType | Hex.fromBytes.ErrorType | Errors.GlobalErrorType;
}
/**
 * Calculates the [Ripemd160](https://en.wikipedia.org/wiki/RIPEMD) hash of a {@link ox#Bytes.Bytes} or {@link ox#Hex.Hex} value.
 *
 * Backed by `ripemd160` from [`@noble/hashes`](https://github.com/paulmillr/noble-hashes), an audited & minimal JS hashing library, unless another implementation is installed with {@link ox#Engine.set}.
 *
 * @example
 * ```ts twoslash
 * import { Hash } from 'ox'
 *
 * Hash.ripemd160('0xdeadbeef')
 * // '0x226821c2f5423e11fe9af68bd285c249db2e4b5a'
 * ```
 *
 * @param value - {@link ox#Bytes.Bytes} or {@link ox#Hex.Hex} value.
 * @param options - Options.
 * @returns Ripemd160 hash.
 */
export declare function ripemd160<value extends Hex.Hex | Bytes.Bytes, as extends 'Hex' | 'Bytes' = (value extends Hex.Hex ? 'Hex' : never) | (value extends Bytes.Bytes ? 'Bytes' : never)>(value: value | Hex.Hex | Bytes.Bytes, options?: ripemd160.Options<as>): ripemd160.ReturnType<as>;
export declare namespace ripemd160 {
    type Options<as extends 'Hex' | 'Bytes' = 'Hex' | 'Bytes'> = {
        /** The return type. @default 'Hex' */
        as?: as | 'Hex' | 'Bytes' | undefined;
    };
    type ReturnType<as extends 'Hex' | 'Bytes' = 'Hex' | 'Bytes'> = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never);
    type ErrorType = Bytes.from.ErrorType | Hex.fromBytes.ErrorType | Errors.GlobalErrorType;
}
/**
 * Calculates the [Sha256](https://en.wikipedia.org/wiki/SHA-256) hash of a {@link ox#Bytes.Bytes} or {@link ox#Hex.Hex} value.
 *
 * Backed by `sha256` from [`@noble/hashes`](https://github.com/paulmillr/noble-hashes), an audited & minimal JS hashing library, unless another implementation is installed with {@link ox#Engine.set}.
 *
 * @example
 * ```ts twoslash
 * import { Hash } from 'ox'
 *
 * Hash.sha256('0xdeadbeef')
 * // '0x5f78c33274e43fa9de5659265c1d917e25c03722dcb0b8d27db8d5feaa813953'
 * ```
 *
 * @param value - {@link ox#Bytes.Bytes} or {@link ox#Hex.Hex} value.
 * @param options - Options.
 * @returns Sha256 hash.
 */
export declare function sha256<value extends Hex.Hex | Bytes.Bytes, as extends 'Hex' | 'Bytes' = (value extends Hex.Hex ? 'Hex' : never) | (value extends Bytes.Bytes ? 'Bytes' : never)>(value: value | Hex.Hex | Bytes.Bytes, options?: sha256.Options<as>): sha256.ReturnType<as>;
export declare namespace sha256 {
    type Options<as extends 'Hex' | 'Bytes' = 'Hex'> = {
        /** The return type. @default 'Hex' */
        as?: as | 'Hex' | 'Bytes' | undefined;
    };
    type ReturnType<as extends 'Hex' | 'Bytes' = 'Hex'> = (as extends 'Bytes' ? Bytes.Bytes : never) | (as extends 'Hex' ? Hex.Hex : never);
    type ErrorType = Bytes.from.ErrorType | Hex.fromBytes.ErrorType | Errors.GlobalErrorType;
}
/**
 * Checks if a string is a valid hash value.
 *
 * @example
 * ```ts twoslash
 * import { Hash } from 'ox'
 *
 * Hash.validate('0x')
 * // @log: false
 *
 * Hash.validate(
 *   '0x3ea2f1d0abf3fc66cf29eebb70cbd4e7fe762ef8a09bcc06c8edf641230afec0'
 * )
 * // @log: true
 * ```
 *
 * @param value - Value to check.
 * @returns Whether the value is a valid hash.
 */
export declare function validate(value: string): value is Hex.Hex;
export declare namespace validate {
    type ErrorType = Hex.validate.ErrorType | Hex.size.ErrorType | Errors.GlobalErrorType;
}
/** Thrown when an incremental hash state has been consumed or destroyed. */
export declare class HasherDestroyedError extends Errors.BaseError {
    readonly name = "Hash.HasherDestroyedError";
    constructor();
}
/** Thrown when a digest output buffer is too small. */
export declare class InvalidDigestSizeError extends Errors.BaseError {
    readonly name = "Hash.InvalidDigestSizeError";
    constructor(options: InvalidDigestSizeError.Options);
}
export declare namespace InvalidDigestSizeError {
    type Options = {
        /** Minimum output size. */
        minimum: number;
        /** Received output size. */
        size: number;
    };
}
//# sourceMappingURL=Hash.d.ts.map