Add notice that tryCaller is for tests only

OpenZeppelin · Oct 26, 2023 · ad90687 · ad90687
1 parent e0a92dc
commit ad90687
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/Upgrades.sol b/src/Upgrades.sol
@@ -158,6 +158,8 @@ library Upgrades {
     }
 
     /**
+     * @notice For tests only.
+     *
      * @dev Upgrades a proxy to a new implementation contract. Only supported for UUPS or transparent proxies.
      *
      * Requires that either the `referenceContract` option is set, or the new implementation contract has a `@custom:oz-upgrades-from <reference>` annotation.
@@ -182,6 +184,8 @@ library Upgrades {
     }
 
     /**
+     * @notice For tests only.
+     *
      * @dev Upgrades a proxy to a new implementation contract. Only supported for UUPS or transparent proxies.
      *
      * Requires that either the `referenceContract` option is set, or the new implementation contract has a `@custom:oz-upgrades-from <reference>` annotation.
@@ -261,6 +265,8 @@ library Upgrades {
     }
 
     /**
+     * @notice For tests only.
+     *
      * @dev Upgrades a beacon to a new implementation contract.
      *
      * Requires that either the `referenceContract` option is set, or the new implementation contract has a `@custom:oz-upgrades-from <reference>` annotation.
@@ -283,6 +289,8 @@ library Upgrades {
     }
 
     /**
+     * @notice For tests only.
+     *
      * @dev Upgrades a beacon to a new implementation contract.
      *
      * Requires that either the `referenceContract` option is set, or the new implementation contract has a `@custom:oz-upgrades-from <reference>` annotation.
@@ -401,6 +409,7 @@ library Upgrades {
     }
 
     /**
+     * @notice For tests only.
      * @dev Runs a function as a prank, or just runs the function normally if the prank could not be started.
      */
     modifier tryPrank(address deployer) {