mirror of openzeppelin-contracts
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
github-actions[bot] 6ba452dea4
Merge release-v5.0 branch (#4787)
1 day ago
.changeset Make Multicall context-aware 2 days ago
.github Migrate Ownable tests (#4657) 2 months ago
audits Remove v5.0 release candidate note and add audit (#4663) 2 months ago
certora Use ERC-XXX syntax (#4730) 2 weeks ago
contracts Merge release-v5.0 branch (#4787) 1 day ago
docs Update Math `try*` operations return reference (#4775) 1 week ago
hardhat Migrate Ownable tests (#4657) 2 months ago
lib Merge release-v5.0 branch (#4787) 1 day ago
scripts Refactor EnumerableSet generation and tests (#4762) 2 weeks ago
test Make Multicall context-aware 2 days 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) 12 months ago
.gitignore Update remappings.txt for upgradeable contracts and set up submodule (#4639) 2 months ago
.gitmodules Bump and pin Forge Std submodule (#4102) 9 months ago
.mocharc.js Use Hardhat recommended Mocha configuration (#2805) 2 years ago
.prettierrc Update linters (major) (#4563) 3 months ago
.solcover.js Use Prettier for JS files (#3913) 11 months ago
CHANGELOG.md Merge release-v5.0 branch (#4787) 1 day ago
CODE_OF_CONDUCT.md Update guidelines and project documentation (#3966) 11 months ago
CONTRIBUTING.md Add `RELEASING.md` docs (#3981) 10 months ago
FUNDING.json Create FUNDING.json (#4751) 2 weeks ago
GUIDELINES.md Use ERC-XXX syntax (#4730) 2 weeks ago
LICENSE Update guidelines and project documentation (#3966) 11 months ago
README.md Remove v5.0 release candidate note and add audit (#4663) 2 months ago
RELEASING.md Improve documentation about backwards compatibility (#4627) 2 months ago
SECURITY.md Update SECURITY.md and remove support for 2.x version (#4683) 4 weeks ago
foundry.toml Update remappings.txt for upgradeable contracts and set up submodule (#4639) 2 months ago
hardhat.config.js Migrate Ownable tests (#4657) 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 dependency @changesets/read to ^0.6.0 (#4764) 2 weeks ago
package.json Merge release-v5.0 branch (#4787) 1 day ago
remappings.txt Update remappings and install instructions for Foundry on docs site (#4498) 4 months ago
renovate.json Update renovate.json 10 months ago
requirements.txt Formal verification of AccessManager (#4611) 2 months ago
slither.config.json Enable more Slither detectors (#4219) 7 months ago
solhint.config.js Add custom linting rules (#4132) 5 months ago



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.

[!IMPORTANT] OpenZeppelin Contracts uses semantic versioning to communicate backwards compatibility of its API and storage layout. For upgradeable contracts, the storage layout of different major versions should be assumed incompatible, for example, it is unsafe to upgrade from 4.9.3 to 5.0.0. Learn more at Backwards Compatibility.



Hardhat, Truffle (npm)

$ npm install @openzeppelin/contracts

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 SECURITY.md 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 GUIDELINES.md.

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 www.openzeppelin.com/tos (the "Terms").