diamante-base
v1.0.0
Published
Low-level support library for the Diamante network.
Downloads
88
Readme
JS Diamante Base
The diamante-base library is the lowest-level diamante helper library. It consists of classes to read, write, hash, and sign the xdr structures that are used in diamante-core. This is an implementation in JavaScript that can be used on either Node.js or web browsers.
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,diamante-base
will fallback to the much slower implementation contained intweetnacl
.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 usingnpm install
or--without-optional
usingyarn install
).If you are using
diamante-base
in a browser you can ignore this. However, for production backend deployments you should most likely be usingsodium-native
. Ifsodium-native
is successfully installed and working,DiamanteBase.FastSigning
variable will be equaltrue
. Otherwise it will befalse
.
Quick start
Using yarn to include js-diamante-base in your own project:
yarn add @diamante/diamante-base
For browsers, use Bower to install it. It exports a
variable DiamanteBase
. The example below assumes you have diamante-base.js
relative to your html file.
<script src="diamante-base.js"></script>
<script>
console.log(DiamanteBase);
</script>
Install
To use as a module in a Node.js project
- Install it using yarn:
yarn add @diamante/diamante-base
- require/import it in your JavaScript:
var DiamanteBase = require('@diamante/diamante-base');
To self host for use in the browser
- Install it using bower:
bower install diamante-base
- Include it in the browser:
<script src="./bower_components/diamante-base/diamante-base.js"></script>
<script>
console.log(DiamanteBase);
</script>
If you don't want to use install Bower, you can copy built JS files from the bower-js-diamante-base repo.
To use the cdnjs hosted script in the browser
- Instruct the browser to fetch the library from cdnjs, a 3rd party service that hosts js libraries:
<script src="https://cdnjs.cloudflare.com/ajax/libs/diamante-base/{version}/diamante-base.js"></script>
<script>
console.log(DiamanteBase);
</script>
Note that this method relies using a third party to host the JS library. This may not be entirely secure.
Make sure that you are using the latest version number. They can be found on the releases page in Github.
To develop and test js-diamante-base itself
- Install Node 18.x
We support the oldest LTS release of Node, which is currently 18.x. Please likewise install and develop on Node 16 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/diamante/js-diamante-base.git
- Install dependencies inside js-diamante-base folder
cd js-diamante-base
yarn
- Observe the project's code style
While you're making changes, make sure to regularly run the linter to catch any linting errors (in addition to making sure your text editor supports ESLint)
yarn lint
as well as fixing any formatting errors with
yarn fmt
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/. (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 js-diamante-base, take a look at the docs in the docs folder.
Testing
To run all tests:
yarn test
To run a specific set of tests:
yarn test:node
yarn test:browser
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
js-diamante-base is licensed under an Apache-2.0 license. See the LICENSE file for details.