Bitgo UTXO Lib

https://www.npmjs.com/package/@bitgo/utxo-lib
Admin
A library that wraps bitcoinjs-lib, providing multicoin support for various UTXO-based...
Tokens:1,646
Snippets:37
Trust Score:9.6
Update:11 months ago
Show doc for...
Tokens:
Raw
### Install @bitgo/utxo-lib using npm or yarn

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=code

Installs the @bitgo/utxo-lib package using either npm or yarn package managers. This is the first step to using the library in your project.

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

# using yarn
yarn add @bitgo/utxo-lib
```

--------------------------------

### Install @bitgo/utxo-lib using npm or yarn

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=dependencies

Installs the @bitgo/utxo-lib package for use in JavaScript projects. This is the first step to integrating altcoin transaction support.

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

```bash
yarn add @bitgo/utxo-lib
```

--------------------------------

### Install @bitgo/utxo-lib Package

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=readme

Install the @bitgo/utxo-lib package using either npm or yarn package managers. The package is a wrapper around bitcoinjs-lib with added altcoin support and is suitable for Node.js and browser environments.

```Shell
# using npm
npm install @bitgo/utxo-lib
```

```Shell
# using yarn
yarn add @bitgo/utxo-lib
```

--------------------------------

### Setting up @bitgo/utxo-lib in JavaScript

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=versions

Import the library in ESM for modern JavaScript modules or CJS for Node.js CommonJS. Depends on the module system used in the project. Allows access to utxolib functions for transaction operations.

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

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

--------------------------------

### Create and build altcoin transactions with utxolib

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=dependencies

Provides methods for creating transaction builders and parsing/building transactions for various altcoins using the utxolib library. It relies on network objects for coin-specific configurations.

```javascript
utxolib.bitgo.createTransactionFromBuffer(buffer, network);
// or
utxolib.bitgo.createTransactionFromHex(string, network);

utxolib.bitgo.createTransactionBuilderForNetwork(network);

utxolib.bitgo.createTransactionBuilderFromTransaction(tx);
```

--------------------------------

### Create UTXO transactions from buffer or hex

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=code

Demonstrates how to create UTXO transactions from either a buffer or a hexadecimal string using the provided network configuration. These methods are essential for parsing existing transaction data.

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

--------------------------------

### Import utxolib in NodeJS (CJS)

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=dependencies

Shows how to import the utxolib library using CommonJS (CJS) syntax, commonly used in Node.js environments.

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

--------------------------------

### Create UTXO Transaction Builder

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=dependents

Demonstrates how to create a transaction builder for a specific network. This builder can then be used to construct new transactions.

```javascript
utxolib.bitgo.createTransactionBuilderForNetwork(network): UtxoTransactionBuilder
```

--------------------------------

### Access supported cryptocurrency networks

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib

Reference table showing how to access network configuration objects for supported UTXO cryptocurrencies including Bitcoin, Bitcoin Cash, Litecoin, Zcash, and others. Each network has mainnet and testnet variants. Network objects configure transaction parsing and building behavior for specific cryptocurrencies.

```javascript
// 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
// eCash | utxolib.networks.ecash | utxolib.networks.ecashTestnet
// Litecoin | utxolib.networks.litecoin | utxolib.networks.litecoinTest
// Zcash | utxolib.networks.zcash | utxolib.networks.zcashTest
```

--------------------------------

### Import utxolib in JavaScript (ESM)

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=dependencies

Demonstrates how to import the utxolib library using ECMAScript Modules (ESM) syntax for modern JavaScript environments.

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

--------------------------------

### Create UTXO Transactions from Buffer or Hex

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=dependents

Provides methods to create UTXO transactions from a buffer or hexadecimal string, along with a network object. This is useful for parsing existing transaction data.

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

--------------------------------

### Creating UTXO Transactions with @bitgo/utxo-lib

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=versions

Use bitgo methods to create transactions from buffers, hex strings, or builders based on network configurations. Interfaces match bitcoinjs-lib Transaction type. Supports altcoins like Bitcoin Cash and Litecoin; inputs are buffers/strings/transactions, outputs are UtxoTransaction or UtxoTransactionBuilder objects.

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

utxolib.bitgo.createTransactionBuilderForNetwork(network): UtxoTransactionBuilder

utxolib.bitgo.createTransactionBuilderFromTransaction(tx): UtxoTransactionBuilder
```

--------------------------------

### Create and Build Bitcoin Transactions

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=readme

Create transactions from buffer or hex format, and build new transactions using the transaction builder. The UtxoTransaction and UtxoTransactionBuilder classes provide the same interface as bitcoinjs-lib's Transaction type. Returns UtxoTransaction objects and UtxoTransactionBuilder instances for multi-coin support.

```JavaScript
utxolib.bitgo.createTransactionFromBuffer(buffer, network): UtxoTransaction
```

```JavaScript
utxolib.bitgo.createTransactionFromHex(string, network): UtxoTransaction
```

```JavaScript
utxolib.bitgo.createTransactionBuilderForNetwork(network): UtxoTransactionBuilder
```

```JavaScript
utxolib.bitgo.createTransactionBuilderFromTransaction(tx): UtxoTransactionBuilder
```

--------------------------------

### Create UTXO Transaction Builder from Existing Transaction

Source: https://www.npmjs.com/package/@bitgo/utxo-lib/package/%40bitgo/utxo-lib_activetab=dependents

Enables the creation of a new transaction builder initialized with an existing transaction object. This is useful for modifying or analyzing existing transactions.

```javascript
utxolib.bitgo.createTransactionBuilderFromTransaction(tx): UtxoTransactionBuilder
```
Tokens:
Raw