SPV Wallet: JS Client

Table of Contents

• About
• Installation
• Usage
• Options
• Development
• Code Standards
• Contributing
• License

About

SPV Wallet: JS Client is a TypeScript package which acts as a http client to SPV Wallet. Using this library, you can build your own solutions that utilize this non-custodial wallet.

For comprehensive information and guidance, please refer to the SPV Wallet Documentation.

Key features

• Sending transactions (standard and OP_RETURN);
• Listing transactions, UTXOs, destinations;
• Getting balance;
• Managing SPV Wallet as an admin;
  • Registering xPubs;
  • Creating Paymails;
• Generating keys (xPriv, xPub).

Installation

To use this package in your application, you can add it using yarn.

yarn add @bsv/spv-wallet-js-client

Usage

You can find the examples of usage in the examples directory.

The main concept is to create a new instance of the SpvWalletClient class and use its methods to interact with the SPV Wallet server.

import { SpvWalletClient } from '@bsv/spv-wallet-js-client';

const spvWalletServerUrl = 'http://localhost:3003';

// Create a new instance of the SPV Wallet client
const client = new SpvWalletClient(spvWalletServerUrl, {
  // connecting with the xPriv is one of the options (see below)
  xPriv: 'xpriv.....',
});

// Use the client to interact with the SPV Wallet server
// For example, check the balance
const userInfo = await client.GetUser();
console.log('Current balance:', userInfo.currentBalance);

During creation or usage of the client an exception can be thrown - see handle-exceptions example how to handle these situations. Additionally you can check ./src/errors.ts file where custom errors are defined.

Options

SPV Wallet URL

The first argument of the SpvWalletClient constructor is the URL of the SPV Wallet server.

Note the /api/v1 or /v1 suffix is not required, it will be resolved automatically.

Keys configuration

The second argument is an object which is responsible for configuring what key to use. It is typescripted so it will help you with the options.

Generally, there are two kinds of requests:

• User requests - to interact with the wallet as a user
• Admin requests - to manage the SPV Wallet

To make user requests, you need to provide one of the following options:

• xPriv string - which allows you to make all non-admin requests
• accessKey string - same as xPriv but without the ability to call methods: SignTransaction and SendToRecipients
• xPub string - in this case, your requests will not be signed and you also won't be able to call SignTransaction and SendToRecipients

Regerdless of the option you choose, you can always add the admin key to the options object.

See the examples of different ways to create the client:

const client = new SpvWalletClient(spvWalletServerUrl, {
  // all non-admin requests will work
  xPriv: 'xpriv.....',
});
const client = new SpvWalletClient(spvWalletServerUrl, {
  // all non-admin requests will work except SignTransaction and SendToRecipients
  accessKey: 'accesskey.....',
});
const client = new SpvWalletClient(spvWalletServerUrl, {
  // part non-admin requests will work and they will not be signed
  xPub: 'xpub.....',
});
const client = new SpvWalletClient(spvWalletServerUrl, {
  // all non-admin and admin requests will work
  xPriv: 'xpriv.....',
  adminKey: 'adminkey.....',
});
const client = new SpvWalletClient(spvWalletServerUrl, {
  // only admin requests will work
  adminKey: 'adminkey.....',
});

Optional logger configuration

The third optional argument is responsible for a logger configuration. You can either configure log level (default info) or provide your own logger which implements Logger interface (see ./src/logger.ts)

Unless you provide your own logger, the standard console will be used.

To disable logging, you can set the log level to disabled.

Check the example presenting how to define custom-logger.

Development

This package is based on rollup.js which handles configuration, hot-reloading and making a build.

To run the package for develompent purposes, make sure you've installed all dependencies with yarn install, then just run:

yarn dev

After that, in the dist directory, compiled package should appear. Additionally, rollup will observe the source files rebuilding the dist if needed (hot-reloading).

You can test your changes locally, the same way as our examples are run. You can find them in examples directory.

Build the package

To build the package use

yarn build

See more scripts in the package.json file or the makefile.

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

If you want to manually make releases, please install GoReleaser:

goreleaser for easy binary or library deployment to Github and can be installed:

• using make: make install-releaser
• using brew: brew install goreleaser

The .goreleaser.yml file is used to configure goreleaser.

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

View all makefile commands

make help

List of all current commands:

audit                         Checks for vulnerabilities in dependencies
clean                         Remove previous builds and any test cache data
help                          Show this help message
install                       Installs the dependencies for the package
install-all-contributors      Installs all contributors locally
outdated                      Checks for outdated packages via npm
publish                       Will publish the version to npm
release                       Full production release (creates release in Github)
release                       Run after releasing - deploy to npm
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                          Will run unit tests
update-contributors           Regenerates the contributors html/list

Code Standards

Please read our code standards document

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