Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libsv/go-bc
The go-to Bitcoin Block Chain (BC) Go library.
https://github.com/libsv/go-bc
bitcoin bitcoin-golang-library bitcoinsv bsv go golang
Last synced: 11 days ago
JSON representation
The go-to Bitcoin Block Chain (BC) Go library.
- Host: GitHub
- URL: https://github.com/libsv/go-bc
- Owner: libsv
- License: isc
- Created: 2021-02-17T13:47:12.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-24T09:18:56.000Z (6 months ago)
- Last Synced: 2024-06-18T20:20:57.566Z (5 months ago)
- Topics: bitcoin, bitcoin-golang-library, bitcoinsv, bsv, go, golang
- Language: Go
- Homepage: https://pkg.go.dev/github.com/libsv/go-bc
- Size: 2.32 MB
- Stars: 10
- Watchers: 5
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# go-bc
> The go-to Bitcoin Block Chain (BC) GoLang library
[](https://github.com/libsv/go-bc/releases)
[](https://github.com/libsv/go-bc/actions)
[](https://goreportcard.com/report/github.com/libsv/go-bc)
[](https://codecov.io/gh/libsv/go-bc)
[](https://golang.org/)
[](https://github.com/sponsors/libsv)
[](https://gobitcoinsv.com/#sponsor)
## 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-bc** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```shell script
go get -u github.com/libsv/go-bc
```
## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/libsv/go-bc)
[](https://pkg.go.dev/github.com/libsv/go-bc)
For more information around the technical aspects of Bitcoin, please see the updated [Bitcoin Wiki](https://wiki.bitcoinsv.io/index.php/Main_Page)
### Features
- Block header building
- Coinbase transaction building (cb1 + cb2 in stratum protocol)
- Bitcoin block hash difficulty and hashrate functions
- Merkle proof/root/branch functions
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-bc/actions) and
uses [Go version 1.15.x](https://golang.org/doc/go1.15). 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:
```shell script
make bench
```
## Code Standards
Read more about this Go project's [code standards](CODE_STANDARDS.md).
## Usage
View the [examples](examples)
## Maintainers
| [
](https://github.com/jadwahab) |
|:---:|
| [JW](https://github.com/jadwahab) |
## Contributors
| [](https://github.com/jadwahab) | [
](https://github.com/ordishs) | [
](https://github.com/liam) |
|:---:|:---:|:---:|
| [JW](https://github.com/jadwahab) | [SO](https://github.com/ordishs) | [LM](https://github.com/liam) |
## Contributing
View the [contributing guidelines](CONTRIBUTING.md) and please follow the [code of conduct](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:
## License
