rover-base2 v0.0.2
Rover JS Base
The rover-base library is the lowest-level rover helper library. It consists of classes to read, write, hash, and sign the xdr structures that are used in rover-core. This is an implementation in JavaScript that can be used on either Node.js or web browsers.
Warning! Node version of this package is using
ed25519
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,rover-base
will fallback to the much slower implementation contained intweetnacl
.If you are using
rover-base
in a browser you can ignore this. However, for production backend deployments you should definitely be usinged25519
. Ifed25519
is successfully installed and workingRoverBase.FastSigning
variable will be equaltrue
. Otherwise it will befalse
.
Quick start
Using npm to include rover-js-base in your own project:
npm install --save rover-base
For browsers, use Bower to install it. It exports a
variable RoverBase
. The example below assumes you have rover-base.js
relative to your html file.
<script src="rover-base.js"></script>
<script>console.log(RoverBase);</script>
Install
To use as a module in a Node.js project
Install it using npm:
npm install --save rover-base
require/import it in your JavaScript:
var RoverBase = require('rover-base');
To self host for use in the browser
Install it using bower:
bower install rover-base
Include it in the browser:
<script src="./bower_components/rover-base/rover-base.js"></script> <script>console.log(RoverBase);</script>
If you don't want to use install Bower, you can copy built JS files from the bower-rover-js-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/stellar-base/{version}/stellar-base.js"></script> <script>console.log(RoverBase);</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 rover-js-base itself
Clone the repo
git clone https://github.com/stellar/rover-js-base.git
Install dependencies inside rover-js-base folder
cd rover-js-base npm install
Usage
For information on how to use rover-js-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
Tests are also run on the Travis CI rover-js-base project automatically.
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 Travis CI.
npm >=2.13.0 required. Read more about npm version.
License
rover-js-base is licensed under an Apache-2.0 license. See the LICENSE file for details.