⚠️ Deprecated. @bitgo/utxo-bin is deprecated. Its successor is wasm-utxo-cli, the command-line interface shipped with @bitgo/wasm-utxo in the BitGoWASM repository, which provides address encoding/decoding and PSBT inspection for UTXO-based coins.

wasm-utxo-cli is a native binary built from Rust (cargo install --path . from BitGoWASM/packages/wasm-utxo/cli); it is not published as an npm package. Migrate any utxo-bin usage to wasm-utxo-cli.

utxo-bin

This repository contains a CLI tool for parsing BitGo wallet transactions (withdrawals) and formatting them for terminal output.

Installation

npm

To install the tool globally, run

npm install --global @bitgo/utxo-bin

This will enable the utxo-bin tool to be run from anywhere on your system.

npx

To run the tool without installing, you can use npx. Be aware that this will download the package every time you run it.

npx @bitgo/utxo-bin ...

parseTx

From file

utxo-bin -n bitcoin parseTx <path-to-file>

From hex or base64

utxo-bin -n bitcoin parseTx --data <hex/base64>

From stdin

echo <txhex> | utxo-bin -n bitcoin parseTx --stdin

utxo-bin -n bitcoin parseTx --stdin
<paste txhex>
<CTRL-D>

From clipboard

utxo-bin -n bitcoin parseTx --clipboard

From txid

utxo-bin -n bitcoin parseTx --txid b0b7e5c2fbbbeb42478f91e1c14b300624a9419631e70dd1564084fb28a55155

Lookup inputs

utxo-bin -n bitcoin parseTx \
  --txid b0b7e5c2fbbbeb42478f91e1c14b300624a9419631e70dd1564084fb28a55155 \
  --fetchInputs

Formats

Supported transactions formats are

• full-signed transactions
• half-signed transactions in proprietary bitcoinjs-lib format ("legacy")
• half-signed transactions in PSBT/BIP174 format

Supported encodings are hex and base64.

parseAddress

utxo-bin -n bitcoin parseAddress 3QJmV3qfvL9SuYo34YihAf3sRCW3qSinyC

Convert to other networks:

utxo-bin -n bitcoin parseAddress 3QJmV3qfvL9SuYo34YihAf3sRCW3qSinyC --convert

Generate addresses

utxo-bin generateAddresses \
    --userKey xpub661MyMwAqRbcEvoSo4qrsT5xhByHzUoBjm88hdCPohF1rdQ4TkntuHfccN2N7FbmAmBgmaBxD7VY1QZ43YfgGRLBL37BBkBhYbezgnsPRVP \
    --backupKey xpub661MyMwAqRbcF8Evdu2twZS3ELM8Wg6DqSrVR8GpvCeXMgj3rNPf4nasU1FBzX9yeWYTfyikk7rfuWS5FkMqGnh3HpxeeYtuQEx7FVq5FZa \
    --bitgoKey xpub661MyMwAqRbcEnKX5fhLKdrixijBk4sYCZ7gQ1qRUmib2dXragQVAjv9GmXL4tusTKRwcrYAGrXGETFkFxKFSBCFUAuqdbdM9u2uyQtYkUW

Development

git clone https://github.com/BitGo/BitGoJS.git
yarn install
cd modules/utxo-bin
yarn tsx bin/index.ts ...

See the toplevel DEVELOPERS.md for more information.