Package Exports

caravan-x
caravan-x/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (caravan-x) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Caravan Regtest Manager

Caravan-X

A terminal-based utility for managing Caravan multisig wallets in regtest mode. This tool simplifies development and testing with Caravan by providing an easy-to-use interface for:

Managing Bitcoin wallets in regtest mode
Creating and configuring multisig wallet setups
Handling PSBTs (Partially Signed Bitcoin Transactions)
Mining blocks and simulating network activity
Integrating with Caravan for multisig wallet management

Features

Bitcoin Wallet Management

Create and manage various types of Bitcoin wallets
Generate and extract private keys
Fund wallets by mining blocks
Send funds between wallets
View wallet details and balances

Caravan Multisig Support

Create multisig wallet configurations for Caravan
Set up watch-only wallets for multisig addresses
Configure private keys for signing transactions
Import and export wallet configurations
Generate extended public keys (xpubs)

Transaction Operations

Create PSBTs for multisig transactions
Sign PSBTs with various wallets or private keys
Analyze, decode, and inspect PSBTs
Finalize and broadcast transactions
Extract signatures in Caravan-compatible format

Regtest Environment Management

Mine blocks to confirm transactions
Generate new regtest coins for testing
Simulate network activity
Test with different fee rates and confirmation settings

Prerequisites

Node.js v22 or later
Bitcoin Core running in regtest mode
Caravan (optional, for UI-based multisig wallet management)

Installation

Install globally using npm:

npm install -g caravan-x

Quick Start

Make sure Bitcoin Core is running in regtest mode
Run the command:

caravan-x

This will start the interactive menu interface.

Installation for development

Clone the repository:

git clone https://github.com/yourusername/caravan-regtest-manager.git
cd caravan-regtest-manager

Install dependencies:
```
npm install
```
Build the project:
```
npm run build
```
Link the CLI globally (optional):
```
npm link
```

Usage

Interactive Mode

Start the interactive terminal UI:

npm start

Or if you've linked it globally:

caravan-x

Configuration

The default configuration is stored in ~/.caravan-regtest/config.json. You can modify this file to change:

Bitcoin Core RPC connection settings
Directory paths for Caravan wallet configurations
Key storage locations

Command Line Usage

You can also use various commands directly:

# List all wallets
caravan-x list-wallets

# Create a new wallet
caravan-x create-wallet

# List Caravan wallets
caravan-x list-caravan

# Create a new Caravan multisig wallet
caravan-x create-caravan

# Fund a wallet with regtest coins
caravan-x fund-wallet --wallet <wallet-name>

# Create a new PSBT
caravan-x create-psbt

# Sign a PSBT with a wallet
caravan-x sign-psbt --file <psbt-file> --wallet <wallet-name>

# Mine blocks
caravan-x mine --blocks 10 --wallet mywallet

# Start blockchain visualization
caravan-x start-visualization

Run caravan-x --help to see all available commands.

Development

Running in Development Mode

npm run dev

Linting

npm run lint

Running Tests

npm test

Security Considerations

This tool is intended for regtest and development purposes only. It should never be used with real funds or on mainnet because:

Private keys may be stored in plain text
Security is not hardened for production use
It focuses on developer convenience over security best practices

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.