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

Add the RenExSDK using NPM

npm install --save @renex/renex

Add the RenExSDK using Yarn

yarn add @renex/renex

Importing the SDK

Importing using the require syntax

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

Importing using the ES6 syntax

import { RenExSDK } from "@renex/renex";

Usage

Pass in a provider object to instantiate the SDK and set the address.

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

Before you can use account specific functions such as fetching account balances or opening orders, you must tell the SDK which Ethereum account to use. This address must be the same one that has been KYC'd via Kyber or Wyre. You can check if your account has been verified by visiting RenEx Beta.

sdk.setAddress("0xece04c40dc55b1c6e3882966ed41e7982f3d26a6");

For information on SDK usage, check out the official SDK Docs or clone the examples repository.

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

@renex/renex