Function DescriptorsFactory

DescriptorsFactory(
    ecc: TinySecp256k1Interface,
): {
    Output: typeof Output;
    parseKeyExpression: KeyExpressionParser;
    expand: (
        params: {
            descriptor: string;
            index?: number;
            change?: number;
            checksumRequired?: boolean;
            network?: Network;
            allowMiniscriptInP2SH?: boolean;
        },
    ) => Expansion;
    ECPair: ECPairAPI;
    BIP32: BIP32API;
}
Constructs the necessary functions and classes for working with descriptors using an external elliptic curve (ecc) library.

Notably, it returns the Output class, which provides methods to create, sign, and finalize PSBTs based on descriptor expressions.

The Factory also returns utility methods like expand (detailed below) and parseKeyExpression (see KeyExpressionParser).

Additionally, for convenience, the function returns BIP32 and ECPair. These are bitcoinjs-lib classes designed for managing BIP32 keys and public/private key pairs: ECPair, respectively.
Parameters
- ecc: TinySecp256k1Interface
  An object with elliptic curve operations, such as tiny-secp256k1 or @bitcoinerlab/secp256k1.
Returns {
    Output: typeof Output;
    parseKeyExpression: KeyExpressionParser;
    expand: (
        params: {
            descriptor: string;
            index?: number;
            change?: number;
            checksumRequired?: boolean;
            network?: Network;
            allowMiniscriptInP2SH?: boolean;
        },
    ) => Expansion;
    ECPair: ECPairAPI;
    BIP32: BIP32API;
}
- Output: typeof Output
- parseKeyExpression: KeyExpressionParser
  Takes a string key expression (xpub, xprv, pubkey or wif) and parses it
- expand: (
      params: {
          descriptor: string;
          index?: number;
          change?: number;
          checksumRequired?: boolean;
          network?: Network;
          allowMiniscriptInP2SH?: boolean;
      },
  ) => Expansion
- ECPair: ECPairAPI
- BIP32: BIP32API
- Defined in descriptors.ts:246

Function DescriptorsFactory

Parameters

Returns { Output: typeof Output; parseKeyExpression: KeyExpressionParser; expand: ( params: { descriptor: string; index?: number; change?: number; checksumRequired?: boolean; network?: Network; allowMiniscriptInP2SH?: boolean; }, ) => Expansion; ECPair: ECPairAPI; BIP32: BIP32API;}

Output: typeof Output

parseKeyExpression: KeyExpressionParser

expand: ( params: { descriptor: string; index?: number; change?: number; checksumRequired?: boolean; network?: Network; allowMiniscriptInP2SH?: boolean; },) => Expansion

ECPair: ECPairAPI

BIP32: BIP32API

Settings

Returns {
Output: typeof Output;
parseKeyExpression: KeyExpressionParser;
expand: (
params: {
descriptor: string;
index?: number;
change?: number;
checksumRequired?: boolean;
network?: Network;
allowMiniscriptInP2SH?: boolean;
},
) => Expansion;
ECPair: ECPairAPI;
BIP32: BIP32API;
}

expand: (
params: {
descriptor: string;
index?: number;
change?: number;
checksumRequired?: boolean;
network?: Network;
allowMiniscriptInP2SH?: boolean;
},
) => Expansion