@bithive/select-utxo v0.1.1

Select UTXO

A tool for UTXO selection

Install

pnpm add @bithive/select-utxo

Usage

import { selectUtxo } from '@bithive/select-utxo';
import * as bitcoin from 'bitcoinjs-lib';

// Testnet
const network = bitcoin.networks.testnet;

// Sender address and script
const senderAddress = 'tb1qf...devcu'; // Native Segwit address
const senderScript = bitcoin.address.toOutputScript(senderAddress, network);

// Sent value
const sentValue = 3500;

// Fee of sent BTC transaction
const sentFeeRate = 5;

// Receiver address and script
const receiverAddress = 'tb1qz...vgncd'; // Native Segwit address
const receiverScript = bitcoin.address.toOutputScript(receiverAddress, network);

// UTXOs owned by sender
const utxos = [
  {
    hash: Buffer.from(
      '0000000000000000000000000000000000000000000000000000000000000001',
      'hex',
    ),
    index: 1,
    witnessUtxo: { // Native Segwit UTXO
      value: 1234,
      script: senderScript,
    },
    value: 1234,
    script: senderScript,
  },
  {
    hash: Buffer.from(
      '0000000000000000000000000000000000000000000000000000000000000002',
      'hex',
    ),
    index: 2,
    value: 2345,
    witnessUtxo: { // Native Segwit UTXO
      value: 2345,
      script: senderScript,
    },
    script: senderScript,
  },
  {
    hash: Buffer.from(
      '0000000000000000000000000000000000000000000000000000000000000003',
      'hex',
    ),
    index: 3,
    witnessUtxo: { // Native Segwit UTXO
      value: 3456,
      script: senderScript,
    },
    value: 3456,
    script: senderScript,
  },
  {
    hash: Buffer.from(
      '0000000000000000000000000000000000000000000000000000000000000004',
      'hex',
    ),
    index: 4,
    witnessUtxo: { // Native Segwit UTXO
      value: 4567,
      script: senderScript,
    },
    value: 4567,
    script: senderScript,
  },
];

// TXOs to send BTC to receiver
const txos = [
  {
    value: sentValue,
    script: receiverScript,
  },
];

// Select UTXO
const result = selectUtxo({
  utxos,
  txos,
  // feeLimit: 1000, // Specify `feeLimit` here if needed
  feeRate: sentFeeRate,
  changeScript: senderScript,
  // strategy: 'Greedy', // Specify `strategy` here if needed
});

console.log(result);

// Build PSBT with selection result
const psbt = new bitcoin.Psbt({ network })
  .addInputs(result.utxos)
  .addOutputs(result.txos);

console.log(psbt);

Strategies