tonicpow / go-minercraft

Interact with Bitcoin Miner APIs

go-minercraft

Interact with Bitcoin Miner APIs via mAPI or ARC (unofficial Go library of Minercraft)

Table of Contents

• Installation
• Documentation
• Examples & Tests
• Benchmarks
• Code Standards
• Usage
• Maintainers
• Contributing
• License

Installation

go-minercraft requires a supported release of Go.

go get -u github.com/tonicpow/go-minercraft/v2

If you want to install the deprecated V1:

go get -u github.com/tonicpow/go-minercraft@v1

Documentation

View the generated documentation

This package interacts with BSV miners using the Merchant API specification.

View documentation on hosting your own mAPI server.

Features

• Merchant API Support:
  • Policy Quote
  • Fee Quote
  • Query Transaction Status
  • Submit Transaction
  • Submit Batched Transactions
• ARC Support
• Custom Features:
  • Client is completely configurable
  • Using default heimdall http client with exponential backoff & more
  • Use your own HTTP client
  • Use your own miner configuration
  • Uses common type: bt.Fee for easy integration across projects
  • Current miner information located at response.Miner.name and defaults
  • 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
  • Mempool
  • GorillaPool
  • Matterpool

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
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 run via GitHub Actions and uses Go version 1.19.x. View the 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

MrZ

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! 🚀

Credits

Unwriter & Interplanaria for their original contribution: Minercraft which was the inspiration for this library.

nChain & team for developing the brfc-merchant-api specifications.

wregulski for adding ARC support.

License