@activeledger/sdk-bip39/lib/key.d.ts

NodeJS package for use when integrating with Activeledger with BIP39 Support

import { KeyHandler as KH, IKey } from "@activeledger/sdk";
/**
 * Extends SDK IKey to include phrase words
 *
 * @export
 * @interface IKeyExtended
 * @extends {IKey}
 */
export interface IKeyExtended extends IKey {
    phrase?: string;
}
/**
 * Extends SDK KeyHandler for compatibility and adds BIP39 features
 *
 * @export
 * @class KeyHandler
 * @extends {KH}
 */
export declare class KeyHandler extends KH {
    /**
     * Generate new Key Pair with BIP39 wordlist
     *
     * @param {string} keyName
     * @param {boolean} [compressed]
     * @returns {Promise<IKeyExtended>}
     * @memberof KeyHandler
     */
    generateBIP39Key(keyName: string, compressed?: boolean): Promise<IKeyExtended>;
    /**
     * Generate Key Pair from BIP39 wordlist
     *
     * @param {string} keyName
     * @param {string} phrase
     * @param {boolean} [compressed]
     * @returns {Promise<IKeyExtended>}
     * @memberof KeyHandler
     */
    restoreBIP39Key(keyName: string, phrase: string, compressed?: boolean): Promise<IKeyExtended>;
}