buxserver

README

BUX: Server

Get started using BUX in five minutes

Table of Contents

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

About

Read more about BUX

Installation

bux-server requires a supported release of Go.

go get -u github.com/BuxOrg/bux-server

build

go build -o bux-server cmd/server/*

run

./bux-server

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

• BitcoinSchema/go-bitcoin
• BuxOrg/bux
• mrz1836/go-api-router
• mrz1836/go-sanitize
• stretchr/testify
• tonicpow/go-paymail
• See all dependencies

Library Deployment

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

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

Usage

Every variable which is used and can be configured is described in config.example.yaml

Defaults

If you run Bux-Server without editing anything, it will use the default configuration from file defaults.go. It is set up to use freecache, sqlite with enabled paymail with signing disabled and with beef.

Config Variables

Default config variables can be overridden by (in this order of importance):

1. Flags (only the ones below)
2. ENV variables
3. Config file

Flags

Available flags:

  -C, --config_file string                       custom config file path
  -h, --help                                     show help
  -v, --version                                  show version
  -d, --dump_config                              dump config to file, specified by config_file (-C) flag

To generate config file with defaults, use the --dump flag, or:

go run ./cmd/server/main.go -d

The default config file path is project root, and the default file name is config.yaml. This can be overridden by -C flag.

go run ./cmd/server/main.go -C /my/config.json

Environment variables

To override any config variable with ENV, use the "BUX_" prefix with mapstructure annotation path with "_" as a delimiter in all uppercase. Example:

Let's take this fragment of AppConfig from config.example.yaml:

auth:
    admin_key: xpub661MyMwAqRbcFgfmdkPgE2m5UjHXu9dj124DbaGLSjaqVESTWfCD4VuNmEbVPkbYLCkykwVZvmA8Pbf8884TQr1FgdG2nPoHR8aB36YdDQh
    require_signing: false
    scheme: xpub
    signing_disabled: true

To override admin_key in auth config, use the path with "_" as a path delimiter and BUX_ as prefix. So:

BUX_AUTH_ADMIN_KEY="admin_key"

To be able to use TAAL API Key is needed.

To get and API Key:

1. Enter the URL https://platform.taal.com/ in your browser.
2. Register or login on to TAAL PLATFORM.
3. Your mainnet and testnet API keys will be displayed on dashboard tab.

https://docs.taal.com/introduction/get-an-api-key

To use your API key put key in token field in config.example.yaml

nodes -> apis -> token

Examples & Tests

All unit tests 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

Docker Compose Quickstart

To get started with development, bux-server provides a start.sh script which is using docker-compose.yml file to starts up Bux Server with selected database and cache storage. To start, we need to fill the config json which we want to use, for example: config/envs/development.json.

Main configuration is done when running the script.

There are two way of running this script:

1. with manual configuration - Every option is displayed in terminal and user can choose which database/cache storage use and configure how to run bux-server.

./start.sh

1. with flags which define how to set up docker services. Ever option is displayed when you ran the script with flag -h or --help. Possible options:

./start.sh -db postgresql -c redis -bs true -env development -b false 

-l/--load option add possibility to use previously created .env.config file and run bux-server with simple command:

./start.sh -l

Code Standards

Read more about this Go project's code standards.

Contributing

All kinds of contributions are welcome!
To get started, take a look at code standards.
View the contributing guidelines and follow the code of conduct.

License

Documentation

Overview

Package buxserver is a complete stand-alone server using the BUX Engine

Run: go run cmd/server/main.go

If you have any suggestions or comments, please feel free to open an issue on this GitHub repository!

By BuxOrg (https://github.com/BuxOrg)