plasma-js-lib effectively wraps the JSON-RPC interface that our plasma clients expose and provides a nice API for app developers to work with.
There are several easy ways to start using
If you're developing a
Node.js application, you can simply install
$ npm install --save plasma-js-lib
If you're developing a browser application, we provide a compressed and minified version of
plasma-js-lib that you can include in a
plasma-js-lib API documentation is available here.
Welcome! If you're looking to contribute to
plasma-js-lib, you're in the right place.
Contributing Guide and CoC
Plasma Group follows a Contributing Guide and Code of Conduct adapted slightly from the Contributor Covenant. All contributors are expected to read through this guide. We're here to cultivate a welcoming and inclusive contributing environment, and every new contributor needs to do their part to uphold our community standards.
Requirements and Setup
Cloning the Repo
Before you start working on
plasma-js-lib, you'll need to clone our GitHub repository:
git clone firstname.lastname@example.org:plasma-group/plasma-js-lib.git
Now, enter the repository.
plasma-js-lib is tested and built with
Although you do not need
Node.js to use this library in your application, you'll need to install
Node.js (and its corresponding package manager,
npm) for your system before contributing.
We've provided a detailed explanation of now to install
Node.js on Windows, Mac, and Linux.
plasma-js-lib has been tested on the following versions of Node:
If you're having trouble getting a component of
plasma-js-lib running, please try installing one of the above versions of
Node.js and try again.
It's pretty easy to switch
Node.js versions using
npm install -g n
Next, install your desired verson of
plasma-js-lib makes use of several
Install all required packages with:
$ npm install
Run all tests with:
$ npm test
gulp to provide a process to build
plasma-js-lib for in-browser usage.
If you'd like to build
plasma-js-lib yourself, simply run:
$ npm run build