BUX

Bitcoin UTXO & xPub Management Engine

About
Installation
Documentation
Examples & Tests
Benchmarks
Code Standards
Usage
Contributing
License

About

TLDR;

Application developers should focus on their applications and should not be bogged down with managing UTXOs or XPubs. Developers should be able to use an open-source, easy to install solution to rapidly build full-featured Bitcoin applications.

DISCLAIMER

BUX is still considered "ALPHA" and should not be used in production until a major v1.0.0 is released.

BUX: Out-of-the-box Features:

xPub & UTXO State Management (state, balance, utxos, destinations)
Bring your own Database (MySQL, PostgreSQL, SQLite, Mongo or interface your own)
Caching (FreeCache, Redis or interface your own)
Task Management (TaskQ or interface your own)
Transaction Syncing (queue, broadcast, push to mempool or on-chain, or interface your own)
Future plugins using BRFC standards

Project Assumptions: MVP

No private keys are used, only the xPub (or access key) is given to bux
(BYOX) Bring your own xPub
Signing a transaction is outside this application (IE: bux-server or bux-client)
All transactions need to be submitted to the bux service to effectively track utxo states
Database can be backed up, but not regenerated from chain
- Certain data is not on chain, plus re-scanning an xPub is expensive and not easily possible with 3rd party limitations

Installation

bux requires a supported release of Go.

go get -u github.com/BuxOrg/bux

Documentation

View the generated documentation

Repository Features

This repository was created using MrZ's go-template

Built-in Features

Continuous integration via GitHub Actions
Build automation via Make
Dependency management using Go Modules
Code formatting using gofumpt and linting with golangci-lint and yamllint
Unit testing with testify, race detector, code coverage HTML report and Codecov report
Releasing using GoReleaser on new Tag
Dependency scanning and updating thanks to Dependabot and Nancy
Security code analysis using CodeQL Action
Automatic syndication to pkg.go.dev on every release
Generic templates for Issues and Pull Requests in Github
All standard Github files such as LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and SECURITY.md
Code ownership configuration for Github
All your ignore files for vs-code, docker and git
Automatic sync for labels into Github using a pre-defined configuration
Built-in powerful merging rules using Mergify
Welcome new contributors on their first Pull-Request
Follows the standard-readme specification
Visual Studio Code configuration with Go
(Optional) Slack, Discord or Twitter announcements on new Github Releases
(Optional) Easily add contributors in any Issue or Pull-Request

Package Dependencies

Library Deployment

Releases are automatically created when you create a new git tag!

If you want to manually make releases, please install GoReleaser:

goreleaser for easy binary or library deployment to Github and can be installed:

using make: make install-releaser
using brew: brew install goreleaser

The .goreleaser.yml file is used to configure goreleaser.

Automatic Releases on Tag Creation (recommended)

Automatic releases via Github Actions from creating a new tag:

make tag version=1.2.3

Manual Releases (optional)

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production (manually).

Makefile Commands

View all makefile commands

make help

List of all current commands:

all                           Runs multiple commands
clean                         Remove previous builds and any cached 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-all-contributors      Installs all contributors locally
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-all-db                   Runs all tests including embedded database tests
test-all-db-ci                Runs all tests including embedded database tests (CI)
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-contributors           Regenerates the contributors html/list
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.18.x. View the configuration file.

Run all unit tests (excluding database tests)

make test

Run database integration tests

make test-all-db

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

Checkout all the examples!

Contributing

View the contributing guidelines and 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! 🚀