fix ERC1404 visibility layers and move custom errors to internal interface

ItsNickBarry · ItsNickBarry · commit 41e9ba704212 · 2022-10-04T19:01:02.000-04:00
diff --git a/abi/ERC1404Base.json b/abi/ERC1404Base.json
@@ -1,4 +1,9 @@
 [
+  {
+    "inputs": [],
+    "name": "ERC1404Base__ArrayLengthMismatch",
+    "type": "error"
+  },
   {
     "inputs": [],
     "name": "ERC20Base__ApproveFromZeroAddress",
diff --git a/abi/ERC1404BaseInternal.json b/abi/ERC1404BaseInternal.json
@@ -1,4 +1,9 @@
 [
+  {
+    "inputs": [],
+    "name": "ERC1404Base__ArrayLengthMismatch",
+    "type": "error"
+  },
   {
     "inputs": [],
     "name": "ERC20Base__ApproveFromZeroAddress",
diff --git a/abi/ERC1404BaseStorage.json b/abi/ERC1404BaseStorage.json
diff --git a/abi/IERC1404Base.json b/abi/IERC1404Base.json
@@ -1,4 +1,54 @@
 [
+  {
+    "inputs": [],
+    "name": "ERC1404Base__ArrayLengthMismatch",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__ApproveFromZeroAddress",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__ApproveToZeroAddress",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__BurnExceedsBalance",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__BurnFromZeroAddress",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__InsufficientAllowance",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__MintToZeroAddress",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__TransferExceedsBalance",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__TransferFromZeroAddress",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__TransferToZeroAddress",
+    "type": "error"
+  },
   {
     "anonymous": false,
     "inputs": [
diff --git a/abi/IERC1404BaseInternal.json b/abi/IERC1404BaseInternal.json
@@ -0,0 +1,102 @@
+[
+  {
+    "inputs": [],
+    "name": "ERC1404Base__ArrayLengthMismatch",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__ApproveFromZeroAddress",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__ApproveToZeroAddress",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__BurnExceedsBalance",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__BurnFromZeroAddress",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__InsufficientAllowance",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__MintToZeroAddress",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__TransferExceedsBalance",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__TransferFromZeroAddress",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ERC20Base__TransferToZeroAddress",
+    "type": "error"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Approval",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Transfer",
+    "type": "event"
+  }
+]
diff --git a/abi/IERC1404Internal.json b/abi/IERC1404Internal.json
@@ -0,0 +1,52 @@
+[
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "spender",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Approval",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "from",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "to",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "value",
+        "type": "uint256"
+      }
+    ],
+    "name": "Transfer",
+    "type": "event"
+  }
+]
diff --git a/abi/ISolidStateERC1404.json b/abi/ISolidStateERC1404.json
@@ -1,4 +1,9 @@
 [
+  {
+    "inputs": [],
+    "name": "ERC1404Base__ArrayLengthMismatch",
+    "type": "error"
+  },
   {
     "inputs": [],
     "name": "ERC20Base__ApproveFromZeroAddress",
diff --git a/abi/SolidStateERC1404.json b/abi/SolidStateERC1404.json
@@ -14,6 +14,11 @@
     "name": "ECDSA__InvalidV",
     "type": "error"
   },
+  {
+    "inputs": [],
+    "name": "ERC1404Base__ArrayLengthMismatch",
+    "type": "error"
+  },
   {
     "inputs": [],
     "name": "ERC20Base__ApproveFromZeroAddress",
diff --git a/contracts/interfaces/IERC1404.sol b/contracts/interfaces/IERC1404.sol
@@ -3,12 +3,13 @@
 pragma solidity ^0.8.8;
 
 import { IERC20 } from './IERC20.sol';
+import { IERC1404Internal } from './IERC1404Internal.sol';
 
 /**
  * @title ERC1404 interface
  * @dev see https://github.com/ethereum/EIPs/issues/1404
  */
-interface IERC1404 is IERC20 {
+interface IERC1404 is IERC1404Internal, IERC20 {
     /**
      * @notice return restriction code resulting from given transaction parameters
      * @return restriction code (0 if no restriction exists)
diff --git a/contracts/interfaces/IERC1404Internal.sol b/contracts/interfaces/IERC1404Internal.sol
@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.8;
+
+import { IERC20Internal } from './IERC20Internal.sol';
+
+/**
+ * @title ERC1404 interface
+ * @dev see https://github.com/ethereum/EIPs/issues/1404
+ */
+interface IERC1404Internal is IERC20Internal {
+
+}
diff --git a/contracts/token/ERC1404/SolidStateERC1404Mock.sol b/contracts/token/ERC1404/SolidStateERC1404Mock.sol
@@ -3,13 +3,10 @@
 pragma solidity ^0.8.8;
 
 import { SolidStateERC1404 } from './SolidStateERC1404.sol';
-import { ERC1404BaseStorage } from './base/ERC1404BaseStorage.sol';
 
 contract SolidStateERC1404Mock is SolidStateERC1404 {
-    using ERC1404BaseStorage for ERC1404BaseStorage.Layout;
-
     constructor(uint8[] memory errorCodes, string[] memory errorMessages) {
-        ERC1404BaseStorage.layout().setRestrictions(errorCodes, errorMessages);
+        _setRestrictions(errorCodes, errorMessages);
     }
 
     function _detectTransferRestriction(
diff --git a/contracts/token/ERC1404/base/ERC1404BaseInternal.sol b/contracts/token/ERC1404/base/ERC1404BaseInternal.sol
@@ -4,14 +4,36 @@ pragma solidity ^0.8.8;
 
 import { IERC1404 } from '../../../interfaces/IERC1404.sol';
 import { ERC20BaseInternal } from '../../ERC20/base/ERC20BaseInternal.sol';
+import { IERC1404BaseInternal } from './IERC1404BaseInternal.sol';
 import { ERC1404BaseStorage } from './ERC1404BaseStorage.sol';
 
 /**
  * @title Base ERC1404 internal functions
  */
-abstract contract ERC1404BaseInternal is ERC20BaseInternal {
+abstract contract ERC1404BaseInternal is
+    IERC1404BaseInternal,
+    ERC20BaseInternal
+{
     using ERC1404BaseStorage for ERC1404BaseStorage.Layout;
 
+    function _setRestrictions(
+        uint8[] memory restrictionCodes,
+        string[] memory restrictionMessages
+    ) internal {
+        if (restrictionCodes.length != restrictionMessages.length)
+            revert ERC1404Base__ArrayLengthMismatch();
+
+        mapping(uint8 => string) storage restrictions = ERC1404BaseStorage
+            .layout()
+            .restrictions;
+
+        unchecked {
+            for (uint256 i; i < restrictionCodes.length; i++) {
+                restrictions[restrictionCodes[i]] = restrictionMessages[i];
+            }
+        }
+    }
+
     function _detectTransferRestriction(
         address from,
         address to,
@@ -24,8 +46,7 @@ abstract contract ERC1404BaseInternal is ERC20BaseInternal {
         virtual
         returns (string memory)
     {
-        return
-            ERC1404BaseStorage.layout().getRestrictionMessage(restrictionCode);
+        return ERC1404BaseStorage.layout().restrictions[restrictionCode];
     }
 
     /**
diff --git a/contracts/token/ERC1404/base/ERC1404BaseMock.sol b/contracts/token/ERC1404/base/ERC1404BaseMock.sol
@@ -3,13 +3,10 @@
 pragma solidity ^0.8.8;
 
 import { ERC1404Base } from './ERC1404Base.sol';
-import { ERC1404BaseStorage } from './ERC1404BaseStorage.sol';
 
 contract ERC1404BaseMock is ERC1404Base {
-    using ERC1404BaseStorage for ERC1404BaseStorage.Layout;
-
     constructor(uint8[] memory errorCodes, string[] memory errorMessages) {
-        ERC1404BaseStorage.layout().setRestrictions(errorCodes, errorMessages);
+        _setRestrictions(errorCodes, errorMessages);
     }
 
     function _detectTransferRestriction(
diff --git a/contracts/token/ERC1404/base/ERC1404BaseStorage.sol b/contracts/token/ERC1404/base/ERC1404BaseStorage.sol
diff --git a/contracts/token/ERC1404/base/IERC1404Base.sol b/contracts/token/ERC1404/base/IERC1404Base.sol
diff --git a/contracts/token/ERC1404/base/IERC1404BaseInternal.sol b/contracts/token/ERC1404/base/IERC1404BaseInternal.sol

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,9 @@`
`1`	`1`	`[`
	`2`	`+ {`
	`3`	`+ "inputs": [],`
	`4`	`+ "name": "ERC1404Base__ArrayLengthMismatch",`
	`5`	`+ "type": "error"`
	`6`	`+ },`
`2`	`7`	`{`
`3`	`8`	`"inputs": [],`
`4`	`9`	`"name": "ERC20Base__ApproveFromZeroAddress",`