{"id":18254711,"url":"https://github.com/bitcoin-sv/spv-wallet","last_synced_at":"2025-04-07T12:05:37.352Z","repository":{"id":37438619,"uuid":"457823171","full_name":"bitcoin-sv/spv-wallet","owner":"bitcoin-sv","description":"Open-source non-custodial hosted wallet for the BSV Blockchain (UTXOs, xPubs, Paymail \u0026 More!)","archived":false,"fork":false,"pushed_at":"2024-10-29T14:35:35.000Z","size":4331,"stargazers_count":49,"open_issues_count":6,"forks_count":14,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-10-29T15:56:32.134Z","etag":null,"topics":["bsv","bux","go","paymail","server","spv-wallet","spv-wallet-team","utxo","xpub"],"latest_commit_sha":null,"homepage":"https://docs.bsvblockchain.org/network-topology/applications/spv-wallet","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitcoin-sv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"BuxOrg","custom":"https://gobitcoinsv.com/?utm_source=github\u0026utm_medium=sponsor-link\u0026utm_campaign=bux-server\u0026utm_term=bux-server\u0026utm_content=bux-server"}},"created_at":"2022-02-10T14:54:16.000Z","updated_at":"2024-10-29T13:06:23.000Z","dependencies_parsed_at":"2024-01-01T11:27:49.623Z","dependency_job_id":"a446b79f-434c-419a-a29b-80a23570a5ab","html_url":"https://github.com/bitcoin-sv/spv-wallet","commit_stats":null,"previous_names":["bitcoin-sv/spv-wallet","buxorg/bux-server"],"tags_count":222,"template":false,"template_full_name":"mrz1836/go-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoin-sv%2Fspv-wallet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoin-sv%2Fspv-wallet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoin-sv%2Fspv-wallet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitcoin-sv%2Fspv-wallet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitcoin-sv","download_url":"https://codeload.github.com/bitcoin-sv/spv-wallet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247648976,"owners_count":20972945,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bsv","bux","go","paymail","server","spv-wallet","spv-wallet-team","utxo","xpub"],"created_at":"2024-11-05T10:13:20.308Z","updated_at":"2025-04-07T12:05:37.303Z","avatar_url":"https://github.com/bitcoin-sv.png","language":"Go","funding_links":["https://github.com/sponsors/BuxOrg","https://gobitcoinsv.com/?utm_source=github\u0026utm_medium=sponsor-link\u0026utm_campaign=bux-server\u0026utm_term=bux-server\u0026utm_content=bux-server"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# SPV Wallet\n\n\n[![Release](https://img.shields.io/github/release-pre/bitcoin-sv/spv-wallet.svg?logo=github\u0026style=flat\u0026v=3)](https://github.com/bitcoin-sv/spv-wallet/releases)\n[![Build Status](https://img.shields.io/github/actions/workflow/status/bitcoin-sv/spv-wallet/run-tests.yml?branch=main\u0026v=3)](https://github.com/bitcoin-sv/spv-wallet/actions)\n[![Report](https://goreportcard.com/badge/github.com/bitcoin-sv/spv-wallet?style=flat\u0026v=3)](https://goreportcard.com/report/github.com/bitcoin-sv/spv-wallet)\n[![codecov](https://codecov.io/gh/bitcoin-sv/spv-wallet/branch/main/graph/badge.svg?v=3)](https://codecov.io/gh/bitcoin-sv/spv-wallet)\n[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://api.mergify.com/v1/badges/bitcoin-sv/spv-wallet\u0026style=flat\u0026v=3)](https://mergify.io)\n\u003cbr\u003e\n\n[![Go](https://img.shields.io/github/go-mod/go-version/bitcoin-sv/spv-wallet?v=3)](https://golang.org/)\n[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod\u0026v=3)](https://gitpod.io/#https://github.com/bitcoin-sv/spv-wallet)\n[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat\u0026v=3)](https://github.com/RichardLitt/standard-readme)\n[![Makefile Included](https://img.shields.io/badge/Makefile-Supported%20-brightgreen?=flat\u0026logo=probot\u0026v=3)](Makefile)\n\u003cbr/\u003e\n\n\u003c/div\u003e\n\n## Table of Contents\n\n- [SPV Wallet](#spv-wallet)\n  - [Table of Contents](#table-of-contents)\n  - [About](#about)\n  - [Installation](#installation)\n      - [build](#build)\n      - [run](#run)\n  - [Documentation](#documentation)\n      - [Built-in Features](#built-in-features)\n    - [Automatic Releases on Tag Creation (recommended)](#automatic-releases-on-tag-creation-recommended)\n    - [Manual Releases (optional)](#manual-releases-optional)\n  - [Usage](#usage)\n    - [Defaults](#defaults)\n    - [Config Variables](#config-variables)\n      - [Flags](#flags)\n      - [Environment variables](#environment-variables)\n    - [Examples \\\u0026 Tests](#examples--tests)\n    - [Benchmarks](#benchmarks)\n    - [Docker Compose Quickstart](#docker-compose-quickstart)\n  - [Code Standards](#code-standards)\n  - [Contributing](#contributing)\n  - [License](#license)\n\n\u003cbr/\u003e\n\n## About\n\nA comprehensive non-custodial wallet for BSV digital currency.\n\nMore in-depth information and guidance about SPV Wallet Toolbox you can find [here](https://docs.bsvblockchain.org/network-topology/applications/spv-wallet).\n\n\u003cbr/\u003e\n\n## Installation\n\n**spv-wallet** requires a [supported release of Go](https://golang.org/doc/devel/release.html#policy).\n\n```shell script\ngo get -u github.com/bitcoin-sv/spv-wallet\n```\n\n#### build\n\n```shell script\ngo build -o spv-wallet cmd/*\n```\n\n#### run\n\n```shell script\n./spv-wallet\n```\n\u003cbr/\u003e\n\n## Documentation\n\nView the generated [documentation](https://pkg.go.dev/github.com/bitcoin-sv/spv-wallet)\n\n[![GoDoc](https://godoc.org/github.com/bitcoin-sv/spv-wallet?status.svg\u0026style=flat\u0026v=3)](https://pkg.go.dev/github.com/bitcoin-sv/spv-wallet)\nView the generated [documentation](https://pkg.go.dev/github.com/bitcoin-sv/spv-wallet)\n\n[![GoDoc](https://godoc.org/github.com/bitcoin-sv/spv-wallet?status.svg\u0026style=flat\u0026v=3)](https://pkg.go.dev/github.com/bitcoin-sv/spv-wallet)\n\n\u003cbr/\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e\u003ccode\u003eRepository Features\u003c/code\u003e\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr/\u003e\n\nThis repository was created using [MrZ's `go-template`](https://github.com/mrz1836/go-template#about)\n\n#### Built-in Features\n\n-   Continuous integration via [GitHub Actions](https://github.com/features/actions)\n-   Build automation via [Make](https://www.gnu.org/software/make)\n-   Dependency management using [Go Modules](https://github.com/golang/go/wiki/Modules)\n-   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)\n-   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/)\n-   Releasing using [GoReleaser](https://github.com/goreleaser/goreleaser) on [new Tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging)\n-   Dependency scanning and updating thanks to [Dependabot](https://dependabot.com) and [Nancy](https://github.com/sonatype-nexus-community/nancy)\n-   Security code analysis using [CodeQL Action](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)\n-   Automatic syndication to [pkg.go.dev](https://pkg.go.dev/) on every release\n-   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\n-   All standard GitHub files such as `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md`\n-   Code [ownership configuration](.github/CODEOWNERS) for GitHub\n-   All your ignore files for [vs-code](.editorconfig), [docker](.dockerignore) and [git](.gitignore)\n-   Automatic sync for [labels](.github/labels.yml) into GitHub using a pre-defined [configuration](.github/labels.yml)\n-   Built-in powerful merging rules using [Mergify](https://mergify.io/)\n-   Welcome [new contributors](.github/mergify.yml) on their first Pull-Request\n-   Follows the [standard-readme](https://github.com/RichardLitt/standard-readme/blob/master/spec.md) specification\n-   [Visual Studio Code](https://code.visualstudio.com) configuration with [Go](https://code.visualstudio.com/docs/languages/go)\n-   (Optional) [Slack](https://slack.com), [Discord](https://discord.com) or [Twitter](https://twitter.com) announcements on new GitHub Releases\n-   (Optional) Easily add [contributors](https://allcontributors.org/docs/en/bot/installation) in any Issue or Pull-Request\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e\u003ccode\u003ePackage Dependencies\u003c/code\u003e\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr/\u003e\n\n-   [BitcoinSchema/go-bitcoin](https://github.com/BitcoinSchema/go-bitcoin)\n-   [bitcoin-sv/spv-wallet](https://github.com/bitcoin-sv/spv-wallet)\n-   [mrz1836/go-api-router](https://github.com/mrz1836/go-api-router)\n-   [mrz1836/go-sanitize](https://github.com/mrz1836/go-sanitize)\n-   [stretchr/testify](https://github.com/stretchr/testify)\n-   [tonicpow/go-paymail](https://github.com/tonicpow/go-paymail)\n-   [See all dependencies](go.mod)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e\u003ccode\u003eLibrary Deployment\u003c/code\u003e\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr/\u003e\n\nReleases are automatically created when you create a new [git tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging)!\n\n### Automatic Releases on Tag Creation (recommended)\n\nAutomatic releases via [GitHub Actions](.github/workflows/release.yml) from creating a new tag:\n\n```shell\nmake tag version=1.2.3\n```\n\n\u003cbr/\u003e\n\n### Manual Releases (optional)\n\nUse `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production (manually).\n\n\u003cbr/\u003e\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003e\u003ccode\u003eMakefile Commands\u003c/code\u003e\u003c/strong\u003e\u003c/summary\u003e\n\u003cbr/\u003e\n\nView all `makefile` commands\n\n```shell script\nmake help\n```\n\nList of all current commands:\n\n```text\nall                           Runs multiple commands\nclean                         Remove previous builds and any cached data\nclean-mods                    Remove all the Go mod cache\ncoverage                      Shows the test coverage\ndiff                          Show the git diff\ngenerate                      Runs the go generate command in the base of the repo\ngodocs                        Sync the latest tag with GoDocs\nhelp                          Show this help message\ninstall                       Install the application\ninstall-all-contributors      Installs all contributors locally\ninstall-go                    Install the application (Using Native Go)\ninstall-releaser              Install the GoReleaser application\nlint                          Run the golangci-lint application (install if not found)\nrelease                       Full production release (creates release in GitHub)\nrelease                       Runs common.release then runs godocs\nrelease-snap                  Test the full release (build binaries)\nrelease-test                  Full production test release (everything except deploy)\nreplace-version               Replaces the version in HTML/JS (pre-deploy)\ntag                           Generate a new tag and push (tag version=0.0.0)\ntag-remove                    Remove a tag if found (tag-remove version=0.0.0)\ntag-update                    Update an existing tag to current commit (tag-update version=0.0.0)\ntest                          Runs lint and ALL tests\ntest-ci                       Runs all tests via CI (exports coverage)\ntest-ci-no-race               Runs all tests via CI (no race) (exports coverage)\ntest-ci-short                 Runs unit tests via CI (exports coverage)\ntest-no-lint                  Runs just tests\ntest-short                    Runs vet, lint and tests (excludes integration tests)\ntest-unit                     Runs tests and outputs coverage\nuninstall                     Uninstall the application (and remove files)\nupdate-contributors           Regenerates the contributors html/list\nupdate-linter                 Update the golangci-lint package (macOS only)\nvet                           Run the Go vet application\n```\n\n\u003c/details\u003e\n\n\u003cbr/\u003e\n\n## Usage\n\n\u003e Every variable which is used and can be configured is described in [config.example.yaml](config.example.yaml)\n\n\n### Defaults\n\nIf you run spv-wallet without editing anything, it will use the default configuration from file [defaults.go](/config/defaults.go). It is set up to use _freecache_, _sqlite_ with enabled _paymail_ with _signing disabled_ and with _beef_.\n\n\n### Config Variables\n\nDefault config variables can be overridden by (in this order of importance):\n1. Flags (only the ones below)\n2. ENV variables\n3. Config file\n\n#### Flags\n\nAvailable flags:\n\n```bash\n  -C, --config_file string                       custom config file path\n  -h, --help                                     show help\n  -v, --version                                  show version\n  -d, --dump_config                              dump config to file, specified by config_file (-C) flag\n```\n\nTo generate config file with defaults, use the --dump flag, or:\n```bash\ngo run ./cmd/main.go -d\n```\n\nThe default config file path is **project root**, and the default file name is **config.yaml**. This can be overridden by -C flag.\n```bash\ngo run ./cmd/main.go -C /my/config.json\n```\n\n#### Environment variables\n\nTo override any config variable with ENV, use the \"SPVWALLET\\_\" prefix with mapstructure annotation path with \"_\" as a delimiter in all uppercase. Example:\n\nLet's take this fragment of AppConfig from `config.example.yaml`:\n\n```yaml\nauth:\n    admin_key: xpub661MyMwAqRbcFgfmdkPgE2m5UjHXu9dj124DbaGLSjaqVESTWfCD4VuNmEbVPkbYLCkykwVZvmA8Pbf8884TQr1FgdG2nPoHR8aB36YdDQh\n    require_signing: false\n    scheme: xpub\n```\n\nTo override admin_key in auth config, use the path with \"_\" as a path delimiter and SPVWALLET\\_ as prefix. So:\n```bash\nSPVWALLET_AUTH_ADMIN_KEY=\"admin_key\"\n```\n\nTo be able to use TAAL API Key is needed. \n\nTo get and API Key:\n\n\n1. Enter the URL https://platform.taal.com/ in your browser.\n2. Register or login on to TAAL PLATFORM.\n3. Your mainnet and testnet API keys will be displayed on dashboard tab.\n\nhttps://docs.taal.com/introduction/get-an-api-key\n\nTo use your API key put key in ``token`` field in ```config.example.yaml```\n\n``nodes`` -\u003e ``apis`` -\u003e ``token``\n\n\n\u003cbr/\u003e\n\n### Examples \u0026 Tests\n\nAll unit tests run via [GitHub Actions](https://github.com/bitcoin-sv/spv-wallet/actions) and\nAll unit tests run via [GitHub Actions](https://github.com/bitcoin-sv/spv-wallet/actions) and\nuses [Go version 1.19.x](https://golang.org/doc/go1.19). View the [configuration file](.github/workflows/run-tests.yml).\n\n\u003cbr/\u003e\n\nRun all tests (including integration tests)\n\n```shell script\nmake test\n```\n\n\u003cbr/\u003e\n\nRun tests (excluding integration tests)\n\n```shell script\nmake test-short\n```\n\u003cbr/\u003e\n\n### Benchmarks\n\nRun the Go benchmarks:\n\n```shell script\nmake bench\n```\n\n\u003cbr/\u003e\n\n### Docker Compose Quickstart\n\n`spv-wallet` provides a `start.sh` script\nwhich is using `docker-compose.yml` file to starts up `SPV Wallet` with web-frontend, web-backend and selected database and cache storage.\n\nMain configuration is done when running the script.\n\nThere are two way of running this script:\n1. with manual configuration - Every option is displayed in terminal and user can choose\n   which database/cache storage use and configure how to run spv-wallet.\n  ```bash\n  ./start.sh\n  ```\n2. with flags which define how to set up docker services. Ever option is displayed when\n   you ran the script with flag `-h` or `--help`. Possible options:\n  ```bash\n  ./start.sh -db postgresql -c redis -sw true -b false \n  ```\n\n`-l/--load` option add possibility to use previously created `.env.config` file and run spv-wallet with simple command:\n  ```bash\n  ./start.sh -l\n  ```\n\n\nPorts which are used:\n\n- 3002 - SPV Wallet web-frontend\n- 8180 - SPV Wallet web-backend\n- 3003 - SPV Wallet (core service)\n- 3000 - SPV Wallet admin\n- 5432 - PostgreSQL DB\n- 6379 - Redis\n- 8080 - Block Headers Service\n- 80 - in case of exposing on the paymail domain and its subdomains\n- 443 - in case of exposing on the paymail domain and its subdomains\n\u003cbr/\u003e\n\n## Code Standards\nRead more about this Go project's [code standards](.github/CODE_STANDARDS.md).\n\n\u003cbr/\u003e\n\n## Contributing\nAll kinds of contributions are welcome!\n\u003cbr/\u003e\nTo get started, take a look at [code standards](.github/CODE_STANDARDS.md).\n\u003cbr/\u003e\nView the [contributing guidelines](.github/CODE_STANDARDS.md#3-contributing) and follow the [code of conduct](.github/CODE_OF_CONDUCT.md).\n\n\u003cbr/\u003e\n\n## License\n\n[![License](https://img.shields.io/github/license/bitcoin-sv/spv-wallet.svg?style=flat\u0026v=3)](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitcoin-sv%2Fspv-wallet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitcoin-sv%2Fspv-wallet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitcoin-sv%2Fspv-wallet/lists"}