Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,29 @@

## Overview

### Release tags

We use NPM tags to clearly distinguish between audited and non-audited versions of our package:

| Tag | Purpose | Description |
| :--------- | :----------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **latest** | ✅ Audited releases | Stable, audited versions of the package. This is the **default** version installed when users run `npm install @openzeppelin/contracts`. |
| **dev** | 🧪 Final but not audited | Versions that are finalized and feature-complete but have **not yet been audited**. This version is fully tested, can be used in production and is covered by the bug bounty. |
| **next** | 🚧 Release candidates | Pre-release versions that are **not final**. Used for testing and validation before the version becomes a final `dev` or `latest` release. |

### Installation

#### Hardhat (npm)

```
$ npm install @openzeppelin/contracts
```
→ Installs the latest audited release (`latest`).

```
$ npm install @openzeppelin/contracts@dev
```
→ Installs the latest unaudited release (`dev`).

#### Foundry (git)

Expand Down
30 changes: 30 additions & 0 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,30 @@ IMPORTANT: OpenZeppelin Contracts uses semantic versioning to communicate backwa

== Overview

[[release-tags]]
=== Release Tags

We use NPM tags to clearly distinguish between audited and non-audited versions of our package:

[%header,cols=3*]
|===
| *Tag*
| *Purpose*
| *Description*

| *latest*
| ✅ Audited releases
| Stable, audited versions of the package. This is the *default* version installed when users run `npm install @openzeppelin/contracts`.

| *dev*
| 🧪 Final but not audited
| Versions that are finalized and feature-complete but have *not yet been audited*. This version is fully tested, can be used in production and is covered by the bug bounty.

| *next*
| 🚧 Release candidates
| Pre-release versions that are *not final*. Used for testing and validation before the version becomes a final `dev` or `latest` release.
|===

[[install]]
=== Installation

Expand All @@ -18,6 +42,12 @@ IMPORTANT: OpenZeppelin Contracts uses semantic versioning to communicate backwa
```console
$ npm install @openzeppelin/contracts
```
→ Installs the latest audited release (`latest`).

```
$ npm install @openzeppelin/contracts@dev
```
→ Installs the latest unaudited release (`dev`).

==== Foundry (git)

Expand Down
30 changes: 18 additions & 12 deletions scripts/upgradeable/upgradeable.patch
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@ index ff596b0c3..000000000
-<!-- Make sure that you have reviewed the OpenZeppelin Contracts Contributor Guidelines. -->
-<!-- https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/CONTRIBUTING.md -->
diff --git a/README.md b/README.md
index 2f92281b3..a0e46695d 100644
index 6a01f5616..168b74aa7 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,9 @@
@@ -18,6 +18,9 @@
> [!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](https://docs.openzeppelin.com/contracts/backwards-compatibility).

Expand All @@ -71,17 +71,23 @@ index 2f92281b3..a0e46695d 100644
++
## Overview

### Installation
@@ -27,7 +30,7 @@
### Release tags
@@ -35,12 +38,12 @@ We use NPM tags to clearly distinguish between audited and non-audited versions
#### Hardhat (npm)

```
-$ npm install @openzeppelin/contracts
+$ npm install @openzeppelin/contracts-upgradeable
```
→ Installs the latest audited release (`latest`).

#### Foundry (git)
@@ -39,10 +42,10 @@ $ npm install @openzeppelin/contracts
```
-$ npm install @openzeppelin/contracts@dev
+$ npm install @openzeppelin/contracts-upgradeable@dev
```
→ Installs the latest unaudited release (`dev`).

@@ -53,10 +56,10 @@ $ npm install @openzeppelin/contracts@dev
> Foundry installs the latest version initially, but subsequent `forge update` commands will use the `master` branch.

```
Expand All @@ -94,7 +100,7 @@ index 2f92281b3..a0e46695d 100644

### Usage

@@ -51,10 +54,11 @@ Once installed, you can use the contracts in the library by importing them:
@@ -65,10 +68,11 @@ Once installed, you can use the contracts in the library by importing them:
```solidity
pragma solidity ^0.8.20;

Expand All @@ -110,15 +116,15 @@ index 2f92281b3..a0e46695d 100644
}
```
diff --git a/contracts/package.json b/contracts/package.json
index 8ccb9465e..509cd7f05 100644
index 3535a2f56..9a73abc22 100644
--- a/contracts/package.json
+++ b/contracts/package.json
@@ -1,5 +1,5 @@
{
- "name": "@openzeppelin/contracts",
+ "name": "@openzeppelin/contracts-upgradeable",
"description": "Secure Smart Contract library for Solidity",
"version": "5.4.0",
"version": "5.5.0",
"files": [
@@ -13,7 +13,7 @@
},
Expand All @@ -140,7 +146,7 @@ index 8ccb9465e..509cd7f05 100644
+ }
}
diff --git a/contracts/utils/ReentrancyGuard.sol b/contracts/utils/ReentrancyGuard.sol
index 6e44894dc..7b076aaa7 100644
index c156fa1cc..895e39342 100644
--- a/contracts/utils/ReentrancyGuard.sol
+++ b/contracts/utils/ReentrancyGuard.sol
@@ -36,6 +36,11 @@ abstract contract ReentrancyGuard {
Expand All @@ -167,7 +173,7 @@ index 6e44894dc..7b076aaa7 100644
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
diff --git a/contracts/utils/cryptography/EIP712.sol b/contracts/utils/cryptography/EIP712.sol
index 0eaef9d27..01f1b5f58 100644
index 2bc45a4b2..09e84815e 100644
--- a/contracts/utils/cryptography/EIP712.sol
+++ b/contracts/utils/cryptography/EIP712.sol
@@ -4,7 +4,6 @@
Expand Down Expand Up @@ -341,7 +347,7 @@ index 0eaef9d27..01f1b5f58 100644
}
}
diff --git a/package.json b/package.json
index f6960972a..369e2e1e6 100644
index 0e387a8e7..4f2a6bea6 100644
--- a/package.json
+++ b/package.json
@@ -35,7 +35,7 @@
Expand Down