Skip to content

bitcoin-sv/spv-wallet-web-backend

Repository files navigation

SPV WALLET WEB BACKEND

Go application used as a web backend with storage for custodial wallet's xpriv keys, utilizing a non-custodial spv-wallet service.


The spv-wallet-web-backend is an HTTP server that serves as the referential backend server for a custodial web wallet for Bitcoin SV (BSV). It integrates and utilizes the spv-wallet component to handle various BSV-related operations, including the creation of transactions and listing incoming and outgoing transactions.

For in-depth information and guidance, please refer to the SPV Wallet Documentation.

How to use it

Endpoints documentation

For endpoints documentation you can visit swagger which is exposed on port 8180 by default.

http://localhost:8180/swagger/index.html

Contribution

To easy development process we use https://taskfile.dev/

Installation of taskfile

Task offers many installation methods. Check out the available methods on the installation documentation page.

Tasks

List

To see the list of available tasks just call

task

Installing and set up tools

To install missing tools that are need just call

task install
Git hooks

Also consider installing git hooks with the command:

task git-hooks:install

So it will ensure that tests are passing and linter is not complaining before git push.

Start application

To start application locally with performed all the code checks first use the command

task start

if you just want to run app without all the checks

task run

Run checks & tests

To verify the code overall run verification task

task verify

If you just want a static check of a code run

task verify:check

If you want to run tests then run

task test

License

Open BSV License.