Catalog npm
Back to packageRELEASE DETAILS

0.33.6

npm

0x.js

A javascript library for interacting with the 0x protocol

0x.js0xprojectethereumexchangetokens
Published18 Mar 2018
Direct dependencies55
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.

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 55

Native requirements
55 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
@0xproject/assert
Environment
{
  "local_name": "@0xproject/assert",
  "alias": false,
  "peer_metadata": null
}
^0.2.3runtime
@0xproject/base-contract
Environment
{
  "local_name": "@0xproject/base-contract",
  "alias": false,
  "peer_metadata": null
}
^0.0.5runtime
@0xproject/json-schemas
Environment
{
  "local_name": "@0xproject/json-schemas",
  "alias": false,
  "peer_metadata": null
}
^0.7.17runtime
@0xproject/types
Environment
{
  "local_name": "@0xproject/types",
  "alias": false,
  "peer_metadata": null
}
^0.4.1runtime
@0xproject/utils
Environment
{
  "local_name": "@0xproject/utils",
  "alias": false,
  "peer_metadata": null
}
^0.4.3runtime
@0xproject/web3-wrapper
Environment
{
  "local_name": "@0xproject/web3-wrapper",
  "alias": false,
  "peer_metadata": null
}
^0.3.1runtime
bintrees
Environment
{
  "local_name": "bintrees",
  "alias": false,
  "peer_metadata": null
}
^1.0.2runtime
bn.js
Environment
{
  "local_name": "bn.js",
  "alias": false,
  "peer_metadata": null
}
^4.11.8runtime
ethereumjs-abi
Environment
{
  "local_name": "ethereumjs-abi",
  "alias": false,
  "peer_metadata": null
}
^0.6.4runtime
ethereumjs-blockstream
Environment
{
  "local_name": "ethereumjs-blockstream",
  "alias": false,
  "peer_metadata": null
}
^2.0.6runtime
ethereumjs-util
Environment
{
  "local_name": "ethereumjs-util",
  "alias": false,
  "peer_metadata": null
}
^5.1.1runtime
ethers-contracts
Environment
{
  "local_name": "ethers-contracts",
  "alias": false,
  "peer_metadata": null
}
^2.2.1runtime
ethers-typescript-typings
Environment
{
  "local_name": "ethers-typescript-typings",
  "alias": false,
  "peer_metadata": null
}
^0.0.4runtime
js-sha3
Environment
{
  "local_name": "js-sha3",
  "alias": false,
  "peer_metadata": null
}
^0.7.0runtime
lodash
Environment
{
  "local_name": "lodash",
  "alias": false,
  "peer_metadata": null
}
^4.17.4runtime
uuid
Environment
{
  "local_name": "uuid",
  "alias": false,
  "peer_metadata": null
}
^3.1.0runtime
web3
Environment
{
  "local_name": "web3",
  "alias": false,
  "peer_metadata": null
}
^0.20.0runtime
web3-typescript-typings
Environment
{
  "local_name": "web3-typescript-typings",
  "alias": false,
  "peer_metadata": null
}
^0.10.2runtime
@0xproject/abi-gen
Environment
{
  "local_name": "@0xproject/abi-gen",
  "alias": false,
  "peer_metadata": null
}
^0.2.7development
@0xproject/dev-utils
Environment
{
  "local_name": "@0xproject/dev-utils",
  "alias": false,
  "peer_metadata": null
}
^0.3.2development
@0xproject/monorepo-scripts
Environment
{
  "local_name": "@0xproject/monorepo-scripts",
  "alias": false,
  "peer_metadata": null
}
^0.1.14development
@0xproject/tslint-config
Environment
{
  "local_name": "@0xproject/tslint-config",
  "alias": false,
  "peer_metadata": null
}
^0.4.12development
@types/bintrees
Environment
{
  "local_name": "@types/bintrees",
  "alias": false,
  "peer_metadata": null
}
^1.0.2development
@types/jsonschema
Environment
{
  "local_name": "@types/jsonschema",
  "alias": false,
  "peer_metadata": null
}
^1.1.1development
@types/lodash
Environment
{
  "local_name": "@types/lodash",
  "alias": false,
  "peer_metadata": null
}
^4.14.86development
@types/mocha
Environment
{
  "local_name": "@types/mocha",
  "alias": false,
  "peer_metadata": null
}
^2.2.42development
@types/node
Environment
{
  "local_name": "@types/node",
  "alias": false,
  "peer_metadata": null
}
^8.0.53development
@types/sinon
Environment
{
  "local_name": "@types/sinon",
  "alias": false,
  "peer_metadata": null
}
^2.2.2development
@types/uuid
Environment
{
  "local_name": "@types/uuid",
  "alias": false,
  "peer_metadata": null
}
^3.4.2development
awesome-typescript-loader
Environment
{
  "local_name": "awesome-typescript-loader",
  "alias": false,
  "peer_metadata": null
}
^3.1.3development
chai
Environment
{
  "local_name": "chai",
  "alias": false,
  "peer_metadata": null
}
^4.0.1development
chai-as-promised
Environment
{
  "local_name": "chai-as-promised",
  "alias": false,
  "peer_metadata": null
}
^7.1.0development
chai-as-promised-typescript-typings
Environment
{
  "local_name": "chai-as-promised-typescript-typings",
  "alias": false,
  "peer_metadata": null
}
^0.0.12development
chai-bignumber
Environment
{
  "local_name": "chai-bignumber",
  "alias": false,
  "peer_metadata": null
}
^2.0.1development
chai-typescript-typings
Environment
{
  "local_name": "chai-typescript-typings",
  "alias": false,
  "peer_metadata": null
}
^0.0.6development
copyfiles
Environment
{
  "local_name": "copyfiles",
  "alias": false,
  "peer_metadata": null
}
^1.2.0development
dirty-chai
Environment
{
  "local_name": "dirty-chai",
  "alias": false,
  "peer_metadata": null
}
^2.0.1development
json-loader
Environment
{
  "local_name": "json-loader",
  "alias": false,
  "peer_metadata": null
}
^0.5.4development
mocha
Environment
{
  "local_name": "mocha",
  "alias": false,
  "peer_metadata": null
}
^4.0.1development
npm-run-all
Environment
{
  "local_name": "npm-run-all",
  "alias": false,
  "peer_metadata": null
}
^4.1.2development
nyc
Environment
{
  "local_name": "nyc",
  "alias": false,
  "peer_metadata": null
}
^11.0.1development
opn-cli
Environment
{
  "local_name": "opn-cli",
  "alias": false,
  "peer_metadata": null
}
^3.1.0development
prettier
Environment
{
  "local_name": "prettier",
  "alias": false,
  "peer_metadata": null
}
^1.11.1development
request
Environment
{
  "local_name": "request",
  "alias": false,
  "peer_metadata": null
}
^2.81.0development
request-promise-native
Environment
{
  "local_name": "request-promise-native",
  "alias": false,
  "peer_metadata": null
}
^1.0.5development
shx
Environment
{
  "local_name": "shx",
  "alias": false,
  "peer_metadata": null
}
^0.2.2development
sinon
Environment
{
  "local_name": "sinon",
  "alias": false,
  "peer_metadata": null
}
^4.0.0development
source-map-support
Environment
{
  "local_name": "source-map-support",
  "alias": false,
  "peer_metadata": null
}
^0.5.0development
truffle-hdwallet-provider
Environment
{
  "local_name": "truffle-hdwallet-provider",
  "alias": false,
  "peer_metadata": null
}
^0.0.3development
tslint
Environment
{
  "local_name": "tslint",
  "alias": false,
  "peer_metadata": null
}
5.8.0development
typedoc
Environment
{
  "local_name": "typedoc",
  "alias": false,
  "peer_metadata": null
}
github:0xProject/typedocdevelopment
types-bn
Environment
{
  "local_name": "types-bn",
  "alias": false,
  "peer_metadata": null
}
^0.0.1development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
2.7.1development
web3-provider-engine
Environment
{
  "local_name": "web3-provider-engine",
  "alias": false,
  "peer_metadata": null
}
^13.0.1development
webpack
Environment
{
  "local_name": "webpack",
  "alias": false,
  "peer_metadata": null
}
^3.1.0development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "integrity": "sha512-1tYVrXQiaGEGGa1iC4Gq+5kKACdT3G3AcRqVDDuXo1qcchW+ty8AkHNtxnB+i4mUrVxQqMUD0o3gV2DO4Bgtrg==",
  "shasum": "c1b46c1f1be3f7bd91ea0985aa07224e4490f5e1",
  "tarball": "https://registry.npmjs.org/0x.js/-/0x.js-0.33.6.tgz",
  "fileCount": 185,
  "unpackedSize": 1392495,
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEQCIHotnPswsgYFfigquJR6IR6IPjFs7hVmOyxtCv9jz++TAiAzwV5qXU/+EAB4EJFdMfXZb8HH0OkEkWiDkWEJ10DyKA=="
    }
  ]
}

Repository

PENDING
0xproject/0x-monorepo

Shared repository data · GitHub

License detected in repository
Not collected

Repository

PENDING
0xproject/0x.js

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:47 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:79ce53448031aaaecdbebfb97bd024eb47ba8eec12eea3de4c69194b4dcd7c29

Other collected versions

9.2.015 Jul9.1.624 Jun9.1.53 Mar9.1.427 Feb9.1.326 Feb9.1.225 FebView all collected versions →