/go-bt

The go-to Bitcoin Transaction (BT) GoLang library.

Primary LanguageGoISC LicenseISC

go-bt

The go-to Bitcoin Transaction (BT) GoLang library

Release Build Status Report codecov Go Sponsor Donate


Table of Contents


Installation

go-bt requires a supported release of Go.

go get -u github.com/libsv/go-bt

Documentation

View the generated documentation

GoDoc

For more information around the technical aspects of Bitcoin, please see the updated Bitcoin Wiki


Features

  • Full Featured Bitcoin Transactions

  • Auto-Fee Calculations for Change Address

  • Bitcoin Transaction Script Functionality

    • P2PKH (base58 addresses)
    • Data (OP_RETURN)
    • BIP276

  • Transaction Signing Extendability

Coming Soon! (18 monthsTM)

  • Complete SigHash Flag Capability
Library Deployment

goreleaser for easy binary or library deployment to Github and can be installed via: brew install goreleaser.

The .goreleaser.yml file is used to configure goreleaser.

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.

Makefile Commands

View all makefile commands

make help

List of all current commands:

all                      Runs multiple commands
clean                    Remove previous builds and any test cache data
clean-mods               Remove all the Go mod cache
coverage                 Shows the test coverage
godocs                   Sync the latest tag with GoDocs
help                     Show this help message
install                  Install the application
install-go               Install the application (Using Native Go)
lint                     Run the golangci-lint application (install if not found)
release                  Full production release (creates release in Github)
release                  Runs common.release then runs godocs
release-snap             Test the full release (build binaries)
release-test             Full production test release (everything except deploy)
replace-version          Replaces the version in HTML/JS (pre-deploy)
tag                      Generate a new tag and push (tag version=0.0.0)
tag-remove               Remove a tag if found (tag-remove version=0.0.0)
tag-update               Update an existing tag to current commit (tag-update version=0.0.0)
test                     Runs vet, lint and ALL tests
test-short               Runs vet, lint and tests (excludes integration tests)
test-travis              Runs all tests via Travis (also exports coverage)
test-travis-no-race      Runs all tests (no race) (also exports coverage)
test-travis-short        Runs unit tests via Travis (also exports coverage)
uninstall                Uninstall the application (and remove files)
update-linter            Update the golangci-lint package (macOS only)
vet                      Run the Go vet application

Examples & Tests

All unit tests and examples run via Travis CI and uses Go version 1.15.x. View the deployment configuration file.

Run all tests (including integration tests)

make test

Run tests (excluding integration tests)

make test-short

Benchmarks

Run the Go benchmarks:

make bench

Code Standards

Read more about this Go project's code standards.


Usage

View the examples


Maintainers

JH JW MrZ
JH JW MrZ

Contributors

DW JH JW MrZ SO
DW JH JW MrZ SO

Contributing

View the contributing guidelines and please 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

License