@arbitrum/nitro-contracts 3.0.0-beta.1 → 3.0.1-beta.0

package/build/contracts/src/test-helpers/NoReceiveForwarder.sol/NoReceiveForwarder.json

@@ -0,0 +1,29 @@
+{
+  "_format": "hh-sol-artifact-1",
+  "contractName": "NoReceiveForwarder",
+  "sourceName": "src/test-helpers/NoReceiveForwarder.sol",
+  "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "to",
+          "type": "address"
+        },
+        {
+          "internalType": "bytes",
+          "name": "data",
+          "type": "bytes"
+        }
+      ],
+      "name": "forward",
+      "outputs": [],
+      "stateMutability": "payable",
+      "type": "function"
+    }
+  ],
+  "bytecode": "0x608060405234801561001057600080fd5b506101fd806100206000396000f3fe60806040526004361061001e5760003560e01c80636fadcf7214610023575b600080fd5b610036610031366004610119565b610038565b005b60008373ffffffffffffffffffffffffffffffffffffffff163484846040516100629291906101b7565b60006040518083038185875af1925050503d806000811461009f576040519150601f19603f3d011682016040523d82523d6000602084013e6100a4565b606091505b5050905080610113576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f63616c6c20666f7277617264206661696c656400000000000000000000000000604482015260640160405180910390fd5b50505050565b60008060006040848603121561012e57600080fd5b833573ffffffffffffffffffffffffffffffffffffffff8116811461015257600080fd5b9250602084013567ffffffffffffffff8082111561016f57600080fd5b818601915086601f83011261018357600080fd5b81358181111561019257600080fd5b8760208285010111156101a457600080fd5b6020830194508093505050509250925092565b818382376000910190815291905056fea26469706673582212203996320cdbc9b8ea355853350e9a51787af243804ec23fd90319a01c2b224d9364736f6c63430008110033",
+  "deployedBytecode": "0x60806040526004361061001e5760003560e01c80636fadcf7214610023575b600080fd5b610036610031366004610119565b610038565b005b60008373ffffffffffffffffffffffffffffffffffffffff163484846040516100629291906101b7565b60006040518083038185875af1925050503d806000811461009f576040519150601f19603f3d011682016040523d82523d6000602084013e6100a4565b606091505b5050905080610113576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f63616c6c20666f7277617264206661696c656400000000000000000000000000604482015260640160405180910390fd5b50505050565b60008060006040848603121561012e57600080fd5b833573ffffffffffffffffffffffffffffffffffffffff8116811461015257600080fd5b9250602084013567ffffffffffffffff8082111561016f57600080fd5b818601915086601f83011261018357600080fd5b81358181111561019257600080fd5b8760208285010111156101a457600080fd5b6020830194508093505050509250925092565b818382376000910190815291905056fea26469706673582212203996320cdbc9b8ea355853350e9a51787af243804ec23fd90319a01c2b224d9364736f6c63430008110033",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

package/build/contracts/src/test-helpers/NoReceiveForwarder.sol/ReceivingForwarder.dbg.json

@@ -0,0 +1,4 @@
+{
+  "_format": "hh-sol-dbg-1",
+  "buildInfo": "../../../build-info/911b9fef16d3e7eaeb8dea63439959bf.json"
+}

package/build/contracts/src/test-helpers/NoReceiveForwarder.sol/ReceivingForwarder.json

@@ -0,0 +1,33 @@
+{
+  "_format": "hh-sol-artifact-1",
+  "contractName": "ReceivingForwarder",
+  "sourceName": "src/test-helpers/NoReceiveForwarder.sol",
+  "abi": [
+    {
+      "inputs": [
+        {
+          "internalType": "address",
+          "name": "to",
+          "type": "address"
+        },
+        {
+          "internalType": "bytes",
+          "name": "data",
+          "type": "bytes"
+        }
+      ],
+      "name": "forward",
+      "outputs": [],
+      "stateMutability": "payable",
+      "type": "function"
+    },
+    {
+      "stateMutability": "payable",
+      "type": "receive"
+    }
+  ],
+  "bytecode": "0x608060405234801561001057600080fd5b50610208806100206000396000f3fe6080604052600436106100225760003560e01c80636fadcf721461002e57600080fd5b3661002957005b600080fd5b61004161003c366004610124565b610043565b005b60008373ffffffffffffffffffffffffffffffffffffffff1634848460405161006d9291906101c2565b60006040518083038185875af1925050503d80600081146100aa576040519150601f19603f3d011682016040523d82523d6000602084013e6100af565b606091505b505090508061011e576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f63616c6c20666f7277617264206661696c656400000000000000000000000000604482015260640160405180910390fd5b50505050565b60008060006040848603121561013957600080fd5b833573ffffffffffffffffffffffffffffffffffffffff8116811461015d57600080fd5b9250602084013567ffffffffffffffff8082111561017a57600080fd5b818601915086601f83011261018e57600080fd5b81358181111561019d57600080fd5b8760208285010111156101af57600080fd5b6020830194508093505050509250925092565b818382376000910190815291905056fea2646970667358221220fb5da8e70caf6f2639bfbe3a4913e31755738d9142bcd77130be79d23e58c72a64736f6c63430008110033",
+  "deployedBytecode": "0x6080604052600436106100225760003560e01c80636fadcf721461002e57600080fd5b3661002957005b600080fd5b61004161003c366004610124565b610043565b005b60008373ffffffffffffffffffffffffffffffffffffffff1634848460405161006d9291906101c2565b60006040518083038185875af1925050503d80600081146100aa576040519150601f19603f3d011682016040523d82523d6000602084013e6100af565b606091505b505090508061011e576040517f08c379a000000000000000000000000000000000000000000000000000000000815260206004820152601360248201527f63616c6c20666f7277617264206661696c656400000000000000000000000000604482015260640160405180910390fd5b50505050565b60008060006040848603121561013957600080fd5b833573ffffffffffffffffffffffffffffffffffffffff8116811461015d57600080fd5b9250602084013567ffffffffffffffff8082111561017a57600080fd5b818601915086601f83011261018e57600080fd5b81358181111561019d57600080fd5b8760208285010111156101af57600080fd5b6020830194508093505050509250925092565b818382376000910190815291905056fea2646970667358221220fb5da8e70caf6f2639bfbe3a4913e31755738d9142bcd77130be79d23e58c72a64736f6c63430008110033",
+  "linkReferences": {},
+  "deployedLinkReferences": {}
+}

package/build/contracts/src/test-helpers/OutboxWithoutOptTester.sol/OutboxWithoutOptTester.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/333933d304b0c599711e6e34df65b848.json"
+  "buildInfo": "../../../build-info/911b9fef16d3e7eaeb8dea63439959bf.json"
 }

package/build/contracts/src/test-helpers/RollupMock.sol/RollupMock.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/333933d304b0c599711e6e34df65b848.json"
+  "buildInfo": "../../../build-info/911b9fef16d3e7eaeb8dea63439959bf.json"
 }

package/build/contracts/src/test-helpers/TestToken.sol/TestToken.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/333933d304b0c599711e6e34df65b848.json"
+  "buildInfo": "../../../build-info/911b9fef16d3e7eaeb8dea63439959bf.json"
 }

package/build/contracts/src/test-helpers/ValueArrayTester.sol/ValueArrayTester.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/333933d304b0c599711e6e34df65b848.json"
+  "buildInfo": "../../../build-info/911b9fef16d3e7eaeb8dea63439959bf.json"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arbitrum/nitro-contracts",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.1-beta.0",
   "description": "Layer 2 precompiles and rollup for Arbitrum Nitro",
   "author": "Offchain Labs, Inc.",
   "license": "BUSL-1.1",
@@ -40,6 +40,7 @@
     "test:storage": "./test/storage/test.bash",
     "test:signatures": "./test/signatures/test-sigs.bash",
     "test:e2e": "hardhat test test/e2e/*.ts",
+    "test:e2e:stylus": "hardhat test test/e2e/stylusDeployer.ts",
     "test:upgrade": "./scripts/testUpgrade.bash",
     "test:foundry": "forge test --gas-limit 10000000000",
     "test:update": "yarn run test:signatures || yarn run test:storage",

package/src/mocks/ArbOS11To32UpgradeTest.sol

@@ -0,0 +1,18 @@
+// Copyright 2024, Offchain Labs, Inc.
+// For license information, see https://github.com/OffchainLabs/nitro-contracts/blob/main/LICENSE
+// SPDX-License-Identifier: BUSL-1.1
+
+pragma solidity ^0.8.24;
+
+import "../precompiles/ArbSys.sol";
+
+contract ArbOS11To32UpgradeTest {
+    function mcopy() external returns (bytes32 x) {
+        assembly {
+            mstore(0x20, 0x9) // Store 0x9 at word 1 in memory
+            mcopy(0, 0x20, 0x20) // Copies 0x9 to word 0 in memory
+            x := mload(0) // Returns 32 bytes "0x9"
+        }
+        require(ArbSys(address(0x64)).arbOSVersion() == 55 + 32, "EXPECTED_ARBOS_32");
+    }
+}

package/src/mocks/BigMap.sol

@@ -0,0 +1,23 @@
+// Copyright 2025, Offchain Labs, Inc.
+// For license information, see:
+// https://github.com/OffchainLabs/nitro/blob/master/LICENSE.md
+// SPDX-License-Identifier: BUSL-1.1
+
+pragma solidity ^0.8.0;
+
+contract BigMap {
+    mapping(uint256 => uint256) public data;
+    uint256 size;
+
+    function clearAndAddValues(uint256 clear, uint256 add) external {
+        uint256 i = size;
+        while (i < size + add) {
+            data[i] = 8675309;
+            i++;
+        }
+        size = i;
+        for (uint256 j = 0; j < clear; j++) {
+            data[j] = 0;
+        }
+    }
+}

package/src/stylus/StylusDeployer.sol

@@ -0,0 +1,164 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.17;
+
+import {ArbWasm} from "../precompiles/ArbWasm.sol";
+
+/// @title A Stylus contract deployer, activator and initializer
+/// @author The name of the author
+/// @notice Stylus contracts do not support constructors. Instead, Stylus devs can use this contract to deploy and
+///         initialize their contracts atomically
+contract StylusDeployer {
+    ArbWasm constant ARB_WASM = ArbWasm(0x0000000000000000000000000000000000000071);
+
+    event ContractDeployed(address deployedContract);
+
+    error ContractDeploymentError(bytes bytecode);
+    error ContractInitializationError(address newContract);
+    error RefundExcessValueError(uint256 excessValue);
+    error EmptyBytecode();
+    error InitValueButNotInitData();
+
+    /// @notice Deploy, activate and initialize a stylus contract
+    ///         In order to call a stylus contract, and therefore initialize it, it must first be activated.
+    ///         This contract provides an atomic way of deploying, activating and initializing a stylus contract.
+    ///
+    ///         Initialisation will be called if initData is supplied, other initialization is skipped
+    ///         Activation is not always necessary. If a contract has the same code has as another recently activated
+    ///         contract then activation will be skipped.
+    ///         If additional value remains in the contract after activation it will be transferred to the msg.sender
+    ///         to that end the caller must ensure that they can receive eth.
+    ///
+    ///         The caller should do the following before calling this contract:
+    ///         1. Check whether the contract will require activation, and if so what the cost will be.
+    ///            This can be done by spoofing an address with the contract code, then calling ArbWasm.programVersion to compare the
+    ///            the returned result against ArbWasm.stylusVersion. If activation is required ArbWasm.activateProgram can then be called
+    ///            to find the returned dataFee.
+    ///         2. Next this deploy function can be called. The value of the call must be set to the previously ascertained dataFee + initValue
+    ///            If activation is not require, the value of the call should be set to initValue
+    ///
+    ///         Note: Stylus contract caching is not done by the deployer, and will have to be done separately after deployment.
+    ///         See https://docs.arbitrum.io/stylus/how-tos/caching-contracts for more details on caching
+    /// @param bytecode The bytecode of the stylus contract to be deployed
+    /// @param initData Initialisation call data. After deployment the contract will be called with this data
+    ///                 If no initialisation data is provided then the newly deployed contract will not be called.
+    ///                 This means that the receive or dataless fallback function cannot be called from this contract.
+    /// @param initValue Initialisation value. After deployment, the contract will be called with the init data and this value.
+    ///                  At least as much eth as init value must be provided with this call. Init value is specified here separately
+    ///                  rather than using the msg.value since the msg.value may need to be greater than the init value to accomodate activation data fee.
+    ///                  See the @notice block above for more details.
+    /// @param salt If a non zero salt is provided the contract will be created using CREATE2 instead of CREATE
+    ///             The supplied salt will be hashed with the initData so that wherever the address is observed
+    ///             it was initialised with the same variables.
+    /// @return The address of the deployed conract
+    function deploy(
+        bytes calldata bytecode,
+        bytes calldata initData,
+        uint256 initValue,
+        bytes32 salt
+    ) public payable returns (address) {
+        if (salt != 0) {
+            // if a salt was supplied, hash the salt with the init data. This guarantees that
+            // anywhere the address of this contract is seen the same init data was used
+            salt = initSalt(salt, initData);
+        }
+
+        address newContractAddress = deployContract(bytecode, salt);
+        bool shouldActivate = requiresActivation(newContractAddress);
+        uint256 dataFee = 0;
+        if (shouldActivate) {
+            // ensure there will be enough left over for init
+            // activateProgram will return unused value back to this contract without an EVM call
+            uint256 activationValue = msg.value - initValue;
+            (, dataFee) = ARB_WASM.activateProgram{value: activationValue}(newContractAddress);
+        }
+
+        // initialize - this will fail if the program wasn't activated by this point
+        // we check if initData exists to avoid calling contracts unnecessarily
+        if (initData.length != 0) {
+            (bool success,) = address(newContractAddress).call{value: initValue}(initData);
+            if (!success) {
+                revert ContractInitializationError(newContractAddress);
+            }
+        } else if (initValue != 0) {
+            // if initValue exists init data should too
+            revert InitValueButNotInitData();
+        }
+
+        // refund any remaining value
+        uint256 bal = msg.value - dataFee - initValue;
+        if (bal != 0) {
+            // the caller must be payable
+            (bool sent,) = payable(msg.sender).call{value: bal}("");
+            if (!sent) {
+                revert RefundExcessValueError(bal);
+            }
+        }
+
+        // activation already emits the following event:
+        // event ProgramActivated(bytes32 indexed codehash, bytes32 moduleHash, address program, uint256 dataFee, uint16 version);
+        emit ContractDeployed(newContractAddress);
+
+        return newContractAddress;
+    }
+
+    /// @notice When using CREATE2 the deployer includes the init data and value in the salt so that callers
+    ///         can be sure that wherever they encourter this address it was initialized with the same data and value
+    /// @param salt A user supplied salt
+    /// @param initData The init data that will be used to init the deployed contract
+    function initSalt(bytes32 salt, bytes calldata initData) public pure returns (bytes32) {
+        return keccak256(abi.encodePacked(salt, initData));
+    }
+
+    /// @notice Checks whether a contract requires activation
+    function requiresActivation(
+        address addr
+    ) public view returns (bool) {
+        // currently codeHashVersion returns an error when codeHashVersion != stylus version
+        // so we do a try/catch to to check it
+        uint16 codeHashVersion;
+        try ARB_WASM.codehashVersion(addr.codehash) returns (uint16 version) {
+            codeHashVersion = version;
+        } catch {
+            // stylus version is always >= 1
+            codeHashVersion = 0;
+        }
+
+        // due to the bug in ARB_WASM.codeHashVersion we know that codeHashVersion will either be 0 or the current
+        // version. We still check that is not equal to the stylusVersion
+        return codeHashVersion != ARB_WASM.stylusVersion();
+    }
+
+    /// @notice Deploy the a contract with the supplied bytecode.
+    ///         Will create2 if the supplied salt is non zero
+    function deployContract(bytes memory bytecode, bytes32 salt) internal returns (address) {
+        if (bytecode.length == 0) {
+            revert EmptyBytecode();
+        }
+
+        address newContractAddress;
+        if (salt != 0) {
+            assembly {
+                newContractAddress := create2(0, add(bytecode, 0x20), mload(bytecode), salt)
+            }
+        } else {
+            assembly {
+                newContractAddress := create(0, add(bytecode, 0x20), mload(bytecode))
+            }
+        }
+
+        // bubble up the revert if there was one
+        assembly {
+            if and(iszero(newContractAddress), not(iszero(returndatasize()))) {
+                let p := mload(0x40)
+                returndatacopy(p, 0, returndatasize())
+                revert(p, returndatasize())
+            }
+        }
+
+        if (newContractAddress == address(0)) {
+            revert ContractDeploymentError(bytecode);
+        }
+
+        return newContractAddress;
+    }
+}

package/src/test-helpers/NoReceiveForwarder.sol

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+/// @notice A call forward that doesnt implement the receive or fallback functions, so cant receive value
+contract NoReceiveForwarder {
+    function forward(address to, bytes calldata data) public payable {
+        (bool success,) = address(to).call{value: msg.value}(data);
+        require(success, "call forward failed");
+    }
+}
+
+/// @notice A call forward that does implement the receive or fallback functions, so cant receive value
+contract ReceivingForwarder {
+    function forward(address to, bytes calldata data) public payable {
+        (bool success,) = address(to).call{value: msg.value}(data);
+        require(success, "call forward failed");
+    }
+
+    receive() external payable {}
+}
+
+/// @notice Errors upon construction
+contract ConstructorError {
+    constructor() {
+        require(false, "test error in constructor");
+    }
+}
+
+/// @notice Errors upon construction
+contract ConstructorFine {
+    constructor() {
+        require(true, "test error in constructor");
+    }
+
+    function number() public pure returns (uint256) {
+        return 0;
+    }
+}