₿ go-bitcoin

A library for working with Bitcoin (BSV) transactions, addresses, keys, encryption, and more.

CI / CD	Quality & Security	Docs & Meta	Community

🗂️ Table of Contents

• Installation
• Documentation
• Examples & Tests
• Benchmarks
• Code Standards
• Maintainers
• Contributing
• License

📦 Installation

go-bitcoin requires a supported release of Go.

go get -u github.com/bitcoinschema/go-bitcoin/v2

📚 Documentation

View the generated documentation

Features

• Addresses
  • Address from PrivateKey (bec.PrivateKey)
  • Address from Script
• Encryption
  • Encrypt With Private Key
  • Decrypt With Private Key
  • Encrypt Shared
• HD Keys (Master / xPub)
  • Generate HD Keys
  • Generate HD Key from string
  • Get HD Key by Path
  • Get PrivateKey by Path
  • Get HD Child Key
  • Get Addresses from HD Key
  • Get XPub from HD Key
  • Get HD Key from XPub
  • Get PublicKeys for Path
  • Get Addresses for Path
• PubKeys
  • Create PubKey from PrivateKey
  • PubKey from String
• Private Keys
  • Create PrivateKey
  • Create WIF
  • PrivateKey (string) to Address (string)
  • PrivateKey from string
  • Generate Shared Keypair
  • Get Private and Public keys
  • WIF to PrivateKey
  • PrivateKey to WIF
• Scripts
  • Script from Address
• Signatures
  • Sign & Verify a Bitcoin Message
  • Verify a DER Signature
• Transactions
  • Calculate Fee
  • Create Tx
  • Create Tx using WIF
  • Create Tx with Change
  • Tx from Hex

Package Dependencies

• bitcoinsv/bsvd
• libsv/go-bk
• libsv/go-bt

Development Setup (Getting Started)

Install MAGE-X build tool for development:

# Install MAGE-X for development and building
go install github.com/mrz1836/mage-x/cmd/magex@latest
magex update:install

Library Deployment

This project uses goreleaser for streamlined binary and library deployment to GitHub. To get started, install it via:

brew install goreleaser

The release process is defined in the .goreleaser.yml configuration file.

Then create and push a new Git tag using:

magex version:bump bump=patch push

This process ensures consistent, repeatable releases with properly versioned artifacts and citation metadata.

Build Commands

View all build commands

magex help

GitHub Workflows

🎛️ The Workflow Control Center

All GitHub Actions workflows in this repository are powered by configuration files: .env.base (default configuration) and optionally .env.custom (project-specific overrides) – your one-stop shop for tweaking CI/CD behavior without touching a single YAML file! 🎯

Configuration Files:

• .env.base – Default configuration that works for most Go projects
• .env.custom – Optional project-specific overrides

This magical file controls everything from:

• 🚀 Go version matrix (test on multiple versions or just one)
• 🏃 Runner selection (Ubuntu or macOS, your wallet decides)
• 🔬 Feature toggles (coverage, fuzzing, linting, race detection, benchmarks)
• 🛡️ Security tool versions (gitleaks, nancy, govulncheck)
• 🤖 Auto-merge behaviors (how aggressive should the bots be?)
• 🏷️ PR management rules (size labels, auto-assignment, welcome messages)

Pro tip: Want to disable code coverage? Just add ENABLE_CODE_COVERAGE=false to your .env.custom to override the default in .env.base and push. No YAML archaeology required!

Workflow Name	Description
auto-merge-on-approval.yml	Automatically merges PRs after approval and all required checks, following strict rules.
codeql-analysis.yml	Analyzes code for security vulnerabilities using GitHub CodeQL.
dependabot-auto-merge.yml	Automatically merges Dependabot PRs that meet all requirements.
fortress.yml	Runs the GoFortress security and testing workflow, including linting, testing, releasing, and vulnerability checks.
pull-request-management.yml	Labels PRs by branch prefix, assigns a default user if none is assigned, and welcomes new contributors with a comment.
scorecard.yml	Runs OpenSSF Scorecard to assess supply chain security.
stale.yml	Warns about (and optionally closes) inactive issues and PRs on a schedule or manual trigger.
sync-labels.yml	Keeps GitHub labels in sync with the declarative manifest at .github/labels.yml.

Updating Dependencies

To update all dependencies (Go modules, linters, and related tools), run:

magex deps:update

This command ensures all dependencies are brought up to date in a single step, including Go modules and any managed tools. It is the recommended way to keep your development environment and CI in sync with the latest versions.

🧪 Examples & Tests

All unit tests and examples run via GitHub Actions and uses Go version 1.23.x. View the configuration file for more details.

Run all tests (fast):

magex test

Run all tests with race detector (slower):

magex test:race

⚡ Benchmarks

Run the Go benchmarks:

magex bench

🛠️ Code Standards

Read more about this Go project's code standards.

👥 Maintainers

MrZ	Satchmo

🤝 Contributing

View the contributing guidelines and follow the code of conduct.

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀

📝 License