Skip to content
OpenZeppelin SDK repository for CLI and upgrades.js
JavaScript TypeScript Solidity Shell
Branch: master
Clone or download
Latest commit 4577820 Aug 19, 2019

README.md

OpenZeppelin SDK

standard-readme compliant CircleCI lerna

Formerly known as ZeppelinOS

OpenZeppelin is a platform to develop, deploy and operate smart contract projects on Ethereum and every other EVM and eWASM-powered blockchain.

This repository includes the OpenZeppelin Command-Line Interface, JavaScript Library, and the sources for the Documentation Website.

Install

First, install Node.js and npm. Then, install the OpenZeppelin SDK running:

npm install --global @openzeppelin/cli

Usage

We recommend to use the OpenZeppelin SDK through the openzeppelin sdk command-line interface.

To start, create a directory for the project and access it:

mkdir my-project
cd my-project

Use npm to create a package.json file:

npm init

And initialize the OpenZeppelin SDK project:

openzeppelin init my-project

Now it is possible to add contracts to the project with the openzeppelin add command, push these contracts to a blockchain network with openzeppelin push, use openzeppelin create to create instances for these contracts that later can be upgraded, and many more things.

Run openzeppelin --help for more details about thes and all the other functions of the OpenZeppelin CLI.

The OpenZeppelin SDK documentation explains how to build a project using our platform, how to upgrade contracts, how to share packages for other projects to reuse, how to vouch for the quality of a package, how to use the JavaScript libraries to operate the project, and it explains details of the platform and some advanced topics.

Security

If you find a security issue, please contact us at security@openzeppelin.com. We give rewards for reported issues, according to impact and severity.

Maintainers

Development setup

Run npm install in the root of the project, followed by npx lerna bootstrap to have lerna install all dependencies in all packages and symlink them as needed.

Contribute

To contribute, join our forum or community channel on Telegram, where you can talk to all the OpenZeppelin developers, contributors, partners, and users.

You can also follow the recent developments of the project in our blog and Twitter account.

License

MIT © OpenZeppelin

You can’t perform that action at this time.