Update Ownable2Step.sol

OpenZeppelin · Nov 1, 2023 · 4c6fb8a · 4c6fb8a
1 parent 94697be
commit 4c6fb8a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/contracts/access/Ownable2Step.sol b/contracts/access/Ownable2Step.sol
@@ -10,6 +10,12 @@ import {Ownable} from "./Ownable.sol";
  * there is an account (an owner) that can be granted exclusive access to
  * specific functions.
  *
+ * This extension of the {Ownable} contract includes a two-step mechanism to transfer
+ * ownership, where the new owner must call {acceptOwnership} in order to replace the
+ * old one. This can help prevent common mistakes, such as transfers of ownership to
+ * incorrect accounts, or to contracts that are unable to interact with the 
+ * permission system.
+ *
  * The initial owner is specified at deployment time in the constructor for `Ownable`. This
  * can later be changed with {transferOwnership} and {acceptOwnership}.
  *