feat: add meta-tx (erc2771) support to account register and namespace (#17)

* forge install: openzeppelin-contracts

* add oz remappings

* feat: add erc2771context to account registry

* feat: add erc2771 context to namespace

* update gas snapshot

Author: varunsrin

.gas-snapshot

@@ -1,70 +1,70 @@
-AccountRegistryTest:testCancelRecoveryFromCustodyAddress() (gas: 134604)
-AccountRegistryTest:testCancelRecoveryFromRecoveryAddress() (gas: 134769)
-AccountRegistryTest:testCannotCancelRecoveryIfNotStarted() (gas: 92888)
-AccountRegistryTest:testCannotCancelRecoveryIfUnauthorized() (gas: 143224)
-AccountRegistryTest:testCannotCompleteRecoveryIfNotStarted() (gas: 103867)
-AccountRegistryTest:testCannotCompleteRecoveryIfUnauthorized() (gas: 145950)
-AccountRegistryTest:testCannotCompleteRecoveryToAddressThatOwnsAnId() (gas: 170083)
-AccountRegistryTest:testCannotCompleteRecoveryWhenInEscrow() (gas: 143753)
-AccountRegistryTest:testCannotRegisterTwice() (gas: 59151)
-AccountRegistryTest:testCannotRequestRecoveryToAddressThatOwnsAnId() (gas: 115813)
-AccountRegistryTest:testCannotRequestRecoveryUnlessAuthorized() (gas: 69253)
-AccountRegistryTest:testCannotRequestRecoveryUnlessIssued() (gas: 17797)
-AccountRegistryTest:testCannotSetRecoveryAddressWithoutId() (gas: 18880)
-AccountRegistryTest:testCannotTransferIfNoId() (gas: 21689)
-AccountRegistryTest:testCannotTransferToAddressWithId() (gas: 90461)
-AccountRegistryTest:testRecoveryCompletion() (gas: 133042)
-AccountRegistryTest:testRegister() (gas: 89924)
-AccountRegistryTest:testRequestRecovery() (gas: 144812)
-AccountRegistryTest:testSetRecoveryAddress() (gas: 95325)
-AccountRegistryTest:testTransfer() (gas: 75750)
-NameSpaceTest:testBidAfterOneStep() (gas: 220057)
-NameSpaceTest:testBidAndOverpay() (gas: 215676)
-NameSpaceTest:testBidFlatRate() (gas: 218435)
-NameSpaceTest:testBidImmediately() (gas: 231728)
-NameSpaceTest:testBidOnHundredthStep() (gas: 218435)
-NameSpaceTest:testBidOnPenultimateStep() (gas: 218425)
-NameSpaceTest:testBidShouldClearRecovery() (gas: 261975)
-NameSpaceTest:testCancelRecoveryFromCustodyAddress() (gas: 223880)
-NameSpaceTest:testCancelRecoveryFromRecoveryAddress() (gas: 223486)
+AccountRegistryTest:testCancelRecoveryFromCustodyAddress() (gas: 135294)
+AccountRegistryTest:testCancelRecoveryFromRecoveryAddress() (gas: 135469)
+AccountRegistryTest:testCannotCancelRecoveryIfNotStarted() (gas: 93253)
+AccountRegistryTest:testCannotCancelRecoveryIfUnauthorized() (gas: 143722)
+AccountRegistryTest:testCannotCompleteRecoveryIfNotStarted() (gas: 104236)
+AccountRegistryTest:testCannotCompleteRecoveryIfUnauthorized() (gas: 146409)
+AccountRegistryTest:testCannotCompleteRecoveryToAddressThatOwnsAnId() (gas: 170667)
+AccountRegistryTest:testCannotCompleteRecoveryWhenInEscrow() (gas: 144212)
+AccountRegistryTest:testCannotRegisterTwice() (gas: 59413)
+AccountRegistryTest:testCannotRequestRecoveryToAddressThatOwnsAnId() (gas: 116341)
+AccountRegistryTest:testCannotRequestRecoveryUnlessAuthorized() (gas: 69534)
+AccountRegistryTest:testCannotRequestRecoveryUnlessIssued() (gas: 17887)
+AccountRegistryTest:testCannotSetRecoveryAddressWithoutId() (gas: 19024)
+AccountRegistryTest:testCannotTransferIfNoId() (gas: 21856)
+AccountRegistryTest:testCannotTransferToAddressWithId() (gas: 90944)
+AccountRegistryTest:testRecoveryCompletion() (gas: 133409)
+AccountRegistryTest:testRegister() (gas: 90240)
+AccountRegistryTest:testRequestRecovery() (gas: 145181)
+AccountRegistryTest:testSetRecoveryAddress() (gas: 95738)
+AccountRegistryTest:testTransfer() (gas: 76111)
+NameSpaceTest:testBidAfterOneStep() (gas: 220251)
+NameSpaceTest:testBidAndOverpay() (gas: 215870)
+NameSpaceTest:testBidFlatRate() (gas: 218629)
+NameSpaceTest:testBidImmediately() (gas: 231922)
+NameSpaceTest:testBidOnHundredthStep() (gas: 218629)
+NameSpaceTest:testBidOnPenultimateStep() (gas: 218619)
+NameSpaceTest:testBidShouldClearRecovery() (gas: 262274)
+NameSpaceTest:testCancelRecoveryFromCustodyAddress() (gas: 224337)
+NameSpaceTest:testCancelRecoveryFromRecoveryAddress() (gas: 223953)
 NameSpaceTest:testCannotBidIfRegistrable() (gas: 30917)
-NameSpaceTest:testCannotBidUnlessBiddable() (gas: 175767)
-NameSpaceTest:testCannotCancelRecoveryIfNotStarted() (gas: 188104)
-NameSpaceTest:testCannotCancelRecoveryIfUnauthorized() (gas: 234673)
+NameSpaceTest:testCannotBidUnlessBiddable() (gas: 175857)
+NameSpaceTest:testCannotCancelRecoveryIfNotStarted() (gas: 188379)
+NameSpaceTest:testCannotCancelRecoveryIfUnauthorized() (gas: 235048)
 NameSpaceTest:testCannotCommitWithInvalidName() (gas: 22838)
-NameSpaceTest:testCannotCompleteRecoveryIfExpired() (gas: 246680)
-NameSpaceTest:testCannotCompleteRecoveryIfNotStarted() (gas: 192361)
-NameSpaceTest:testCannotCompleteRecoveryIfUnauthorized() (gas: 219947)
-NameSpaceTest:testCannotCompleteRecoveryWhenInEscrow() (gas: 236285)
+NameSpaceTest:testCannotCompleteRecoveryIfExpired() (gas: 246950)
+NameSpaceTest:testCannotCompleteRecoveryIfNotStarted() (gas: 192631)
+NameSpaceTest:testCannotCompleteRecoveryIfUnauthorized() (gas: 220397)
+NameSpaceTest:testCannotCompleteRecoveryWhenInEscrow() (gas: 236645)
 NameSpaceTest:testCannotReclaimUnlessMinted() (gas: 17407)
 NameSpaceTest:testCannotRegisterBeforeDelay() (gas: 90808)
 NameSpaceTest:testCannotRegisterWithoutPayment() (gas: 85835)
-NameSpaceTest:testCannotRenewIfBiddable() (gas: 165411)
-NameSpaceTest:testCannotRenewIfRegistered() (gas: 165495)
+NameSpaceTest:testCannotRenewIfBiddable() (gas: 165501)
+NameSpaceTest:testCannotRenewIfRegistered() (gas: 165585)
 NameSpaceTest:testCannotRenewIfRegistrable() (gas: 31908)
 NameSpaceTest:testCannotRenewIfRegistrable2() (gas: 31950)
-NameSpaceTest:testCannotRenewWithoutPayment() (gas: 158554)
-NameSpaceTest:testCannotRequestRecoveryIfRegistrable() (gas: 26459)
-NameSpaceTest:testCannotRequestRecoveryToZeroAddr() (gas: 187942)
-NameSpaceTest:testCannotRequestRecoveryUnlessAuthorized() (gas: 166372)
-NameSpaceTest:testCannotSetRecoveryIfExpired() (gas: 167538)
-NameSpaceTest:testCannotSetRecoveryIfRegistrable() (gas: 20896)
-NameSpaceTest:testCannotSetRecoveryUnlessOwner() (gas: 161134)
+NameSpaceTest:testCannotRenewWithoutPayment() (gas: 158644)
+NameSpaceTest:testCannotRequestRecoveryIfRegistrable() (gas: 26549)
+NameSpaceTest:testCannotRequestRecoveryToZeroAddr() (gas: 188122)
+NameSpaceTest:testCannotRequestRecoveryUnlessAuthorized() (gas: 166552)
+NameSpaceTest:testCannotSetRecoveryIfExpired() (gas: 167808)
+NameSpaceTest:testCannotSetRecoveryIfRegistrable() (gas: 20986)
+NameSpaceTest:testCannotSetRecoveryUnlessOwner() (gas: 161314)
 NameSpaceTest:testCurrYear() (gas: 78247)
 NameSpaceTest:testCurrYearPayment() (gas: 45881)
 NameSpaceTest:testGenerateCommit() (gas: 40350)
-NameSpaceTest:testOwnerOfRevertsIfExpired() (gas: 155313)
+NameSpaceTest:testOwnerOfRevertsIfExpired() (gas: 155403)
 NameSpaceTest:testOwnerOfRevertsIfRegistrable() (gas: 12872)
-NameSpaceTest:testReclaimBiddableNames() (gas: 184070)
-NameSpaceTest:testReclaimRegisteredNames() (gas: 192240)
-NameSpaceTest:testReclaimRenewableNames() (gas: 184124)
-NameSpaceTest:testReclaimResetsRecoveryState() (gas: 228103)
-NameSpaceTest:testRecoveryCompletion() (gas: 247168)
-NameSpaceTest:testRegister() (gas: 259089)
-NameSpaceTest:testRenewOther() (gas: 176902)
-NameSpaceTest:testRenewSelf() (gas: 174319)
-NameSpaceTest:testRenewWithOverpayment() (gas: 179869)
-NameSpaceTest:testRequestRecovery() (gas: 244135)
-NameSpaceTest:testSetRecoveryAddress() (gas: 192253)
-NameSpaceTest:testTransferFromCannotTransferExpiredName() (gas: 173939)
-NameSpaceTest:testTransferFromResetsRecovery() (gas: 227445)
+NameSpaceTest:testReclaimBiddableNames() (gas: 184160)
+NameSpaceTest:testReclaimRegisteredNames() (gas: 192312)
+NameSpaceTest:testReclaimRenewableNames() (gas: 184214)
+NameSpaceTest:testReclaimResetsRecoveryState() (gas: 228319)
+NameSpaceTest:testRecoveryCompletion() (gas: 247456)
+NameSpaceTest:testRegister() (gas: 259269)
+NameSpaceTest:testRenewOther() (gas: 177082)
+NameSpaceTest:testRenewSelf() (gas: 174499)
+NameSpaceTest:testRenewWithOverpayment() (gas: 180049)
+NameSpaceTest:testRequestRecovery() (gas: 244495)
+NameSpaceTest:testSetRecoveryAddress() (gas: 192523)
+NameSpaceTest:testTransferFromCannotTransferExpiredName() (gas: 174029)
+NameSpaceTest:testTransferFromResetsRecovery() (gas: 227661)

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "lib/solmate"]
 	path = lib/solmate
 	url = https://github.com/Rari-Capital/solmate
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/openzeppelin/openzeppelin-contracts

lib/openzeppelin-contracts

@@ -1,2 +1,3 @@
 ds-test/=lib/forge-std/lib/ds-test/src/
 forge-std/=lib/forge-std/src/
+@openzeppelin/=lib/openzeppelin-contracts/

remappings.txt

@@ -6,10 +6,12 @@ import "forge-std/Script.sol";
 import {AccountRegistry} from "../src/AccountRegistry.sol";
 
 contract AccountRegistryScript is Script {
+    address gorliTrustedForwarder = address(0x7A95fA73250dc53556d264522150A940d4C50238);
+
     function setUp() public {}
 
     function run() public {
         vm.broadcast();
-        new AccountRegistry();
+        new AccountRegistry(gorliTrustedForwarder);
     }
 }

script/AccountRegistry.s.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.15;
 
+import {ERC2771Context} from "../lib/openzeppelin-contracts/contracts/metatx/ERC2771Context.sol";
+
 error Unauthorized(); // The caller does not have the authority to perform this action.
 error ZeroId(); // The id is zero, which is invalid
 error HasId(); // The custody address has another id
@@ -20,7 +22,9 @@ error Escrow(); // The recovery request is still in escrow
  *
  * @dev Function calls use payable to marginally reduce gas usage.
  */
-contract AccountRegistry {
+contract AccountRegistry is ERC2771Context {
+    constructor(address _trustedForwarder) ERC2771Context(_trustedForwarder) {}
+
     /*//////////////////////////////////////////////////////////////
                         REGISTRY EVENTS
     //////////////////////////////////////////////////////////////*/
@@ -77,14 +81,16 @@ contract AccountRegistry {
      *      to overflow given that every increment requires a new on-chain transaction.
      */
     function register() external payable {
-        if (idOf[msg.sender] != 0) revert HasId();
+        address _msgSender = _msgSender();
+
+        if (idOf[_msgSender] != 0) revert HasId();
 
         unchecked {
             idCounter++;
         }
 
-        idOf[msg.sender] = idCounter;
-        emit Register(msg.sender, idCounter);
+        idOf[_msgSender] = idCounter;
+        emit Register(_msgSender, idCounter);
     }
 
     /*//////////////////////////////////////////////////////////////
@@ -98,13 +104,14 @@ contract AccountRegistry {
      * @param to The address to transfer the id to.
      */
     function transfer(address to) external payable {
-        uint256 id = idOf[msg.sender];
+        address _msgSender = _msgSender();
+        uint256 id = idOf[_msgSender];
 
         if (id == 0) revert ZeroId();
 
         if (idOf[to] != 0) revert HasId();
 
-        _unsafeTransfer(id, msg.sender, to);
+        _unsafeTransfer(id, _msgSender, to);
     }
 
     /**
@@ -131,12 +138,12 @@ contract AccountRegistry {
     //////////////////////////////////////////////////////////////*/
 
     /**
-     * INVARIANT 1:  idOf[address] != 0 if msg.sender == recoveryOf[idOf[address]] during
+     * INVARIANT 1:  idOf[address] != 0 if _msgSender() == recoveryOf[idOf[address]] during
      * invocation of requestRecovery, completeRecovery and cancelRecovery
      *
      * recoveryOf[idOf[address]] != address(0) only if idOf[address] != 0 [setRecoveryAddress]
      * when idOf[address] == 0, recoveryof[idOf[address]] also == address(0) [_unsafeTransfer]
-     * msg.sender != address(0) [by definition]
+     * _msgSender() != address(0) [by definition]
      *
      * INVARIANT 2:  idOf[address] != 0 if recoveryClockOf[idOf[address]] != 0
      *
@@ -155,7 +162,7 @@ contract AccountRegistry {
      * @param recoveryAddress the address to set as the recovery.
      */
     function setRecoveryAddress(address recoveryAddress) external payable {
-        uint256 id = idOf[msg.sender];
+        uint256 id = idOf[_msgSender()];
 
         if (id == 0) revert ZeroId();
 
@@ -177,7 +184,7 @@ contract AccountRegistry {
     function requestRecovery(address from, address to) external payable {
         uint256 id = idOf[from];
 
-        if (msg.sender != recoveryOf[id]) revert Unauthorized();
+        if (_msgSender() != recoveryOf[id]) revert Unauthorized();
         if (idOf[to] != 0) revert HasId();
 
         recoveryClockOf[id] = block.timestamp;
@@ -197,7 +204,7 @@ contract AccountRegistry {
         uint256 id = idOf[from];
         address destination = recoveryDestinationOf[id];
 
-        if (msg.sender != recoveryOf[id]) revert Unauthorized();
+        if (_msgSender() != recoveryOf[id]) revert Unauthorized();
         if (recoveryClockOf[id] == 0) revert NoRecovery();
 
         if (block.timestamp < recoveryClockOf[id] + 259_200) revert Escrow();
@@ -218,7 +225,9 @@ contract AccountRegistry {
     function cancelRecovery(address from) external payable {
         uint256 id = idOf[from];
 
-        if (msg.sender != from && msg.sender != recoveryOf[id]) revert Unauthorized();
+        address _msgSender = _msgSender();
+
+        if (_msgSender != from && _msgSender != recoveryOf[id]) revert Unauthorized();
         if (recoveryClockOf[id] == 0) revert NoRecovery();
 
         emit CancelRecovery(id);

src/AccountRegistry.sol

@@ -2,10 +2,9 @@
 pragma solidity ^0.8.15;
 
 import {ERC721} from "../lib/solmate/src/tokens/ERC721.sol";
-
 import {Owned} from "../lib/solmate/src/auth/Owned.sol";
-
 import {FixedPointMathLib} from "../lib/solmate/src/utils/FixedPointMathLib.sol";
+import {ERC2771Context} from "../lib/openzeppelin-contracts/contracts/metatx/ERC2771Context.sol";
 
 error InsufficientFunds(); // The transaction does not have enough money to pay for this.
 error Unauthorized(); // The caller is not authorized to perform this action.
@@ -31,7 +30,7 @@ error InvalidRecovery(); // The recovery address is being set to the custody add
  * @title Namespace
  * @author varunsrin
  */
-contract Namespace is ERC721, Owned {
+contract Namespace is ERC721, Owned, ERC2771Context {
     using FixedPointMathLib for uint256;
 
     /*//////////////////////////////////////////////////////////////
@@ -116,8 +115,9 @@ contract Namespace is ERC721, Owned {
         string memory _name,
         string memory _symbol,
         address _owner,
-        address _vault
-    ) ERC721(_name, _symbol) Owned(_owner) {
+        address _vault,
+        address _trustedForwarder
+    ) ERC721(_name, _symbol) Owned(_owner) ERC2771Context(_trustedForwarder) {
         vault = _vault;
     }
 
@@ -199,7 +199,7 @@ contract Namespace is ERC721, Owned {
             expiryOf[tokenId] = timestampOfYear(currYear() + 1);
         }
 
-        payable(msg.sender).transfer(msg.value - _currYearFee);
+        payable(_msgSender()).transfer(msg.value - _currYearFee);
     }
 
     /**
@@ -227,7 +227,7 @@ contract Namespace is ERC721, Owned {
 
         emit Renew(tokenId, expiryOf[tokenId]);
 
-        payable(msg.sender).transfer(msg.value - fee);
+        payable(_msgSender()).transfer(msg.value - fee);
     }
 
     /**
@@ -267,14 +267,16 @@ contract Namespace is ERC721, Owned {
 
         if (msg.value < price) revert InsufficientFunds();
 
-        _unsafeTransfer(msg.sender, tokenId);
+        address _msgSender = _msgSender();
+
+        _unsafeTransfer(_msgSender, tokenId);
 
         unchecked {
             // timestampOfYear(currentYear) is taken from a pre-determined list and cannot overflow
             expiryOf[tokenId] = timestampOfYear(currYear() + 1);
         }
 
-        payable(msg.sender).transfer(msg.value - price);
+        payable(_msgSender).transfer(msg.value - price);
     }
 
     /*//////////////////////////////////////////////////////////////
@@ -341,7 +343,7 @@ contract Namespace is ERC721, Owned {
      *                        set to zero to disable the recovery functionality.
      */
     function setRecoveryAddress(uint256 tokenId, address recoveryAddress) external payable {
-        if (ownerOf(tokenId) != msg.sender) revert Unauthorized();
+        if (ownerOf(tokenId) != _msgSender()) revert Unauthorized();
 
         recoveryOf[tokenId] = recoveryAddress;
         emit SetRecoveryAddress(recoveryAddress, tokenId);
@@ -365,7 +367,7 @@ contract Namespace is ERC721, Owned {
         if (to == address(0)) revert InvalidRecovery();
 
         // Invariant 3 ensures that a request cannot be made after ownership change without consent
-        if (msg.sender != recoveryOf[tokenId]) revert Unauthorized();
+        if (_msgSender() != recoveryOf[tokenId]) revert Unauthorized();
 
         recoveryClockOf[tokenId] = block.timestamp;
         recoveryDestinationOf[tokenId] = to;
@@ -383,7 +385,7 @@ contract Namespace is ERC721, Owned {
         if (block.timestamp >= expiryOf[tokenId]) revert Unauthorized();
 
         // Invariant 3 prevents unauthorized access if the name has been re-posessed by another.
-        if (msg.sender != recoveryOf[tokenId]) revert Unauthorized();
+        if (_msgSender() != recoveryOf[tokenId]) revert Unauthorized();
 
         // Invariant 3 ensures that a recovery request cannot be compeleted after a change of
         // ownership without explicit consent from the new owner
@@ -408,7 +410,8 @@ contract Namespace is ERC721, Owned {
      * @param tokenId the uint256 representation of the username.
      */
     function cancelRecovery(uint256 tokenId) external payable {
-        if (msg.sender != _ownerOf[tokenId] && msg.sender != recoveryOf[tokenId])
+        address _msgSender = _msgSender();
+        if (_msgSender != _ownerOf[tokenId] && _msgSender != recoveryOf[tokenId])
             revert Unauthorized();
 
         if (recoveryClockOf[tokenId] == 0) revert NoRecovery();

src/Namespace.sol

@@ -25,15 +25,16 @@ contract AccountRegistryTest is Test {
                         CONSTRUCTORS
     //////////////////////////////////////////////////////////////*/
 
-    function setUp() public {
-        accountRegistry = new AccountRegistry();
-    }
-
     address alice = address(0x123);
     address bob = address(0x456);
     address charlie = address(0x789);
+    address trustedForwarder = address(0xC8223c8AD514A19Cc10B0C94c39b52D4B43ee61A);
     uint256 escrowPeriod = 259_200;
 
+    function setUp() public {
+        accountRegistry = new AccountRegistry(trustedForwarder);
+    }
+
     /*//////////////////////////////////////////////////////////////
                        REGISTRATION TESTS
     //////////////////////////////////////////////////////////////*/