Add tests for PreimageOracle (#6293)

op-bindings/bindings/preimageoracle_more.go

@@ -15,7 +15,7 @@ var PreimageOracleStorageLayout = new(solc.StorageLayout)
 
 var PreimageOracleDeployedBin = "0x608060405234801561001057600080fd5b506004361061007d5760003560e01c8063e03110e11161005b578063e03110e114610111578063e159261114610139578063fe4ac08e1461014e578063fef2b4ed146101c357600080fd5b806361238bde146100825780638542cf50146100c0578063a57c202c146100fe575b600080fd5b6100ad610090366004610433565b600160209081526000928352604080842090915290825290205481565b6040519081526020015b60405180910390f35b6100ee6100ce366004610433565b600260209081526000928352604080842090915290825290205460ff1681565b60405190151581526020016100b7565b6100ad61010c36600461049e565b6101e3565b61012461011f366004610433565b610242565b604080519283526020830191909152016100b7565b61014c6101473660046104e0565b610333565b005b61014c61015c36600461052c565b6000838152600260209081526040808320878452825280832080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff001660019081179091558684528252808320968352958152858220939093559283529082905291902055565b6100ad6101d136600461055e565b60006020819052908152604090205481565b60243560c081901b608052600090608881858237207effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f0200000000000000000000000000000000000000000000000000000000000000179392505050565b6000828152600260209081526040808320848452909152812054819060ff166102cb576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601460248201527f7072652d696d616765206d757374206578697374000000000000000000000000604482015260640160405180910390fd5b50600083815260208181526040909120546102e78160086105a6565b6102f28560206105a6565b1061031057836103038260086105a6565b61030d91906105be565b91505b506000938452600160209081526040808620948652939052919092205492909150565b6044356000806008830186111561034957600080fd5b60c083901b6080526088838682378087017ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff80151908490207effffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff167f02000000000000000000000000000000000000000000000000000000000000001760008181526002602090815260408083208b8452825280832080547fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0016600190811790915584845282528083209a83529981528982209390935590815290819052959095209190915550505050565b6000806040838503121561044657600080fd5b50508035926020909101359150565b60008083601f84011261046757600080fd5b50813567ffffffffffffffff81111561047f57600080fd5b60208301915083602082850101111561049757600080fd5b9250929050565b600080602083850312156104b157600080fd5b823567ffffffffffffffff8111156104c857600080fd5b6104d485828601610455565b90969095509350505050565b6000806000604084860312156104f557600080fd5b83359250602084013567ffffffffffffffff81111561051357600080fd5b61051f86828701610455565b9497909650939450505050565b6000806000806080858703121561054257600080fd5b5050823594602084013594506040840135936060013592509050565b60006020828403121561057057600080fd5b5035919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b600082198211156105b9576105b9610577565b500190565b6000828210156105d0576105d0610577565b50039056fea164736f6c634300080f000a"
 
-var PreimageOracleDeployedSourceMap = "143:4615:58:-:0;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;356:68;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;413:25:228;;;401:2;386:18;356:68:58;;;;;;;;500:66;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;614:14:228;;607:22;589:41;;577:2;562:18;500:66:58;449:187:228;2153:850:58;;;;;;:::i;:::-;;:::i;837:564::-;;;;;;:::i;:::-;;:::i;:::-;;;;1581:25:228;;;1637:2;1622:18;;1615:34;;;;1554:18;837:564:58;1407:248:228;3294:1462:58;;;;;;:::i;:::-;;:::i;:::-;;1743:262;;;;;;:::i;:::-;1876:19;;;;:14;:19;;;;;;;;:31;;;;;;;;:38;;;;1910:4;1876:38;;;;;;1924:18;;;;;;;;:30;;;;;;;;;:37;;;;1971:20;;;;;;;;;;:27;1743:262;237:50;;;;;;:::i;:::-;;;;;;;;;;;;;;;2153:850;2320:4;2307:18;2566:3;2562:14;;;2457:4;2550:27;2230:12;;2597:11;2307:18;2717:16;2597:11;2699:41;2839:20;2953:19;2946:27;2975:11;2943:44;;2153:850;-1:-1:-1;;;2153:850:58:o;837:564::-;937:12;990:20;;;:14;:20;;;;;;;;:29;;;;;;;;;937:12;;990:29;;982:62;;;;;;;3101:2:228;982:62:58;;;3083:21:228;3140:2;3120:18;;;3113:30;3179:22;3159:18;;;3152:50;3219:18;;982:62:58;;;;;;;;-1:-1:-1;1175:14:58;1192:21;;;1163:2;1192:21;;;;;;;;1243:10;1192:21;1252:1;1243:10;:::i;:::-;1227:12;:7;1237:2;1227:12;:::i;:::-;:26;1223:87;;1292:7;1279:10;:6;1288:1;1279:10;:::i;:::-;:20;;;;:::i;:::-;1269:30;;1223:87;-1:-1:-1;1366:19:58;;;;:13;:19;;;;;;;;:28;;;;;;;;;;;;837:564;;-1:-1:-1;837:564:58:o;3294:1462::-;3590:4;3577:18;3395:12;;3719:1;3709:12;;3693:29;;3690:77;;;3751:1;3748;3741:12;3690:77;4010:3;4006:14;;;3910:4;3994:27;4041:11;4015:4;4160:16;4041:11;4142:41;4373:29;;;4377:11;4373:29;4367:36;4425:20;;;;4572:19;4565:27;4594:11;4562:44;4625:19;;;;4603:1;4625:19;;;;;;;;:32;;;;;;;;:39;;;;4660:4;4625:39;;;;;;4674:18;;;;;;;;:31;;;;;;;;;:38;;;;4722:20;;;;;;;;;;;:27;;;;-1:-1:-1;;;;3294:1462:58:o;14:248:228:-;82:6;90;143:2;131:9;122:7;118:23;114:32;111:52;;;159:1;156;149:12;111:52;-1:-1:-1;;182:23:228;;;252:2;237:18;;;224:32;;-1:-1:-1;14:248:228:o;641:347::-;692:8;702:6;756:3;749:4;741:6;737:17;733:27;723:55;;774:1;771;764:12;723:55;-1:-1:-1;797:20:228;;840:18;829:30;;826:50;;;872:1;869;862:12;826:50;909:4;901:6;897:17;885:29;;961:3;954:4;945:6;937;933:19;929:30;926:39;923:59;;;978:1;975;968:12;923:59;641:347;;;;;:::o;993:409::-;1063:6;1071;1124:2;1112:9;1103:7;1099:23;1095:32;1092:52;;;1140:1;1137;1130:12;1092:52;1180:9;1167:23;1213:18;1205:6;1202:30;1199:50;;;1245:1;1242;1235:12;1199:50;1284:58;1334:7;1325:6;1314:9;1310:22;1284:58;:::i;:::-;1361:8;;1258:84;;-1:-1:-1;993:409:228;-1:-1:-1;;;;993:409:228:o;1660:477::-;1739:6;1747;1755;1808:2;1796:9;1787:7;1783:23;1779:32;1776:52;;;1824:1;1821;1814:12;1776:52;1860:9;1847:23;1837:33;;1921:2;1910:9;1906:18;1893:32;1948:18;1940:6;1937:30;1934:50;;;1980:1;1977;1970:12;1934:50;2019:58;2069:7;2060:6;2049:9;2045:22;2019:58;:::i;:::-;1660:477;;2096:8;;-1:-1:-1;1993:84:228;;-1:-1:-1;;;;1660:477:228:o;2142:385::-;2228:6;2236;2244;2252;2305:3;2293:9;2284:7;2280:23;2276:33;2273:53;;;2322:1;2319;2312:12;2273:53;-1:-1:-1;;2345:23:228;;;2415:2;2400:18;;2387:32;;-1:-1:-1;2466:2:228;2451:18;;2438:32;;2517:2;2502:18;2489:32;;-1:-1:-1;2142:385:228;-1:-1:-1;2142:385:228:o;2532:180::-;2591:6;2644:2;2632:9;2623:7;2619:23;2615:32;2612:52;;;2660:1;2657;2650:12;2612:52;-1:-1:-1;2683:23:228;;2532:180;-1:-1:-1;2532:180:228:o;3248:184::-;3300:77;3297:1;3290:88;3397:4;3394:1;3387:15;3421:4;3418:1;3411:15;3437:128;3477:3;3508:1;3504:6;3501:1;3498:13;3495:39;;;3514:18;;:::i;:::-;-1:-1:-1;3550:9:228;;3437:128::o;3570:125::-;3610:4;3638:1;3635;3632:8;3629:34;;;3643:18;;:::i;:::-;-1:-1:-1;3680:9:228;;3570:125::o"
+var PreimageOracleDeployedSourceMap = "144:4615:58:-:0;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;357:68;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;413:25:229;;;401:2;386:18;357:68:58;;;;;;;;501:66;;;;;;:::i;:::-;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;614:14:229;;607:22;589:41;;577:2;562:18;501:66:58;449:187:229;2154:850:58;;;;;;:::i;:::-;;:::i;838:564::-;;;;;;:::i;:::-;;:::i;:::-;;;;1581:25:229;;;1637:2;1622:18;;1615:34;;;;1554:18;838:564:58;1407:248:229;3295:1462:58;;;;;;:::i;:::-;;:::i;:::-;;1744:262;;;;;;:::i;:::-;1877:19;;;;:14;:19;;;;;;;;:31;;;;;;;;:38;;;;1911:4;1877:38;;;;;;1925:18;;;;;;;;:30;;;;;;;;;:37;;;;1972:20;;;;;;;;;;:27;1744:262;238:50;;;;;;:::i;:::-;;;;;;;;;;;;;;;2154:850;2321:4;2308:18;2567:3;2563:14;;;2458:4;2551:27;2231:12;;2598:11;2308:18;2718:16;2598:11;2700:41;2840:20;2954:19;2947:27;2976:11;2944:44;;2154:850;-1:-1:-1;;;2154:850:58:o;838:564::-;938:12;991:20;;;:14;:20;;;;;;;;:29;;;;;;;;;938:12;;991:29;;983:62;;;;;;;3101:2:229;983:62:58;;;3083:21:229;3140:2;3120:18;;;3113:30;3179:22;3159:18;;;3152:50;3219:18;;983:62:58;;;;;;;;-1:-1:-1;1176:14:58;1193:21;;;1164:2;1193:21;;;;;;;;1244:10;1193:21;1253:1;1244:10;:::i;:::-;1228:12;:7;1238:2;1228:12;:::i;:::-;:26;1224:87;;1293:7;1280:10;:6;1289:1;1280:10;:::i;:::-;:20;;;;:::i;:::-;1270:30;;1224:87;-1:-1:-1;1367:19:58;;;;:13;:19;;;;;;;;:28;;;;;;;;;;;;838:564;;-1:-1:-1;838:564:58:o;3295:1462::-;3591:4;3578:18;3396:12;;3720:1;3710:12;;3694:29;;3691:77;;;3752:1;3749;3742:12;3691:77;4011:3;4007:14;;;3911:4;3995:27;4042:11;4016:4;4161:16;4042:11;4143:41;4374:29;;;4378:11;4374:29;4368:36;4426:20;;;;4573:19;4566:27;4595:11;4563:44;4626:19;;;;4604:1;4626:19;;;;;;;;:32;;;;;;;;:39;;;;4661:4;4626:39;;;;;;4675:18;;;;;;;;:31;;;;;;;;;:38;;;;4723:20;;;;;;;;;;;:27;;;;-1:-1:-1;;;;3295:1462:58:o;14:248:229:-;82:6;90;143:2;131:9;122:7;118:23;114:32;111:52;;;159:1;156;149:12;111:52;-1:-1:-1;;182:23:229;;;252:2;237:18;;;224:32;;-1:-1:-1;14:248:229:o;641:347::-;692:8;702:6;756:3;749:4;741:6;737:17;733:27;723:55;;774:1;771;764:12;723:55;-1:-1:-1;797:20:229;;840:18;829:30;;826:50;;;872:1;869;862:12;826:50;909:4;901:6;897:17;885:29;;961:3;954:4;945:6;937;933:19;929:30;926:39;923:59;;;978:1;975;968:12;923:59;641:347;;;;;:::o;993:409::-;1063:6;1071;1124:2;1112:9;1103:7;1099:23;1095:32;1092:52;;;1140:1;1137;1130:12;1092:52;1180:9;1167:23;1213:18;1205:6;1202:30;1199:50;;;1245:1;1242;1235:12;1199:50;1284:58;1334:7;1325:6;1314:9;1310:22;1284:58;:::i;:::-;1361:8;;1258:84;;-1:-1:-1;993:409:229;-1:-1:-1;;;;993:409:229:o;1660:477::-;1739:6;1747;1755;1808:2;1796:9;1787:7;1783:23;1779:32;1776:52;;;1824:1;1821;1814:12;1776:52;1860:9;1847:23;1837:33;;1921:2;1910:9;1906:18;1893:32;1948:18;1940:6;1937:30;1934:50;;;1980:1;1977;1970:12;1934:50;2019:58;2069:7;2060:6;2049:9;2045:22;2019:58;:::i;:::-;1660:477;;2096:8;;-1:-1:-1;1993:84:229;;-1:-1:-1;;;;1660:477:229:o;2142:385::-;2228:6;2236;2244;2252;2305:3;2293:9;2284:7;2280:23;2276:33;2273:53;;;2322:1;2319;2312:12;2273:53;-1:-1:-1;;2345:23:229;;;2415:2;2400:18;;2387:32;;-1:-1:-1;2466:2:229;2451:18;;2438:32;;2517:2;2502:18;2489:32;;-1:-1:-1;2142:385:229;-1:-1:-1;2142:385:229:o;2532:180::-;2591:6;2644:2;2632:9;2623:7;2619:23;2615:32;2612:52;;;2660:1;2657;2650:12;2612:52;-1:-1:-1;2683:23:229;;2532:180;-1:-1:-1;2532:180:229:o;3248:184::-;3300:77;3297:1;3290:88;3397:4;3394:1;3387:15;3421:4;3418:1;3411:15;3437:128;3477:3;3508:1;3504:6;3501:1;3498:13;3495:39;;;3514:18;;:::i;:::-;-1:-1:-1;3550:9:229;;3437:128::o;3570:125::-;3610:4;3638:1;3635;3632:8;3629:34;;;3643:18;;:::i;:::-;-1:-1:-1;3680:9:229;;3570:125::o"
 
 func init() {
 	if err := json.Unmarshal([]byte(PreimageOracleStorageLayoutJSON), PreimageOracleStorageLayout); err != nil {

packages/contracts-bedrock/.gas-snapshot

@@ -331,6 +331,9 @@ OptimismPortal_Test:test_receive_succeeds() (gas: 127513)
 OptimismPortal_Test:test_simple_isOutputFinalized_succeeds() (gas: 32971)
 OptimismPortal_Test:test_unpause_onlyGuardian_reverts() (gas: 46098)
 OptimismPortal_Test:test_unpause_succeeds() (gas: 31756)
+PreimageOracle_Test:test_computePreimageKey_succeeds() (gas: 6267)
+PreimageOracle_Test:test_loadKeccak256PreimagePart_outOfBoundsOffset_reverts() (gas: 9025)
+PreimageOracle_Test:test_loadKeccak256PreimagePart_succeeds() (gas: 77552)
 ProxyAdmin_Test:test_chugsplashChangeProxyAdmin_succeeds() (gas: 35586)
 ProxyAdmin_Test:test_chugsplashGetProxyAdmin_succeeds() (gas: 15675)
 ProxyAdmin_Test:test_chugsplashGetProxyImplementation_succeeds() (gas: 51084)

packages/contracts-bedrock/contracts/cannon/PreimageOracle.sol

 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.15;
+pragma solidity ^0.8.15;
 
 /// @title PreimageOracle
 /// @notice A contract for storing permissioned pre-images.

packages/contracts-bedrock/contracts/test/PreimageOracle.t.sol

+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.15;
+
+import { Test } from "forge-std/Test.sol";
+
+import { PreimageOracle } from "../cannon/PreimageOracle.sol";
+
+contract PreimageOracle_Test is Test {
+    PreimageOracle oracle;
+
+    /// @notice Sets up the testing suite.
+    function setUp() public {
+        oracle = new PreimageOracle();
+        vm.label(address(oracle), "PreimageOracle");
+    }
+
+    /// @notice Test the pre-image key computation with a known pre-image.
+    function test_computePreimageKey_succeeds() public {
+        bytes memory preimage = hex"deadbeef";
+        bytes32 key = oracle.computePreimageKey(preimage);
+        bytes32 known = 0x02fd4e189132273036449fc9e11198c739161b4c0116a9a2dccdfa1c492006f1;
+        assertEq(key, known);
+    }
+
+    /// @notice Tests that a pre-image is correctly set.
+    function test_loadKeccak256PreimagePart_succeeds() public {
+        // Set the pre-image
+        bytes memory preimage = hex"deadbeef";
+        bytes32 key = oracle.computePreimageKey(preimage);
+        uint256 offset = 0;
+        oracle.loadKeccak256PreimagePart(offset, preimage);
+
+        // Validate the pre-image part
+        bytes32 part = oracle.preimageParts(key, offset);
+        bytes32 expectedPart = 0x0000000000000004deadbeef0000000000000000000000000000000000000000;
+        assertEq(part, expectedPart);
+
+        // Validate the pre-image length
+        uint256 length = oracle.preimageLengths(key);
+        assertEq(length, preimage.length);
+
+        // Validate that the pre-image part is set
+        bool ok = oracle.preimagePartOk(key, offset);
+        assertTrue(ok);
+    }
+
+    /// @notice Tests that a pre-image cannot be set with an out-of-bounds offset.
+    function test_loadKeccak256PreimagePart_outOfBoundsOffset_reverts() public {
+        bytes memory preimage = hex"deadbeef";
+        uint256 offset = preimage.length + 9;
+
+        vm.expectRevert();
+        oracle.loadKeccak256PreimagePart(offset, preimage);
+    }
+
+    /// @notice Reading a pre-image part that has not been set should revert.
+    function testFuzz_readPreimage_missingPreimage_reverts(bytes32 key, uint256 offset) public {
+        vm.expectRevert("pre-image must exist");
+        oracle.readPreimage(key, offset);
+    }
+}