<div align="center">

BUX

:warning: This repository is deprecated. :warning:

Use github.com/bitcoin-sv/spv-wallet/engine instead

<br>

<br/>

</div>

Bitcoin UTXO & xPub Management Engine

Table of Contents

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

<br/>

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.

<br/>

---

DISCLAIMER

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

---

<br/>

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

<br/>

Installation

bux requires a supported release of Go.

go get -u github.com/BuxOrg/bux

<br/>

Documentation

View the generated documentation

<br/> <details> <summary><strong><code>Repository Features</code></strong></summary> <br/>

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

</details> <details> <summary><strong><code>Package Dependencies</code></strong></summary> <br/>

• bitcoinschema/go-bitcoin
• bitcoinschema/go-map
• coocood/freecache
• gorm.io/gorm
• libsv/go-bk
• libsv/go-bt
• mrz1836/go-cache
• mrz1836/go-cachestore
• mrz1836/go-datastore
• mrz1836/go-logger
• newrelic/go-agent
• robfig/cron
• stretchr/testify
• tonicpow/go-minercraft
• bitcoin-sv/go-paymail
• vmihailenco/taskq

</details> <details> <summary><strong><code>Library Deployment</code></strong></summary> <br/>

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.

<br/>

Automatic Releases on Tag Creation (recommended)

Automatic releases via GitHub Actions from creating a new tag:

make tag version=1.2.3

<br/>

Manual Releases (optional)

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

<br/> </details> <details> <summary><strong><code>Makefile Commands</code></strong></summary> <br/>

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