From c7c6ae4e2a0a14aae3b52f0aaefd54ad66e6268d Mon Sep 17 00:00:00 2001 From: Guilherme Dantas Date: Tue, 30 May 2023 11:13:55 -0300 Subject: [PATCH] refactor(contracts): make portals and relays inherit "input relay" * Make portals and relays inherit `InputRelay` * Make portals and relays interfaces inherit `IInputRelay` --- onchain/rollups/contracts/portals/ERC1155BatchPortal.sol | 8 ++++---- onchain/rollups/contracts/portals/ERC1155SinglePortal.sol | 8 ++++---- onchain/rollups/contracts/portals/ERC20Portal.sol | 8 ++++---- onchain/rollups/contracts/portals/ERC721Portal.sol | 8 ++++---- onchain/rollups/contracts/portals/EtherPortal.sol | 8 ++++---- onchain/rollups/contracts/portals/IERC1155BatchPortal.sol | 4 ++-- .../rollups/contracts/portals/IERC1155SinglePortal.sol | 4 ++-- onchain/rollups/contracts/portals/IERC20Portal.sol | 4 ++-- onchain/rollups/contracts/portals/IERC721Portal.sol | 4 ++-- onchain/rollups/contracts/portals/IEtherPortal.sol | 4 ++-- onchain/rollups/contracts/relays/DAppAddressRelay.sol | 8 ++++---- onchain/rollups/contracts/relays/IDAppAddressRelay.sol | 4 ++-- 12 files changed, 36 insertions(+), 36 deletions(-) diff --git a/onchain/rollups/contracts/portals/ERC1155BatchPortal.sol b/onchain/rollups/contracts/portals/ERC1155BatchPortal.sol index e2b1228a..28a55b60 100644 --- a/onchain/rollups/contracts/portals/ERC1155BatchPortal.sol +++ b/onchain/rollups/contracts/portals/ERC1155BatchPortal.sol @@ -15,18 +15,18 @@ pragma solidity ^0.8.8; import {IERC1155} from "@openzeppelin/contracts/token/ERC1155/IERC1155.sol"; import {IERC1155BatchPortal} from "./IERC1155BatchPortal.sol"; -import {Portal} from "./Portal.sol"; -import {IInputBox} from "../inputs/IInputBox.sol"; +import {InputRelay} from "./InputRelay.sol"; +import {IInputBox} from "./IInputBox.sol"; import {InputEncoding} from "../common/InputEncoding.sol"; /// @title ERC-1155 Batch Transfer Portal /// /// @notice This contract allows anyone to perform batch transfers of /// ERC-1155 tokens to a DApp while informing the off-chain machine. -contract ERC1155BatchPortal is Portal, IERC1155BatchPortal { +contract ERC1155BatchPortal is InputRelay, IERC1155BatchPortal { /// @notice Constructs the portal. /// @param _inputBox The input box used by the portal - constructor(IInputBox _inputBox) Portal(_inputBox) {} + constructor(IInputBox _inputBox) InputRelay(_inputBox) {} function depositBatchERC1155Token( IERC1155 _token, diff --git a/onchain/rollups/contracts/portals/ERC1155SinglePortal.sol b/onchain/rollups/contracts/portals/ERC1155SinglePortal.sol index e1ad0849..dcaee52f 100644 --- a/onchain/rollups/contracts/portals/ERC1155SinglePortal.sol +++ b/onchain/rollups/contracts/portals/ERC1155SinglePortal.sol @@ -15,18 +15,18 @@ pragma solidity ^0.8.8; import {IERC1155} from "@openzeppelin/contracts/token/ERC1155/IERC1155.sol"; import {IERC1155SinglePortal} from "./IERC1155SinglePortal.sol"; -import {Portal} from "./Portal.sol"; -import {IInputBox} from "../inputs/IInputBox.sol"; +import {InputRelay} from "./InputRelay.sol"; +import {IInputBox} from "./IInputBox.sol"; import {InputEncoding} from "../common/InputEncoding.sol"; /// @title ERC-1155 Single Transfer Portal /// /// @notice This contract allows anyone to perform single transfers of /// ERC-1155 tokens to a DApp while informing the off-chain machine. -contract ERC1155SinglePortal is Portal, IERC1155SinglePortal { +contract ERC1155SinglePortal is InputRelay, IERC1155SinglePortal { /// @notice Constructs the portal. /// @param _inputBox The input box used by the portal - constructor(IInputBox _inputBox) Portal(_inputBox) {} + constructor(IInputBox _inputBox) InputRelay(_inputBox) {} function depositSingleERC1155Token( IERC1155 _token, diff --git a/onchain/rollups/contracts/portals/ERC20Portal.sol b/onchain/rollups/contracts/portals/ERC20Portal.sol index 06aad16f..5c0ad4eb 100644 --- a/onchain/rollups/contracts/portals/ERC20Portal.sol +++ b/onchain/rollups/contracts/portals/ERC20Portal.sol @@ -15,18 +15,18 @@ pragma solidity ^0.8.8; import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import {IERC20Portal} from "./IERC20Portal.sol"; -import {Portal} from "./Portal.sol"; -import {IInputBox} from "../inputs/IInputBox.sol"; +import {InputRelay} from "./InputRelay.sol"; +import {IInputBox} from "./IInputBox.sol"; import {InputEncoding} from "../common/InputEncoding.sol"; /// @title ERC-20 Portal /// /// @notice This contract allows anyone to perform transfers of /// ERC-20 tokens to a DApp while informing the off-chain machine. -contract ERC20Portal is Portal, IERC20Portal { +contract ERC20Portal is InputRelay, IERC20Portal { /// @notice Constructs the portal. /// @param _inputBox The input box used by the portal - constructor(IInputBox _inputBox) Portal(_inputBox) {} + constructor(IInputBox _inputBox) InputRelay(_inputBox) {} function depositERC20Tokens( IERC20 _token, diff --git a/onchain/rollups/contracts/portals/ERC721Portal.sol b/onchain/rollups/contracts/portals/ERC721Portal.sol index faaf7bd2..15f1a37f 100644 --- a/onchain/rollups/contracts/portals/ERC721Portal.sol +++ b/onchain/rollups/contracts/portals/ERC721Portal.sol @@ -15,18 +15,18 @@ pragma solidity ^0.8.8; import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol"; import {IERC721Portal} from "./IERC721Portal.sol"; -import {Portal} from "./Portal.sol"; -import {IInputBox} from "../inputs/IInputBox.sol"; +import {InputRelay} from "./InputRelay.sol"; +import {IInputBox} from "./IInputBox.sol"; import {InputEncoding} from "../common/InputEncoding.sol"; /// @title ERC-721 Portal /// /// @notice This contract allows anyone to perform transfers of /// ERC-721 tokens to a DApp while informing the off-chain machine. -contract ERC721Portal is Portal, IERC721Portal { +contract ERC721Portal is InputRelay, IERC721Portal { /// @notice Constructs the portal. /// @param _inputBox The input box used by the portal - constructor(IInputBox _inputBox) Portal(_inputBox) {} + constructor(IInputBox _inputBox) InputRelay(_inputBox) {} function depositERC721Token( IERC721 _token, diff --git a/onchain/rollups/contracts/portals/EtherPortal.sol b/onchain/rollups/contracts/portals/EtherPortal.sol index a3413874..902fa8fa 100644 --- a/onchain/rollups/contracts/portals/EtherPortal.sol +++ b/onchain/rollups/contracts/portals/EtherPortal.sol @@ -13,21 +13,21 @@ pragma solidity ^0.8.8; import {IEtherPortal} from "./IEtherPortal.sol"; -import {Portal} from "./Portal.sol"; -import {IInputBox} from "../inputs/IInputBox.sol"; +import {InputRelay} from "./InputRelay.sol"; +import {IInputBox} from "./IInputBox.sol"; import {InputEncoding} from "../common/InputEncoding.sol"; /// @title Ether Portal /// /// @notice This contract allows anyone to perform transfers of /// Ether to a DApp while informing the off-chain machine. -contract EtherPortal is Portal, IEtherPortal { +contract EtherPortal is InputRelay, IEtherPortal { /// @notice Raised when the Ether transfer fails. error EtherTransferFailed(); /// @notice Constructs the portal. /// @param _inputBox The input box used by the portal - constructor(IInputBox _inputBox) Portal(_inputBox) {} + constructor(IInputBox _inputBox) InputRelay(_inputBox) {} function depositEther( address _dapp, diff --git a/onchain/rollups/contracts/portals/IERC1155BatchPortal.sol b/onchain/rollups/contracts/portals/IERC1155BatchPortal.sol index 7915d42b..3906e590 100644 --- a/onchain/rollups/contracts/portals/IERC1155BatchPortal.sol +++ b/onchain/rollups/contracts/portals/IERC1155BatchPortal.sol @@ -12,11 +12,11 @@ pragma solidity ^0.8.8; -import {IPortal} from "./IPortal.sol"; +import {IInputRelay} from "./IInputRelay.sol"; import {IERC1155} from "@openzeppelin/contracts/token/ERC1155/IERC1155.sol"; /// @title ERC-1155 Batch Transfer Portal interface -interface IERC1155BatchPortal is IPortal { +interface IERC1155BatchPortal is IInputRelay { // Permissionless functions /// @notice Transfer a batch of ERC-1155 tokens to a DApp and add an input to diff --git a/onchain/rollups/contracts/portals/IERC1155SinglePortal.sol b/onchain/rollups/contracts/portals/IERC1155SinglePortal.sol index 138fcebe..403a4f4c 100644 --- a/onchain/rollups/contracts/portals/IERC1155SinglePortal.sol +++ b/onchain/rollups/contracts/portals/IERC1155SinglePortal.sol @@ -12,11 +12,11 @@ pragma solidity ^0.8.8; -import {IPortal} from "./IPortal.sol"; +import {IInputRelay} from "./IInputRelay.sol"; import {IERC1155} from "@openzeppelin/contracts/token/ERC1155/IERC1155.sol"; /// @title ERC-1155 Single Transfer Portal interface -interface IERC1155SinglePortal is IPortal { +interface IERC1155SinglePortal is IInputRelay { // Permissionless functions /// @notice Transfer an ERC-1155 token to a DApp and add an input to diff --git a/onchain/rollups/contracts/portals/IERC20Portal.sol b/onchain/rollups/contracts/portals/IERC20Portal.sol index 3eefc321..d51ab6cb 100644 --- a/onchain/rollups/contracts/portals/IERC20Portal.sol +++ b/onchain/rollups/contracts/portals/IERC20Portal.sol @@ -12,11 +12,11 @@ pragma solidity ^0.8.8; -import {IPortal} from "./IPortal.sol"; +import {IInputRelay} from "./IInputRelay.sol"; import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; /// @title ERC-20 Portal interface -interface IERC20Portal is IPortal { +interface IERC20Portal is IInputRelay { // Permissionless functions /// @notice Transfer ERC-20 tokens to a DApp and add an input to diff --git a/onchain/rollups/contracts/portals/IERC721Portal.sol b/onchain/rollups/contracts/portals/IERC721Portal.sol index b50eedf5..dbb385be 100644 --- a/onchain/rollups/contracts/portals/IERC721Portal.sol +++ b/onchain/rollups/contracts/portals/IERC721Portal.sol @@ -12,11 +12,11 @@ pragma solidity ^0.8.8; -import {IPortal} from "./IPortal.sol"; +import {IInputRelay} from "./IInputRelay.sol"; import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol"; /// @title ERC-721 Portal interface -interface IERC721Portal is IPortal { +interface IERC721Portal is IInputRelay { // Permissionless functions /// @notice Transfer an ERC-721 token to a DApp and add an input to diff --git a/onchain/rollups/contracts/portals/IEtherPortal.sol b/onchain/rollups/contracts/portals/IEtherPortal.sol index 102919a7..ae71240a 100644 --- a/onchain/rollups/contracts/portals/IEtherPortal.sol +++ b/onchain/rollups/contracts/portals/IEtherPortal.sol @@ -12,10 +12,10 @@ pragma solidity ^0.8.8; -import {IPortal} from "./IPortal.sol"; +import {IInputRelay} from "./IInputRelay.sol"; /// @title Ether Portal interface -interface IEtherPortal is IPortal { +interface IEtherPortal is IInputRelay { // Permissionless functions /// @notice Transfer Ether to a DApp and add an input to diff --git a/onchain/rollups/contracts/relays/DAppAddressRelay.sol b/onchain/rollups/contracts/relays/DAppAddressRelay.sol index 3cca3481..2f13e41a 100644 --- a/onchain/rollups/contracts/relays/DAppAddressRelay.sol +++ b/onchain/rollups/contracts/relays/DAppAddressRelay.sol @@ -13,18 +13,18 @@ pragma solidity ^0.8.8; import {IDAppAddressRelay} from "./IDAppAddressRelay.sol"; -import {Relay} from "./Relay.sol"; -import {IInputBox} from "../inputs/IInputBox.sol"; +import {InputRelay} from "./InputRelay.sol"; +import {IInputBox} from "./IInputBox.sol"; import {InputEncoding} from "../common/InputEncoding.sol"; /// @title DApp Address Relay /// /// @notice This contract allows anyone to inform the off-chain machine /// of the address of the DApp contract in a trustless and permissionless way. -contract DAppAddressRelay is Relay, IDAppAddressRelay { +contract DAppAddressRelay is InputRelay, IDAppAddressRelay { /// @notice Constructs the relay. /// @param _inputBox The input box used by the relay - constructor(IInputBox _inputBox) Relay(_inputBox) {} + constructor(IInputBox _inputBox) InputRelay(_inputBox) {} function relayDAppAddress(address _dapp) external override { bytes memory input = InputEncoding.encodeDAppAddressRelay(_dapp); diff --git a/onchain/rollups/contracts/relays/IDAppAddressRelay.sol b/onchain/rollups/contracts/relays/IDAppAddressRelay.sol index 661f616b..28369ca9 100644 --- a/onchain/rollups/contracts/relays/IDAppAddressRelay.sol +++ b/onchain/rollups/contracts/relays/IDAppAddressRelay.sol @@ -12,10 +12,10 @@ pragma solidity ^0.8.8; -import {IRelay} from "./IRelay.sol"; +import {IInputRelay} from "./IInputRelay.sol"; /// @title DApp Address Relay interface -interface IDAppAddressRelay is IRelay { +interface IDAppAddressRelay is IInputRelay { // Permissionless functions /// @notice Add an input to a DApp's input box with its address.