NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add comment and tests for zero address behavior in Ownable2Step.transferOwnership() (#5226)

Browse Source 
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com>
This commit is contained in:
PurrProof
2024-09-25 17:34:12 +02:00
committed by Hadrien Croubois
parent ce7376ea8a
commit e747501394
2 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
contracts/access/Ownable2Step.sol
View File

@ -37,6 +37,8 @@ abstract contract Ownable2Step is Ownable {
/**
* @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one.
* Can only be called by the current owner.
*
* Setting `newOwner` to the zero address is allowed; this can be used to cancel an initiated ownership transfer.
*/
function transferOwnership(address newOwner) public virtual override onlyOwner {
_pendingOwner = newOwner;

17
test/access/Ownable2Step.test.js
View File

@ -81,5 +81,22 @@ describe('Ownable2Step', function () {
expect(await this.ownable2Step.owner()).to.equal(this.accountA);
});
it('allows the owner to cancel an initiated ownership transfer by setting newOwner to zero address', async function () {
// initiate ownership transfer to accountA
await this.ownable2Step.connect(this.owner).transferOwnership(this.accountA);
expect(await this.ownable2Step.pendingOwner()).to.equal(this.accountA);
// cancel the ownership transfer by setting newOwner to zero address
await expect(this.ownable2Step.connect(this.owner).transferOwnership(ethers.ZeroAddress))
.to.emit(this.ownable2Step, 'OwnershipTransferStarted')
.withArgs(this.owner, ethers.ZeroAddress);
expect(await this.ownable2Step.pendingOwner()).to.equal(ethers.ZeroAddress);
// verify that accountA cannot accept ownership anymore
await expect(this.ownable2Step.connect(this.accountA).acceptOwnership())
.to.be.revertedWithCustomError(this.ownable2Step, 'OwnableUnauthorizedAccount')
.withArgs(this.accountA);
});
});
});