open-index/open-npm huggingface dataset:
npm package: @ocario/contract-addresses
Description: Used to get known addresses of deployed Ocario contracts
Latest version: 0.0.31

##@ocario/contract-addresses

A tiny utility library for getting known deployed contract addresses for a
particular network.

## Installation

```bash
yarn add @ocario/contract-addresses
```

**Import**

```typescript
import { getContractAddressesForChainOrThrow } from '@ocario/contract-addresses';
```

or

```javascript
var getContractAddressesForChainOrThrow = require('@ocario/contract-addresses').getContractAddressesForChainOrThrow;
```

## 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](../../.github/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=@ocario/contract-addresses yarn build
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @ocario/contract-artifacts
Description: ocario smart contract compilation artifacts
Latest version: 0.0.1

## @ocario/contract-artifacts

Smart contract compilation artifacts for the latest version of the Ocario Protocol.

## Installation

```bash
yarn add @ocario/contract-artifacts
```

**Import**

```typescript
import * as artifacts from '@ocario/contract-artifacts';
```

or

```javascript
var artifacts = require('@ocario/contract-artifacts');
```

## 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](../../.github/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=@ocario/contract-artifacts yarn build
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```

### Development

This package needs to be updated manually when deploying a new contract.
Post-deployment workflow:

1. Update `@ocario/contract-addresses`
2. Copy the contract artifact into `@ocario/contract-artifacts`. If updating all the artifacts at once, you can use `yarn artifacts_update`. If manually coping an artifact, make sure to use `yarn artifacts_transform` to remove unwanted fields.
3. Regenerate the wrappers. `cd ../contract-wrappers && yarn rebuild`
npm package: @ocario/contract-wrappers
Description: Wrappers for Ocario smart contract wrappers generated using @Ocario/abi-gen
Latest version: 0.0.8

## @ocario/contract-wrappers

Wrappers for ocario smart contracts, generated using @ocario/abi-gen.

## Installation

**Install**

```bash
npm install @ocario/contract-wrappers --save
```

**Import**

```typescript
import { ContractWrappers } from '@ocario/contract-wrappers';
```

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

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

## 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](../../.github/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=@ocario/contract-wrappers yarn build
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```

### Documentation

Documentation for this package is generated by TypeDoc, using the Solidity source code for ocario contracts. Each contract corresponds to one global-level module, which contains relevant enums and interfaces for its events and structs. Most significantly, each module exports a class, `<ContractName>Contract`, e.g. `ExchangeContract`, which implements helper methods for all the functions defined in the corresponding contract.

A convention to note is that these contract-specific helper methods are defined as _object literals_, which are separated from methods in the generated documentation. Each contract method has a number of sub-methods, e.g. `sendTransactionAsync`, or `estimateGasAsync`, which are documented separately. This is an example of an expected method call signature: `exchangeContractInstance.fillOrder.sendTransactionAsync(...arguments)`.

### Development

This package contains generated code. We use the `abi-gen` utility to generate wrappers from compiler artifacts in `@ocario/contract-artifacts`. To re-generate wrappers, e.g. when `@ocario/contract-artifacts` has been updated, run `yarn wrappers:generate && yarn wrappers:prettier`.
npm package: @ocario/contracts-erc20
Description: Token contracts used by Ocario protocol
Latest version: 0.0.1

## ERC20 Tokens

This package contains implementations of various [ERC20](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md) tokens, including WETH (Wrapped Ether) and ZRX. Addresses of the deployed contracts can be found in this Ocario [guide](https://Ocario.org/docs/guides/Ocario-cheat-sheet) or the [DEPLOYS](./DEPLOYS.json) file within this package.

## Installation

**Install**

```bash
npm install @Ocario/contracts-erc20 --save
```

## Bug bounty

A bug bounty for the 2.0.0 contracts is ongoing! Instructions can be found [here](https://Ocario.org/docs/guides/bug-bounty-program).

## Contributing

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

For proposals regarding the Ocario protocol's smart contract architecture, message format, or additional functionality, go to the [Ocario Improvement Proposals (ZEIPs)](https://github.com/OcarioProject/ZEIPs) repository and follow the contribution guidelines provided therein.

Please read our [contribution guidelines](../../.github/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=@Ocario/contracts-erc20 yarn build
```

Or continuously rebuild on change:

```bash
PKG=@Ocario/contracts-erc20 yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @ocario/contracts-utils
Description: Smart contract utils of Ocario protocol
Latest version: 0.0.1

## Contracts utils

This package contains smart contract utilities and libraries that are used throughout the entire codebase of smart contracts. These contracts are all generic and may helpful to use outside of the context of Ocario protocol.

## Installation

**Install**

```bash
npm install @ocario/contracts-utils --save
```

## Contributing

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

For proposals regarding the Ocario protocol's smart contract architecture, message format, or additional functionality, go to the [Ocario Improvement Proposals (ZEIPs)](https://github.com/Ocario-Project/ZEIPs) repository and follow the contribution guidelines provided therein.

Please read our [contribution guidelines](../../.github/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=@ocario/contracts-utils yarn build
```

Or continuously rebuild on change:

```bash
PKG=@ocario/contracts-utils yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @ocario/contracts-zero-ex
Description: Extensible contracts for interacting with the 0x protocol
Latest version: 0.0.4

## OcarioEx (OcarioExchangeProxy)

This package contains contracts for the OcarioEx extensible contract architecture.

> **_NOTE:_**  This repo is undergoing a tooling change. If adding a contract, you will need to
> add it to `compiler.json`. You can generate the entire list by running the following:
> `find . -type f -name "*.sol" | grep -v foundry | grep -v "contracts/dep" | grep -v "node_modules"`

## Installation

**Install**

```bash
npm install @ocario/contracts-zero-ex --save
```

## Contributing

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

For proposals regarding the Ocario protocol's smart contract architecture, message format, or additional functionality, go to the [Ocario Improvement Proposals (ZEIPs)](https://github.com/Ocario-Project/protocol.git) repository and follow the contribution guidelines provided therein.

Please read our [contribution guidelines](../../.github/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=@ocario/contracts-zero-ex yarn build
```

Or continuously rebuild on change:

```bash
PKG=@ocario/contracts-zero-ex yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```

### Run Integration Tests
you will need to create a .env that the root of `/contracts/zero-ex` containing rpc's for all 7 chains the tests will be run on

```sh
ARBITRUM_RPC_URL=https://arb-mainnet........
AVALANCHE_RPC_URL=https://avalanche-mainnet......
BSC_RPC_URL=https://bsc-mainnet......
FANTOM_RPC_URL=https://fantom-mainnet......
MAINNET_RPC_URL=https://eth-mainnet......
OPTIMISM_RPC_URL=https://opt-mainnet......
POLYGON_RPC_URL=https://polygon-mainnet......
```

```bash
git submodule update --init --recursive
foundryup
yarn test:integration
```
npm package: @ocario/protocol-utils
Description: Ocario protocol utils
Latest version: 11.17.17

## @ocario/protocol-utils

ocario protocol-related utilities for the V4/Exchange Proxy constellation of contracts, with tooling related to:

-   Limit orders
-   Rfq orders
-   Transformers
-   Signatures
-   EIP712 hashing

### Read the [Documentation](https://ocario.org/docs/protocol/protocol-utils).

## Installation

```bash
yarn add @ocario/protocol-utils
```

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

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

## 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](../../.github/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=@ocario/protocol-utils yarn build
```

Or continuously rebuild on change:

```bash
PKG=@ocario/protocol-utils yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```