@did-btcr2/bitcoin 0.1.2 → 0.2.1

package/dist/types/rpc-client.d.ts

@@ -1,506 +0,0 @@
-import { default as RpcClient } from 'bitcoin-core';
-import { AddMultiSigAddressParams, BitcoinSignature, BlockHashOptions, BlockHeader, BlockResponse, BumpFeeOptions, BumpFeeResult, ChainInfo, CreateMultisigParams, CreateMultiSigResult, CreateRawTxInputs, CreateRawTxOutputs, CreateWalletDescriptorOptions, CreateWalletDescriptorsResult, CreateWalletParams, CreateWalletResult, DecodedRawTransaction, DerivedAddresses, FeeEstimateMode, FundRawTxOptions, FundRawTxResult, GetBlockParams, GetUTXOsResult, IClientConfig, ImportDescriptorRequest, ImportMultiOptions, ImportMultiRequest, ImportMultiResult, ListTransactionsParams, ListTransactionsResult, ListUnspentParams, MemoryStats, MempoolContent, MempoolInfo, MiningInfo, Outpoint, PeerInfo, RawTransactionResponse, RawTransactionV2, ReturnFormatOptions, RpcClientConfig, ScanBlocksParams, ScriptDecoded, SendAllParams, SendAllResult, SendManyParams, SignedRawTx, UnspentTxInfo, ValidateAddressResult, VerbosityLevel, WalletTransaction } from './types.js';
-import { IBitcoinRpc } from './interface.js';
-/**
- * Encapsulates a {@link RpcClient | Client} object from {@link https://www.npmjs.com/package/bitcoin-core | `bitcoin-core`}.
- * Implements a strongly-typed {@link IBitcoinRpc | IBitcoinRpc interface} for added expresivity and developer support.
- * @class BitcoinRpc
- * @type {BitcoinRpc}
- */
-export declare class BitcoinRpc implements IBitcoinRpc {
-    /**
-     * The encapsulated {@link RpcClientConfig} object.
-     * @private
-     * @type {RpcClient} An instance of the Client class from {@link https://www.npmjs.com/package/bitcoin-core | `bitcoin-core`}.
-     * See {@link https://github.com/ruimarinho/bitcoin-core/blob/master/src/index.d.ts#L64 | `Client`} for more information.
-     */
-    private _client;
-    /**
-     * The encapsulated {@link RpcClientConfig} object.
-     * @private
-     * @type {RpcClientConfig} ClientConfig from {@link https://www.npmjs.com/package/bitcoin-core | `bitcoin-core`}.
-     * See {@link https://github.com/ruimarinho/bitcoin-core/blob/master/src/index.d.ts#L39 | `ClientConfig`} for more information.
-     */
-    private _config;
-    /**
-     * Constructs a new {@link BitcoinRpc} instance from a new {@link RpcClient | RpcClient}.
-     * @param {RpcClientConfig} config The bitcoin-core client instance.
-     * @example
-     * ```
-     *  import BitcoinRpc from '@did-btcr2/method';
-     *  const bob = BitcoinRpc.connect(); // To use default polar config, pass no args. Polar must run locally.
-     * ```
-     */
-    constructor(config: RpcClientConfig);
-    /**
-     * Get the config for the current BitcoinRpc object.
-     * @returns {RpcClientConfig} The encapsulated {@link RpcClientConfig} object.
-     * @example
-     * ```
-     *  import BitcoinRpc from '@did-btcr2/method';
-     *  const alice = BitcoinRpc.connect();
-     *  const config = alice.config;
-     * ```
-     */
-    get config(): RpcClientConfig;
-    /**
-     * Get the client for the current BitcoinRpc object.
-     * @returns {RpcClient} The encapsulated {@link RpcClient} object.
-     * @example
-     * ```
-     * const alice = BitcoinRpc.connect();
-     * const config = alice.client;
-     * ```
-     */
-    get client(): RpcClient;
-    /**
-     * Static method initializes a new BitcoinRpc client with the given configuration.
-     * The RpcClient returned by this method does not have any named methods.
-     * Use this method to create and pass a new RpcClient instance to a BitcoinRpc constructor.
-     *
-     * @param {IClientConfig} config The configuration object for the client (optional).
-     * @returns {RpcClient} A new RpcClient instance.
-     * @example
-     * ```
-     * const options: IClientConfig = {
-     *     host: 'http://localhost:18443',
-     *     username: 'alice',
-     *     password: 'alicepass',
-     *     version: '28.1.0',
-     * }
-     * const aliceClient = BitcoinRpc.initialize(options); // Client config required
-     * const alice = new BitcoinRpc(aliceClient);
-     * ```
-     */
-    static initialize(config?: IClientConfig): RpcClient;
-    /**
-     * Static method connects to a bitcoin node running the bitcoin core daemon (bitcoind).
-     * To use default polar config, do not pass a config. See {@link DEFAULT_RPC_CLIENT_CONFIG} for default config.
-     * @required A locally running {@link https://github.com/jamaljsr/polar | Polar Lightning} regtest node.
-     *
-     * @param {?RpcClientConfig} config The configuration object for the client (optional).
-     * @returns A new {@link BitcoinRpc} instance.
-     * @example
-     * ```
-     * const alice = BitcoinRpc.connect();
-     * ```
-     */
-    static connect(config?: RpcClientConfig): BitcoinRpc;
-    /**
-     * Check if the given error is a JSON-RPC error.
-     * @param {unknown} e The error to check.
-     * @returns {boolean} True if the error is a JSON-RPC error, false otherwise.
-     */
-    isJsonRpcError(e: unknown): e is Error & {
-        name: 'RpcError';
-        code?: number;
-    };
-    /**
-     * Executes a JSON-RPC command on the bitcoind node.
-     * @param {MethodNameInLowerCase} method The name of the method to call.
-     * @param {Array<any>} parameters The parameters to pass to the method.
-     * @returns {Promise<T>} A promise resolving to the result of the command.
-     */
-    private executeRpc;
-    /**
-     * Handle errors that occur while executing commands.
-     * @param methods An array of {@link BatchOption} objects.
-     * @param error The error that was thrown.
-     * @throws Throws a {@link BitcoinRpcError} with the error message.
-     */
-    private handleError;
-    /**
-     * TODO: Comments
-     */
-    getUnspentTransactionOutputs(outpoints: Outpoint[]): Promise<GetUTXOsResult>;
-    /**
-     * TODO: Comments
-     */
-    getTransactionByHash(hash: string, options?: ReturnFormatOptions): Promise<string>;
-    /**
-     * TODO: Comments
-     */
-    getBlockHeadersByHash(hash: string, count: number, options?: ReturnFormatOptions): Promise<BlockHeader[]>;
-    /**
-     * TODO: Comments
-     */
-    getMemoryPoolContent(): Promise<MempoolContent>;
-    /**
-     * TODO: Comments
-     */
-    getMemoryPoolInformation(): Promise<MempoolInfo>;
-    /**
-     * Alias for `getblock <hash> 2`
-     */
-    getBlockByHash(hash: string, options?: BlockHashOptions): Promise<BlockHeader>;
-    /**
-     * TODO: Comments
-     */
-    abandonTransaction(txid: string): Promise<void>;
-    /**
-     * TODO: Comments
-     */
-    abortRescan(): Promise<void>;
-    /**
-     * TODO: Comments
-     */
-    addMultiSigAddress(params: AddMultiSigAddressParams): Promise<string>;
-    /**
-     * TODO: Comments
-     */
-    addWitnessAddress(address: string): Promise<void>;
-    /**
-     * TODO: Comments
-     */
-    backupWallet(destination: string): Promise<void>;
-    /**
-     * TODO: Comments
-     */
-    bumpFee(txid: string, options?: BumpFeeOptions): Promise<BumpFeeResult>;
-    /**
-     * TODO: Comments
-     */
-    createMultiSig(nrequired: number, keys: string[]): Promise<CreateMultiSigResult>;
-    /**
-     * TODO: Comments
-     */
-    createWallet(params: CreateWalletParams): Promise<CreateWalletResult>;
-    /**
-     * TODO: Comments
-     */
-    decodeScript(hexstring: string): Promise<ScriptDecoded>;
-    /**
-     * TODO: Comments
-     */
-    getBestBlockHash(): Promise<string>;
-    /**
-     * Returns the block data associated with a `blockhash` of a valid block.
-     * @param {GetBlockParams} params See {@link GetBlockParams} for details.
-     * @param {?string} params.blockhash The blockhash of the block to query.
-     * @param {?number} params.height The block height of the block to query.
-     * @param {?VerbosityLevel} params.verbosity The verbosity level. See {@link VerbosityLevel}.
-     * @returns {BlockResponse} A promise resolving to a {@link BlockResponse} formatted depending on `verbosity` level.
-     * @throws {BitcoinRpcError} If neither `blockhash` nor `height` is provided.
-     */
-    getBlock({ blockhash, height, verbosity }: GetBlockParams): Promise<BlockResponse | undefined>;
-    /**
-     * Returns the blockheight of the most-work fully-validated chain. The genesis block has height 0.
-     * @returns {Blockheight} The number of the blockheight with the most-work of the fully-validated chain.
-     */
-    getBlockCount(): Promise<number>;
-    /**
-     * Returns the blockhash of the block at the given height in the active chain.
-     */
-    getBlockHash(height: number): Promise<string>;
-    /**
-     * TODO: Comments
-     */
-    getBlockHeader(hash: string, verbose?: boolean): Promise<string | BlockHeader>;
-    /**
-     * TODO: Comments
-     */
-    getBlockchainInfo(): Promise<ChainInfo>;
-    /**
-     * TODO: Comments
-     */
-    getInfo(...args: any[]): Promise<void>;
-    /**
-     * TODO: Comments
-     */
-    getMemoryInfo(mode?: 'stats' | 'mallocinfo'): Promise<MemoryStats | string>;
-    /**
-     * TODO: Comments
-     */
-    scanBlocks(params: ScanBlocksParams): Promise<any>;
-    /**
-     * TODO: Comments
-     */
-    fundRawTransaction(hexstring: string, options: FundRawTxOptions): Promise<FundRawTxResult>;
-    /**
-     * Sign inputs for raw transaction (serialized, hex-encoded).
-     * The second optional argument (may be null) is an array of previous transaction outputs that
-     * this transaction depends on but may not yet be in the block chain.
-     * Requires wallet passphrase to be set with walletpassphrase call if wallet is encrypted.
-     * @param {string} hexstring The hex-encoded transaction to send.
-     */
-    signRawTransaction(hexstring: string): Promise<SignedRawTx>;
-    /**
-     * Submit a raw transaction (serialized, hex-encoded) to local node and network.
-     *
-     * The transaction will be sent unconditionally to all peers, so using sendrawtransaction
-     * for manual rebroadcast may degrade privacy by leaking the transaction's origin, as
-     * nodes will normally not rebroadcast non-wallet transactions already in their mempool.
-     *
-     * @param {string} hexstring The hex-encoded transaction to send.
-     * @param {numbner} [maxfeerate] If not passed, default is 0.10.
-     * @returns {Promise<string>} A promise resolving to the transaction hash in hex.
-     */
-    sendRawTransaction(hexstring: string, maxfeerate?: number | string, maxBurnAmount?: number | string): Promise<string>;
-    /**
-     * Combines calls to `signRawTransaction` and `sendRawTransaction`.
-     * @param {string} params.hexstring The hex-encoded transaction to send.
-     * @returns {Promise<string>} A promise resolving to the transaction hash in hex.
-     */
-    signAndSendRawTransaction(hexstring: string): Promise<string>;
-    /**
-     * Combines calls to `createRawTransaction`, `signRawTransaction` and `sendRawTransaction`.
-     * @param {CreateRawTxInputs[]} inputs The inputs to the transaction (required).
-     * @param {CreateRawTxOutputs[]} outputs The outputs of the transaction (required).
-     * @returns {Promise<string>} A promise resolving to the transaction hash in hex.
-     */
-    createSignSendRawTransaction(inputs: CreateRawTxInputs[], outputs: CreateRawTxOutputs[]): Promise<string>;
-    /**
-     * TODO: Comments
-     */
-    listTransactions(params: ListTransactionsParams): Promise<ListTransactionsResult>;
-    /**
-     * TODO: Comments
-     */
-    decodeRawTransaction(hexstring: string): Promise<DecodedRawTransaction>;
-    /**
-     * TODO: Comments
-     */
-    combineRawTransaction(txs: string[]): Promise<string>;
-    /**
-     * Create a transaction spending the given inputs and creating new outputs.
-     * Outputs can be addresses or data.
-     * Returns hex-encoded raw transaction.
-     * Note that the transaction's inputs are not signed, and
-     * it is not stored in the wallet or transmitted to the network.
-     * @param {TxInForCreateRaw[]} inputs The inputs to the transaction (required).
-     * @param {CreateRawTxOutputs[]} outputs The outputs of the transaction (required).
-     * @param {number} [locktime] The locktime of the transaction (optional).
-     * @param {boolean} [replacable] Whether the transaction is replaceable (optional).
-     * @returns {string} The hex-encoded raw transaction.
-     */
-    createRawTransaction(inputs: CreateRawTxInputs[], outputs: CreateRawTxOutputs[], locktime?: number, replacable?: boolean): Promise<string>;
-    /**
-     * Creates a multi-signature address with n signature of m keys required.
-     *
-     * @param {CreateMultisigParams} params The parameters for the createMultisig command.
-     * @param {number} params.nrequired The number of required signatures out of the n keys (required).
-     * @param {string[]} params.keys The hex-encoded public keys (required).
-     * @param {?string} params.address_type The address type to use (optional, options=["legacy", "p2sh-segwit", "bech32"], default="legacy").
-     * @returns {CreateMultiSigResult} json object with the address and redeemScript.
-     *
-     * @example Create a multisig address from 2 public keys
-     * ```
-     * const bob = BitcoinRpc.connect();
-     * const keys = [
-     *  '03789ed0bb717d88f7d321a368d905e7430207ebbd82bd342cf11ae157a7ace5fd',
-     *  '03dbc6764b8884a92e871274b87583e6d5c2a58819473e17e107ef3f6aa5a61626'
-     * ];
-     * const multisig = await bob.createMultisig({ nrequired: 2, keys });
-     * ```
-     */
-    createMultisig({ nrequired, keys, address_type }: CreateMultisigParams): Promise<CreateMultiSigResult>;
-    /**
-     * TODO: Comments
-     */
-    getDescriptorInfo(descriptor: string): Promise<any>;
-    /**
-     * TODO: Comments
-     */
-    signMessageWithPrivkey(privkey: string, message: string): Promise<BitcoinSignature>;
-    /**
-     * TODO: Comments
-     */
-    validateAddress(address: string): Promise<ValidateAddressResult>;
-    /**
-     * TODO: Comments
-     */
-    verifyMessage(address: string, signature: string, message: string): Promise<boolean>;
-    /**
-     * Derives one or more addresses corresponding to an output descriptor.
-     * Examples of output descriptors are:
-     *   pkh(<pubkey>)                                     P2PKH outputs for the given pubkey
-     *   wpkh(<pubkey>)                                    Native segwit P2PKH outputs for the given pubkey
-     *   sh(multi(<n>,<pubkey>,<pubkey>,...))              P2SH-multisig outputs for the given threshold and pubkeys
-     *   raw(<hex script>)                                 Outputs whose output script equals the specified hex-encoded bytes
-     *   tr(<pubkey>,multi_a(<n>,<pubkey>,<pubkey>,...))   P2TR-multisig outputs for the given threshold and pubkeys
-     *
-     * In the above, <pubkey> either refers to a fixed public key in hexadecimal notation, or to an xpub/xprv optionally followed by one
-     * or more path elements separated by "/", where "h" represents a hardened child key.
-     *
-     * See {@link https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md | github.com/bitcoin/bitcoin/descriptors.md}
-     * for more information.
-     * @async
-     * @param {string} descriptor The descriptor.
-     * @param {Array<number>} range If descriptor is ranged, must specify end or [begin,end] to derive.
-     * @returns {Array<DerivedAddresses>} a list of derived addresses
-     * @example First three native segwit receive addresses
-     * ```
-     * const bitcoind = BitcoinRpc.connect()
-     * const addresses = bitcoind.deriveAddresses("wpkh([d34db33f/84h/0h/0h]xpub6DJ2dN.../0/*)#cjjspncu", [0,2])
-     * ```
-     */
-    deriveAddresses(descriptor: string, range?: Array<number>): Promise<Array<DerivedAddresses>>;
-    /**
-     * TODO: Comments
-     */
-    addMultisigAddress(): Promise<any>;
-    /**
-     * Creates the wallet's descriptor for the given address type. The address type must be one that the
-     * wallet does not already have a descriptor for. Requires wallet passphrase to be set with walletpassphrase call
-     * if wallet is encrypted.
-     * @param type The address type the descriptor will produce. Options are "legacy", "p2sh-segwit", "bech32", and "bech32m". (string, required)
-     * @param options Options object that can be used to pass named arguments, listed below. (json object, optional)
-     * @param options.internal Whether to only make one descriptor that is internal (if parameter is true) or external (if parameter is false)
-     *                          (boolean, optional, default=Both external and internal will be generated unless this parameter is specified)
-     * @param options.hdkey The HD key that the wallet knows the private key of, listed using 'gethdkeys', to use for this descriptor's key.
-     *                       (string, optional, default=The HD key used by all other active descriptors)
-     * @returns A {@link CreateWalletDescriptorsResult} response object
-     */
-    createWalletDescriptor(type: string, options: CreateWalletDescriptorOptions): Promise<CreateWalletDescriptorsResult>;
-    /**
-     * TODO: Comments
-     */
-    getBalance(): Promise<any>;
-    /**
-     * TODO: Comments
-     */
-    getNewAddress(account?: string): Promise<string>;
-    /**
-     * TODO: Comments
-     */
-    importAddress(script: string, label?: string, rescan?: boolean, p2sh?: boolean): Promise<void>;
-    /**
-     * Import descriptors.
-     *
-     * This will trigger a rescan of the blockchain based on the earliest timestamp of all descriptors being imported.
-     * Requires a new wallet backup. Note: This call can take over an hour to complete if using an early timestamp;
-     * during that time, other rpc calls may report that the imported keys, addresses or scripts exist but related
-     * transactions are still missing. The rescan is significantly faster if block filters are available
-     * (using startup option "-blockfilterindex=1").
-     *
-     * @param requests Array of {@link ImportDescriptorRequest} objects to be imported
-     * @returns Array of {@link ImportDescriptorResult} objects
-     * @returns
-     */
-    importDescriptors(requests: Array<ImportDescriptorRequest>): Promise<any>;
-    /**
-     * TODO: Comments
-     */
-    importMulti(requests: ImportMultiRequest[], options?: ImportMultiOptions): Promise<Array<ImportMultiResult>>;
-    /**
-     * TODO: Comments
-     */
-    listUnspent(params: ListUnspentParams): Promise<UnspentTxInfo[]>;
-    /**
-     * TODO: Comments
-     */
-    rescanBlockchain(): Promise<any>;
-    /**
-     * Send an amount to a given address.
-     * @async
-     * @param {string} address The address to send to.
-     * @param {number} amount The amount to send in BTC.
-     * @returns {Promise<SendToAddressResult>} A promise resolving to the transaction id.
-     */
-    sendToAddress(address: string, amount: number): Promise<RawTransactionV2>;
-    /**
-     * TODO: Comments
-     */
-    signMessage(): Promise<any>;
-    /**
-     * TODO: Comments
-     */
-    signRawTransactionWithWallet(): Promise<any>;
-    /**
-     * TODO: Comments
-     */
-    send(): Promise<any>;
-    /**
-     * @warning EXPERIMENTAL this call may be changed in future releases.
-     *
-     * Spend the value of all (or specific) confirmed UTXOs & unconfirmed change in the wallet to one or
-     * more recipients. Unconfirmed inbound UTXOs and locked UTXOs will not be spent. Sendall will respect the
-     * avoid_reuse wallet flag. If your wallet contains many small inputs, either because it received tiny payments or as
-     * a result of accumulating change, consider using `send_max` to exclude inputs that are worth less than the fees
-     * needed to spend them.
-     *
-     * @param {SendAllParams} params The parameters for the sendAll command.
-     * @param {Recipients} params.recipients The recipient destination addresses.
-     *    Each address may only appear once. Optionally some recipients can be specified with an
-     *    amount to perform payments, but at least one address must appear without a specified amount.
-     * @param {SendAllOptions} params.options Options object that can be used to pass named arguments.
-     * @param {} params.options.conf_target Confirmation target in blocks. numeric, optional, default=wallet -txconfirmtarget.
-     * @param estimate_mode The fee estimate mode, must be one of (case insensitive). string, optional, default="unset".
-     *    See {@link FeeEstimateMode} for possible values.
-     * @param fee_rate Specify a fee rate in sat/vB. numeric or string, optional, default=not set,
-     *    falls back to wallet fee estimation
-     * @param options: Options object that can be used to pass named arguments. json object, optional
-     *
-     * @returns A promise resolving to a {@link SendAllResult} object
-     *
-     * @example
-     * Spend all UTXOs from the wallet with a fee rate of 1 sat/vB using named arguments
-     * const bob = BitcoinRpc.connect({
-     *    username: 'bob',
-     *    password: 'bobpass',
-     *    host: 'http://127.0.0.1:18443',
-     *    allowDefaultWallet: true,
-     *    version: '28.1.0'
-     * });
-     * const sendall = await bob.sendAll({
-     *    recipients: [
-     *      'bc1q09vm5lfy0j5reeulh4x5752q25uqqvz34hufdl',
-     *      'bc1q02ad21edsxd23d32dfgqqsz4vv4nmtfzuklhy3'
-     *    ],
-     *     options: { fee_rate: 1.1 }
-     * });
-     */
-    sendAll(params: SendAllParams): Promise<SendAllResult>;
-    /**
-     * TODO: Comments
-     */
-    sendMany(params: SendManyParams): Promise<string>;
-    /**
-     * Get detailed information about in-wallet transaction <txid>.
-     * @param txid: The transaction id. (string, required)
-     * @param {boolean} include_watchonly Whether to include watch-only addresses in balance calculation and details.
-     * @returns {WalletTransaction} A promise resolving to a {@link WalletTransaction} object.
-     */
-    getTransaction(txid: string, include_watchonly?: boolean): Promise<WalletTransaction>;
-    /**
-     * Get detailed information about a transaction.
-     *
-     * By default, this call only returns a transaction if it is in the mempool. If -txindex is enabled
-     * and no blockhash argument is passed, it will return the transaction if it is in the mempool or any block.
-     * If a blockhash argument is passed, it will return the transaction if the specified block is available and
-     * the transaction is in that block.
-     * @async
-     * @param {string} txid The transaction id (required).
-     * @param {?VerbosityLevel} verbosity Response format: 0 (hex), 1 (json) or 2 (jsonext).
-     * @param {?string} blockhash The block in which to look for the transaction (optional).
-     * @returns {GetRawTransaction} A promise resolving to data about a transaction in the form specified by verbosity.
-     */
-    getRawTransaction(txid: string, verbosity?: VerbosityLevel, blockhash?: string): Promise<RawTransactionResponse>;
-    /**
-     * Get detailed information about multiple transactions. An extension of {@link getRawTransaction}.
-     *
-     * @async
-     * @param {Array<string>} txids An array of transaction ids.
-     * @param {?VerbosityLevel} verbosity Response format: 0 (hex), 1 (json) or 2 (jsonext).
-     * @returns {Promise<Array<RawTransactionResponse>>}
-     */
-    getRawTransactions(txids: string[], verbosity?: VerbosityLevel): Promise<RawTransactionResponse[]>;
-    clearBanned(): Promise<void>;
-    disconnectNode(address?: string, nodeid?: number): Promise<void>;
-    dumpPrivKey(address: string): Promise<string>;
-    dumpWallet(filename: string): Promise<{
-        filename: string;
-    }>;
-    encryptWallet(passphrase: string): Promise<void>;
-    estimateSmartFee(conf_target: number, estimate_mode?: FeeEstimateMode): Promise<{
-        feerate?: number;
-        errors?: string[];
-        blocks?: number;
-    }>;
-    getConnectionCount(): Promise<number>;
-    getDifficulty(): Promise<number>;
-    getMempoolInfo(): Promise<MempoolInfo>;
-    getMiningInfo(): Promise<MiningInfo>;
-    getPeerInfo(): Promise<PeerInfo[]>;
-    walletLock(passphrase: string, timeout: number): Promise<void>;
-}

package/dist/types/rpc-client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"rpc-client.d.ts","sourceRoot":"","sources":["../../src/rpc-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EACL,wBAAwB,EAExB,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,EACX,aAAa,EAKb,cAAc,EACd,aAAa,EACb,SAAS,EACT,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,6BAA6B,EAC7B,6BAA6B,EAC7B,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,EACrB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,cAAc,EACd,aAAa,EACb,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,sBAAsB,EACtB,sBAAsB,EACtB,iBAAiB,EACjB,WAAW,EACX,cAAc,EACd,WAAW,EAEX,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,sBAAsB,EAGtB,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,aAAa,EACb,cAAc,EACd,WAAW,EACX,aAAa,EACb,qBAAqB,EACrB,cAAc,EACd,iBAAiB,EAClB,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7C;;;;;GAKG;AACH,qBAAa,UAAW,YAAW,WAAW;IAC5C;;;;;OAKG;IACH,OAAO,CAAC,OAAO,CAAY;IAE3B;;;;;OAKG;IACH,OAAO,CAAC,OAAO,CAAkB;IAEjC;;;;;;;;OAQG;gBACS,MAAM,EAAE,eAAe;IAKnC;;;;;;;;;OASG;IACH,IAAI,MAAM,IAAI,eAAe,CAG5B;IAED;;;;;;;;OAQG;IACH,IAAI,MAAM,IAAI,SAAS,CAGtB;IAED;;;;;;;;;;;;;;;;;;OAkBG;WACW,UAAU,CAAC,MAAM,CAAC,EAAE,aAAa,GAAG,SAAS;IAK3D;;;;;;;;;;;OAWG;WACW,OAAO,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,UAAU;IAK3D;;;;OAIG;IACI,cAAc,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,KAAK,GAAG;QAAE,IAAI,EAAE,UAAU,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE;IAQnF;;;;;OAKG;YACW,UAAU;IAiBxB;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IA2BnB;;OAEG;IACU,4BAA4B,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzF;;OAEG;IACU,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/F;;OAEG;IACU,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAItH;;OAEG;IACU,oBAAoB,IAAI,OAAO,CAAC,cAAc,CAAC;IAI5D;;OAEG;IACU,wBAAwB,IAAI,OAAO,CAAC,WAAW,CAAC;IAI7D;;OAEG;IACU,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI3F;;OAEG;IACU,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5D;;OAEG;IACU,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAIzC;;OAEG;IACU,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlF;;OAEG;IACU,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9D;;OAEG;IACU,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7D;;OAEG;IACU,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAIpF;;OAEG;IACU,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAI7F;;OAEG;IACU,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIlF;;OAEG;IACU,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAIpE;;OAEG;IACU,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIhD;;;;;;;;OAQG;IACU,QAAQ,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IA6B3G;;;OAGG;IACU,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAI7C;;OAEG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1D;;OAEG;IACU,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,GAAG,WAAW,CAAC;IAI3F;;OAEG;IACU,iBAAiB,IAAI,OAAO,CAAC,SAAS,CAAC;IAIpD;;OAEG;IACU,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD;;OAEG;IACU,aAAa,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,YAAY,GAAG,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC;IAIxF;;OAEG;IACU,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,GAAG,CAAC;IAI/D;;OAEG;IACU,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IAIvG;;;;;;OAMG;IACU,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIxE;;;;;;;;;;OAUG;IACU,kBAAkB,CAC7B,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAC5B,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAC9B,OAAO,CAAC,MAAM,CAAC;IAKlB;;;;OAIG;IACU,yBAAyB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAK1E;;;;;OAKG;IACU,4BAA4B,CAAC,MAAM,EAAE,iBAAiB,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAOtH;;OAEG;IACU,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAI9F;;OAEG;IACU,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIpF;;OAEG;IACU,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlE;;;;;;;;;;;OAWG;IACU,oBAAoB,CAAC,MAAM,EAAE,iBAAiB,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAIvJ;;;;;;;;;;;;;;;;;;OAkBG;IACU,cAAc,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAInH;;OAEG;IACU,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIhE;;OAEG;IACU,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAIhG;;OAEG;IACU,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAI7E;;OAEG;IACU,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjG;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAIzG;;OAEG;IACU,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC;IAI/C;;;;;;;;;;;OAWG;IACU,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,6BAA6B,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAIjI;;OAEG;IACU,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IAIvC;;OAEG;IACU,aAAa,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI7D;;OAEG;IACU,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3G;;;;;;;;;;;;OAYG;IACU,iBAAiB,CAAC,QAAQ,EAAE,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAItF;;OAEG;IACU,WAAW,CAAC,QAAQ,EAAE,kBAAkB,EAAE,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAIzH;;OAEG;IACU,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI7E;;OAEG;IACU,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC;IAI7C;;;;;;OAMG;IACU,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAKtF;;OAEG;IACU,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC;IAIxC;;OAEG;IACU,4BAA4B,IAAI,OAAO,CAAC,GAAG,CAAC;IAIzD;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC;IAIjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACU,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAInE;;OAEG;IACU,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAI9D;;;;;OAKG;IACU,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIlG;;;;;;;;;;;;OAYG;IACU,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,cAAc,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAgB7H;;;;;;;OAOG;IACU,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAQ/G,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI7C,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;KAAE,CAAC;IAI5D,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhD,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;KAAE,CAAC;IAI1I,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIrC,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAIhC,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC;IAItC,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC;IAIpC,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAIlC,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG/D"}

package/src/bitcoin.node.ts

@@ -1,121 +0,0 @@
-import { MethodError } from '@did-btcr2/common';
-import { networks } from 'bitcoinjs-lib';
-import { DEFAULT_REST_CLIENT_CONFIG, DEFAULT_RPC_CLIENT_CONFIG } from './constants.js';
-import { getNetwork } from './network.js';
-import { BitcoinRest } from './rest-client.js';
-import { BitcoinRpc } from './rpc-client.js';
-import { AvailableNetworks, BitcoinClientConfig } from './types.js';
-
-export type BitcoinNetworkConfig = {
-  name: keyof AvailableNetworks;
-  rpc: BitcoinRpc;
-  rest: BitcoinRest;
-  config: BitcoinClientConfig;
-  data: networks.Network;
-};
-
-export type BitcoinNetworkConfigMap = {
-  [key in keyof AvailableNetworks]?: BitcoinNetworkConfig;
-};
-
-/**
- * General class to house the Bitcoin client connections, client config and various utility methods.
- * @name Bitcoin
- * @type {Bitcoin}
- */
-export class Bitcoin {
-  public network: BitcoinNetworkConfig;
-  public mainnet?: BitcoinNetworkConfig;
-  public testnet?: BitcoinNetworkConfig;
-  public signet?: BitcoinNetworkConfig;
-  public mutinynet?: BitcoinNetworkConfig;
-  public regtest?: BitcoinNetworkConfig;
-
-  /**
-   * Creates an instance of the Bitcoin class.
-   * @param {BitcoinNetworkConfigMap} configs Optional configuration object for the Bitcoin client. If not provided, it will
-   * be loaded from the BITCOIN_CLIENT_CONFIG environment variables.
-   * @throws {MethodError} If no configs is passed and BITCOIN_NETWORK_CONFIG is missing or invalid.
-   */
-  constructor(configs?: BitcoinNetworkConfigMap) {
-    const BITCOIN_NETWORK_CONFIG = process.env.BITCOIN_NETWORK_CONFIG ?? JSON.stringify(configs ?? {
-      regtest : {
-        rpc  : DEFAULT_RPC_CLIENT_CONFIG,
-        rest : DEFAULT_REST_CLIENT_CONFIG
-      }
-    });
-
-    if(!BITCOIN_NETWORK_CONFIG) {
-      throw new MethodError(
-        'No BITCOIN_NETWORK_CONFIG available: must pass `configs` to constructor or set `BITCOIN_NETWORK_CONFIG` in env',
-        'MISSING_BITCOIN_NETWORK_CONFIG',
-        { BITCOIN_NETWORK_CONFIG }
-      );
-    }
-
-    // Check if BITCOIN_NETWORK_CONFIG is parsable JSON string
-    if (!JSON.parsable(BITCOIN_NETWORK_CONFIG)) {
-      throw new MethodError(
-        'Parsing failed: malformed BITCOIN_NETWORK_CONFIG',
-        'MISSING_MALFORMED_BITCOIN_NETWORK_CONFIG',
-        { BITCOIN_NETWORK_CONFIG }
-      );
-    }
-
-    // Parse the BITCOIN_NETWORK_CONFIG
-    const networkConfigs: Record<string, BitcoinClientConfig> = JSON.parse(BITCOIN_NETWORK_CONFIG);
-
-    // Set a list of available networks
-    const networks: (keyof AvailableNetworks)[] = ['mainnet', 'testnet', 'signet', 'mutinynet', 'regtest'];
-
-    // Iterate over the networks and create the client connections
-    for (const network of networks) {
-      const networkConfig: BitcoinClientConfig = (configs?.[network] ?? networkConfigs[network]) as BitcoinClientConfig;
-      if (networkConfig) {
-        this[network] = {
-          name   : network,
-          config : networkConfig,
-          rpc    : new BitcoinRpc(networkConfig.rpc ?? DEFAULT_RPC_CLIENT_CONFIG),
-          rest   : new BitcoinRest(networkConfig.rest ?? DEFAULT_REST_CLIENT_CONFIG) ,
-          data   : getNetwork(network),
-        };
-      }
-    }
-
-    // Load and check the ACTIVE_NETWORK variable
-    const ACTIVE_NETWORK = (process.env.ACTIVE_NETWORK?.toLowerCase() ?? 'regtest') as keyof AvailableNetworks;
-    if (!ACTIVE_NETWORK) {
-      throw new MethodError('Missing ACTIVE_NETWORK environment variable', 'MISSING_ACTIVE_NETWORK', { ACTIVE_NETWORK });
-    }
-
-
-    if (!this[ACTIVE_NETWORK]) {
-      throw new MethodError(
-        `No configuration found for ACTIVE_NETWORK='${ACTIVE_NETWORK}'`,
-        'MISSING_CONFIG_FOR_NETWORK'
-      );
-    }
-
-    this.network = this[ACTIVE_NETWORK];
-  }
-
-  /**
-   * Converts Bitcoin (BTC) to satoshis (SAT).
-   * @param {number} btc - The amount in BTC.
-   * @returns {number} The amount in SAT.
-   */
-  public static btcToSats (btc: number): number {
-    return Math.round(btc * 1e8);
-  };
-
-  /**
-   * Converts satoshis (SAT) to Bitcoin (BTC).
-   * @param {number} sats - The amount in SAT.
-   * @returns {number} The amount in BTC.
-   */
-  public static satsToBtc (sats: number): number {
-    return sats / 1e8;
-  };
-}
-
-export const bitcoin = new Bitcoin();

package/src/index.browser.ts

@@ -1,9 +0,0 @@
-export * from './bitcoin.browser.js';
-export * from './constants.js';
-export * from './errors.js';
-export * from './interface.js';
-export * from './network.js';
-export * from './rest-client.js';
-export * from './rpc-client.js';
-export * from './taproot.js';
-export * from './types.js';

package/src/index.node.ts

@@ -1,9 +0,0 @@
-export * from './bitcoin.node.js';
-export * from './constants.js';
-export * from './errors.js';
-export * from './interface.js';
-export * from './network.js';
-export * from './rest-client.js';
-export * from './rpc-client.js';
-export * from './taproot.js';
-export * from './types.js';