Skip to content

Latest commit

 

History

History
141 lines (99 loc) · 6.71 KB

README.md

File metadata and controls

141 lines (99 loc) · 6.71 KB
Raw

js-payshares-sdk

Build Status Coverage Status Dependency Status

js-payshares-sdk is a Javascript library for communicating with a Payshares Horizon server. It is used for building Payshares apps either on Node.js or in the browser.

It provides:

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

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

If you are using payshares-sdk/payshares-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 PaysharesSdk.FastSigning variable will be equal true. Otherwise it will be false.

js-payshares-sdk vs js-payshares-base

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

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

Quick start

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

npm install --save payshares-sdk

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

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

Install

To use as a module in a Node.js project

  1. Install it using npm:
npm install --save payshares-sdk
  1. require/import it in your JavaScript:
var PaysharesSdk = require('payshares-sdk');

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

Unfortunately, the Payshares platform development team mostly works on OS X and Linux, and so sometimes bugs creep through that are specific to windows. When installing payshares-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 payshares-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 self host for use in the browser

  1. Install it using bower:
bower install payshares-sdk
  1. Include it in the browser:
<script src="./bower_components/payshares-sdk/payshares-sdk.js"></script>
<script>console.log(PaysharesSdk);</script>

If you don't want to use install Bower, you can copy built JS files from the bower-js-payshares-sdk repo.

To use the cdnjs hosted script in the browser

  1. 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/payshares-sdk/{version}/payshares-sdk.js"></script>
<script>console.log(PaysharesSdk);</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-payshares-sdk itself

  1. Clone the repo:
git clone https://github.com/payshares/js-payshares-sdk.git
  1. Install dependencies inside js-payshares-sdk folder:
cd js-payshares-sdk
npm install

Usage

For information on how to use js-payshares-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

js-payshares-sdk is licensed under an Apache-2.0 license. See the LICENSE file for details.