JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 17
  • Score
    100M100P100Q45784F
  • License GPL-3.0

The official RenEx Software Development Kit in typescript.

Package Exports

  • @renex/renex

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@renex/renex) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Official RenEx SDK

The official Javascript SDK for interacting with RenEx -- the world's first decentralized dark pool exchange.

Installation

npm install --save @renex/renex

Usage

var { RenExSDK } = require("@renex/renex");

var provider = window.web3.currentProvider;
var sdk = new RenExSDK(provider);

For Developers

To build:

npm run watch
# or
npm run build:dev

To run tests:

You'll need to create a .env file which contains the following exported variables:

export MNEMONIC="some mnemonic here"
export INFURA_KEY="your infura api key"

Then just run the following command to execute the tests. Make sure there is sufficient Kovan ETH in the linked account before running tests.

npm run test

To update the typescript bindings:

In order to update the bindings in src/contracts/bindings, you need to clone renex-sol and run:

cd renex-sol
npm run bindings
cd ../
cp renex-sol/test-ts/bindings/*.ts src/contracts/bindings