Back to packageRELEASE DETAILS

1.0.4

npm

0x.js

A javascript library for interacting with the 0x protocol

Published21 Sept 2018

Direct dependencies44

Transitive dependenciesNot calculated

README

Current package documentation

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

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 44

Native requirements

44 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
@0xproject/assert Environment { "local_name": "@0xproject/assert", "alias": false, "peer_metadata": null }	`^1.0.9`	runtime
@0xproject/base-contract Environment { "local_name": "@0xproject/base-contract", "alias": false, "peer_metadata": null }	`^2.0.3`	runtime
@0xproject/contract-wrappers Environment { "local_name": "@0xproject/contract-wrappers", "alias": false, "peer_metadata": null }	`^1.0.4`	runtime
@0xproject/order-utils Environment { "local_name": "@0xproject/order-utils", "alias": false, "peer_metadata": null }	`^1.0.3`	runtime
@0xproject/order-watcher Environment { "local_name": "@0xproject/order-watcher", "alias": false, "peer_metadata": null }	`^1.0.4`	runtime
@0xproject/subproviders Environment { "local_name": "@0xproject/subproviders", "alias": false, "peer_metadata": null }	`^2.0.3`	runtime
@0xproject/types Environment { "local_name": "@0xproject/types", "alias": false, "peer_metadata": null }	`^1.0.2`	runtime
@0xproject/typescript-typings Environment { "local_name": "@0xproject/typescript-typings", "alias": false, "peer_metadata": null }	`^2.0.1`	runtime
@0xproject/utils Environment { "local_name": "@0xproject/utils", "alias": false, "peer_metadata": null }	`^1.0.9`	runtime
@0xproject/web3-wrapper Environment { "local_name": "@0xproject/web3-wrapper", "alias": false, "peer_metadata": null }	`^2.0.3`	runtime
ethereum-types Environment { "local_name": "ethereum-types", "alias": false, "peer_metadata": null }	`^1.0.7`	runtime
ethers Environment { "local_name": "ethers", "alias": false, "peer_metadata": null }	`3.0.22`	runtime
lodash Environment { "local_name": "lodash", "alias": false, "peer_metadata": null }	`^4.17.5`	runtime
web3-provider-engine Environment { "local_name": "web3-provider-engine", "alias": false, "peer_metadata": null }	`14.0.6`	runtime
@0xproject/abi-gen Environment { "local_name": "@0xproject/abi-gen", "alias": false, "peer_metadata": null }	`^1.0.9`	development
@0xproject/dev-utils Environment { "local_name": "@0xproject/dev-utils", "alias": false, "peer_metadata": null }	`^1.0.8`	development
@0xproject/migrations Environment { "local_name": "@0xproject/migrations", "alias": false, "peer_metadata": null }	`^1.0.10`	development
@0xproject/monorepo-scripts Environment { "local_name": "@0xproject/monorepo-scripts", "alias": false, "peer_metadata": null }	`^1.0.9`	development
@0xproject/tslint-config Environment { "local_name": "@0xproject/tslint-config", "alias": false, "peer_metadata": null }	`^1.0.7`	development
@types/lodash Environment { "local_name": "@types/lodash", "alias": false, "peer_metadata": null }	`4.14.104`	development
@types/mocha Environment { "local_name": "@types/mocha", "alias": false, "peer_metadata": null }	`^2.2.42`	development
@types/node Environment { "local_name": "@types/node", "alias": false, "peer_metadata": null }	`*`	development
@types/sinon Environment { "local_name": "@types/sinon", "alias": false, "peer_metadata": null }	`^2.2.2`	development
@types/web3-provider-engine Environment { "local_name": "@types/web3-provider-engine", "alias": false, "peer_metadata": null }	`^14.0.0`	development
awesome-typescript-loader Environment { "local_name": "awesome-typescript-loader", "alias": false, "peer_metadata": null }	`^3.1.3`	development
chai Environment { "local_name": "chai", "alias": false, "peer_metadata": null }	`^4.0.1`	development
chai-as-promised Environment { "local_name": "chai-as-promised", "alias": false, "peer_metadata": null }	`^7.1.0`	development
chai-bignumber Environment { "local_name": "chai-bignumber", "alias": false, "peer_metadata": null }	`^2.0.1`	development
copyfiles Environment { "local_name": "copyfiles", "alias": false, "peer_metadata": null }	`^2.0.0`	development
dirty-chai Environment { "local_name": "dirty-chai", "alias": false, "peer_metadata": null }	`^2.0.1`	development
json-loader Environment { "local_name": "json-loader", "alias": false, "peer_metadata": null }	`^0.5.4`	development
make-promises-safe Environment { "local_name": "make-promises-safe", "alias": false, "peer_metadata": null }	`^1.1.0`	development
mocha Environment { "local_name": "mocha", "alias": false, "peer_metadata": null }	`^4.1.0`	development
npm-run-all Environment { "local_name": "npm-run-all", "alias": false, "peer_metadata": null }	`^4.1.2`	development
nyc Environment { "local_name": "nyc", "alias": false, "peer_metadata": null }	`^11.0.1`	development
opn-cli Environment { "local_name": "opn-cli", "alias": false, "peer_metadata": null }	`^3.1.0`	development
shx Environment { "local_name": "shx", "alias": false, "peer_metadata": null }	`^0.2.2`	development
sinon Environment { "local_name": "sinon", "alias": false, "peer_metadata": null }	`^4.0.0`	development
source-map-support Environment { "local_name": "source-map-support", "alias": false, "peer_metadata": null }	`^0.5.0`	development
tslint Environment { "local_name": "tslint", "alias": false, "peer_metadata": null }	`5.11.0`	development
typedoc Environment { "local_name": "typedoc", "alias": false, "peer_metadata": null }	`0.12.0`	development
typescript Environment { "local_name": "typescript", "alias": false, "peer_metadata": null }	`3.0.1`	development
uglifyjs-webpack-plugin Environment { "local_name": "uglifyjs-webpack-plugin", "alias": false, "peer_metadata": null }	`^1.3.0`	development
webpack Environment { "local_name": "webpack", "alias": false, "peer_metadata": null }	`^3.1.0`	development

Distribution files

1 collected

Distribution 1

Source distribution

Source file

Checksums from source

{
  "shasum": "20aa0fc4dd8a229cfbcbffdce4ad285272d6c4f6",
  "tarball": "https://registry.npmjs.org/0x.js/-/0x.js-1.0.4.tgz",
  "integrity": "sha512-GThrK4NpbL2DjxCRj9kqdXqAkK7pYOLLp8DUYKW3xYCIBG5xk8OAimBd7g1ykm9paGbUUNq0M0KeQAoHFDXuxg==",
  "fileCount": 13,
  "unpackedSize": 69228,
  "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbpQeuCRA9TVsSAnZWagAA+DUP/j4aXXrVdBiIvj+YM6Jn\nx4BjDX2Aj1B5Fk+1eBdIAZx346HyJ4CTmNqbyobB1b0Tf76YX6K4nYYMTtY7\nh8SPvuIDyKnal5pIG2z8GifAFJLoIlg5HjVB9gTupDARnIOPd/U/DIlOJhGA\nQ89Jt2fneyR4DGxRRP3CmJumNhyogpoYi5P/RKOBT8ifj0H/mMpVbK9VWpZJ\nA9AWI3a77OnEjK2A+6MECvN+hLM82scaOXwDt+vE+iCGqc9CN+qZeFWt+8eK\ntNOjWXGsWGXFgvA0L/eCEFTjby27yi1LzlvNrC98qKL4rkTAwguBX8cdkwcm\n+x1/Qx4ZS9JaIbdYLmOgEuP4ujxwFTl/eLRbPSKvBHRbNQQgOCpqvr1t+7dc\ntTieQc8kcVfmad050dl7/VrlRhiSdo+U0zcma4ER+vMKv0MG08uGSVakyAtX\nPQn/Hdl2GH/iZl84KJFSgNFMEhv8/hhpghvd1lTYqDqNf+3lKp2wc6hOx4Ta\n9L7ytZmOE1/YVLvxB0BldiOt8beR2KjewNtkVEf0JwzB5JdVkhhdL+f5+wVX\nYutIAktDgS/ibi3M9EYCqKhJrtB7RzPCbwLZXu2tUFgESeCMKFK+blrHrXHT\n5WrB3l2ElIptFO2LMJJm56oQExRFw9mcvG590VxI30wJPiTnvYIAgjY6qvrj\nn25h\r\n=4bVI\r\n-----END PGP SIGNATURE-----\r\n",
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEUCIQCRYmBKPq+LBgoBQLNv1rwI8cmD6Mi3PkaEcoiX7DDg5wIgcpjB0Fjbpp0jROs0jBupfDhQeR6iJzroF6vu3yW5GeA="
    }
  ]
}