Merge remote-tracking branch 'origin/master' into post-nitro-cleanup

K199017017 · Oct 29, 2022 · 7d28732 · 7d28732
2 parents 8912415 + 119da9e
commit 7d28732
Show file tree

Hide file tree

Showing 109 changed files with 346 additions and 186 deletions.
diff --git a/packages/arb-bridge-eth/README.md b/packages/arb-bridge-eth/README.md
@@ -8,3 +8,9 @@ sudo docker run -p 7545:7545 -it arb-bridge-eth
 ```
 
 This repository is offered under the Apache 2.0 license. See LICENSE for details.
+
+## Only for classic version
+
+This package has been deprecated!
+
+If you want to use what was once called `arb-bridge-eth`, look into the latest and greatest [`nitro/contracts`](https://github.com/OffchainLabs/nitro/tree/master/contracts)!
diff --git a/packages/arb-bridge-eth/contracts/arch/Hashing.sol b/packages/arb-bridge-eth/contracts/arch/Hashing.sol
@@ -20,6 +20,10 @@ pragma solidity ^0.6.11;
 
 import "./Value.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 library Hashing {
     using Hashing for Value.Data;
     using Value for Value.CodePoint;

diff --git a/packages/arb-bridge-eth/contracts/arch/IOneStepProof.sol b/packages/arb-bridge-eth/contracts/arch/IOneStepProof.sol
@@ -22,6 +22,10 @@ pragma solidity >=0.6.9 <0.9.0;
 import "../bridge/interfaces/IBridge.sol";
 import "../bridge/interfaces/ISequencerInbox.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/token-bridge-contracts)
+ * for new updates
+ */
 interface IOneStepProof {
     // Bridges is sequencer bridge then delayed bridge
     function executeStep(

diff --git a/packages/arb-bridge-eth/contracts/arch/Machine.sol b/packages/arb-bridge-eth/contracts/arch/Machine.sol
@@ -22,6 +22,10 @@ import "./Marshaling.sol";
 
 import "../libraries/DebugPrint.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 library Machine {
     using Hashing for Value.Data;
 

diff --git a/packages/arb-bridge-eth/contracts/arch/Marshaling.sol b/packages/arb-bridge-eth/contracts/arch/Marshaling.sol
@@ -23,6 +23,10 @@ import "./Hashing.sol";
 
 import "../libraries/BytesLib.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 library Marshaling {
     using BytesLib for bytes;
     using Value for Value.Data;

diff --git a/packages/arb-bridge-eth/contracts/arch/OneStepProof.sol b/packages/arb-bridge-eth/contracts/arch/OneStepProof.sol
@@ -26,7 +26,10 @@ import "../bridge/Messages.sol";
 import "../libraries/BytesLib.sol";
 
 // Originally forked from https://github.com/leapdao/solEVM-enforcer/tree/master
-
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract OneStepProof is OneStepProofCommon {
     using Machine for Machine.Data;
     using Hashing for Value.Data;

diff --git a/packages/arb-bridge-eth/contracts/arch/OneStepProof2.sol b/packages/arb-bridge-eth/contracts/arch/OneStepProof2.sol
@@ -51,6 +51,10 @@ import "./Machine.sol";
 
 // Originally forked from https://github.com/leapdao/solEVM-enforcer/tree/master
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract OneStepProof2 is OneStepProofCommon {
     /* solhint-disable no-inline-assembly */
 

diff --git a/packages/arb-bridge-eth/contracts/arch/OneStepProofCommon.sol b/packages/arb-bridge-eth/contracts/arch/OneStepProofCommon.sol
@@ -24,6 +24,10 @@ import "./Machine.sol";
 import "../bridge/interfaces/IBridge.sol";
 import "../bridge/interfaces/ISequencerInbox.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 abstract contract OneStepProofCommon is IOneStepProof {
     using Machine for Machine.Data;
     using Hashing for Value.Data;

diff --git a/packages/arb-bridge-eth/contracts/arch/OneStepProofHash.sol b/packages/arb-bridge-eth/contracts/arch/OneStepProofHash.sol
@@ -23,7 +23,10 @@ import "./OneStepProofCommon.sol";
 import "../libraries/Precompiles.sol";
 
 // Originally forked from https://github.com/leapdao/solEVM-enforcer/tree/master
-
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract OneStepProofHash is OneStepProofCommon {
     function executeHashInsn(AssertionContext memory context) internal pure {
         Value.Data memory val = popVal(context.stack);

diff --git a/packages/arb-bridge-eth/contracts/arch/Value.sol b/packages/arb-bridge-eth/contracts/arch/Value.sol
@@ -18,6 +18,10 @@
 
 pragma solidity ^0.6.11;
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 library Value {
     uint8 internal constant INT_TYPECODE = 0;
     uint8 internal constant CODE_POINT_TYPECODE = 1;

diff --git a/packages/arb-bridge-eth/contracts/bridge/Bridge.sol b/packages/arb-bridge-eth/contracts/bridge/Bridge.sol
@@ -26,6 +26,10 @@ import "@openzeppelin/contracts/utils/Address.sol";
 
 import "./interfaces/IBridge.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract Bridge is OwnableUpgradeable, IBridge {
     using Address for address;
     struct InOutInfo {

diff --git a/packages/arb-bridge-eth/contracts/bridge/BridgeUtils.sol b/packages/arb-bridge-eth/contracts/bridge/BridgeUtils.sol
@@ -21,6 +21,10 @@ pragma solidity ^0.6.11;
 import "./interfaces/IBridge.sol";
 import "./interfaces/ISequencerInbox.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract BridgeUtils {
     function getCountsAndAccumulators(IBridge delayedBridge, ISequencerInbox sequencerInbox)
         external

diff --git a/packages/arb-bridge-eth/contracts/bridge/Inbox.sol b/packages/arb-bridge-eth/contracts/bridge/Inbox.sol
@@ -32,6 +32,10 @@ import "../libraries/AddressAliasHelper.sol";
 import "@openzeppelin/contracts/utils/Address.sol";
 import "./Bridge.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract Inbox is IInbox, WhitelistConsumer, Cloneable {
     uint8 internal constant ETH_TRANSFER = 0;
     uint8 internal constant L2_MSG = 3;

diff --git a/packages/arb-bridge-eth/contracts/bridge/Messages.sol b/packages/arb-bridge-eth/contracts/bridge/Messages.sol
@@ -18,6 +18,10 @@
 
 pragma solidity ^0.6.11;
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 library Messages {
     function messageHash(
         uint8 kind,

diff --git a/packages/arb-bridge-eth/contracts/bridge/NitroMigrator.sol b/packages/arb-bridge-eth/contracts/bridge/NitroMigrator.sol
@@ -37,6 +37,10 @@ import { INitroRollup, IArbOwner, NitroReadyMagicNums } from "./NitroMigratorUti
 pragma solidity ^0.6.11;
 pragma experimental ABIEncoderV2;
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract NitroMigrator is OwnableUpgradeable, IMessageProvider {
     uint8 internal constant L1MessageType_shutdownForNitro = 128;
 

diff --git a/packages/arb-bridge-eth/contracts/bridge/NitroMigratorUtil.sol b/packages/arb-bridge-eth/contracts/bridge/NitroMigratorUtil.sol
@@ -24,6 +24,10 @@ import "./interfaces/IInbox.sol";
 import "@arbitrum/nitro-contracts/src/bridge/IBridge.sol" as INitroBridge;
 import "@arbitrum/nitro-contracts/src/bridge/IInbox.sol" as INitroInbox;
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface INitroRollup {
     struct GlobalState {
         bytes32[2] bytes32Vals;

diff --git a/packages/arb-bridge-eth/contracts/bridge/Old_Outbox/OldOutbox.sol b/packages/arb-bridge-eth/contracts/bridge/Old_Outbox/OldOutbox.sol
@@ -35,6 +35,10 @@ import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 
 import { NitroReadyMagicNums } from "../NitroMigratorUtil.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract OldOutbox is IOutbox, Cloneable {
     using BytesLib for bytes;
 

diff --git a/packages/arb-bridge-eth/contracts/bridge/Old_Outbox/OutboxEntry.sol b/packages/arb-bridge-eth/contracts/bridge/Old_Outbox/OutboxEntry.sol
@@ -20,6 +20,10 @@ pragma solidity ^0.6.11;
 
 import "../../libraries/Cloneable.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract OutboxEntry is Cloneable {
     address outbox;
     bytes32 public root;

diff --git a/packages/arb-bridge-eth/contracts/bridge/Outbox.sol b/packages/arb-bridge-eth/contracts/bridge/Outbox.sol
@@ -32,6 +32,10 @@ import "@openzeppelin/contracts/proxy/BeaconProxy.sol";
 import "@openzeppelin/contracts/proxy/UpgradeableBeacon.sol";
 import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract Outbox is IOutbox, Cloneable {
     using BytesLib for bytes;
 

diff --git a/packages/arb-bridge-eth/contracts/bridge/SequencerInbox.sol b/packages/arb-bridge-eth/contracts/bridge/SequencerInbox.sol
@@ -28,6 +28,10 @@ import "../validator/IGasRefunder.sol";
 import { NitroReadyMagicNums } from "./NitroMigratorUtil.sol";
 import "./Messages.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface OldRollup {
     function sequencerInboxMaxDelayBlocks() external view returns (uint256);
 

diff --git a/packages/arb-bridge-eth/contracts/bridge/interfaces/IBridge.sol b/packages/arb-bridge-eth/contracts/bridge/interfaces/IBridge.sol
@@ -19,6 +19,10 @@
 // solhint-disable-next-line compiler-version
 pragma solidity >=0.6.9 <0.9.0;
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface IBridge {
     event MessageDelivered(
         uint256 indexed messageIndex,

diff --git a/packages/arb-bridge-eth/contracts/bridge/interfaces/IInbox.sol b/packages/arb-bridge-eth/contracts/bridge/interfaces/IInbox.sol
@@ -22,6 +22,10 @@ pragma solidity >=0.6.9 <0.9.0;
 import "./IBridge.sol";
 import "./IMessageProvider.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface IInbox is IMessageProvider {
     function sendL2Message(bytes calldata messageData) external returns (uint256);
 

diff --git a/packages/arb-bridge-eth/contracts/bridge/interfaces/IMessageProvider.sol b/packages/arb-bridge-eth/contracts/bridge/interfaces/IMessageProvider.sol
@@ -19,6 +19,10 @@
 // solhint-disable-next-line compiler-version
 pragma solidity >=0.6.9 <0.9.0;
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface IMessageProvider {
     event InboxMessageDelivered(uint256 indexed messageNum, bytes data);
 

diff --git a/packages/arb-bridge-eth/contracts/bridge/interfaces/IOutbox.sol b/packages/arb-bridge-eth/contracts/bridge/interfaces/IOutbox.sol
@@ -21,6 +21,10 @@ pragma solidity >=0.6.9 <0.9.0;
 
 import "./IBridge.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface IOutbox {
     event OutboxEntryCreated(
         uint256 indexed batchNum,

diff --git a/packages/arb-bridge-eth/contracts/bridge/interfaces/ISequencerInbox.sol b/packages/arb-bridge-eth/contracts/bridge/interfaces/ISequencerInbox.sol
@@ -19,6 +19,10 @@
 // solhint-disable-next-line compiler-version
 pragma solidity >=0.6.9 <0.9.0;
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface ISequencerInbox {
     event SequencerBatchDelivered(
         uint256 indexed firstMessageNum,

diff --git a/packages/arb-bridge-eth/contracts/challenge/Challenge.sol b/packages/arb-bridge-eth/contracts/challenge/Challenge.sol
@@ -27,6 +27,10 @@ import "../arch/IOneStepProof.sol";
 
 import "./ChallengeLib.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract Challenge is Cloneable, IChallenge {
     using SafeMath for uint256;
 

diff --git a/packages/arb-bridge-eth/contracts/challenge/ChallengeFactory.sol b/packages/arb-bridge-eth/contracts/challenge/ChallengeFactory.sol
@@ -23,6 +23,10 @@ import "./IChallengeFactory.sol";
 import "@openzeppelin/contracts/proxy/BeaconProxy.sol";
 import "@openzeppelin/contracts/proxy/UpgradeableBeacon.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract ChallengeFactory is IChallengeFactory {
     IOneStepProof[] public executors;
     UpgradeableBeacon public beacon;

diff --git a/packages/arb-bridge-eth/contracts/challenge/ChallengeLib.sol b/packages/arb-bridge-eth/contracts/challenge/ChallengeLib.sol
@@ -21,6 +21,10 @@ pragma solidity ^0.6.11;
 import "../libraries/MerkleLib.sol";
 import "@openzeppelin/contracts/math/SafeMath.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 library ChallengeLib {
     using SafeMath for uint256;
 

diff --git a/packages/arb-bridge-eth/contracts/challenge/IChallenge.sol b/packages/arb-bridge-eth/contracts/challenge/IChallenge.sol
@@ -23,6 +23,10 @@ import "../bridge/interfaces/IBridge.sol";
 import "../bridge/interfaces/ISequencerInbox.sol";
 import "../arch/IOneStepProof.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface IChallenge {
     function initializeChallenge(
         IOneStepProof[] calldata _executors,

diff --git a/packages/arb-bridge-eth/contracts/challenge/IChallengeFactory.sol b/packages/arb-bridge-eth/contracts/challenge/IChallengeFactory.sol
@@ -22,6 +22,10 @@ pragma solidity >=0.6.9 <0.9.0;
 import "../bridge/interfaces/IBridge.sol";
 import "../bridge/interfaces/ISequencerInbox.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface IChallengeFactory {
     function createChallenge(
         address _resultReceiver,

diff --git a/packages/arb-bridge-eth/contracts/libraries/AddressAliasHelper.sol b/packages/arb-bridge-eth/contracts/libraries/AddressAliasHelper.sol
@@ -18,6 +18,10 @@
 
 pragma solidity ^0.6.11;
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 library AddressAliasHelper {
     uint160 constant offset = uint160(0x1111000000000000000000000000000000001111);
 

diff --git a/packages/arb-bridge-eth/contracts/libraries/NitroReadyQuery.sol b/packages/arb-bridge-eth/contracts/libraries/NitroReadyQuery.sol
@@ -18,6 +18,10 @@
 
 pragma solidity ^0.6.11;
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface NitroReadyContract {
     function isNitroReady() external pure returns (uint256);
 }

diff --git a/packages/arb-bridge-eth/contracts/rollup/BridgeCreator.sol b/packages/arb-bridge-eth/contracts/rollup/BridgeCreator.sol
@@ -29,6 +29,10 @@ import "@openzeppelin/contracts/access/Ownable.sol";
 import "@openzeppelin/contracts/proxy/ProxyAdmin.sol";
 import "../libraries/Whitelist.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 contract BridgeCreator is Ownable {
     Bridge public delayedBridgeTemplate;
     SequencerInbox public sequencerInboxTemplate;

diff --git a/packages/arb-bridge-eth/contracts/rollup/INode.sol b/packages/arb-bridge-eth/contracts/rollup/INode.sol
@@ -19,6 +19,10 @@
 // solhint-disable-next-line compiler-version
 pragma solidity >=0.6.9 <0.9.0;
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface INode {
     function initialize(
         address _rollup,

diff --git a/packages/arb-bridge-eth/contracts/rollup/INodeFactory.sol b/packages/arb-bridge-eth/contracts/rollup/INodeFactory.sol
@@ -19,6 +19,10 @@
 // solhint-disable-next-line compiler-version
 pragma solidity >=0.6.9 <0.9.0;
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface INodeFactory {
     function createNode(
         bytes32 _stateHash,

diff --git a/packages/arb-bridge-eth/contracts/rollup/IRollupCore.sol b/packages/arb-bridge-eth/contracts/rollup/IRollupCore.sol
@@ -21,6 +21,10 @@ pragma solidity >=0.6.9 <0.9.0;
 
 import "./INode.sol";
 
+/**
+ * @notice DEPRECATED - only for classic version, see new repo (https://github.com/OffchainLabs/nitro/tree/master/contracts)
+ * for new updates
+ */
 interface IRollupCore {
     function _stakerMap(address stakerAddress)
         external