Table of Contents

• SPV Wallet
  • Table of Contents
  • About
  • Installation
    • build
    • run
  • Documentation
    • Built-in Features
  • Automatic Releases on Tag Creation (recommended)
  • Manual Releases (optional)
  • Usage
  • Defaults
  • Config Variables
    • Flags
    • Environment variables
  • Examples \& Tests
  • Benchmarks
  • Docker Compose Quickstart
  • Code Standards
  • Contributing
  • License

About

A comprehensive non-custodial wallet for BSV digital currency.

More in-depth information and guidance about SPV Wallet Toolbox you can find here.

Installation

spv-wallet requires a supported release of Go.

go get -u github.com/bitcoin-sv/spv-wallet

build

go build -o spv-wallet cmd/*

run

./spv-wallet

Documentation

View the generated documentation

View the generated documentation

Usage

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

Defaults

If you run spv-wallet 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/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/main.go -C /my/config.json

Environment variables

To override any config variable with ENV, use the "SPVWALLET_" 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

To override adminkey in auth config, use the path with "" as a path delimiter and SPVWALLET_ as prefix. So:

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

spv-wallet provides a start.sh script which is using docker-compose.yml file to starts up SPV Wallet with web-frontend, web-backend and selected database and cache storage.

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 spv-wallet.

   ./start.sh

2. 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 -sw true -b false 

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

  ./start.sh -l

Ports which are used:

• 3002 - SPV Wallet web-frontend
• 8180 - SPV Wallet web-backend
• 3003 - SPV Wallet (core service)
• 3000 - SPV Wallet admin
• 5432 - PostgreSQL DB
• 6379 - Redis
• 8080 - Block Headers Service
• 80 - in case of exposing on the paymail domain and its subdomains
• 443 - in case of exposing on the paymail domain and its subdomains
  

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