Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tonicpow/go-minercraft
Interact with Bitcoin Miner APIs
https://github.com/tonicpow/go-minercraft
arc bitcoin bitcoinsv brfc bsv mapi merchant-api miner minercraft
Last synced: 3 months ago
JSON representation
Interact with Bitcoin Miner APIs
- Host: GitHub
- URL: https://github.com/tonicpow/go-minercraft
- Owner: tonicpow
- License: mit
- Created: 2020-10-07T20:26:45.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-17T14:52:10.000Z (7 months ago)
- Last Synced: 2024-09-30T09:22:47.140Z (3 months ago)
- Topics: arc, bitcoin, bitcoinsv, brfc, bsv, mapi, merchant-api, miner, minercraft
- Language: Go
- Homepage:
- Size: 2.04 MB
- Stars: 12
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# go-minercraft
> Interact with Bitcoin Miner APIs via mAPI or ARC (unofficial Go library of [Minercraft](https://github.com/interplanaria/minercraft))
[](https://github.com/tonicpow/go-minercraft/releases)
[](https://github.com/tonicpow/go-minercraft/actions)
[](https://goreportcard.com/report/github.com/tonicpow/go-minercraft)
[](https://codecov.io/gh/tonicpow/go-minercraft)
[](https://golang.org/)
[](https://github.com/bitcoin-sv-specs/brfc-merchantapi)
[](https://github.com/bitcoin-sv/arc)
[](https://mergify.io)
[](https://gitpod.io/#https://github.com/tonicpow/go-minercraft)
## 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-minercraft** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).
```shell script
go get -u github.com/tonicpow/go-minercraft/v2
```
> If you want to install the **deprecated V1**:
```shell script
go get -u github.com/tonicpow/go-minercraft@v1
```
## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/tonicpow/go-minercraft)
[](https://pkg.go.dev/github.com/tonicpow/go-minercraft)
This package interacts with BSV miners using the [Merchant API](https://github.com/bitcoin-sv-specs/brfc-merchantapi) specification.
View documentation on hosting your own [mAPI server](https://github.com/bitcoin-sv/merchantapi-reference).
### Features
- Merchant API Support:
- [x] [Policy Quote](https://github.com/bitcoin-sv-specs/brfc-merchantapi#1-get-policy-quote)
- [x] [Fee Quote](https://github.com/bitcoin-sv-specs/brfc-merchantapi#2-get-fee-quote)
- [x] [Query Transaction Status](https://github.com/bitcoin-sv-specs/brfc-merchantapi#4-query-transaction-status)
- [x] [Submit Transaction](https://github.com/bitcoin-sv-specs/brfc-merchantapi#3-submit-transaction)
- [x] [Submit Batched Transactions](https://github.com/bitcoin-sv-specs/brfc-merchantapi#5-submit-multiple-transactions)
- [ARC](https://github.com/bitcoin-sv/arc) Support
- Custom Features:
- [Client](client.go) is completely configurable
- Using default [heimdall http client](https://github.com/gojektech/heimdall) with exponential backoff & more
- Use your own [HTTP client](client.go)
- Use your own [miner configuration](client.go)
- Uses common type: [`bt.Fee`](https://github.com/libsv/go-bt/blob/master/fees.go) for easy integration across projects
- Current miner information located at `response.Miner.name` and [defaults](config.go)
- Automatic Signature Validation `response.Validated=true/false`
- `AddMiner()` for adding your own customer miner configuration
- `RemoveMiner()` for removing any miner configuration
- `FastestQuote()` asks all miners and returns the fastest quote response
- `BestQuote()` gets all quotes from miners and return the best rate/quote
- `CalculateFee()` returns the fee for a given transaction
- Public Available Miners:
- [TAAl](https://tpow.app/a0f9475a)
- [Mempool](https://tpow.app/361a5570)
- [GorillaPool](https://tpow.app/43adc27e)
- [Matterpool](https://tpow.app/66b32fae)
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
diff Show the git diff
generate Runs the go generate command in the base of the repo
godocs Sync the latest tag with GoDocs
help Show this help message
install Install the application
install-go Install the application (Using Native Go)
install-releaser Install the GoReleaser application
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 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-no-lint Runs just tests
test-short Runs vet, lint and tests (excludes integration tests)
test-unit Runs tests and outputs 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](examples) run via [GitHub Actions](https://github.com/tonicpow/go-minercraft/actions) and
uses [Go version 1.19.x](https://golang.org/doc/go1.19). 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](client.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)
## Maintainers
| [
](https://github.com/mrz1836) |
|:------------------------------------------------------------------------------------------------:|
| [MrZ](https://github.com/mrz1836) |
## 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/tonicpow) :clap:
or by making a [**bitcoin donation**](https://tonicpow.com/?utm_source=github&utm_medium=sponsor-link&utm_campaign=go-minercraft&utm_term=go-minercraft&utm_content=go-minercraft) to ensure this journey continues indefinitely! :rocket:
[](https://github.com/tonicpow/go-minercraft/stargazers)
### Credits
[Unwriter & Interplanaria](https://github.com/interplanaria) for their original contribution: [Minercraft](https://github.com/interplanaria/minercraft) which was the inspiration for this library.
nChain & team for developing the [brfc-merchant-api](https://github.com/bitcoin-sv-specs/brfc-merchantapi) specifications.
[wregulski](https://github.com/wregulski) for adding [ARC](https://www.bitcoinsv.com/arc) support.
## License
[](LICENSE)