OpenZeppelin Contracts is a library for secure smart contract development.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Ownerless Inc 68204769a1
Fix function documentation in Nonces (#4597)
Co-authored-by: Francisco <>
2 weeks ago
.changeset Remove non-standard increaseAllowance and decreaseAllowance from ERC20 (#4585) 3 weeks ago
.github Use namespaced storage for upgradeable contracts (#4534) 3 weeks ago
audits Add final PDF report for v4.9 audit (#4235) 5 months ago
certora Remove non-standard increaseAllowance and decreaseAllowance from ERC20 (#4585) 3 weeks ago
contracts Fix function documentation in Nonces (#4597) 2 weeks ago
docs Update remappings and install instructions for Foundry on docs site (#4498) 2 months ago
hardhat Fix error when running hardhat test with parameters (#4265) 5 months ago
lib Update `forge-std` submodule to `v1.2.0` (#3885) 9 months ago
scripts Use namespaced storage for upgradeable contracts (#4534) 3 weeks ago
test Remove non-standard increaseAllowance and decreaseAllowance from ERC20 (#4585) 3 weeks ago
.codecov.yml Remove Codecov Patch status outside PRs 1 year ago
.editorconfig Remove line length configuration for markdown files 1 year ago
.eslintrc Simplify ESLint config (#3903) 9 months ago
.gitignore Add Pausable FV (#4117) 7 months ago
.gitmodules Bump and pin Forge Std submodule (#4102) 7 months ago
.mocharc.js Use Hardhat recommended Mocha configuration (#2805) 2 years ago
.prettierrc Update linters (major) (#4563) 3 weeks ago
.solcover.js Use Prettier for JS files (#3913) 9 months ago Use the _update mechanism in ERC721 (#4377) 2 months ago Update guidelines and project documentation (#3966) 9 months ago Add `` docs (#3981) 8 months ago Follow _approve overrides in ERC721._update (#4552) 1 month ago
LICENSE Update guidelines and project documentation (#3966) 9 months ago Fix blog link (#4532) 1 month ago Add `` docs (#3981) 8 months ago Update guidelines and project documentation (#3966) 9 months ago
foundry.toml Fix spurious CI check failures (#4160) 6 months ago
hardhat.config.js Update pragma to 0.8.20 (#4489) 2 months ago
logo.svg use svg logo for better scaling 3 years ago
netlify.toml Fix documentation previews in pull requests (#2015) 4 years ago
package-lock.json Update linters (major) (#4563) 3 weeks ago
package.json Update linters (major) (#4563) 3 weeks ago
remappings.txt Update remappings and install instructions for Foundry on docs site (#4498) 2 months ago
renovate.json Update renovate.json 8 months ago
requirements.txt Migrate FV specs to CVL2 (#4527) 3 weeks ago
slither.config.json Enable more Slither detectors (#4219) 5 months ago
solhint.config.js Add custom linting rules (#4132) 3 months ago

Warning Version 5.0 is under active development. The code in this branch is not recommended for use.


NPM Package Coverage Status GitPOAPs Docs Forum

A library for secure smart contract development. Build on a solid foundation of community-vetted code.

🧙 Not sure how to get started? Check out Contracts Wizard — an interactive smart contract generator.

🏗️ Want to scale your decentralized application? Check out OpenZeppelin Defender — a secure platform for automating and monitoring your operations.



Hardhat, Truffle (npm)

$ npm install @openzeppelin/contracts

OpenZeppelin Contracts features a stable API, which means that your contracts won't break unexpectedly when upgrading to a newer minor version.

Foundry (git)

Warning When installing via git, it is a common error to use the master branch. This is a development branch that should be avoided in favor of tagged releases. The release process involves security measures that the master branch does not guarantee.

Warning Foundry installs the latest version initially, but subsequent forge update commands will use the master branch.

$ forge install OpenZeppelin/openzeppelin-contracts

Add @openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/ in remappings.txt.


Once installed, you can use the contracts in the library by importing them:

pragma solidity ^0.8.20;

import {ERC721} from "@openzeppelin/contracts/token/ERC721/ERC721.sol";

contract MyCollectible is ERC721 {
    constructor() ERC721("MyCollectible", "MCO") {

If you're new to smart contract development, head to Developing Smart Contracts to learn about creating a new project and compiling your contracts.

To keep your system secure, you should always use the installed code as-is, and neither copy-paste it from online sources nor modify it yourself. The library is designed so that only the contracts and functions you use are deployed, so you don't need to worry about it needlessly increasing gas costs.

Learn More

The guides in the documentation site will teach about different concepts, and how to use the related contracts that OpenZeppelin Contracts provides:

  • Access Control: decide who can perform each of the actions on your system.
  • Tokens: create tradeable assets or collectives, and distribute them via Crowdsales.
  • Utilities: generic useful tools including non-overflowing math, signature verification, and trustless paying systems.

The full API is also thoroughly documented, and serves as a great reference when developing your smart contract application. You can also ask for help or follow Contracts's development in the community forum.

Finally, you may want to take a look at the guides on our blog, which cover several common use cases and good practices. The following articles provide great background reading, though please note that some of the referenced tools have changed, as the tooling in the ecosystem continues to rapidly evolve.


This project is maintained by OpenZeppelin with the goal of providing a secure and reliable library of smart contract components for the ecosystem. We address security through risk management in various areas such as engineering and open source best practices, scoping and API design, multi-layered review processes, and incident response preparedness.

The OpenZeppelin Contracts Security Center contains more details about the secure development process.

The security policy is detailed in as well, and specifies how you can report security vulnerabilities, which versions will receive security patches, and how to stay informed about them. We run a bug bounty program on Immunefi to reward the responsible disclosure of vulnerabilities.

The engineering guidelines we follow to promote project quality can be found in

Past audits can be found in audits/.

Smart contracts are a nascent technology and carry a high level of technical risk and uncertainty. Although OpenZeppelin is well known for its security audits, using OpenZeppelin Contracts is not a substitute for a security audit.

OpenZeppelin Contracts is made available under the MIT License, which disclaims all warranties in relation to the project and which limits the liability of those that contribute and maintain the project, including OpenZeppelin. As set out further in the Terms, you acknowledge that you are solely responsible for any use of OpenZeppelin Contracts and you assume all risks associated with any such use.


OpenZeppelin Contracts exists thanks to its contributors. There are many ways you can participate and help build high quality software. Check out the contribution guide!


OpenZeppelin Contracts is released under the MIT License.

Your use of this Project is governed by the terms found at (the "Terms").