Bitbank - Relay

(c) 2021-present Bernd Fix brf@hoi-polloi.org >Y<

bitbank-relay is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

bitbank-relay is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

SPDX-License-Identifier: AGPL3.0-or-later

WARNING

This software is not yet ready for productive use.

Introduction

The bitbank-relay software enables individuals and small organizations to accept cryptocurrencies (Bitcoin, Ethereum and ten other Altcoins) on their webpage.

To manage the received coins it is highly recommended to use a multi-coin HD wallet with optional Trezor support.

Build

If you want to build the software yourself, you need Go v1.16+ that can be downloaded here. Make sure you setup Go-related environment variables as described in the Go documentation.

After you have cloned the repository to your local machine (and every time you pull a newer version), you should update the dependencies for bitbank-relay:

go mod tidy

To build the three components (configurator, db and web), you can either use the GNU Makefile (recommended) or build it manually.

GNU Makefile

Using the GNU Makefile will incorporate the latest Git tag (version) into the binaries and is the recommended way of building the executables:

make

Manual build

No version information ("v0.0.0") is inserted into the binaries during manual build:

cd configurator
go build
cd ../db
go build
cd ../web
go build
cd ..

Configuration

You need to configure/setup the bitbank-relay package in parallel with the multi-coin HD wallet / Trezor device you want to use to manage incoming crypto funds. You can either do this automatically, semi-automatically or manually.

The steps are described in a separate README.

Deployment

The deployment for bitbank-relay includes:

• web executable (from the web/ folder)
• config.json (the genrated/edited configuration file)
• an initialized relay database (MySQL or SQLite3)
• integration into a website for use

A detailed description can be found in a separate README.

Maintenance

The maintenance can either be done by directly interacting with the relay database via SQL commands or by using a GUI. The steps are described in detail in a separate README.

Testing

To run the unit tests in the repo folder:

go test -v ./...

Currently no unit tests are defined.