Frequently Asked Questions (FAQ)

When will the next version of an OpenZeppelin project be released?

See the OpenZeppelin open-source processes: Redesigning OpenZeppelin open-source processes

Where can I find documentation on OpenZeppelin projects?

Documentation for OpenZeppelin projects is at docs.openzeppelin.com

What does it mean for OpenZeppelin to have a stable API?

See OpenZeppelin Contracts API Stability for an in-depth discussion of this topic.

What is the difference between @openzeppelin/contracts and @openzeppelin/contracts-ethereum-package?

@openzeppelin/contracts is set up for general usage, while @openzeppelin/contracts-ethereum-package is tailored for being used with OpenZeppelin Upgrades. This means that its contracts are already set up to be upgradeable.

Can my project/EIP be added to OpenZeppelin?

We're always open to including new features in the library! Start a new topic under the OpenZeppelin category describing your feature and why it's a good idea, along with some general use cases and requirements for it.

Accepted features typically go through a short design phase until an API is settled on, at which point we're ready to start taking in Pull Requests. Opening a PR before said design is final is discouraged, since usually some discussion is required before a merge, which often means refactoring the proposed code.