@bitcoinerlab/descriptors - v2.3.4
    Preparing search index...

    Type Alias Expansion

    DescriptorsFactory creates and returns the expand() function that parses a descriptor expression and destructures it into its elemental parts. Expansion is the type that expand() returns.

    type Expansion = {
        payment?: Payment;
        expandedExpression?: string;
        miniscript?: string;
        expansionMap?: ExpansionMap;
        isSegwit?: boolean;
        isTaproot?: boolean;
        expandedMiniscript?: string;
        redeemScript?: Buffer;
        witnessScript?: Buffer;
        isRanged: boolean;
        canonicalExpression: string;
    }
    Index

    Properties

    payment? expandedExpression? miniscript? expansionMap? isSegwit? isTaproot? expandedMiniscript? redeemScript? witnessScript? isRanged canonicalExpression

    Properties

    payment?: Payment

    The corresponding bitcoinjs-lib Payment for the provided expression, if applicable.

    expandedExpression?: string

    The expanded descriptor expression. See ExpansionMap for a detailed explanation.

    miniscript?: string

    The extracted miniscript from the expression, if any.

    expansionMap?: ExpansionMap

    A map of key expressions in the descriptor to their corresponding expanded keys. See ExpansionMap for a detailed explanation.

    isSegwit?: boolean

    A boolean indicating whether the descriptor uses SegWit.

    isTaproot?: boolean

    A boolean indicating whether the descriptor uses Taproot.

    expandedMiniscript?: string

    The expanded miniscript, if any. It corresponds to the expandedExpression without the top-level script expression.

    redeemScript?: Buffer

    The redeem script for the descriptor, if applicable.

    witnessScript?: Buffer

    The witness script for the descriptor, if applicable.

    isRanged: boolean

    Whether the descriptor is a ranged-descriptor.

    canonicalExpression: string

    This is the preferred or authoritative representation of an output descriptor expression. It removes the checksum and, if it is a ranged-descriptor, it particularizes it to its index.

    Settings

    Member Visibility

    On This Page

    Properties