OMG-JS

This is a Javascript/Typescript library that allows you to interact with OMG Network's MoreVP implementation of Plasma. It provides functions to:

1. Deposit (Eth/ERC20) from the Rootchain into the Childchain.
2. Transact on the Childchain.
3. Exit from the Childchain back to the Rootchain.
4. Challenge invalid exits.

Compatibility

omg-js follows a modified semver with the first part referring to its own library versioning and the second part referring to its compatible elixir-omg version.

ie. v1.0.3-2.0.1

1.0.3 -> omg-js version
2.0.1 -> compatible elixir-omg version

Installation

Node

Requires Node >= 8.11.3 < 13.0.0

npm install @omisego/omg-js

Browser

You can add omg-js to a website quickly. Just add this script tag.

<script src="https://unpkg.com/@omisego/browser-omg-js"></script>

React Native

omg-js can easily be integrated with React Native projects. Only some Node specific modules will need to be pollyfilled using the process below.

First install rn-nodeify to your project

npm install rn-nodeify

Then, add this postinstall script to your project's package.json

"scripts": {
    "postinstall": "omgjs-polyfill"
}

Then install the omg-js library

npm install @omisego/omg-js

Usage

1. Instantiate an omgjs instance passing configuration values and a Web3 provider.

import Web3 from 'web3';
import OmgJS from '@omisego/omg-js';

const web3Provider = new Web3.providers.HttpProvider(eth_node);
const omgjs = new OmgJS({
  plasmaContractAddress: plasmaframework_contract_address,
  watcherUrl: watcher_url,
  web3Provider
});

2. Call a method on the instance. If you're using Typescript, you can access any of the library interfaces.

import { ITransactionReceipt } from '@omisego/omg-js';

const depositResult: ITransactionReceipt = await omgjs.deposit({
  amount: 1,
  txOptions: { from, privateKey }
});

console.log(`Deposit success! ${depositResult.transactionHash}`);

3. Check out the documentation or examples for more information.

Documentation

Documentation for omg-js

Examples

You can find examples on common library methods and instructions on how to run them in the /examples folder.

Integration Tests

You can find instructions on running the integrations tests in the /integration-tests folder.