btc-hdkey/hdkey.d.ts

Hierarchical Deterministic Wallet support for BTC

export declare type network = 'testnet' | 'mainnet';
export declare type keyType = "public" | "private";
export declare class HDKey {
    /**
     * Generate a BIP39 menemonic
     */
    randomMenemonic(): string;
    /**
     * Generate a pseudo-random seed from BIP39 menemonic
     * @param menemonic
     */
    seedFromMenemonic(menemonic: string): string;
    /**
     * Derive an extended keypair from seed
     * @param seed The seed-string to use for generating the HDKey
     * @param net Network to use ("testnet", "mainnet")
     * @param n n-th derived keypair default:0
     */
    deriveAccount(seed: string, net?: network, n?: number): {
        publicExtendedKey: string;
        privateExtendedKey: string;
    };
    /**
     *
     * @param extendedKey Extended key to generate address from
     * @param networkName Network to use ("testnet", "mainnet")
     * @param n n-th derived address default:0
     */
    generateAddress(extendedKey: string, n?: number): string;
    HDKeyFromExtendedKey(extendedKeyB58: string): any | false;
    checkHDKey(key: string): {
        net: network;
        type: keyType;
    } | false;
    deriveAddress(extendedKey: string, n: number, derivationPrefix?: string): string | false;
    deriveKey(extendedKey: string, n: number, derivationPrefix?: string): any | false;
    addressFromHDKey(hdkey: string, net?: network): string;
}