@williamqin-bitgo/utxo-lib
TypeScript icon, indicating that this package has built-in type declarations

2.4.1-tnumber.v2 • Public • Published

BitGo UTXO library

This library is a wrapper around bitcoinjs-lib adding altcoin support.

Features

  • Multicoin support: Configurable behaviour based on network objects.
  • Backed by BitGo

Installation

# using npm
npm install @bitgo/utxo-lib

# using yarn
yarn add @bitgo/utxo-lib

Setup

JavaScript (ESM)

import * as utxolib from '@bitgo/utxo-lib'

NodeJS (CJS)

const utxolib = require('@bitgo/utxo-lib')

Usage

Support for parsing and building altcoin transactions is provided by the following methods

utxolib.bitgo.createTransactionFromBuffer(buffer, network): UtxoTransaction
// (similarly `createTransactionFromHex(string, network)`)

utxolib.bitgo.createTransactionBuilderForNetwork(network): UtxoTransactionBuilder

utxolib.bitgo.createTransactionBuilderFromTransaction(tx): UtxoTransactionBuilder

The UtxoTransaction(Builder) classes have the same interface as the Transaction type in bitcoinjs-lib .

Supported coins

Network Mainnet Testnet
Bitcoin utxolib.networks.bitcoin utxolib.networks.testnet
Bitcoin Cash utxolib.networks.bitcoincash utxolib.networks.bitcoincashTestnet
Bitcoin Gold utxolib.networks.bitcoingold utxolib.networks.bitcoingoldTestnet
Bitcoin SV (Satoshi Vision) utxolib.networks.bitcoinsv utxolib.networks.bitcoinsvTestnet
Dash utxolib.networks.dash utxolib.networks.dash
Litecoin utxolib.networks.litecoin utxolib.networks.litecoinTest
Zcash utxolib.networks.zcash utxolib.networks.zcashTest

Bitcoin SV no longer supports sending funds to BitGo wallets. Existing customers with Bitcoin SV in BitGo wallets will still be able to access and sweep funds to an external Bitcoin SV wallet.

Package Sidebar

Install

npm i @williamqin-bitgo/utxo-lib

Weekly Downloads

1

Version

2.4.1-tnumber.v2

License

MIT

Unpacked Size

506 kB

Total Files

99

Last publish

Collaborators

  • williamqin-bitgo