bux

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 37 Open GitHub ↗

Bitcoin UTXO & xPub Management Engine

Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BUX

# :warning: This repository is deprecated. :warning: 
## Use [github.com/bitcoin-sv/spv-wallet/engine](https://github.com/bitcoin-sv/spv-wallet/tree/master/engine) instead

[![Release](https://img.shields.io/github/release-pre/BuxOrg/bux.svg?logo=github&style=flat&v=2)](https://github.com/BuxOrg/bux/releases)
[![Build Status](https://img.shields.io/github/actions/workflow/status/BuxOrg/bux/run-tests.yml?branch=master&v=2)](https://github.com/BuxOrg/bux/actions)
[![Report](https://goreportcard.com/badge/github.com/BuxOrg/bux?style=flat&v=2)](https://goreportcard.com/report/github.com/BuxOrg/bux)
[![codecov](https://codecov.io/gh/BuxOrg/bux/branch/master/graph/badge.svg?v=2)](https://codecov.io/gh/BuxOrg/bux)
[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/BuxOrg/bux&style=flat&v=2)](https://mergify.com)

[![Go](https://img.shields.io/github/go-mod/go-version/BuxOrg/bux?v=2)](https://golang.org/)
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod&v=2)](https://gitpod.io/#https://github.com/BuxOrg/bux)
[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat&v=2)](https://github.com/RichardLitt/standard-readme)
[![Makefile Included](https://img.shields.io/badge/Makefile-Supported%20-brightgreen?=flat&logo=probot&v=2)](https://raw.githubusercontent.com/BuxOrg/bux/master/Makefile)
 
</div>

> Bitcoin UTXO & xPub Management Engine

## Table of Contents
- [About](#about)
- [Installation](#installation)
- [Documentation](#documentation)
- [Usage](#usage)
  - [Examples & Tests](#examples--tests)
  - [Benchmarks](#benchmarks)
- [Code Standards](#code-standards)
- [Contributing](#contributing)
- [License](#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](https://www.mysql.com/), [PostgreSQL](https://www.postgresql.org/), [SQLite](https://www.sqlite.org), [Mongo](https://www.mongodb.com/) or [interface](https://github.com/mrz1836/go-datastore/blob/master/interface.go) your own)
- Caching ([FreeCache](https://github.com/github.com/coocood/freecache), [Redis](https://redis.io/) or [interface](https://github.com/mrz1836/go-cachestore/blob/master/interface.go) your own)
- Task Management ([TaskQ](https://github.com/vmihailenco/taskq) or [interface](taskmanager/interface.go) your own)
- Transaction Syncing (queue, broadcast, push to mempool or on-chain, or [interface](chainstate/interface.go) your own)
- Future plugins using [BRFC standards](http://bsvalias.org/01-brfc-specifications.html)

#### **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](https://github.com/BuxOrg/bux-server) or [bux-client](https://github.com/BuxOrg/go-buxclient))
- 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](https://golang.org/doc/devel/release.html#policy).
```shell script
go get -u github.com/BuxOrg/bux
```

## Documentation
View the generated [documentation](https://pkg.go.dev/github.com/BuxOrg/bux)

[![GoDoc](https://godoc.org/github.com/BuxOrg/bux?status.svg&style=flat&v=2)](https://pkg.go.dev/github.com/BuxOrg/bux)

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

This repository was created using [MrZ's `go-template`](https://github.com/mrz1836/go-template#about)

#### Built-in Features
- Continuous integration via [GitHub Actions](https://github.com/features/actions)
- Build automation via [Make](https://www.gnu.org/software/make)
- Dependency management using [Go Modules](https://github.com/golang/go/wiki/Modules)
- Code formatting using [gofumpt](https://github.com/mvdan/gofumpt) and linting with [golangci-lint](https://github.com/golangci/golangci-lint) and [yamllint](https://yamllint.readthedocs.io/en/stable/index.html)
- Unit testing with [testify](https://github.com/stretchr/testify), [race detector](https://blog.golang.org/race-detector), code coverage [HTML report](https://blog.golang.org/cover) and [Codecov report](https://codecov.io/)
- Releasing using [GoReleaser](https://github.com/goreleaser/goreleaser) on [new Tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging)
- Dependency scanning and updating thanks to [Dependabot](https://dependabot.com) and [Nancy](https://github.com/sonatype-nexus-community/nancy)
- Security code analysis using [CodeQL Action](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)
- Automatic syndication to [pkg.go.dev](https://pkg.go.dev/) on every release
- Generic templates for [Issues and Pull Requests](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository) in GitHub
- All standard GitHub files such as `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md`
- Code [ownership configuration](.github/CODEOWNERS) for GitHub
- All your ignore files for [vs-code](.editorconfig), [docker](.dockerignore) and [git](.gitignore)
- Automatic sync for [labels](.github/labels.yml) into GitHub using a pre-defined [configuration](.github/labels.yml)
- Built-in powerful merging rules using [Mergify](https://mergify.io/)
- Welcome [new contributors](.github/mergify.yml) on their first Pull-Request
- Follows the [standard-readme](https://github.com/RichardLitt/standard-readme/blob/master/spec.md) specification
- [Visual Studio Code](https://code.visualstudio.com) configuration with [Go](https://code.visualstudio.com/docs/languages/go)
- (Optional) [Slack](https://slack.com), [Discord](https://discord.com) or [Twitter](https://twitter.com) announcements on new GitHub Releases
- (Optional) Easily add [contributors](https://allcontributors.org/docs/en/bot/installation) in any Issue or Pull-Request

</details>

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

- [bitcoinschema/go-bitcoin](https://github.com/bitcoinschema/go-bitcoin)
- [bitcoinschema/go-map](https://github.com/bitcoinschema/go-map)
- [coocood/freecache](https://github.com/coocood/freecache)
- [gorm.io/gorm](https://gorm.io/gorm)
- [libsv/go-bk](https://github.com/libsv/go-bk)
- [libsv/go-bt](https://github.com/libsv/go-bt)
- [mrz1836/go-cache](https://github.com/mrz1836/go-cache)
- [mrz1836/go-cachestore](https://github.com/mrz1836/go-cachestore)
- [mrz1836/go-datastore](https://github.com/mrz1836/go-datastore)
- [mrz1836/go-logger](https://github.com/mrz1836/go-logger)
- [newrelic/go-agent](https://github.com/newrelic/go-agent)
- [robfig/cron](https://github.com/robfig/cron)
- [stretchr/testify](https://github.com/stretchr/testify)
- [tonicpow/go-minercraft](https://github.com/tonicpow/go-minercraft)
- [bitcoin-sv/go-paymail](https://github.com/bitcoin-sv/go-paymail)
- [vmihailenco/taskq](https://github.com/vmihailenco/taskq)
</details>

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

Releases are automatically created when you create a new [git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging)!

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

[goreleaser](https://github.com/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](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).

### Automatic Releases on Tag Creation (recommended)
Automatic releases via [GitHub Actions](.github/workflows/release.yml) from creating a new tag:
```shell
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).

</details>

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

View all `makefile` commands
```shell script
make help
```

List of all current commands:
```text
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
```
</details>

## Usage

### Examples & Tests

Checkout all the [examples](examples)!

All unit tests and [examples](examples) run via [GitHub Actions](https://github.com/BuxOrg/bux/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 unit tests (excluding database tests)
```shell script
make test
```

Run database integration tests
```shell script
make test-all-db
```

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](.github/CODE_STANDARDS.md).

## Usage

```
func main() {
	client, err := bux.NewClient(
		context.Background(), // Set context
	)
	if err != nil {
		log.Fatalln("error: " + err.Error())
	}

defer func() {
		_ = client.Close(context.Background())
	}()

log.Println("client loaded!", client.UserAgent())
}
```

Checkout all the [examples](examples)!

## Contributing
All kinds of contributions are welcome!
 
To get started, take a look at [code standards](.github/CODE_STANDARDS.md).
 
View the [contributing guidelines](.github/CODE_STANDARDS.md#3-contributing) and follow the [code of conduct](.github/CODE_OF_CONDUCT.md).

## License

[![License](https://img.shields.io/github/license/BuxOrg/bux.svg?style=flat&v=2)](https://raw.githubusercontent.com/BuxOrg/bux/master/LICENSE)

bux

Download

Today's picks

Was this content helpful?

Recent Feedback

bux

Download

Today's picks

Was this content helpful?

Recent Feedback

Download README