2.4.1-tnumber.v2 • Published 2 years ago

@williamqin-bitgo/utxo-lib v2.4.1-tnumber.v2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

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

NetworkMainnetTestnet
Bitcoinutxolib.networks.bitcoinutxolib.networks.testnet
Bitcoin Cashutxolib.networks.bitcoincashutxolib.networks.bitcoincashTestnet
Bitcoin Goldutxolib.networks.bitcoingoldutxolib.networks.bitcoingoldTestnet
Bitcoin SV (Satoshi Vision)utxolib.networks.bitcoinsvutxolib.networks.bitcoinsvTestnet
Dashutxolib.networks.dashutxolib.networks.dash
Litecoinutxolib.networks.litecoinutxolib.networks.litecoinTest
Zcashutxolib.networks.zcashutxolib.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.