@scintilla-network/hashes/src/utils/index.d.ts

Enhanced hash functions for Scintilla and broader crypto / blockchain use

import { HashFunction } from "../types.js";

export interface HMAC {
    update(message: Uint8Array): HMAC;
    digest(): Uint8Array;
}

export const bytesToHex: (bytes: Uint8Array) => string;
export const randomBytes: (length: number) => Uint8Array;
export const toHex: (data: string | Uint8Array) => string;
export const fromHex: (hex: string) => Uint8Array;
export const isHexString: (value: any) => boolean;
export const isUint8Array: (value: any) => boolean;
export const formatMessage: (message: string | Uint8Array) => Uint8Array;
export const formatMessageHash: (hash: string | Uint8Array) => string;
export const fromUtf8: (text: string) => Uint8Array;
export const toUtf8: (bytes: Uint8Array) => string;
export const fromJSON: (json: string) => any;
export const toJSON: (data: any) => string;
export const hash160: HashFunction;

// HMAC functions
export const hmac: (hash: HashFunction, key: string | Uint8Array, message: string | Uint8Array) => Uint8Array;
export const createHmac: (hash: HashFunction, key: string | Uint8Array) => HMAC;

// HKDF functions
export const hkdf: (hash: HashFunction, inputKey: string | Uint8Array, salt: string | Uint8Array, info: string | Uint8Array, length: number) => Uint8Array;
export const hkdfExtract: (hash: HashFunction, inputKey: string | Uint8Array, salt: string | Uint8Array) => Uint8Array;
export const hkdfExpand: (hash: HashFunction, prk: string | Uint8Array, info: string | Uint8Array, length: number) => Uint8Array;

// PBKDF2 functions
export interface PBKDF2Options {
    c: number;
    dkLen: number;
}

export const pbkdf2: (hash: HashFunction, password: string | Uint8Array, salt: string | Uint8Array, options: PBKDF2Options) => Uint8Array;
export const pbkdf2Async: (hash: HashFunction, password: string | Uint8Array, salt: string | Uint8Array, options: PBKDF2Options) => Promise<Uint8Array>;

export const bech32: {
    encode: (prefix: string, words: number[]) => string;
    decode: (str: string) => { prefix: string; words: number[] };
    toWords: (bytes: Uint8Array) => number[];
    fromWords: (words: number[]) => Uint8Array;
};

export const bech32m: {
    encode: (prefix: string, words: number[]) => string;
    decode: (str: string) => { prefix: string; words: number[] };
    toWords: (bytes: Uint8Array) => number[];
    fromWords: (words: number[]) => Uint8Array;
};

export interface Base58Check {
    encode(data: Uint8Array): string;
    decode(str: string): Uint8Array;
}

// Base58 functions
export const base58: {
    encode(data: Uint8Array): string;
    decode(str: string): Uint8Array;
};

// Base58Check functions
export const base58check: Base58Check;
export function createBase58check(hashFunction?: HashFunction): Base58Check;

declare const utils: {
    bytesToHex: (bytes: Uint8Array) => string;
    randomBytes: (length: number) => Uint8Array;
    toHex: (data: string | Uint8Array) => string;
    fromHex: (hex: string) => Uint8Array;
    isHexString: (value: any) => boolean;
    isUint8Array: (value: any) => boolean;
    formatMessage: (message: string | Uint8Array) => Uint8Array;
    formatMessageHash: (hash: string | Uint8Array) => string;
    fromUtf8: (text: string) => Uint8Array;
    toUtf8: (bytes: Uint8Array) => string;
    fromJSON: (json: string) => any;
    toJSON: (data: any) => string;
    hash160: HashFunction;
    doubleSha256: HashFunction;
    bech32: typeof bech32;
    bech32m: typeof bech32m;
    base58: typeof base58;
    base58check: Base58Check;
    createBase58check: typeof createBase58check;
};

export default utils;