rover-js-sdk

rover-js-sdk is a Javascript library for communicating with a Rover Orbit server. It is used for building Rover apps either on Node.js or in the browser.

It provides:

• a networking layer API for Orbit endpoints.
• facilities for building and signing transactions, for communicating with a Rover Orbit instance, and for submitting transactions or querying network history.

Warning! Node version of rover-base (rover-sdk dependency) 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 (and rover-sdk) will fallback to the much slower implementation contained in tweetnacl.

If you are using rover-sdk/rover-base in a browser you can ignore this. However, for production backend deployments you should definitely be using ed25519. If ed25519 is successfully installed and working RoverSdk.FastSigning variable will be equal true. Otherwise it will be false.

rover-js-sdk vs rover-js-base

rover-js-sdk is a high-level library that serves as client side API for Orbit. This library makes extensive use of the lower-level rover-js-base and exposes rover-js-base classes via its export object. rover-js-base can be used as a standalone library for creating Rover primitive constructs via XDR helpers and wrappers. rover-js-base doesn't depend on connecting to Orbit.

rover-js-sdk exposes all rover-js-base classes so you don't have to install rover-js-base along rover-js-sdk.

Quick start

Using npm to include rover-js-sdk in your own project:

npm install --save rover-network-sdk

For browsers, use Bower to install rover-js-sdk. It exports a variable RoverSdk. The example below assumes you have rover-sdk.js relative to your html file.

<script src="rover-sdk.js"></script>
<script>console.log(RoverSdk);</script>

Install

To use as a module in a Node.js project

1. Install it using npm:

npm install --save rover-network-sdk

2. require/import it in your JavaScript:

var RoverSdk = require('rover-network-sdk');

Help! I'm having trouble installing the SDK on Windows

Unfortunately, the Rover platform development team mostly works on OS X and Linux, and so sometimes bugs creep through that are specific to windows. When installing rover-sdk on windows, you might see an error that looks similar to the following:

error MSB8020: The build tools for v120 (Platform Toolset = 'v120 ') cannot be found. To build using the v120 build tools, please install v120 build tools.  Alternatively, you may upgrade to the current Visual Studio tools by selecting the Project menu or right-click the solution, and then selecting "Retarget solution"

To resolve this issue, you should upgrade your version of nodejs, node-gyp and then re-attempt to install the offending package using npm install -g --msvs_version=2015 ed25519. Afterwards, retry installing rover-sdk as normal.

If you encounter the error: "failed to find C:\OpenSSL-Win64", You need to install OpenSSL. More information about this issue can be found here.

In the event the above does not work, please join us on our community slack to get help resolving your issue.

To develop and test rover-js-sdk itself

1. Clone the repo:

git clone https://github.com/laxmicoinofficial/rover-js-sdk.git

2. Install dependencies inside rover-js-sdk folder:

cd rover-js-sdk
npm install

Usage

For information on how to use rover-js-sdk, take a look at the Developers site.

There is also API Documentation here.

Testing

To run all tests:

gulp test

To run a specific set of tests:

gulp test:node
gulp test:browser

Documentation

Documentation for this repo lives in Developers site.

Contributing

For information on how to contribute, please refer to our contribution guide.

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-sdk is licensed under an Apache-2.0 license. See the LICENSE file for details.