@renex/renex/README.md

The official RenEx Software Development Kit in typescript.

# Official RenEx SDK

The official Javascript SDK for interacting with [RenEx](https://ren.exchange) -- the world's first decentralized dark pool exchange.

## Links

* [Official SDK Docs](https://republicprotocol.github.io/renex-sdk-docs)
* [Cloneable Examples](https://github.com/republicprotocol/renex-sdk-examples)

## Installation

Add the RenExSDK using NPM

```bash
npm install @renex/renex
```

Add the RenExSDK using Yarn

```bash
yarn add @renex/renex
```

## Importing the SDK

Importing using the require syntax

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

Importing using the ES6 syntax

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

## Usage

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

```javascript
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](https://ren.exchange).

```javascript
sdk.setAddress("0xece04c40dc55b1c6e3882966ed41e7982f3d26a6");
```

For information on SDK usage, check out the [official SDK Docs](https://republicprotocol.github.io/renex-sdk-docs) or clone the [examples repository](https://github.com/republicprotocol/renex-sdk-examples).

## For Developers

### To build:

```bash
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:

```bash
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.

```bash
npm run test
```

### To update the typescript bindings:

In order to update the bindings in `src/contracts/bindings`, you need to clone [`renex-sol`](https://github.com/republicprotocol/renex-sol) and run:

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