BitcoinerLab Descriptors API - v3.1.7
    Preparing search index...

    Type Alias KeyInfo

    Parsed key-expression metadata.

    See KeyExpressionParser.

    type KeyInfo = {
        keyExpression: string;
        pubkey?: Uint8Array;
        ecpair?: ECPairInterfaceLike;
        bip32?: BIP32InterfaceLike;
        privkey?: Uint8Array;
        xPub?: string;
        xPrv?: string;
        masterFingerprint?: Uint8Array;
        originPath?: string;
        keyPath?: string;
        path?: string;
    }
    Index

    Properties

    keyExpression pubkey? ecpair? bip32? privkey? xPub? xPrv? masterFingerprint? originPath? keyPath? path?

    Properties

    keyExpression: string

    Original key expression string.

    pubkey?: Uint8Array

    Concrete public key when derivable.

    This is usually set unless the key expression is ranged (*). For taproot keys this is x-only (32 bytes).

    ecpair?: ECPairInterfaceLike

    bitcoinjs-compatible single-key signer (when derivable from the expression).

    bip32?: BIP32InterfaceLike

    bitcoinjs-compatible HD node (when derivable from the expression).

    privkey?: Uint8Array

    Raw private key bytes, when available.

    xPub?: string

    Parsed extended public key, when present in the expression.

    xPrv?: string

    Parsed extended private key, when present in the expression.

    masterFingerprint?: Uint8Array

    BIP32 master fingerprint, when available.

    originPath?: string

    Path from masterFingerprint to the xpub/xprv root.

    keyPath?: string

    Path from the xpub/xprv root.

    path?: string

    Full path from the master.

    Format: m/val/val/..., where val is an integer and hardened elements use '.

    Settings

    Member Visibility

    On This Page

    Properties