Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libsv/go-bt
The go-to Bitcoin Transaction (BT) Go library.
https://github.com/libsv/go-bt
bitcoin bitcoin-golang-library bitcoin-script bitcoin-transaction bitcoinsv bsv go golang
Last synced: 8 days ago
JSON representation
The go-to Bitcoin Transaction (BT) Go library.
- Host: GitHub
- URL: https://github.com/libsv/go-bt
- Owner: libsv
- License: isc
- Created: 2020-10-23T16:25:21.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-05T10:38:37.000Z (5 months ago)
- Last Synced: 2024-06-18T15:33:59.616Z (5 months ago)
- Topics: bitcoin, bitcoin-golang-library, bitcoin-script, bitcoin-transaction, bitcoinsv, bsv, go, golang
- Language: Go
- Homepage: https://pkg.go.dev/mod/github.com/libsv/go-bt
- Size: 2.35 MB
- Stars: 67
- Watchers: 12
- Forks: 28
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# go-bt
> The go-to Bitcoin Transaction (BT) GoLang library
[](https://github.com/libsv/go-bt/releases)
[](https://github.com/libsv/go-bt/actions)
[](https://goreportcard.com/report/github.com/libsv/go-bt)
[](https://codecov.io/gh/libsv/go-bt)
[](https://golang.org/)
[](https://github.com/sponsors/libsv)
[](https://gobitcoinsv.com/#sponsor)
[![Mergify Status][mergify-status]][mergify]
[mergify]: https://mergify.com
[mergify-status]: https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/libsv/go-bt&style=flat
## Table of Contents
- [Installation](#installation)
- [Documentation](#documentation)
- [Examples & Tests](#examples--tests)
- [Benchmarks](#benchmarks)
- [Code Standards](#code-standards)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Installation
**go-bt** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```shell script
go get -u github.com/libsv/go-bt/v2
```
## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/libsv/go-bt)
[](https://pkg.go.dev/github.com/libsv/go-bt)
For more information around the technical aspects of Bitcoin, please see the updated [Bitcoin Wiki](https://wiki.bitcoinsv.io/index.php/Main_Page)
### 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](bscript) functionality
- Bitcoin script engine ([interpreter](bscript/interpreter))
- P2PKH (base58 addresses)
- Data (OP_RETURN)
- [BIP276](https://github.com/moneybutton/bips/blob/master/bip-0276.mediawiki)
#### 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](examples) run via [Github Actions](https://github.com/libsv/go-bt/actions) and
uses [Go version 1.16.x](https://golang.org/doc/go1.16). View the [configuration file](.github/workflows/run-tests.yml).
Run all tests (including integration tests)
```shell script
make test
```
Run tests (excluding integration tests)
```shell script
make test-short
```
## Benchmarks
Run the Go [benchmarks](tx_test.go):
```shell script
make bench
```
## Code Standards
Read more about this Go project's [code standards](.github/CODE_STANDARDS.md).
## Usage
View the [examples](examples)
## Contributing
View the [contributing guidelines](.github/CONTRIBUTING.md) and please follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
### 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](https://github.com/sponsors/libsv) :clap:
or by making a [**bitcoin donation**](https://gobitcoinsv.com/#sponsor) to ensure this journey continues indefinitely! :rocket:
[](https://github.com/libsv/go-bt/stargazers)
## License
[](LICENSE)