@0xproject/deployer

Smart contract deployer of 0x protocol

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
1,35413Apr 24, 2021May 23, 2017Minified + gzip package size for @0xproject/deployer in KB

Readme

@0xproject/deployer

This repository contains a CLI tool that facilitates compiling and deployment of smart contracts.

Read the Documentation.

Installation

CLI Installation

yarn global add @0xproject/deployer

API Installation

yarn add @0xproject/deployer

If your project is in TypeScript, add the following to your tsconfig.json:

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

Import

import { Deployer, Compiler } from '@0xproject/deployer';

or

var Deployer = require('@0xproject/deployer').Deployer;
var Compiler = require('@0xproject/deployer').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 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

If this is your first time building this package, you must first build all packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from within the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory:

yarn lerna:rebuild

Or continuously rebuild on change:

yarn dev

You can also build this specific package by running the following from within its directory:

yarn build

or continuously rebuild on change:

yarn build:watch

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.