Loopring Protocol Javascript Library

Development ongoing

Environment

You need to install npm, yarn, and webpack.

Compile

Then run the following commands from project's root directory:

yarn install 

To build the dist directory and lib directory from the src director run the following:

npm run build

Installation

npm install loopring.js --save

Browser Usage

loopring.js ships as both a UMD module and a CommonJS package.

UMD Package

Include the following script tags in your HTML:

<script src="../node_modules/loopring/dist/loopring.min.js"></script>

CommonJS Package

import loopring from 'loopring.js';
or
import {relay} from 'loopring.js';
or
const loopring = require('loopring.js');

To use the library in your JavaSrcipt code, get each component like so:

window.loopring.common
window.loopring.ethereum
window.loopring.relay

中文开发者文档.

English Documention is coming soon

Developers

Before commit your changes or submit a pull request, please lint your code by running:

npm run lint
npm run build