feat(evm): refactor to custom errors/delegate passthrough (#1185)

closes #392 closes #1168
unionlabs · Jan 22, 2024 · c984d2a · c984d2a
2 parents 432e324 + e4d7f48
commit c984d2a
Show file tree

Hide file tree

Showing 37 changed files with 1,365 additions and 1,332 deletions.
diff --git a/evm/contracts/apps/Base.sol b/evm/contracts/apps/Base.sol
@@ -1,8 +1,12 @@
-pragma solidity ^0.8.19;
+pragma solidity ^0.8.23;
 
-import "@openzeppelin/contracts/utils/Context.sol";
+import "@openzeppelin/utils/Context.sol";
 import "../core/05-port/IIBCModule.sol";
 
+library IBCAppLib {
+    error ErrNotIBC();
+}
+
 /**
  * @dev Base contract of the IBC App protocol
  */
@@ -24,10 +28,9 @@ abstract contract IBCAppBase is Context, IIBCModule {
      * @dev Throws if the sender is not the IBC contract.
      */
     function _checkIBC() internal view virtual {
-        require(
-            ibcAddress() == _msgSender(),
-            "IBCAppBase: caller is not the IBC contract"
-        );
+        if (ibcAddress() != _msgSender()) {
+            revert IBCAppLib.ErrNotIBC();
+        }
     }
 
     /**
@@ -128,6 +131,11 @@ abstract contract IBCAppBase is Context, IIBCModule {
         address relayer
     ) external virtual override onlyIBC {}
 
+    /**
+     * @dev See IIBCModule-onTimeoutPacket
+     *
+     * NOTE: You should apply an `onlyIBC` modifier to the function if a derived contract overrides it.
+     */
     function onTimeoutPacket(
         IbcCoreChannelV1Packet.Data calldata packet,
         address relayer

diff --git a/evm/contracts/apps/ucs/00-pingpong/PingPong.sol b/evm/contracts/apps/ucs/00-pingpong/PingPong.sol
@@ -89,19 +89,19 @@ contract PingPong is IBCAppBase {
         IbcCoreChannelV1Packet.Data calldata packet,
         address relayer
     ) external virtual override onlyIBC returns (bytes memory acknowledgement) {
-        PingPongPacket memory packet = PingPongPacketLib.decode(packet.data);
-        emit Ring(packet.ping);
-        uint64 counterpartyTimeoutRevisionNumber = packet
+        PingPongPacket memory pp = PingPongPacketLib.decode(packet.data);
+        emit Ring(pp.ping);
+        uint64 counterpartyTimeoutRevisionNumber = pp
             .counterpartyTimeoutRevisionNumber;
-        uint64 counterpartyTimeoutRevisionHeight = packet
+        uint64 counterpartyTimeoutRevisionHeight = pp
             .counterpartyTimeoutRevisionHeight;
-        packet.ping = !packet.ping;
-        packet.counterpartyTimeoutRevisionNumber = revisionNumber;
-        packet.counterpartyTimeoutRevisionHeight =
+        pp.ping = !pp.ping;
+        pp.counterpartyTimeoutRevisionNumber = revisionNumber;
+        pp.counterpartyTimeoutRevisionHeight =
             uint64(block.number) +
             numberOfBlockBeforePongTimeout;
         initiate(
-            packet,
+            pp,
             counterpartyTimeoutRevisionNumber,
             counterpartyTimeoutRevisionHeight
         );

diff --git a/evm/contracts/apps/ucs/01-relay/ERC20Denom.sol b/evm/contracts/apps/ucs/01-relay/ERC20Denom.sol
@@ -1,6 +1,6 @@
 pragma solidity ^0.8.23;
 
-import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+import "@openzeppelin/token/ERC20/ERC20.sol";
 import "./IERC20Denom.sol";
 
 contract ERC20Denom is ERC20, IERC20Denom {

diff --git a/evm/contracts/apps/ucs/01-relay/IERC20Denom.sol b/evm/contracts/apps/ucs/01-relay/IERC20Denom.sol
@@ -1,6 +1,6 @@
 pragma solidity ^0.8.23;
 
-import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import "@openzeppelin/token/ERC20/IERC20.sol";
 
 interface IERC20Denom is IERC20 {
     function mint(address to, uint256 amount) external;