open-index/open-npm huggingface dataset:
npm package: @0x/mesh-browser
Description: TypeScript and JavaScript bindings for running Mesh directly in the browser.
Latest version: 10.1.0

## @0x/mesh-browser

This package provides an easy way to run a browser-based Mesh node. Specifically, it
provides Typescript and Javascript bindings that can be used to interact with a Mesh
node that is running in the browser and handles the process of loading the mesh node
on the webpage. Because of the fact that this package handles Wasm loading, it is
considerably heavier-weight and may take longer to load than the @0x/mesh-browser-lite
package.

## Installation

```bash
yarn add @0x/mesh-browser
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
```

## Contributing

If you would like to contribute bug fixes or new features to the client, checkout the [0xproject/0x-mesh](https://github.com/0xProject/0x-mesh) project and use the below commands to install the dependencies, build, lint and test your changes.

### Install dependencies

```bash
yarn install
```

### Build

```bash
yarn build
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```
npm package: @0x/mesh-browser-lite
Description: TypeScript and JavaScript bindings for running Mesh directly in the browser. To use this packages, you must use your own copy of the Mesh WebAssembly Binary
Latest version: 11.0.1

## @0x/mesh-browser-lite

This packages provides a set of Typescript and Javascript bindings for running a
0x-mesh node in the browser. The browser node's Wasm binary is not bundled in
this package and is instead expected to be served by the consumer of the package.
This package has a smaller bundle size than the `@0x/mesh-browser` package and
may have faster load times.

## Installation

```bash
yarn add @0x/mesh-browser-lite
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@types"],
}
```

## Contributing

If you would like to contribute bug fixes or new features to the client, checkout the [0xproject/0x-mesh](https://github.com/0xProject/0x-mesh) project and use the below commands to install the dependencies, build, lint and test your changes.

### Install dependencies

```bash
yarn install
```

### Build

```bash
yarn build
```

### Lint

```bash
yarn lint
```
npm package: @0x/orderbook
Description: Library for retrieving and syncing a remote orderbook locally
Author: Jacob Evans
Latest version: 2.2.7

## @0x/orderbook

Package to help fetch orders from a remote source ([Standard Relayer API](https://github.com/0xProject/standard-relayer-api), Mesh) and keep the local orderbook synced and up-to-date.

Supported Order Providers:

-   SRA HTTP Polling
-   SRA Websocket
-   Mesh

## Installation

```bash
yarn add @0x/orderbook
```

**Import**

```typescript
import { Orderbook } from '@0x/orderbook';
```

or

```javascript
var Orderbook = require('@0x/orderbook').Orderbook;
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
```

## Usage

```typescript
// Create an orderbook for makerAssetData, takerAssetData using the SRA Polling Order Provider
// This Provider polls the SRA endpoint automatically every 5 seconds on the supplied asset pairs
const orderbook = Orderbook.getOrderbookForPollingProvider({
    httpEndpoint: 'https://sra.0x.org/v2',
    pollingIntervalMs: 5000,
});
const orders = await orderbook.getOrdersAsync(makerAssetData, takerAssetData);

// Create an orderbook for makerAssetData, takerAssetData using the SRA Websocket Order Provider
// This provider subscribes via websocket to receive order updates on the supplied asset pairs
const orderbook = Orderbook.getOrderbookForWebsocketProvider({
    httpEndpoint: 'https://sra.0x.org/v2',
    websocketEndpoint: 'wss://ws.sra.0x.org',
});
const orders = await orderbook.getOrdersAsync(makerAssetData, takerAssetData);

// Create an orderbook for makerAssetData, takerAssetData using the Mesh Order Provider
// This provider subscribes via websocket to receive order updates on all orders stored in Mesh
const orderbook = Orderbook.getOrderbookForMeshProvider({
    websocketEndpoint: 'wss://MESH_ENDPOINT',
});
const orders = await orderbook.getOrdersAsync(makerAssetData, takerAssetData);
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

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

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

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

```bash
PKG=@0x/orderbook yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/orderbook yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @0x/sol-compiler
Description: Solidity compiler wrapper and artifactor
Author: Amir Bandeali
Latest version: 4.8.5

## @0x/sol-compiler

Sol-compiler is a wrapper around [solc-js](https://www.npmjs.com/package/solc) that adds:

-   Smart re-compilation: Only recompiles when smart contracts have changed
-   Ability to compile an entire project instead of only individual `.sol` files
-   Compilation using the Solidity version specified at the top of each individual `.sol` file
-   Proper parsing of Solidity version ranges
-   Support for the standard [input description](https://solidity.readthedocs.io/en/develop/using-the-compiler.html#input-description) for what information you'd like added to the resulting `artifacts` file (i.e 100% configurable artifacts content).

### Read the [Documentation](https://0x.org/docs/tools/sol-compiler).

## Installation

#### CLI Installation

```bash
yarn global add @0x/sol-compiler
```

#### API Installation

```bash
yarn add @0x/sol-compiler
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
}
```

**Import**

```typescript
import { Compiler } from '@0x/sol-compiler';
```

or

```javascript
var Compiler = require('@0x/sol-compiler').Compiler;
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

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

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

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

```bash
PKG=@0x/sol-compiler yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/sol-compiler yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @0x/sol-cov
Description: Generate coverage reports for Solidity code
Latest version: 2.1.17

## @0x/sol-cov

A Solidity code coverage tool.

### Read the [Documentation](https://0xproject.com/docs/sol-cov).

## Installation

```bash
yarn add @0x/sol-cov
```

**Import**

```javascript
import { CoverageSubprovider } from '@0x/sol-cov';
```

or

```javascript
var CoverageSubprovider = require('@0x/sol-cov').CoverageSubprovider;
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

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

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

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

```bash
PKG=@0x/sol-cov yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/sol-cov yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @0x/sol-profiler
Description: Generate profiler reports for Solidity code
Latest version: 4.1.39

## @0x/sol-profiler

Solidity line-by-line gas profiler.

### Read the [Documentation](https://0x.org/docs/tools/sol-profiler).

## Installation

```bash
yarn add @0x/sol-profiler
```

**Import**

```javascript
import { ProfilerSubprovider } from '@0x/sol-profiler';
```

or

```javascript
var ProfilerSubprovider = require('@0x/sol-profiler').ProfilerSubprovider;
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

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

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

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

```bash
PKG=@0x/sol-profiler yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/sol-profiler yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @0x/sol-resolver
Description: Import resolver for smart contracts dependencies
Latest version: 3.1.13

## @0x/sol-resolver

A Solidity import resolver used by [sol-compiler](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-compiler).

## Installation

```bash
yarn add @0x/sol-resolver
```

**Import**

```javascript
import { Resolver } from '@0x/sol-resolver';
```

or

```javascript
var Resolver = require('@0x/sol-resolver').Resolver;
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

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

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

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

```bash
PKG=@0x/sol-resolver yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/sol-resolver yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```
npm package: @0x/sol-trace
Description: Prints stack trace on Solidity revert
Latest version: 3.0.49

## @0x/sol-trace

Prints a stack trace when a revert is encountered.

### Read the [Documentation](https://0x.org/docs/tools/sol-trace).

## Installation

```bash
yarn add @0x/sol-trace
```

**Import**

```javascript
import { RevertTraceSubprovider } from '@0x/sol-trace';
```

or

```javascript
var RevertTraceSubprovider = require('@0x/sol-trace').RevertTraceSubprovider;
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

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

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

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

```bash
PKG=@0x/sol-trace yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/sol-trace yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @0x/sol-tracing-utils
Description: Common part of trace based solidity tools (sol-coverage, sol-trace, sol-profiler)
Latest version: 7.3.5

## @0x/sol-tracing-utils

Common code for all solidity trace-based tools (sol-coverage, sol-profiler, sol-trace).

## Installation

```bash
yarn add @0x/sol-tracing-utils
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

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

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

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

```bash
PKG=@0x/sol-tracing-utils yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/sol-tracing-utils yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @0x/sra-spec
Description: Standard Relayer API Open API Spec
Author: Francesco Agosti
Latest version: 3.0.9

## @0x/sra-spec

Contains the Standard Relayer API [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification).

The package distributes both a javascript object version and a json version.

A deployed [ReDoc](https://github.com/Rebilly/ReDoc) static site with the API can be found here http://sra-spec.s3-website-us-east-1.amazonaws.com/.

## Usage

```
import { api } from '@0x/sra-spec';
```

## Installation

```
yarn install
```

## Development

You can start a development server that will serve a [ReDoc](https://github.com/Rebilly/ReDoc) documentation instance. It uses the `api.json` file from `lib/` (you must have built at least once with `yarn build` or `yarn build-json`) that is based on the `api` object exported from `src`.

```
yarn watch_without_deps
```

The process will watch for changes, but will not hot-reload so you must refresh the page to see the changes.

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

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

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

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

```bash
PKG=@0x/sra-spec yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/sra-spec yarn watch
```

### Static Site

We also [host a static HTML version of the docs on S3](http://sra-spec.s3-website-us-east-1.amazonaws.com/) for easy sharing.

To build and deploy the site run

```
yarn deploy-site
```

**NOTE: On deploying the site, it will say the site is available at a non-existent URL. Please ignore and use the (now updated) URL above.**

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @0x/ts-doc-gen
Description: A CLI for generating a single MD reference doc file for a TS project
Author: Fabio Berger
Latest version: 0.0.28

## @0x/ts-doc-gen

A CLI for generating a single MD reference doc file for a TS project

## Installation

```bash
yarn add @0x/ts-doc-gen
```

### Install dependencies

```bash
yarn install
```

### Build

```bash
yarn build
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```
npm package: @0x/tslint-config
Description: Lint rules related to 0xProject for TSLint
Author: Fabio Berger
Latest version: 4.1.5

## @0x/tslint-config

TSLint configuration and custom linter rules used by 0xProject.

## Installation

```bash
yarn add --dev @0x/tslint-config
```

## Usage

Add the following to your `tslint.json` file

```json
{
    "extends": ["@0x/tslint-config"]
}
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

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

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

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

```bash
PKG=@0x/tslint-config yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0x/tslint-config yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```