@arbitrum/nitro-contracts 2.1.0 → 3.0.0-alpha.0

package/src/challengeV2/IAssertionChain.sol

@@ -0,0 +1,39 @@
+// Copyright 2023, Offchain Labs, Inc.
+// For license information, see https://github.com/offchainlabs/bold/blob/main/LICENSE
+// SPDX-License-Identifier: BUSL-1.1
+//
+pragma solidity ^0.8.17;
+
+import "../bridge/IBridge.sol";
+import "../osp/IOneStepProofEntry.sol";
+import "../rollup/Assertion.sol";
+
+/// @title  Assertion chain interface
+/// @notice The interface required by the EdgeChallengeManager for requesting assertion data from the AssertionChain
+interface IAssertionChain {
+    function bridge() external view returns (IBridge);
+    function validateAssertionHash(
+        bytes32 assertionHash,
+        AssertionState calldata state,
+        bytes32 prevAssertionHash,
+        bytes32 inboxAcc
+    ) external view;
+    function validateConfig(bytes32 assertionHash, ConfigData calldata configData) external view;
+    function getFirstChildCreationBlock(
+        bytes32 assertionHash
+    ) external view returns (uint64);
+    function getSecondChildCreationBlock(
+        bytes32 assertionHash
+    ) external view returns (uint64);
+    function isFirstChild(
+        bytes32 assertionHash
+    ) external view returns (bool);
+    function isPending(
+        bytes32 assertionHash
+    ) external view returns (bool);
+    function isValidator(
+        address
+    ) external view returns (bool);
+    function getValidators() external view returns (address[] memory);
+    function validatorWhitelistDisabled() external view returns (bool);
+}

package/src/challengeV2/libraries/ArrayUtilsLib.sol

@@ -0,0 +1,61 @@
+// Copyright 2023, Offchain Labs, Inc.
+// For license information, see https://github.com/offchainlabs/bold/blob/main/LICENSE
+// SPDX-License-Identifier: BUSL-1.1
+//
+pragma solidity ^0.8.17;
+
+/// @title  Array utils library
+/// @notice Utils for working with bytes32 arrays
+library ArrayUtilsLib {
+    /// @notice Append an item to the end of an array
+    /// @param arr      The array to append to
+    /// @param newItem  The item to append
+    function append(
+        bytes32[] memory arr,
+        bytes32 newItem
+    ) internal pure returns (bytes32[] memory) {
+        bytes32[] memory clone = new bytes32[](arr.length + 1);
+        for (uint256 i = 0; i < arr.length; i++) {
+            clone[i] = arr[i];
+        }
+        clone[clone.length - 1] = newItem;
+        return clone;
+    }
+
+    /// @notice Get a slice of an existing array
+    /// @dev    End index exlusive so slice(arr, 0, 5) gets the first 5 elements of arr
+    /// @param arr          Array to slice
+    /// @param startIndex   The start index of the slice in the original array - inclusive
+    /// @param endIndex     The end index of the slice in the original array - exlusive
+    function slice(
+        bytes32[] memory arr,
+        uint256 startIndex,
+        uint256 endIndex
+    ) internal pure returns (bytes32[] memory) {
+        require(startIndex < endIndex, "Start not less than end");
+        require(endIndex <= arr.length, "End not less or equal than length");
+
+        bytes32[] memory newArr = new bytes32[](endIndex - startIndex);
+        for (uint256 i = startIndex; i < endIndex; i++) {
+            newArr[i - startIndex] = arr[i];
+        }
+        return newArr;
+    }
+
+    /// @notice Concatenated to arrays
+    /// @param arr1 First array
+    /// @param arr1 Second array
+    function concat(
+        bytes32[] memory arr1,
+        bytes32[] memory arr2
+    ) internal pure returns (bytes32[] memory) {
+        bytes32[] memory full = new bytes32[](arr1.length + arr2.length);
+        for (uint256 i = 0; i < arr1.length; i++) {
+            full[i] = arr1[i];
+        }
+        for (uint256 i = 0; i < arr2.length; i++) {
+            full[arr1.length + i] = arr2[i];
+        }
+        return full;
+    }
+}

package/src/challengeV2/libraries/ChallengeEdgeLib.sol

@@ -0,0 +1,333 @@
+// Copyright 2023, Offchain Labs, Inc.
+// For license information, see https://github.com/offchainlabs/bold/blob/main/LICENSE
+// SPDX-License-Identifier: BUSL-1.1
+//
+pragma solidity ^0.8.17;
+
+import "./Enums.sol";
+import "./ChallengeErrors.sol";
+
+/// @notice An edge committing to a range of states. These edges will be bisected, slowly
+///         reducing them in length until they reach length one. At that point new edges of a different
+///         level will be added that claim the result of this edge, or a one step proof will be calculated
+///         if the edge level is already of type SmallStep.
+struct ChallengeEdge {
+    /// @notice The origin id is a link from the edge to an edge or assertion at a lower level.
+    ///         Intuitively all edges with the same origin id agree on the information committed to in the origin id
+    ///         For a SmallStep edge the origin id is the 'mutual' id of the length one BigStep edge being claimed by the zero layer ancestors of this edge
+    ///         For a BigStep edge the origin id is the 'mutual' id of the length one Block edge being claimed by the zero layer ancestors of this edge
+    ///         For a Block edge the origin id is the assertion hash of the assertion that is the root of the challenge - all edges in this challenge agree
+    ///         that that assertion hash is valid.
+    ///         The purpose of the origin id is to ensure that only edges that agree on a common start position
+    ///         are being compared against one another.
+    bytes32 originId;
+    /// @notice A root of all the states in the history up to the startHeight
+    bytes32 startHistoryRoot;
+    /// @notice The height of the start history root
+    uint256 startHeight;
+    /// @notice A root of all the states in the history up to the endHeight. Since endHeight > startHeight, the startHistoryRoot must
+    ///         commit to a prefix of the states committed to by the endHistoryRoot
+    bytes32 endHistoryRoot;
+    /// @notice The height of the end history root
+    uint256 endHeight;
+    /// @notice Edges can be bisected into two children. If this edge has been bisected the id of the
+    ///         lower child is populated here, until that time this value is 0. The lower child has startHistoryRoot and startHeight
+    ///         equal to this edge, but endHistoryRoot and endHeight equal to some prefix of the endHistoryRoot of this edge
+    bytes32 lowerChildId;
+    /// @notice Edges can be bisected into two children. If this edge has been bisected the id of the
+    ///         upper child is populated here, until that time this value is 0. The upper child has startHistoryRoot and startHeight
+    ///         equal to some prefix of the endHistoryRoot of this edge, and endHistoryRoot and endHeight equal to this edge
+    bytes32 upperChildId;
+    /// @notice The edge or assertion in the upper level that this edge claims to be true.
+    ///         Only populated on zero layer edges
+    bytes32 claimId;
+    /// @notice The entity that supplied a mini-stake accompanying this edge
+    ///         Only populated on zero layer edges
+    address staker;
+    /// @notice The block number when this edge was created
+    uint64 createdAtBlock;
+    /// @notice The block number at which this edge was confirmed
+    ///         Zero if not confirmed
+    uint64 confirmedAtBlock;
+    /// @notice Current status of this edge. All edges are created Pending, and may be updated to Confirmed
+    ///         Once Confirmed they cannot transition back to Pending
+    EdgeStatus status;
+    /// @notice The level of this edge.
+    ///         Level 0 is type Block
+    ///         Last level (defined by NUM_BIGSTEP_LEVEL + 1) is type SmallStep
+    ///         All levels in between are of type BigStep
+    uint8 level;
+    /// @notice Set to true when the staker has been refunded. Can only be set to true if the status is Confirmed
+    ///         and the staker is non zero.
+    bool refunded;
+    /// @notice TODO
+    uint64 totalTimeUnrivaledCache;
+}
+
+library ChallengeEdgeLib {
+    /// @notice Common checks to do when adding an edge
+    function newEdgeChecks(
+        bytes32 originId,
+        bytes32 startHistoryRoot,
+        uint256 startHeight,
+        bytes32 endHistoryRoot,
+        uint256 endHeight
+    ) internal pure {
+        if (originId == 0) {
+            revert EmptyOriginId();
+        }
+        if (endHeight <= startHeight) {
+            revert InvalidHeights(startHeight, endHeight);
+        }
+        if (startHistoryRoot == 0) {
+            revert EmptyStartRoot();
+        }
+        if (endHistoryRoot == 0) {
+            revert EmptyEndRoot();
+        }
+    }
+
+    /// @notice Create a new layer zero edge. These edges make claims about length one edges in the level
+    ///         below. Creating a layer zero edge also requires placing a mini stake, so information
+    ///         about that staker is also stored on this edge.
+    function newLayerZeroEdge(
+        bytes32 originId,
+        bytes32 startHistoryRoot,
+        uint256 startHeight,
+        bytes32 endHistoryRoot,
+        uint256 endHeight,
+        bytes32 claimId,
+        address staker,
+        uint8 level
+    ) internal view returns (ChallengeEdge memory) {
+        if (staker == address(0)) {
+            revert EmptyStaker();
+        }
+        if (claimId == 0) {
+            revert EmptyClaimId();
+        }
+
+        newEdgeChecks(originId, startHistoryRoot, startHeight, endHistoryRoot, endHeight);
+
+        return ChallengeEdge({
+            originId: originId,
+            startHeight: startHeight,
+            startHistoryRoot: startHistoryRoot,
+            endHeight: endHeight,
+            endHistoryRoot: endHistoryRoot,
+            lowerChildId: 0,
+            upperChildId: 0,
+            createdAtBlock: uint64(block.number),
+            claimId: claimId,
+            staker: staker,
+            status: EdgeStatus.Pending,
+            level: level,
+            refunded: false,
+            confirmedAtBlock: 0,
+            totalTimeUnrivaledCache: 0
+        });
+    }
+
+    /// @notice Creates a new child edge. All edges except layer zero edges are child edges.
+    ///         These are edges that are created by bisection, and have parents rather than claims.
+    function newChildEdge(
+        bytes32 originId,
+        bytes32 startHistoryRoot,
+        uint256 startHeight,
+        bytes32 endHistoryRoot,
+        uint256 endHeight,
+        uint8 level
+    ) internal view returns (ChallengeEdge memory) {
+        newEdgeChecks(originId, startHistoryRoot, startHeight, endHistoryRoot, endHeight);
+
+        return ChallengeEdge({
+            originId: originId,
+            startHeight: startHeight,
+            startHistoryRoot: startHistoryRoot,
+            endHeight: endHeight,
+            endHistoryRoot: endHistoryRoot,
+            lowerChildId: 0,
+            upperChildId: 0,
+            createdAtBlock: uint64(block.number),
+            claimId: 0,
+            staker: address(0),
+            status: EdgeStatus.Pending,
+            level: level,
+            refunded: false,
+            confirmedAtBlock: 0,
+            totalTimeUnrivaledCache: 0
+        });
+    }
+
+    /// @notice The "mutualId" of an edge. A mutual id is a hash of all the data that is shared by rivals.
+    ///         Rivals have the same start height, start history root and end height. They also have the same origin id and level.
+    ///         The difference between rivals is that they have a different endHistoryRoot, so that information
+    ///         is not included in this hash.
+    function mutualIdComponent(
+        uint8 level,
+        bytes32 originId,
+        uint256 startHeight,
+        bytes32 startHistoryRoot,
+        uint256 endHeight
+    ) internal pure returns (bytes32) {
+        return
+            keccak256(abi.encodePacked(level, originId, startHeight, startHistoryRoot, endHeight));
+    }
+
+    /// @notice The "mutualId" of an edge. A mutual id is a hash of all the data that is shared by rivals.
+    ///         Rivals have the same start height, start history root and end height. They also have the same origin id and level.
+    ///         The difference between rivals is that they have a different endHistoryRoot, so that information
+    ///         is not included in this hash.
+    function mutualId(
+        ChallengeEdge storage ce
+    ) internal view returns (bytes32) {
+        return mutualIdComponent(
+            ce.level, ce.originId, ce.startHeight, ce.startHistoryRoot, ce.endHeight
+        );
+    }
+
+    function mutualIdMem(
+        ChallengeEdge memory ce
+    ) internal pure returns (bytes32) {
+        return mutualIdComponent(
+            ce.level, ce.originId, ce.startHeight, ce.startHistoryRoot, ce.endHeight
+        );
+    }
+
+    /// @notice The id of an edge. Edges are uniquely identified by their id, and commit to the same information
+    function idComponent(
+        uint8 level,
+        bytes32 originId,
+        uint256 startHeight,
+        bytes32 startHistoryRoot,
+        uint256 endHeight,
+        bytes32 endHistoryRoot
+    ) internal pure returns (bytes32) {
+        return keccak256(
+            abi.encodePacked(
+                mutualIdComponent(level, originId, startHeight, startHistoryRoot, endHeight),
+                endHistoryRoot
+            )
+        );
+    }
+
+    /// @notice The id of an edge. Edges are uniquely identified by their id, and commit to the same information
+    /// @dev    This separate idMem method is to be explicit about when ChallengeEdges are copied into memory. It is
+    ///         possible to pass a storage edge to this method and the id be computed correctly, but that would load
+    ///         the whole struct into memory, so we're explicit here that this should be used for edges already in memory.
+    function idMem(
+        ChallengeEdge memory edge
+    ) internal pure returns (bytes32) {
+        return idComponent(
+            edge.level,
+            edge.originId,
+            edge.startHeight,
+            edge.startHistoryRoot,
+            edge.endHeight,
+            edge.endHistoryRoot
+        );
+    }
+
+    /// @notice The id of an edge. Edges are uniquely identified by their id, and commit to the same information
+    function id(
+        ChallengeEdge storage edge
+    ) internal view returns (bytes32) {
+        return idComponent(
+            edge.level,
+            edge.originId,
+            edge.startHeight,
+            edge.startHistoryRoot,
+            edge.endHeight,
+            edge.endHistoryRoot
+        );
+    }
+
+    /// @notice Does this edge exist in storage
+    function exists(
+        ChallengeEdge storage edge
+    ) internal view returns (bool) {
+        // All edges have a createdAtBlock number
+        return edge.createdAtBlock != 0;
+    }
+
+    /// @notice The length of this edge - difference between the start and end heights
+    function length(
+        ChallengeEdge storage edge
+    ) internal view returns (uint256) {
+        uint256 len = edge.endHeight - edge.startHeight;
+        // It's impossible for a zero length edge to exist
+        if (len == 0) {
+            revert EdgeNotExists(ChallengeEdgeLib.id(edge));
+        }
+        return len;
+    }
+
+    /// @notice Set the children of an edge
+    /// @dev    Children can only be set once
+    function setChildren(
+        ChallengeEdge storage edge,
+        bytes32 lowerChildId,
+        bytes32 upperChildId
+    ) internal {
+        if (edge.lowerChildId != 0 || edge.upperChildId != 0) {
+            revert ChildrenAlreadySet(
+                ChallengeEdgeLib.id(edge), edge.lowerChildId, edge.upperChildId
+            );
+        }
+        edge.lowerChildId = lowerChildId;
+        edge.upperChildId = upperChildId;
+    }
+
+    /// @notice Set the status of an edge to Confirmed
+    /// @dev    Only Pending edges can be confirmed
+    function setConfirmed(
+        ChallengeEdge storage edge
+    ) internal {
+        if (edge.status != EdgeStatus.Pending) {
+            revert EdgeNotPending(ChallengeEdgeLib.id(edge), edge.status);
+        }
+        edge.status = EdgeStatus.Confirmed;
+        edge.confirmedAtBlock = uint64(block.number);
+    }
+
+    /// @notice Is the edge a layer zero edge.
+    function isLayerZero(
+        ChallengeEdge storage edge
+    ) internal view returns (bool) {
+        return edge.claimId != 0 && edge.staker != address(0);
+    }
+
+    /// @notice Set the refunded flag of an edge
+    /// @dev    Checks internally that edge is confirmed, layer zero edge and hasnt been refunded already
+    function setRefunded(
+        ChallengeEdge storage edge
+    ) internal {
+        if (edge.status != EdgeStatus.Confirmed) {
+            revert EdgeNotConfirmed(ChallengeEdgeLib.id(edge), edge.status);
+        }
+        if (!isLayerZero(edge)) {
+            revert EdgeNotLayerZero(ChallengeEdgeLib.id(edge), edge.staker, edge.claimId);
+        }
+        if (edge.refunded == true) {
+            revert EdgeAlreadyRefunded(ChallengeEdgeLib.id(edge));
+        }
+
+        edge.refunded = true;
+    }
+
+    /// @notice Returns the edge type for a given level, given the total number of big step levels
+    function levelToType(
+        uint8 level,
+        uint8 numBigStepLevels
+    ) internal pure returns (EdgeType eType) {
+        if (level == 0) {
+            return EdgeType.Block;
+        } else if (level <= numBigStepLevels) {
+            return EdgeType.BigStep;
+        } else if (level == numBigStepLevels + 1) {
+            return EdgeType.SmallStep;
+        } else {
+            revert LevelTooHigh(level, numBigStepLevels);
+        }
+    }
+}

package/src/challengeV2/libraries/ChallengeErrors.sol

@@ -0,0 +1,108 @@
+// Copyright 2023, Offchain Labs, Inc.
+// For license information, see https://github.com/offchainlabs/bold/blob/main/LICENSE
+// SPDX-License-Identifier: BUSL-1.1
+//
+pragma solidity ^0.8.17;
+
+import "./Enums.sol";
+
+/// @dev The edge is not currently stored
+error EdgeNotExists(bytes32 edgeId);
+/// @dev The edge has already been stored
+error EdgeAlreadyExists(bytes32 edgeId);
+/// @dev The provided assertion hash was empty
+error AssertionHashEmpty();
+/// @dev The assertion hashes are not the same, but should have been
+error AssertionHashMismatch(bytes32 h1, bytes32 h2);
+/// @dev The assertion is not currently pending
+error AssertionNotPending();
+/// @dev The assertion has no sibling
+error AssertionNoSibling();
+/// @dev The edge type specific proof data is empty
+error EmptyEdgeSpecificProof();
+/// @dev The start machine status is empty
+error EmptyStartMachineStatus();
+/// @dev The end machine status is empty
+error EmptyEndMachineStatus();
+/// @dev The claim edge is not pending
+error ClaimEdgeNotPending();
+/// @dev The claim edge does not have a length one rival
+error ClaimEdgeNotLengthOneRival(bytes32 claimId);
+/// @dev The claim edge has an invalid level
+error ClaimEdgeInvalidLevel(uint8 argLevel, uint8 claimLevel);
+/// @dev The val is not a power of two
+error NotPowerOfTwo(uint256 val);
+/// @dev The height has an unexpected value
+error InvalidEndHeight(uint256 actualHeight, uint256 expectedHeight);
+/// @dev The prefix proof is empty
+error EmptyPrefixProof();
+/// @dev The edge is not of type SmallStep
+error EdgeTypeNotSmallStep(uint8 level);
+/// @dev The first rival record is empty
+error EmptyFirstRival();
+/// @dev The difference between two heights is less than 2
+error HeightDiffLtTwo(uint256 h1, uint256 h2);
+/// @dev The edge is not pending
+error EdgeNotPending(bytes32 edgeId, EdgeStatus status);
+/// @dev The edge is unrivaled
+error EdgeUnrivaled(bytes32 edgeId);
+/// @dev The edge is not confirmed
+error EdgeNotConfirmed(bytes32 edgeId, EdgeStatus);
+/// @dev The edge level is unexpected
+error EdgeLevelInvalid(bytes32 edgeId1, bytes32 edgeId2, uint8 level1, uint8 level2);
+/// @dev The claim id on the claimingEdge does not match the provided edge id
+error EdgeClaimMismatch(bytes32 edgeId, bytes32 claimingEdgeId);
+/// @dev The origin id is not equal to the mutual id
+error OriginIdMutualIdMismatch(bytes32 mutualId, bytes32 originId);
+/// @dev The total number of blocks is not above the threshold
+error InsufficientConfirmationBlocks(uint256 totalBlocks, uint256 thresholdBlocks);
+/// @dev The edge is not of length one
+error EdgeNotLengthOne(uint256 length);
+/// @dev No origin id supplied when creating an edge
+error EmptyOriginId();
+/// @dev Invalid heights supplied when creating an edge
+error InvalidHeights(uint256 start, uint256 end);
+/// @dev No start root supplied when creating an edge
+error EmptyStartRoot();
+/// @dev No end root supplied when creating an edge
+error EmptyEndRoot();
+/// @dev No staker supplied when creating a layer zero edge
+error EmptyStaker();
+/// @dev No claim id supplied when creating a layer zero edge
+error EmptyClaimId();
+/// @dev Children already set on edge
+error ChildrenAlreadySet(bytes32 edgeId, bytes32 lowerChildId, bytes32 upperChildId);
+/// @dev Edge is not a layer zero edge
+error EdgeNotLayerZero(bytes32 edgeId, address staker, bytes32 claimId);
+/// @dev The edge staker has already been refunded
+error EdgeAlreadyRefunded(bytes32 edgeId);
+/// @dev No assertion chain address supplied
+error EmptyAssertionChain();
+/// @dev No one step proof entry address supplied
+error EmptyOneStepProofEntry();
+/// @dev No challenge period supplied
+error EmptyChallengePeriod();
+/// @dev No stake receiver address supplied
+error EmptyStakeReceiver();
+/// @dev Stake amounts does not match number of levels
+error StakeAmountsMismatch(uint256 stakeLevels, uint256 numLevels);
+/// @dev A rival edge is already confirmed
+error RivalEdgeConfirmed(bytes32 edgeId, bytes32 confirmedRivalId);
+/// @dev Thrown when big step levels is set to 0
+error ZeroBigStepLevels();
+/// @dev Thrown when there are too many big step levels requested
+error BigStepLevelsTooMany(uint8 levels);
+/// @dev Thrown when the level does not correspond to a valid type
+error LevelTooHigh(uint8 level, uint8 numBigStepLevels);
+/// @dev Thrown for unrecognised edge types
+error InvalidEdgeType(EdgeType edgeType);
+/// @dev Thrown when endHistoryRoot not matching the assertion
+error EndHistoryRootMismatch(bytes32 endHistoryRoot, bytes32 assertionEndRoot);
+/// @dev Thrown when the validator whitelist is enabled and the account attempting to create a layer zero edge is not whitelisted
+error NotValidator(address account);
+/// @dev Thrown when an account has already created a rivalling layer zero edge
+error AccountHasMadeLayerZeroRival(address account, bytes32 mutualId);
+/// @dev Thrown when the cached time is already sufficient
+error CachedTimeSufficient(uint256 actual, uint256 expected);
+/// @dev Thrown when the input is an empty array
+error EmptyArray();