open-index/open-npm huggingface dataset:
npm package: @polyswapai/contract-artifacts
Description: Smart contract compilation artifacts for the latest version of the Protocol.
Author: Polyswap
Latest version: 1.0.1

## @polyswapai/contract-artifacts

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

## Installation

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

**Import**

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

or

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

### 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=@polyswapai/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 `@polyswapai/contract-addresses`
2. Copy the contract artifact into `@polyswapai/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: @polyswapai/contract-wrappers
Description: ## Installation
Author: Polyswap
Latest version: 1.0.1

## @polyswapai/contract-wrappers

## Installation

**Install**

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

**Import**

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

### 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=@polyswapai/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 0x 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 `@polyswapai/contract-artifacts`. To re-generate wrappers, e.g. when `@polyswapai/contract-artifacts` has been updated, run `yarn wrappers:generate && yarn wrappers:prettier`.
npm package: @polyswapai/contracts-erc20
Description: **Install**
Author: Polyswap
Latest version: 1.0.0

## Installation

**Install**

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

### 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=@polyswapai/contracts-erc20 yarn build
```

Or continuously rebuild on change:

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

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```

#### Testing options

Contracts testing options like coverage, profiling, revert traces or backing node choosing - are described [here](../TESTING.md).
npm package: @polyswapai/contracts-proxy
Description: This package contains contracts for the PoodlProxy.
Author: Polyswap
Latest version: 1.0.0

This package contains contracts for the PoodlProxy.

## Installation

**Install**

```bash
npm install @polyswapai/contracts-proxy --save
```

### 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=@polyswapai/contracts-proxy yarn build
```

Or continuously rebuild on change:

```bash
PKG=@polyswapai/contracts-proxy yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @polyswapai/contracts-test-utils
Description: This package contains test utilities used by other smart contracts packages.
Author: Polyswap
Latest version: 1.0.0

## Contracts test utils

This package contains test utilities used by other smart contracts packages.

## Usage

```typescript
import {
    chaiSetup,
    constants,
    expectContractCallFailedAsync,
    expectContractCreationFailedAsync,
    expectTransactionFailedAsync,
    expectTransactionFailedWithoutReasonAsync,
    increaseTimeAndMineBlockAsync,
    provider,
    sendTransactionResult,
    txDefaults,
    web3Wrapper,
} from '@polyswapai/contracts-test-utils';
```

### 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=@polyswapai/contracts-test-utils yarn build
```

Or continuously rebuild on change:

```bash
PKG=@polyswapai/contracts-test-utils yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @polyswapai/contracts-utils
Description: **Install**
Author: Polyswap
Latest version: 1.0.0

## Installation

**Install**

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

### 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=@polyswapai/contracts-utils yarn build
```

Or continuously rebuild on change:

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

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @polyswapai/protocol-utils
Description: ## Installation
Author: Polyswap
Latest version: 1.0.0

## @polyswapai/protocol-utils

## Installation

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

### 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=@polyswapai/protocol-utils yarn build
```

Or continuously rebuild on change:

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

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```