@leather.io/bitcoin 0.16.7 → 0.18.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @leather.io/bitcoin@0.16.7 build /home/runner/work/mono/mono/packages/bitcoin
+> @leather.io/bitcoin@0.18.0 build /home/runner/work/mono/mono/packages/bitcoin
 > tsup
 
 CLI Building entry: src/index.ts
@@ -8,9 +8,9 @@ CLI tsup v8.1.0
 CLI Using tsup config: /home/runner/work/mono/mono/packages/bitcoin/tsup.config.ts
 CLI Target: es2022
 ESM Build start
-ESM dist/index.js     25.37 KB
-ESM dist/index.js.map 49.31 KB
-ESM ⚡️ Build success in 57ms
+ESM dist/index.js     43.72 KB
+ESM dist/index.js.map 84.58 KB
+ESM ⚡️ Build success in 58ms
 DTS Build start
-DTS ⚡️ Build success in 4044ms
-DTS dist/index.d.ts 16.04 KB
+DTS ⚡️ Build success in 4435ms
+DTS dist/index.d.ts 20.41 KB

package/CHANGELOG.md

@@ -310,6 +310,32 @@
   * devDependencies
     * @leather.io/rpc bumped to 2.1.20
 
+## [0.18.0](https://github.com/leather-io/mono/compare/@leather.io/bitcoin-v0.17.0...@leather.io/bitcoin-v0.18.0) (2024-11-29)
+
+
+### Features
+
+* migrate bitcoin generate txs, closes LEA-1735 ([44fd6cf](https://github.com/leather-io/mono/commit/44fd6cfd29a2016b38d96b4e80e377ae7eae81df))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @leather.io/constants bumped to 0.13.6
+    * @leather.io/crypto bumped to 1.6.15
+    * @leather.io/models bumped to 0.23.0
+    * @leather.io/utils bumped to 0.20.1
+  * devDependencies
+    * @leather.io/rpc bumped to 2.1.21
+
+## [0.17.0](https://github.com/leather-io/mono/compare/@leather.io/bitcoin-v0.16.7...@leather.io/bitcoin-v0.17.0) (2024-11-26)
+
+
+### Features
+
+* migrate btc coin selection, closes LEA-1734 ([0cad7aa](https://github.com/leather-io/mono/commit/0cad7aaa35fbc8704d959a16d12965502757fe89))
+
 ## [0.16.4](https://github.com/leather-io/mono/compare/@leather.io/bitcoin-v0.16.3...@leather.io/bitcoin-v0.16.4) (2024-11-19)
 
 

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 import * as ecpair from 'ecpair';
 import * as bitcoin from 'bitcoinjs-lib';
 import * as btc from '@scure/btc-signer';
-import { BitcoinNetworkModes, NetworkModes } from '@leather.io/models';
+import * as _leather_io_models from '@leather.io/models';
+import { BitcoinNetworkModes, Money, AverageBitcoinFeeRates, NetworkModes } from '@leather.io/models';
+import BigNumber from 'bignumber.js';
 import { HDKey, Versions } from '@scure/bip32';
 import * as _scure_btc_signer_payment from '@scure/btc-signer/payment';
 import { P2Ret, P2TROut } from '@scure/btc-signer/payment';
@@ -44,6 +46,121 @@ declare function signBip322MessageSimple(args: SignBip322MessageSimple): Promise
     signature: string;
 }>;
 
+interface CoinSelectionOutput {
+    value: bigint;
+    address?: string;
+}
+interface CoinSelectionUtxo {
+    address: string;
+    txid: string;
+    value: number;
+    vout: number;
+}
+interface CoinSelectionRecipient {
+    address: string;
+    amount: Money;
+}
+interface DetermineUtxosForSpendArgs {
+    feeRate: number;
+    recipients: CoinSelectionRecipient[];
+    utxos: CoinSelectionUtxo[];
+}
+declare function determineUtxosForSpendAll({ feeRate, recipients, utxos, }: DetermineUtxosForSpendArgs): {
+    inputs: CoinSelectionUtxo[];
+    outputs: {
+        value: bigint;
+        address: string;
+    }[];
+    size: number;
+    fee: Money;
+};
+declare function determineUtxosForSpend({ feeRate, recipients, utxos }: DetermineUtxosForSpendArgs): {
+    txVBytes: number;
+    txBytes: number;
+    txWeight: number;
+    filteredUtxos: CoinSelectionUtxo[];
+    inputs: CoinSelectionUtxo[];
+    outputs: CoinSelectionOutput[];
+    size: number;
+    fee: Money;
+};
+
+interface CalculateMaxBitcoinSpend {
+    address: string;
+    utxos: CoinSelectionUtxo[];
+    fetchedFeeRates?: AverageBitcoinFeeRates;
+    feeRate?: number;
+}
+declare function calculateMaxBitcoinSpend({ address, utxos, feeRate, fetchedFeeRates, }: CalculateMaxBitcoinSpend): {
+    spendAllFee: number;
+    amount: _leather_io_models.Money;
+    spendableBitcoin: BigNumber;
+};
+
+declare function getUtxoTotal(utxos: CoinSelectionUtxo[]): BigNumber;
+declare function getSizeInfo(payload: {
+    inputLength: number;
+    recipients: CoinSelectionRecipient[];
+    isSendMax?: boolean;
+}): {
+    txVBytes: number;
+    txBytes: number;
+    txWeight: number;
+};
+declare function getSpendableAmount({ utxos, feeRate, recipients, }: {
+    utxos: CoinSelectionUtxo[];
+    feeRate: number;
+    recipients: CoinSelectionRecipient[];
+}): {
+    spendableAmount: BigNumber;
+    fee: number;
+};
+declare function filterUneconomicalUtxos({ utxos, feeRate, recipients, }: {
+    utxos: CoinSelectionUtxo[];
+    feeRate: number;
+    recipients: CoinSelectionRecipient[];
+}): CoinSelectionUtxo[];
+
+type GetBitcoinTransactionFeeArgs = DetermineUtxosForSpendArgs & {
+    isSendingMax?: boolean;
+};
+declare function getBitcoinTransactionFee({ isSendingMax, ...props }: GetBitcoinTransactionFeeArgs): Money | null;
+interface BitcoinFees {
+    blockchain: 'bitcoin';
+    high: {
+        fee: Money | null;
+        feeRate: number;
+    };
+    standard: {
+        fee: Money | null;
+        feeRate: number;
+    };
+    low: {
+        fee: Money | null;
+        feeRate: number;
+    };
+}
+interface GetBitcoinFeesArgs {
+    feeRates: AverageBitcoinFeeRates;
+    isSendingMax?: boolean;
+    recipients: CoinSelectionRecipient[];
+    utxos: CoinSelectionUtxo[];
+}
+declare function getBitcoinFees({ feeRates, isSendingMax, recipients, utxos }: GetBitcoinFeesArgs): {
+    high: {
+        feeRate: number;
+        fee: Money | null;
+    };
+    standard: {
+        feeRate: number;
+        fee: Money | null;
+    };
+    low: {
+        feeRate: number;
+        fee: Money | null;
+    };
+};
+
 interface BtcSignerNetwork {
     bech32: string;
     pubKeyHash: number;
@@ -53,6 +170,32 @@ interface BtcSignerNetwork {
 declare function getBtcSignerLibNetworkConfigByMode(network: BitcoinNetworkModes): BtcSignerNetwork;
 declare function getBitcoinJsLibNetworkConfigByMode(network: BitcoinNetworkModes): bitcoin.networks.Network;
 
+interface GenerateBitcoinUnsignedTransactionArgs {
+    feeRate: number;
+    isSendingMax?: boolean;
+    payerAddress: string;
+    payerPublicKey: string;
+    network: BtcSignerNetwork;
+    recipients: CoinSelectionRecipient[];
+    utxos: CoinSelectionUtxo[];
+}
+declare function generateBitcoinUnsignedTransactionNativeSegwit({ feeRate, isSendingMax, payerAddress, payerPublicKey, network, recipients, utxos, }: GenerateBitcoinUnsignedTransactionArgs): Promise<{
+    tx: btc.Transaction;
+    hex: string;
+    psbt: Uint8Array;
+    inputs: CoinSelectionUtxo[];
+    fee: _leather_io_models.Money;
+} | null>;
+
+declare enum BitcoinErrorMessage {
+    InsufficientFunds = "Insufficient funds",
+    NoInputsToSign = "No inputs to sign",
+    NoOutputsToSign = "No outputs to sign"
+}
+declare class BitcoinError extends Error {
+    constructor(message: string);
+}
+
 interface BitcoinAccount {
     type: PaymentTypes;
     derivationPath: string;
@@ -302,4 +445,4 @@ declare function lookupDerivationByAddress(args: LookUpDerivationByAddressArgs):
     readonly path?: undefined;
 };
 
-export { type AllowedSighashTypes, type BitcoinAccount, type BitcoinAccountKeychain, type BitcoinNativeSegwitPayer, type BitcoinPayer, type BitcoinPayerBase, type BitcoinPayerInfo, type BitcoinSigner, type BitcoinTaprootPayer, type BtcSignerDefaultBip32Derivation, type BtcSignerLibPaymentTypeIdentifers, type BtcSignerNetwork, type BtcSignerTapBip32Derivation, type PaymentTypeMap, type SupportedPaymentType, type SupportedPaymentTypeMap, type WithDerivePayer, bip322TransactionToSignValues, bitcoinNetworkModeToCoreNetworkMode, bitcoinNetworkToCoreNetworkMap, btcSignerLibPaymentTypeToPaymentTypeMap, coinTypeMap, createNativeSegwitBitcoinJsSigner, createTaprootBitcoinJsSigner, createToSpendTx, createWalletIdDecoratedPath, decodeBitcoinTx, decodeCompressedWifPrivateKey, deriveAddressIndexKeychainFromAccount, deriveAddressIndexZeroFromAccount, deriveBitcoinPayerFromAccount, deriveBtcBip49SeedFromMnemonic, deriveNativeSegwitAccountFromRootKeychain, deriveNativeSegwitReceiveAddressIndexZero, deriveRootBtcKeychain, deriveTaprootAccount, deriveTaprootReceiveAddressIndexZero, ecPairFromPrivateKey, ecdsaPublicKeyLength, ecdsaPublicKeyToSchnorr, encodeMessageWitnessData, extractExtendedPublicKeyFromPolicy, extractRequiredKeyOrigins, getAddressFromOutScript, getBitcoinCoinTypeIndexByNetwork, getBitcoinInputAddress, getBitcoinJsLibNetworkConfigByMode, getBtcSignerLibNetworkConfigByMode, getHdKeyVersionsFromNetwork, getInputPaymentType, getNativeSegwitAccountDerivationPath, getNativeSegwitAddress, getNativeSegwitAddressIndexDerivationPath, getNativeSegwitPaymentFromAddressIndex, getPsbtTxInputs, getPsbtTxOutputs, getTaprootAccountDerivationPath, getTaprootAddress, getTaprootAddressIndexDerivationPath, getTaprootPayment, getTaprootPaymentFromAddressIndex, hashBip322Message, inferNetworkFromAddress, inferNetworkFromPath, inferPaymentTypeFromAddress, inferPaymentTypeFromPath, initBitcoinAccount, initializeBitcoinAccountKeychainFromDescriptor, isBtcSignerLibPaymentType, isSupportedMessageSigningPaymentType, lookUpLedgerKeysByPath, lookupDerivationByAddress, makeNativeSegwitAccountDerivationPath, makeNativeSegwitAddressIndexDerivationPath, makePayToScriptHashAddress, makePayToScriptHashAddressBytes, makePayToScriptHashKeyHash, makeTaprootAccountDerivationPath, makeTaprootAddressIndexDerivationPath, mnemonicToRootNode, parseKnownPaymentType, payToScriptHashTestnetPrefix, payerToBip32Derivation, payerToTapBip32Derivation, paymentTypeMap, publicKeyToPayToScriptHashAddress, serializeKeyOrigin, signBip322MessageSimple, toXOnly, tweakSigner, whenBitcoinNetwork, whenPaymentType, whenSupportedPaymentType };
+export { type AllowedSighashTypes, type BitcoinAccount, type BitcoinAccountKeychain, BitcoinError, BitcoinErrorMessage, type BitcoinFees, type BitcoinNativeSegwitPayer, type BitcoinPayer, type BitcoinPayerBase, type BitcoinPayerInfo, type BitcoinSigner, type BitcoinTaprootPayer, type BtcSignerDefaultBip32Derivation, type BtcSignerLibPaymentTypeIdentifers, type BtcSignerNetwork, type BtcSignerTapBip32Derivation, type CoinSelectionOutput, type CoinSelectionRecipient, type CoinSelectionUtxo, type DetermineUtxosForSpendArgs, type GenerateBitcoinUnsignedTransactionArgs, type GetBitcoinFeesArgs, type PaymentTypeMap, type SupportedPaymentType, type SupportedPaymentTypeMap, type WithDerivePayer, bip322TransactionToSignValues, bitcoinNetworkModeToCoreNetworkMode, bitcoinNetworkToCoreNetworkMap, btcSignerLibPaymentTypeToPaymentTypeMap, calculateMaxBitcoinSpend, coinTypeMap, createNativeSegwitBitcoinJsSigner, createTaprootBitcoinJsSigner, createToSpendTx, createWalletIdDecoratedPath, decodeBitcoinTx, decodeCompressedWifPrivateKey, deriveAddressIndexKeychainFromAccount, deriveAddressIndexZeroFromAccount, deriveBitcoinPayerFromAccount, deriveBtcBip49SeedFromMnemonic, deriveNativeSegwitAccountFromRootKeychain, deriveNativeSegwitReceiveAddressIndexZero, deriveRootBtcKeychain, deriveTaprootAccount, deriveTaprootReceiveAddressIndexZero, determineUtxosForSpend, determineUtxosForSpendAll, ecPairFromPrivateKey, ecdsaPublicKeyLength, ecdsaPublicKeyToSchnorr, encodeMessageWitnessData, extractExtendedPublicKeyFromPolicy, extractRequiredKeyOrigins, filterUneconomicalUtxos, generateBitcoinUnsignedTransactionNativeSegwit, getAddressFromOutScript, getBitcoinCoinTypeIndexByNetwork, getBitcoinFees, getBitcoinInputAddress, getBitcoinJsLibNetworkConfigByMode, getBitcoinTransactionFee, getBtcSignerLibNetworkConfigByMode, getHdKeyVersionsFromNetwork, getInputPaymentType, getNativeSegwitAccountDerivationPath, getNativeSegwitAddress, getNativeSegwitAddressIndexDerivationPath, getNativeSegwitPaymentFromAddressIndex, getPsbtTxInputs, getPsbtTxOutputs, getSizeInfo, getSpendableAmount, getTaprootAccountDerivationPath, getTaprootAddress, getTaprootAddressIndexDerivationPath, getTaprootPayment, getTaprootPaymentFromAddressIndex, getUtxoTotal, hashBip322Message, inferNetworkFromAddress, inferNetworkFromPath, inferPaymentTypeFromAddress, inferPaymentTypeFromPath, initBitcoinAccount, initializeBitcoinAccountKeychainFromDescriptor, isBtcSignerLibPaymentType, isSupportedMessageSigningPaymentType, lookUpLedgerKeysByPath, lookupDerivationByAddress, makeNativeSegwitAccountDerivationPath, makeNativeSegwitAddressIndexDerivationPath, makePayToScriptHashAddress, makePayToScriptHashAddressBytes, makePayToScriptHashKeyHash, makeTaprootAccountDerivationPath, makeTaprootAddressIndexDerivationPath, mnemonicToRootNode, parseKnownPaymentType, payToScriptHashTestnetPrefix, payerToBip32Derivation, payerToTapBip32Derivation, paymentTypeMap, publicKeyToPayToScriptHashAddress, serializeKeyOrigin, signBip322MessageSimple, toXOnly, tweakSigner, whenBitcoinNetwork, whenPaymentType, whenSupportedPaymentType };