go-bt
The go-to Bitcoin Transaction (BT) GoLang library
Table of Contents
- Installation
- Documentation
- Examples & Tests
- Benchmarks
- Code Standards
- Usage
- Maintainers
- Contributing
- License
Installation
go-bt requires a supported release of Go.
go get -u github.com/libsv/go-bt/v2Documentation
View the generated documentation
For more information around the technical aspects of Bitcoin, please see the updated Bitcoin Wiki
Features
- 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/custimisation and extendability for any use case
- Bitcoin Transaction Script functionality
- Bitcoin script engine (interpreter)
- P2PKH (base58 addresses)
- Data (OP_RETURN)
- BIP276
Coming Soon! (18 monthsTM)
- Complete SigHash Flag Capability
- MultiSig functionality
Library Deployment
[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to Github and can be installed via: `brew install goreleaser`. The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/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 ```shell script make help ``` List of all current commands: ```text 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-ci Runs all tests via CI (exports coverage) test-ci-no-race Runs all tests via CI (no race) (exports coverage) test-ci-short Runs unit tests via CI (exports coverage) test-short Runs vet, lint and tests (excludes integration tests) 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 Github Actions and uses Go version 1.16.x. View the configuration file.
Run all tests (including integration tests)
make testRun tests (excluding integration tests)
make test-shortBenchmarks
Run the Go benchmarks:
make benchCode Standards
Read more about this Go project's code standards.
Usage
View the examples
Contributing
View the contributing guidelines and please follow the code of conduct.
How can I help?
All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:. You can also support this project by becoming a sponsor on GitHub :clap: or by making a bitcoin donation to ensure this journey continues indefinitely! :rocket:
License
