@glitterprotocol/glitter-sdk/dist/key/MnemonicKey.d.ts

The JavaScript SDK for Glitter

import { RawKey } from './RawKey';
export declare const GLITTER_COIN_TYPE = 60;
interface MnemonicKeyOptions {
    /**
     * Space-separated list of words for the mnemonic key.
     */
    mnemonic?: string;
    /**
     * BIP44 account number.
     */
    account?: number;
    /**
     * BIP44 index number
     */
    index?: number;
    /**
     * Coin type. Default is LUNA, 330.
     */
    coinType?: number;
}
/**
 * Implements a BIP39 mnemonic wallet with standard key derivation from a word list. Note
 * that this implementation exposes the private key in memory, so it is not advised to use
 * for applications requiring high security.
 */
export declare class MnemonicKey extends RawKey {
    /**
     * Space-separated mnemonic phrase.
     */
    mnemonic: string;
    /**
     * Creates a new signing key from a mnemonic phrase. If no mnemonic is provided, one
     * will be automatically generated.
     *
     * ### Providing a mnemonic
     *
     * ```ts
     * import { MnemonicKey } from 'glitter.js';
     *
     * const mk = new MnemonicKey({ mnemonic: '...' });
     * console.log(mk.accAddress);
     * ```
     *
     * ### Generating a random mnemonic
     *
     * ```ts
     * const mk2 = new MnemonicKey();
     * console.log(mk2.mnemonic);
     * ```
     *
     * @param options
     */
    constructor(options?: MnemonicKeyOptions);
}
export {};