@did-btcr2/bitcoin 0.5.3 → 0.7.0

package/src/client/rpc/protocol.ts

@@ -7,7 +7,7 @@ import { toBase64 } from '../utils.js';
  * Sans-I/O JSON-RPC protocol for Bitcoin Core.
  *
  * Builds {@link HttpRequest} descriptors for JSON-RPC method calls and
- * provides response parsing — without performing any I/O.
+ * provides response parsing, without performing any I/O.
  *
  * **Security note:** Built requests include an `Authorization` header when
  * credentials are configured.  Do not log or persist {@link HttpRequest}

package/src/connection.ts

@@ -1,8 +1,8 @@
 import { MethodError } from '@did-btcr2/common';
-import type { networks } from 'bitcoinjs-lib';
 import type { HttpExecutor } from './client/http.js';
 import { BitcoinRestClient } from './client/rest/index.js';
 import { BitcoinCoreRpcClient } from './client/rpc/index.js';
+import type { BTCNetwork } from './network.js';
 import { getNetwork } from './network.js';
 import type { NetworkName, RestConfig, RpcConfig } from './types.js';
 import { DEFAULT_BITCOIN_NETWORK_CONFIG } from './constants.js';
@@ -57,8 +57,8 @@ export class BitcoinConnection {
   /** RPC client (Bitcoin Core). May be undefined if not configured. */
   readonly rpc?: BitcoinCoreRpcClient;
 
-  /** bitcoinjs-lib network data (for address derivation, PSBT signing, etc.). */
-  readonly data: networks.Network;
+  /** Bitcoin network params (for address derivation, PSBT signing, etc.). */
+  readonly data: BTCNetwork;
 
   constructor(options: BitcoinConnectionOptions) {
     this.name = options.network;

package/src/constants.ts

@@ -8,7 +8,7 @@ export const GENESIS_TX_ID = '4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2
 /**
  * Default endpoint configuration per Bitcoin network.
  *
- * **Regtest RPC:** Credentials are intentionally omitted — callers must
+ * **Regtest RPC:** Credentials are intentionally omitted - callers must
  * provide `username` and `password` via overrides or explicit config.
  * This prevents accidentally using hardcoded credentials in non-local
  * environments.

package/src/fee-estimator.ts

@@ -0,0 +1,52 @@
+/**
+ * Estimates the fee (in satoshis) for a transaction of a given virtual size.
+ *
+ * Callers that build Bitcoin transactions (the did:btcr2 beacon broadcast paths,
+ * single-party and aggregated) delegate fee calculation to a `FeeEstimator` so they
+ * can plug in different strategies: static fee rates for tests/regtest, mempool APIs
+ * for mainnet, Bitcoin Core `estimatesmartfee` RPC for full-node setups, etc.
+ *
+ * Implementations return the **total fee in satoshis** for a transaction of the given
+ * virtual size (`vsize`). Callers pass the vsize; the estimator decides the fee rate
+ * and computes the total.
+ */
+export interface FeeEstimator {
+  /**
+   * Estimate the total fee in satoshis for a transaction of the given vsize.
+   * @param vsize Transaction virtual size in vbytes.
+   * @returns Total fee in satoshis.
+   */
+  estimateFee(vsize: number): Promise<bigint>;
+}
+
+/**
+ * Fee estimator that returns a fixed fee rate regardless of network conditions.
+ *
+ * Suitable for:
+ * - Tests (deterministic outputs)
+ * - Regtest (no real fee market)
+ * - Environments where a fee rate is supplied out-of-band
+ *
+ * For mainnet production use, prefer a dynamic estimator that queries current
+ * network conditions (mempool APIs, Bitcoin Core RPC).
+ */
+export class StaticFeeEstimator implements FeeEstimator {
+  readonly satsPerVbyte: number;
+
+  /**
+   * @param satsPerVbyte Fee rate in satoshis per virtual byte. Default: 5 sat/vB.
+   */
+  constructor(satsPerVbyte: number = 5) {
+    if(satsPerVbyte < 0 || !Number.isFinite(satsPerVbyte)) {
+      throw new Error(`Invalid satsPerVbyte: ${satsPerVbyte}`);
+    }
+    this.satsPerVbyte = satsPerVbyte;
+  }
+
+  async estimateFee(vsize: number): Promise<bigint> {
+    if(vsize < 0 || !Number.isFinite(vsize)) {
+      throw new Error(`Invalid vsize: ${vsize}`);
+    }
+    return BigInt(Math.ceil(vsize * this.satsPerVbyte));
+  }
+}

package/src/index.ts

@@ -23,8 +23,13 @@ export { JsonRpcTransport } from './client/rpc/json-rpc.js';
 export { BitcoinRpcError, BitcoinRestError } from './errors.js';
 export type { RpcErrorType } from './errors.js';
 
+// Fee estimation
+export { StaticFeeEstimator } from './fee-estimator.js';
+export type { FeeEstimator } from './fee-estimator.js';
+
 // Helpers
 export { getNetwork } from './network.js';
+export type { BTCNetwork } from './network.js';
 export { toBase64, safeText } from './client/utils.js';
 
 // Constants

package/src/network.ts

@@ -1,16 +1,36 @@
-import { networks } from 'bitcoinjs-lib';
+import { NETWORK, TEST_NETWORK } from '@scure/btc-signer';
+import type { BTC_NETWORK } from '@scure/btc-signer/utils';
 
-export function getNetwork(network: string): networks.Network {
+/**
+ * Bitcoin network parameters: bech32 HRP, address version bytes, WIF prefix.
+ * Mirrors @scure/btc-signer's `BTC_NETWORK` type.
+ */
+export type BTCNetwork = BTC_NETWORK;
+
+/** Regtest network params (bcrt HRP). */
+const REGTEST_NETWORK: BTCNetwork = {
+  bech32     : 'bcrt',
+  pubKeyHash : 0x6f,
+  scriptHash : 0xc4,
+  wif        : 0xef,
+};
+
+/**
+ * Resolve a named Bitcoin network to its @scure/btc-signer `BTC_NETWORK` params.
+ * Mainnet maps to `NETWORK`; testnet3/testnet4/signet/mutinynet all share `TEST_NETWORK`
+ * (identical address formats); regtest uses its own `bcrt` HRP.
+ */
+export function getNetwork(network: string): BTCNetwork {
   switch (network) {
     case 'bitcoin':
-      return networks.bitcoin;
+      return NETWORK;
     case 'testnet3':
     case 'testnet4':
     case 'signet':
     case 'mutinynet':
-      return networks.testnet;
+      return TEST_NETWORK;
     case 'regtest':
-      return networks.regtest;
+      return REGTEST_NETWORK;
     default:
       throw new Error(`Unknown network "${network}"`);
   }

package/src/types.ts

@@ -9,8 +9,6 @@ export type NetworkName =
   | 'mutinynet'
   | 'regtest';
 
-// ── REST types ──────────────────────────────────────────────────────
-
 export type TransactionStatus = {
   confirmed: boolean;
   block_height: number;
@@ -110,8 +108,6 @@ export interface RestApiCallParams {
 
 export type RestResponse = Response;
 
-// ── RPC types ───────────────────────────────────────────────────────
-
 export interface RpcConfig {
   headers?: Record<string, string>;
   host?: string;
@@ -197,7 +193,7 @@ export type ChainInfo = {
   warnings?: string;
 };
 
-// ── Block types ─────────────────────────────────────────────────────
+
 
 export type Block = {
   hash: string;
@@ -233,8 +229,6 @@ export interface BlockV3 extends Block {
 
 export type BlockResponse = BlockV0 | BlockV1 | BlockV2 | BlockV3;
 
-// ── Transaction types ───────────────────────────────────────────────
-
 export type Transaction = {
   hex: string;
   txid: string;
@@ -482,4 +476,3 @@ export type MethodNameInLowerCase =
   | 'signrawtransactionwithwallet'
   | 'send'
   | 'sendall';
-