deprecate bridge peripherals

packages/arb-bridge-peripherals/README.md

@@ -0,0 +1,5 @@
+# arb-bridge-peripherals
+
+This package has moved!
+
+If you want to use what was once called `arb-bridge-peripherals`, look into the latest and greatest [`token-bridge-contracts`](https://github.com/OffchainLabs/token-bridge-contracts)!

packages/arb-bridge-peripherals/contracts/tokenbridge/arbitrum/IArbToken.sol

@@ -21,6 +21,7 @@
  * for a custom token that interacts with the bridge, see TestArbCustomToken.sol for an example implementation).
  */
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 // solhint-disable-next-line compiler-version
 pragma solidity >=0.6.9 <0.9.0;
 

packages/arb-bridge-peripherals/contracts/tokenbridge/arbitrum/L2ArbitrumMessenger.sol

@@ -20,6 +20,7 @@ pragma solidity ^0.6.11;
 
 import "arbos-precompiles/arbos/builtin/ArbSys.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 /// @notice L2 utility contract to assist with L1 <=> L2 interactions
 /// @dev this is an abstract contract instead of library so the functions can be easily overriden when testing
 abstract contract L2ArbitrumMessenger {

packages/arb-bridge-peripherals/contracts/tokenbridge/arbitrum/StandardArbERC20.sol

@@ -24,6 +24,7 @@ import "../libraries/BytesParser.sol";
 import "./IArbToken.sol";
 
 /**
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  * @title Standard (i.e., non-custom) contract deployed by L2Gateway.sol as L2 ERC20. Includes standard ERC20 interface plus additional methods for deposits/withdraws
  */
 contract StandardArbERC20 is IArbToken, L2GatewayToken, Cloneable {

packages/arb-bridge-peripherals/contracts/tokenbridge/arbitrum/gateway/L2ArbitrumGateway.sol

@@ -31,6 +31,7 @@ import "../../libraries/gateway/TokenGateway.sol";
 
 /**
  * @title Common interface for gatways on Arbitrum messaging to L1.
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 abstract contract L2ArbitrumGateway is L2ArbitrumMessenger, TokenGateway {
     using Address for address;

packages/arb-bridge-peripherals/contracts/tokenbridge/arbitrum/gateway/L2CustomGateway.sol

@@ -24,6 +24,7 @@ import "../../libraries/gateway/ICustomGateway.sol";
 import "@openzeppelin/contracts/math/SafeMath.sol";
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract L2CustomGateway is L2ArbitrumGateway, ICustomGateway {
     // stores addresses of L2 tokens to be used
     mapping(address => address) public override l1ToL2Token;

packages/arb-bridge-peripherals/contracts/tokenbridge/arbitrum/gateway/L2ERC20Gateway.sol

@@ -24,6 +24,7 @@ import "./L2ArbitrumGateway.sol";
 import "../StandardArbERC20.sol";
 import "../../libraries/ClonableBeaconProxy.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract L2ERC20Gateway is L2ArbitrumGateway {
     address public beaconProxyFactory;
 

packages/arb-bridge-peripherals/contracts/tokenbridge/arbitrum/gateway/L2GatewayRouter.sol

@@ -26,6 +26,7 @@ import "arb-bridge-eth/contracts/libraries/AddressAliasHelper.sol";
 /**
  * @title Handles withdrawals from Ethereum into Arbitrum. Tokens are routered to their appropriate L2 gateway (Router itself also conforms to the Gateway interface).
  * @notice Router also serves as an L2-L1 token address oracle.
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 contract L2GatewayRouter is GatewayRouter, L2ArbitrumMessenger {
     modifier onlyCounterpartGateway() override {

packages/arb-bridge-peripherals/contracts/tokenbridge/arbitrum/gateway/L2WethGateway.sol

@@ -23,6 +23,7 @@ import "../../libraries/IWETH9.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/SafeERC20.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract L2WethGateway is L2ArbitrumGateway {
     using SafeERC20 for IERC20;
 

packages/arb-bridge-peripherals/contracts/tokenbridge/ethereum/ICustomToken.sol

@@ -26,6 +26,7 @@ interface ArbitrumEnabledToken {
 
 /**
  * @title Minimum expected interface for L1 custom token (see TestCustomTokenL1.sol for an example implementation)
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 interface ICustomToken is ArbitrumEnabledToken {
     /**

packages/arb-bridge-peripherals/contracts/tokenbridge/ethereum/L1ArbitrumMessenger.sol

@@ -21,6 +21,7 @@ pragma solidity ^0.6.11;
 import "arb-bridge-eth/contracts/bridge/interfaces/IInbox.sol";
 import "arb-bridge-eth/contracts/bridge/interfaces/IOutbox.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 /// @notice L1 utility contract to assist with L1 <=> L2 interactions
 /// @dev this is an abstract contract instead of library so the functions can be easily overriden when testing
 abstract contract L1ArbitrumMessenger {

packages/arb-bridge-peripherals/contracts/tokenbridge/ethereum/gateway/IL1ArbitrumGateway.sol

@@ -24,6 +24,7 @@ import "../../libraries/IERC165.sol";
 
 /**
  * @title Common interface for gatways on L1 messaging to Arbitrum.
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 interface IL1ArbitrumGateway is ITokenGateway, IERC165 {
     function inbox() external view returns (address);

packages/arb-bridge-peripherals/contracts/tokenbridge/ethereum/gateway/IL1GatewayRouter.sol

@@ -25,6 +25,7 @@ import "../../libraries/IERC165.sol";
 /**
  * @title Handles deposits from Erhereum into Arbitrum. Tokens are routered to their appropriate L1 gateway (Router itself also conforms to the Gateway itnerface).
  * @notice Router also serves as an L1-L2 token address oracle.
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 interface IL1GatewayRouter is ITokenGateway, IERC165 {
     /**

packages/arb-bridge-peripherals/contracts/tokenbridge/ethereum/gateway/L1ArbitrumExtendedGateway.sol

@@ -22,6 +22,7 @@ import "../../libraries/ITransferAndCall.sol";
 
 import "./L1ArbitrumGateway.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 interface ITradeableExitReceiver {
     function onExitTransfer(
         address sender,

packages/arb-bridge-peripherals/contracts/tokenbridge/ethereum/gateway/L1ArbitrumGateway.sol

@@ -36,6 +36,7 @@ import "../../libraries/ERC165.sol";
 
 /**
  * @title Common interface for gatways on L1 messaging to Arbitrum.
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 abstract contract L1ArbitrumGateway is
     L1ArbitrumMessenger,

packages/arb-bridge-peripherals/contracts/tokenbridge/ethereum/gateway/L1CustomGateway.sol

@@ -29,6 +29,7 @@ import "arb-bridge-eth/contracts/libraries/Whitelist.sol";
 /**
  * @title Gatway for "custom" bridging functionality
  * @notice Handles some (but not all!) custom Gateway needs.
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 contract L1CustomGateway is L1ArbitrumExtendedGateway, ICustomGateway {
     using Address for address;

packages/arb-bridge-peripherals/contracts/tokenbridge/ethereum/gateway/L1ERC20Gateway.sol

@@ -27,6 +27,7 @@ import "arb-bridge-eth/contracts/libraries/Whitelist.sol";
  * @notice This contract handles token deposits, holds the escrowed tokens on layer 1, and (ultimately) finalizes withdrawals.
  * @dev Any ERC20 that requires non-standard functionality should use a separate gateway.
  * Messages to layer 2 use the inbox's createRetryableTicket method.
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 contract L1ERC20Gateway is L1ArbitrumExtendedGateway {
     // used for create2 address calculation

packages/arb-bridge-peripherals/contracts/tokenbridge/ethereum/gateway/L1GatewayRouter.sol

@@ -31,6 +31,7 @@ import "./IL1ArbitrumGateway.sol";
 /**
  * @title Handles deposits from Erhereum into Arbitrum. Tokens are routered to their appropriate L1 gateway (Router itself also conforms to the Gateway itnerface).
  * @notice Router also serves as an L1-L2 token address oracle.
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 contract L1GatewayRouter is
     WhitelistConsumer,

packages/arb-bridge-peripherals/contracts/tokenbridge/ethereum/gateway/L1WethGateway.sol

@@ -25,6 +25,7 @@ import "../../libraries/IWETH9.sol";
 import "../../test/TestWETH9.sol";
 import "./L1ArbitrumExtendedGateway.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract L1WethGateway is L1ArbitrumExtendedGateway {
     using SafeERC20 for IERC20;
 

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/BytesParser.sol

@@ -20,6 +20,7 @@ pragma solidity ^0.6.11;
 
 import "arb-bridge-eth/contracts/libraries/BytesLib.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 library BytesParser {
     using BytesLib for bytes;
 

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/ClonableBeaconProxy.sol

@@ -6,6 +6,7 @@ import "@openzeppelin/contracts/proxy/BeaconProxy.sol";
 import "@openzeppelin/contracts/proxy/UpgradeableBeacon.sol";
 import "@openzeppelin/contracts/utils/Create2.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 interface ProxySetter {
     function beacon() external view returns (address);
 }

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/ITransferAndCall.sol

@@ -4,6 +4,7 @@ pragma solidity >0.6.0 <0.8.0;
 
 import "@openzeppelin/contracts-upgradeable/token/ERC20/IERC20Upgradeable.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 interface ITransferAndCall is IERC20Upgradeable {
     function transferAndCall(
         address to,

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/IWETH9.sol

@@ -3,6 +3,7 @@
 // solhint-disable-next-line compiler-version
 pragma solidity >=0.6.9 <0.9.0;
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 interface IWETH9 {
     function deposit() external payable;
 

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/L2GatewayToken.sol

@@ -24,6 +24,7 @@ import "../arbitrum/IArbToken.sol";
 
 /**
  * @title Standard (i.e., non-custom) contract used as a base for different L2 Gateways
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 abstract contract L2GatewayToken is aeERC20, IArbToken {
     address public l2Gateway;

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/TransferAndCallToken.sol

@@ -9,6 +9,7 @@ import "./ITransferAndCall.sol";
 /**
  * @notice based on Implementation from https://github.com/smartcontractkit/LinkToken/blob/master/contracts/v0.6/ERC677Token.sol
  * The implementation doesn't return a bool on onTokenTransfer. This is similar to the proposed 677 standard, but still incompatible - thus we don't refer to it as such.
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 abstract contract TransferAndCallToken is ERC20Upgradeable, ITransferAndCall {
     /**

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/aeERC20.sol

@@ -23,6 +23,7 @@ import "./TransferAndCallToken.sol";
 
 /// @title Arbitrum extended ERC20
 /// @notice The recommended ERC20 implementation for Layer 2 tokens
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 /// @dev This implements the ERC20 standard with transferAndCall extenstion/affordances
 contract aeERC20 is ERC20PermitUpgradeable, TransferAndCallToken {
     using AddressUpgradeable for address;

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/aeWETH.sol

@@ -22,6 +22,7 @@ import "./L2GatewayToken.sol";
 import "./IWETH9.sol";
 
 /// @title Arbitrum extended WETH
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract aeWETH is L2GatewayToken, IWETH9 {
     function initialize(
         string memory name_,

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/gateway/GatewayMessageHandler.sol

@@ -19,6 +19,7 @@
 pragma solidity ^0.6.11;
 
 /// @notice this library manages encoding and decoding of gateway communication
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 library GatewayMessageHandler {
     // these are for communication from L1 to L2 gateway
 

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/gateway/GatewayRouter.sol

@@ -26,6 +26,7 @@ import "./IGatewayRouter.sol";
 
 /**
  * @title Common interface for L1 and L2 Gateway Routers
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 abstract contract GatewayRouter is TokenGateway, IGatewayRouter {
     using Address for address;

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/gateway/ICustomGateway.sol

@@ -21,6 +21,7 @@ pragma solidity >=0.6.9 <0.9.0;
 
 // import "./ITokenGateway.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 interface ICustomGateway {
     function l1ToL2Token(address _l1Token) external view returns (address _l2Token);
 

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/gateway/IGatewayRouter.sol

@@ -25,6 +25,7 @@ import "./GatewayMessageHandler.sol";
 
 /**
  * @title Common interface for L1 and L2 Gateway Routers
+ * @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
  */
 interface IGatewayRouter is ITokenGateway {
     function defaultGateway() external view returns (address gateway);

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/gateway/ITokenGateway.sol

@@ -19,6 +19,7 @@
 // solhint-disable-next-line compiler-version
 pragma solidity >=0.6.9 <0.9.0;
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 interface ITokenGateway {
     /// @notice event deprecated in favor of DepositInitiated and WithdrawalInitiated
     // event OutboundTransferInitiated(

packages/arb-bridge-peripherals/contracts/tokenbridge/libraries/gateway/TokenGateway.sol

@@ -21,6 +21,7 @@ pragma solidity ^0.6.11;
 import "./ITokenGateway.sol";
 import "@openzeppelin/contracts/utils/Address.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 abstract contract TokenGateway is ITokenGateway {
     using Address for address;
 

packages/arb-bridge-peripherals/contracts/tokenbridge/test/AddressMappingTest.sol

@@ -21,6 +21,7 @@ pragma solidity ^0.6.11;
 import "../arbitrum/L2ArbitrumMessenger.sol";
 import "arb-bridge-eth/contracts/libraries/AddressAliasHelper.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract AddressMappingTest is L2ArbitrumMessenger {
     function getL1AddressTest(address sender) external pure returns (address l1Address) {
         return AddressAliasHelper.undoL1ToL2Alias(sender);

packages/arb-bridge-peripherals/contracts/tokenbridge/test/ArbSysMock.sol

@@ -1,5 +1,6 @@
 pragma solidity ^0.6.11;
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract ArbSysMock {
     event ArbSysL2ToL1Tx(address from, address to, uint256 value, bytes data);
     uint256 counter;

packages/arb-bridge-peripherals/contracts/tokenbridge/test/InboxMock.sol

@@ -22,6 +22,7 @@ import "arb-bridge-eth/contracts/bridge/interfaces/IOutbox.sol";
 import "arb-bridge-eth/contracts/bridge/interfaces/IBridge.sol";
 import "arb-bridge-eth/contracts/bridge/interfaces/IInbox.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract InboxMock {
     address l2ToL1SenderMock = address(0);
 

packages/arb-bridge-peripherals/contracts/tokenbridge/test/TestArbCustomToken.sol

@@ -21,6 +21,7 @@ pragma solidity ^0.6.11;
 import "../arbitrum/IArbToken.sol";
 import "../libraries/aeERC20.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract TestArbCustomToken is aeERC20, IArbToken {
     address public l2Gateway;
     address public override l1Address;

packages/arb-bridge-peripherals/contracts/tokenbridge/test/TestBytesParser.sol

@@ -20,6 +20,7 @@ pragma solidity ^0.6.11;
 
 import "../libraries/BytesParser.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract TestBytesParser {
     function bytesToString(bytes memory input)
         public

packages/arb-bridge-peripherals/contracts/tokenbridge/test/TestCustomTokenL1.sol

@@ -10,6 +10,7 @@ import "@openzeppelin/contracts/GSN/Context.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts/math/SafeMath.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 interface IL1CustomGateway {
     function registerTokenToL2(
         address _l2Address,

packages/arb-bridge-peripherals/contracts/tokenbridge/test/TestERC20.sol

@@ -21,6 +21,7 @@ pragma solidity ^0.6.11;
 import "../libraries/aeERC20.sol";
 import "@openzeppelin/contracts-upgradeable/drafts/ERC20PermitUpgradeable.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract TestERC20 is aeERC20 {
     constructor() public {
         aeERC20._initialize("IntArbTestToken", "IARB", uint8(18));

packages/arb-bridge-peripherals/contracts/tokenbridge/test/TestPostDepositCall.sol

@@ -20,6 +20,7 @@ pragma solidity ^0.6.11;
 
 import "../libraries/ITransferAndCall.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract L2Called is ITransferAndCallReceiver {
     event Called(uint256 num);
 

packages/arb-bridge-peripherals/contracts/tokenbridge/test/TestWETH9.sol

@@ -6,6 +6,7 @@ import "../libraries/IWETH9.sol";
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import "@openzeppelin/contracts/proxy/ProxyAdmin.sol";
 
+/// @notice DEPRECATED - see new repo(https://github.com/OffchainLabs/token-bridge-contracts) for new updates
 contract TestWETH9 is ERC20, IWETH9 {
     constructor(string memory name_, string memory symbol_) public ERC20(name_, symbol_) {}