# @jachaval/utxo-lib

> Client-side Bitcoin JavaScript library

Latest version **2.1.0-rc-5** (published 2021-11-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install @jachaval/utxo-lib
pnpm add @jachaval/utxo-lib
yarn add @jachaval/utxo-lib
bun add @jachaval/utxo-lib
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score.

Warnings: low downloads; no types; no esm support.

Negative: insecure dependencies; abandoned.

## Facts

| | |
|---|---|
| Version | 2.1.0-rc-5 |
| Published | 2021-11-02 |
| First published | 2021-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.22.0 <17 |
| Dependencies | 6 |
| Unpacked size | 9.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 395 |
| Maintainers | jachaval |
| Keywords | bitgo, utxo, bitcoinjs, bitcoin, zcash, dash, browserify, javascript |

## Links

- npm: https://www.npmjs.com/package/@jachaval/utxo-lib
- Repository: https://github.com/BitGo/BitGoJS
- Homepage: https://github.com/BitGo/BitGoJS#readme
- Issues: https://github.com/BitGo/BitGoJS/issues
- npm.io page: https://npm.io/package/@jachaval/utxo-lib

## Dependencies (6)

- [bs58check](https://npm.io/package/bs58check.md) ^2.0.0
- [typeforce](https://npm.io/package/typeforce.md) ^1.11.3
- [bitcoin-ops](https://npm.io/package/bitcoin-ops.md) ^1.3.0
- [bitcoinjs-lib](https://npm.io/package/bitcoinjs-lib.md) git+https://github.com/BitGo/bitcoinjs-lib.git#e445ccbd706fc0bc00646e6942fdc5177bbf1061
- [@bitgo/blake2b](https://npm.io/package/@bitgo/blake2b.md) ^3.0.1
- [varuint-bitcoin](https://npm.io/package/varuint-bitcoin.md) ^1.0.4

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 2.1.0-rc-5 (latest) — 2021-11-02
- 2.1.0-rc-4 — 2021-11-02
- 2.1.0-rc-3 — 2021-11-01
- 1.9.6-beta-1 — 2021-09-14

## README

# BitGo UTXO library

This library is a wrapper around [bitcoinjs-lib](https://github.com/bitcoinjs/bitcoinjs-lib) adding altcoin support.

## Features
- Multicoin support: Configurable behaviour based on [network](https://github.com/BitGo/bitgo-utxo-lib/blob/master/src/networks.js) objects.
- Backed by [BitGo](https://www.bitgo.com/info/)

## Installation
``` bash
npm install @bitgo/utxo-lib
```

## Setup
### Node.js
```typescript
import * as utxolib from '@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`|

---
_Source: https://npm.io/package/@jachaval/utxo-lib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._