npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

payshares-base

v0.7.6

Published

Low level payshares support library

Downloads

9

Readme

JS Payshares Base

Build Status Code Climate Coverage Status Dependency Status

The payshares-base library is the lowest-level payshares helper library. It consists of classes to read, write, hash, and sign the xdr structures that are used in payshares-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, payshares-base will fallback to the much slower implementation contained in tweetnacl.

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

Quick start

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

npm install --save payshares-base

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

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

Install

To use as a module in a Node.js project

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

To self host for use in the browser

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

If you don't want to use install Bower, you can copy built JS files from the bower-js-payshares-base 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-base/{version}/payshares-base.js"></script>
<script>console.log(PaysharesBase);</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-base itself

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

Usage

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

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