The go-to Bitcoin Transaction (BT) GoLang library
Forked from libsv/go-bt
CI / CD
|
|
Quality
|
|
Security
|
|
Community
|
|
📦 Installation
|
🧪 Examples & Tests
|
📚 Documentation
|
🤝 Contributing
|
🛠️ Code Standards
|
⚡ Benchmarks
|
🤖 AI Usage
|
📝 License
|
👥 Maintainers
|
- Full-featured Bitcoin transactions and transaction manipulation/functionality
- Auto-fee calculations for change outputs
- Transaction fee calculation and related checks
- Interfaced signing/unlocking of transaction inputs for easy adaptation/customization and extendability for any use case
- Bitcoin Transaction Script functionality
- Bitcoin script engine (interpreter)
- P2PKH (base58 addresses)
- Data (OP_RETURN)
- BIP276
go-bt requires a supported release of Go.
go get -u github.com/bsv-blockchain/go-bt/v2- API Reference – Dive into the godocs at pkg.go.dev/github.com/bsv-blockchain/go-bt
- Usage Examples – Browse practical patterns either the examples directory
- Benchmarks – Check the latest numbers in the benchmark results
- Test Suite – Review both the unit tests and fuzz tests (powered by
testify)
For more information around the technical aspects of Bitcoin, please see the updated Bitcoin Wiki
Development Build Commands
Get the MAGE-X build tool for development:
go install github.com/mrz1836/mage-x/cmd/magex@latestView all build commands
magex helpRepository Features
This repository includes 25+ built-in features covering CI/CD, security, code quality, developer experience, and community tooling.
Library Deployment
This project uses goreleaser for streamlined binary and library deployment to GitHub. To get started, install it via:
brew install goreleaserThe release process is defined in the .goreleaser.yml configuration file.
Then create and push a new Git tag using:
magex version:bump push=true bump=patch branch=masterThis process ensures consistent, repeatable releases with properly versioned artifacts and citation metadata.
Pre-commit Hooks
Set up the Go-Pre-commit System to run the same formatting, linting, and tests defined in AGENTS.md before every commit:
go install github.com/mrz1836/go-pre-commit/cmd/go-pre-commit@latest
go-pre-commit installThe system is configured via modular env files in .github/env/ and provides 17x faster execution than traditional Python-based pre-commit hooks. See the complete documentation for details.
GitHub Workflows
All workflows are driven by modular configuration in .github/env/ — no YAML editing required.
Updating Dependencies
To update all dependencies (Go modules, linters, and related tools), run:
magex deps:updateThis command ensures all dependencies are brought up to date in a single step, including Go modules and any tools managed by MAGE-X. It is the recommended way to keep your development environment and CI in sync with the latest versions.
All unit tests and examples run via GitHub Actions and use Go version 1.26.x. View the configuration file.
Run all tests (fast):
magex testRun all tests with race detector (slower):
magex test:raceRun the Go benchmarks:
magex bench| Benchmark | Iterations | ns/op | B/op | allocs/op |
|---|---|---|---|---|
| [Bytes]-toBytesHelper | 4,112,503 | 280.2 | 1024 | 1 |
| [Clone]-clone | 4,117,903 | 291.4 | 416 | 13 |
| [ShallowClone]-clone | 5,963,280 | 196.3 | 296 | 8 |
These benchmarks reflect fast, allocation-free lookups for most retrieval functions, ensuring optimal performance in production environments. Performance benchmarks for the core functions in this library, executed on an Apple M1 Max (ARM64).
Read more about this Go project's code standards.
Read the AI Usage & Assistant Guidelines for details on how AI is used in this project and how to interact with AI assistants.
 |
 |
 |
|---|---|---|
| Siggi | Dylan | MrZ |
View the contributing guidelines and please follow the code of conduct.
All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬.