@dexon-foundation/0x.js

A javascript library for interacting with the 0x protocol

Usage no npm install needed!

<script type="module">
  import dexonFoundation0xJs from 'https://cdn.skypack.dev/@dexon-foundation/0x.js';
</script>

README

0x.js

A TypeScript/Javascript library for interacting with the 0x protocol. It is a high level package which combines a number of underlying packages such as order-utils and order-watcher.

Read the Documentation.

Installation

0x.js ships as both a UMD module and a CommonJS package.

CommonJS (recommended):

Install

npm install 0x.js --save

Import

import {
    assetDataUtils,
    BigNumber,
    ContractWrappers,
    generatePseudoRandomSalt,
    orderHashUtils,
    signatureUtils,
} from '0x.js';

If your project is in TypeScript, add the following to your tsconfig.json:

"compilerOptions": {
    "typeRoots": ["node_modules/@dexon-foundation/typescript-typings/types", "node_modules/@types"],
}

UMD:

Install

Download the UMD module from our releases page and add it to your project.

Import

<script type="text/javascript" src="0x.js"></script>

Contributing

We strongly recommend that the community help us make improvements and determine the future direction of 0x protocol. To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.

Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

PKG=0x.js yarn build

Or continuously rebuild on change:

PKG=0x.js yarn watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test