OpenZeppelin SDK is not being actively developed. We recommend using Upgrades Plugins instead.
For more information, see Building for interoperability: why we’re focusing on Upgrades Plugins.
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.
npm install --global @openzeppelin/cli
If you get an
EACCESS permission deniederror while installing, please refer to the npm documentation on global installs permission errors. Alternatively, you may run
sudo npm install --unsafe-perm --global @openzeppelin/cli, but this is highly discouraged, and you should rather either use a node version manager or manually change npm's default directory.
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
npm to create a
And initialize the OpenZeppelin SDK project:
openzeppelin init my-project
Now it is possible to use
openzeppelin deploy to create instances for these contracts that
later can be upgraded, and many more things.
openzeppelin --help for more details about thes and all the other functions of the
If you find a security issue, please contact us at email@example.com. We give rewards for reported issues, according to impact and severity.
To set up a local development environment for contributing, clone the repository and run
yarn in the root of the project.
Please refer to the contributing guide for more details on how to contribute.
MIT © OpenZeppelin