@digitalbits-blockchain/xdb-digitalbits-base

JS DigitalBits Base

The @digitalbits-blockchain/xdb-digitalbits-base library is the lowest-level digitalbits helper library. It consists of classes to read, write, hash, and sign the xdr structures that are used in digitalbits-core. This is an implementation in JavaScript that can be used on either Node.js or web browsers.

• API Reference

Warning! The Node version of this package uses the sodium-native package, a native implementation of Ed25519 in Node.js, as an optional dependency. This means that if for any reason installation of this package fails, @digitalbits-blockchain/xdb-digitalbits-base will fallback to the much slower implementation contained in tweetnacl.

If you'd explicitly prefer not to install the sodium-native package, pass the appropriate flag to skip optional dependencies when installing this package (e.g. --no-optional if using npm install or --without-optional using yarn install).

If you are using @digitalbits-blockchain/xdb-digitalbits-base in a browser you can ignore this. However, for production backend deployments you should most likely be using sodium-native. If sodium-native is successfully installed and working, DigitalBitsBase.FastSigning variable will be equal true. Otherwise it will be false.

Quick start

Using yarn to include @digitalbits-blockchain/xdb-digitalbits-base in your own project:

yarn add @digitalbits-blockchain/xdb-digitalbits-base

For browsers, use Bower to install it. It exports a variable DigitalBitsBase. The example below assumes you have xdb-digitalbits-base.js relative to your html file.

<script src="xdb-digitalbits-base.js"></script>
<script>
  console.log(DigitalBitsBase);
</script>

Install

To use as a module in a Node.js project

• Install it using yarn:

yarn add @digitalbits-blockchain/xdb-digitalbits-base

• require/import it in your JavaScript:

var DigitalBitsBase = require('@digitalbits-blockchain/xdb-digitalbits-base');

To develop and test xdb-digitalbits-base itself

• Install Node 14.x

We support the oldest LTS release of Node, which is currently 14.x. Please likewise install and develop on Node 14 so you don't get surprised when your code works locally but breaks in CI.

If you work on several projects that use different Node versions, you might find helpful to install a nodejs version manager.

• https://github.com/creationix/nvm
• https://github.com/wbyoung/avn
• https://github.com/asdf-vm/asdf

• Install Yarn

This project uses Yarn to manages its dependencies. To install Yarn, follow the project instructions available at https://yarnpkg.com/en/docs/install.

• Clone the repo

git clone https://github.com/xdbfoundation/xdb-digitalbits-base.git

• Install dependencies inside xdb-digitalbits-base folder

cd xdb-digitalbits-base
yarn

• Observe the project's code style

While you're making changes, make sure to run the linter-watcher to catch any linting errors (in addition to making sure your text editor supports ESLint)

node_modules/.bin/gulp watch

If you're working on a file not in src, limit your code to Node 6.16 ES! See what's supported here: https://node.green/ (The reason is that our npm library must support earlier versions of Node, so the tests need to run on those versions.)

Updating XDR definitions

• Make sure you have Docker installed and running.
• make reset-xdr

Usage

For information on how to use @digitalbits-blockchain/xdb-digitalbits-base, take a look at the docs in the docs folder.

Testing

To run all tests:

gulp test

To run a specific set of tests:

gulp test:node
gulp test:browser

You can also run yarn test for a simpler subset of the test cases.

Tests are also run automatically in Github Actions for every master commit and pull request.

Documentation

Documentation for this repo lives inside the docs folder.

Contributing

Please see the CONTRIBUTING.md for details on how to contribute to this project.

Publishing to npm

npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease]

A new version will be published to npm and Bower by GitHub Actions.

npm >= 2.13.0 required. Read more about npm version.

License

@digitalbits-blockchain/xdb-digitalbits-base is licensed under an Apache-2.0 license. See the LICENSE file for details.