@btc-stamps/tx-builder

🚀 Quick Start

Get started with Bitcoin Stamps and SRC-20 tokens using our comprehensive examples.

# Install the package
npm install @btc-stamps/tx-builder

# Run examples
npm run examples:src20    # SRC-20 token examples
npm run examples:stamps   # Bitcoin Stamps examples

✨ Working Examples

🪙SRC-20 Tokens

Complete SRC-20 encoding examples including DEPLOY, MINT, and TRANSFER operations with validation.

View Code →

🖼️Bitcoin Stamps

Create immutable digital artifacts with automatic chunking and compression detection.

View Code →

🔧Advanced Building

Advanced transaction building patterns with UTXO selection and fee optimization.

View Code →

📖 Documentation

Transaction Structures

Complete Bitcoin transaction format documentation for Stamps and SRC-20.

Read Docs →

Counterparty Encoding

Protocol documentation for message types, encoding formats, and specifications.

Read Docs →

Validation Summary

Encoding format validation results and compliance testing documentation.

Read Docs →

🛡️ Key Features

✅ Bitcoin Stamps: Complete protocol implementation with Counterparty integration
✅ SRC-20 Tokens: Full lifecycle support (deploy, mint, transfer)
✅ UTXO Protection: Automatic detection and protection of valuable assets
✅ Multiple Algorithms: 6 UTXO selection strategies for optimization
✅ Zero Configuration: Works out-of-the-box with reliable defaults
✅ TypeScript First: Full type safety and IntelliSense support
✅ Battle Tested: Comprehensive test coverage with real-world validation

📝 Example Categories

🎯 Simple Examples

SRC-20 Encoding: Basic token operations without complex transaction building
Bitcoin Stamps: Image and text encoding with automatic formatting

📚 Technical Documentation

Transaction Structures: Complete on-chain format specifications
Protocol Documentation: Counterparty and SRC-20 encoding details
Validation Reports: Compliance testing and format validation

🔧 Advanced Topics

UTXO Selection: Multiple algorithms for optimal coin selection
Fee Optimization: Size calculation and fee estimation
Multi-Provider Support: Configuring multiple detection providers

🚀 Running Examples

# Clone the repository
git clone https://github.com/btc-stamps/tx-builder.git
cd tx-builder

# Install dependencies
npm install

# Run specific examples
npx tsx docs/examples/simple-src20-tokens.ts
npx tsx docs/examples/simple-bitcoin-stamps.ts

# Or use npm scripts
npm run examples:src20
npm run examples:stamps
npm run examples  # Run all examples