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 asset-data-utils.
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/@0x/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>
Webpack config
If bundling your project with Webpack, add the following to your webpack.config.js:
If building for web:
node: {
fs: 'empty';
}
If building a node library:
externals: {
fs: true;
}
ContractWrappers uses WebAssembly to simulate Ethereum calls. This toolchain involves generated 'glue' code that requires the fs built-in, but won't actually use it in a web environment. We tell Webpack not to resolve them since we won't need them. The specific dependency is here.
Also see:
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