Merge pull request #1568 from ethereum-optimism/harry/rename_superchain_weth_to_superchain_eth_bridge

fix: rename SuperchainWETH to SuperchainETHBridge

Author: sbvegan

keywords.config.yaml

@@ -158,7 +158,7 @@ metadata_rules:
       - token-standard
       - token-bridge
       - eth-bridging
-      - superchain-weth
+      - superchain-eth-bridge
       - superchain-token-bridge
       - token-deployment
       - event-reading

pages/app-developers/tutorials/supersim/chain-env/chain-a.mdx

@@ -91,7 +91,7 @@ This guide provides network details and contract addresses for OPChainA (chainID
   "EAS": "0x4200000000000000000000000000000000000021",
   "CrossL2Inbox": "0x4200000000000000000000000000000000000022",
   "L2ToL2CrossDomainMessenger": "0x4200000000000000000000000000000000000023",
-  "SuperchainWETH": "0x4200000000000000000000000000000000000024",
+  "SuperchainETHBridge": "0x4200000000000000000000000000000000000024",
   "SuperchainTokenBridge": "0x4200000000000000000000000000000000000028",
 
   // Periphery

pages/app-developers/tutorials/supersim/chain-env/chain-b.mdx

@@ -91,7 +91,7 @@ This guide provides network details and contract addresses for OPChainB (chainID
   "EAS": "0x4200000000000000000000000000000000000021",
   "CrossL2Inbox": "0x4200000000000000000000000000000000000022",
   "L2ToL2CrossDomainMessenger": "0x4200000000000000000000000000000000000023",
-  "SuperchainWETH": "0x4200000000000000000000000000000000000024",
+  "SuperchainETHBridge": "0x4200000000000000000000000000000000000024",
   "SuperchainTokenBridge": "0x4200000000000000000000000000000000000028",
 
   // Periphery

pages/interop/_meta.json

@@ -14,7 +14,7 @@
     "message-passing": "Superchain interop message passing",
     "reading-logs": "Reading logs",
     "op-supervisor": "OP Supervisor",
-    "superchain-weth": "Superchain ETH",
+    "superchain-eth-bridge": "Superchain ETH bridge",
     "superchain-erc20": "SuperchainERC20",
     "compatible-tokens": "Superchain interop compatible tokens",
     "reorg": "Superchain interop reorg awareness",

pages/interop/op-supervisor.mdx

@@ -93,5 +93,5 @@ For a full listing of API names, see the [source code](https://github.com/ethere
 
 *   Build a [revolutionary app](/app-developers/get-started) that uses multiple blockchains within the Superchain
 *   Deploy a [SuperchainERC20](/interop/tutorials/deploy-superchain-erc20) to the Superchain
-*   Learn [how ETH can move across chains](https://docs.optimism.io/interop/superchain-weth)
+*   Learn [how ETH can move across chains](https://docs.optimism.io/interop/superchain-eth-bridge)
 *   For more info about how Superchain interoperability works under the hood, [check out the specs](https://specs.optimism.io/interop/overview.html?utm_source=op-docs&utm_medium=docs).

pages/interop/superchain-weth.mdx pages/interop/superchain-eth-bridge.mdx

@@ -1,17 +1,17 @@
 ---
-title: Superchain ETH
+title: Superchain ETH Bridge
 description: Learn basic details about Interoperable ETH.
 lang: en-US
 content_type: guide
-topic: superchain-eth
+topic: superchain-eth-bridge
 personas:
   - protocol-developer
   - app-developer
 categories:
   - protocol
   - interoperability
   - cross-chain-messaging
-  - superchain-weth
+  - superchain-eth-bridge
   - eth-bridging
   - interoperable-assets
   - cross-domain-messenger
@@ -25,7 +25,7 @@ import { InteropCallout } from '@/components/WipCallout'
 
 <InteropCallout />
 
-# Superchain ETH
+# Superchain ETH Bridge
 
 <Callout>
   This is an explanation of how interop ETH works.
@@ -35,12 +35,12 @@ import { InteropCallout } from '@/components/WipCallout'
 
 InteroperableETH enables seamless ETH transfers across Superchain blockchains. It is implemented using three key contracts:
 
-*   [`SuperchainWETH`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/SuperchainWETH.sol): A bridge contract that facilitates ETH transfers between Superchain blockchains.
+*   [`SuperchainETHBridge`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/SuperchainETHBridge.sol): A bridge contract that facilitates ETH transfers between Superchain blockchains.
 *   [`ETHLiquidity`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/ETHLiquidity.sol): A liquidity provider for ETH transfers. 
-`SuperchainWETH` uses this contract as a liquidity repository to ensure ETH availability on the destination chain.
+`SuperchainETHBridge` uses this contract as a liquidity repository to ensure ETH availability on the destination chain.
 *   [`L2ToL2CrossDomainMessenger`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/L2ToL2CrossDomainMessenger.sol): A messaging contract that [facilitates cross-chain communication](/interop/message-passing).
 
-Superchain ETH deposits ETH into the `ETHLiquidity` contract on the source chain and withdraws an equivalent amount on the destination chain. 
+Superchain ETH Bridge deposits ETH into the `ETHLiquidity` contract on the source chain and withdraws an equivalent amount on the destination chain. 
 This mechanism improves capital efficiency and eliminates liquidity fragmentation and poor user experiences caused by asset wrapping or reliance on liquidity pools.
 
 ## Features and benefits
@@ -65,61 +65,61 @@ This mechanism improves capital efficiency and eliminates liquidity fragmentatio
 sequenceDiagram
   box rgba(0,0,0,0.1) Source Chain
     participant src-liquidity as ETHLiquidity
-    participant src-weth as SuperchainWETH
+    participant src-eth-bridge as SuperchainETHBridge
   end
   actor user as User
   participant any-offchain as User, Relayer, etc.  
   box rgba(0,0,0,0.1) Destination Chain
     participant dst-l2Xl2 as L2ToL2CrossDomainMessenger
-    participant dst-weth as SuperchainWETH
+    participant dst-eth-bridge as SuperchainETHBridge
     participant dst-liquidity as ETHLiquidity       
     participant dst-final as ETH Destination
   end
   rect rgba(0,0,0,0.1)
-    note over src-weth, dst-l2Xl2: Initiating Message
-    user->>src-weth: 1. sendETH(to, chainId) with n ETH
-    src-weth->>src-liquidity: 2. Deposit n ETH
-    src-weth->>dst-l2Xl2: 3. Send relayETH to Superchain WETH on chainId
+    note over src-eth-bridge, dst-l2Xl2: Initiating Message
+    user->>src-eth-bridge: 1. sendETH(to, chainId) with n ETH
+    src-eth-bridge->>src-liquidity: 2. Deposit n ETH
+    src-eth-bridge->>dst-l2Xl2: 3. Send relayETH to SuperchainETHBridge on chainId
   end
   rect rgba(0,0,0,0.1)
-    note over any-offchain,dst-weth: Executing message
+    note over any-offchain,dst-eth-bridge: Executing message
     any-offchain->>dst-l2Xl2: 4. Relay the message
-    dst-l2Xl2->>dst-weth: 5. relayETH(from, to, amount)
-    dst-weth->>dst-liquidity: 6. Withdraw amount ETH
-    dst-weth->>dst-final: 7. Here are amount ETH
+    dst-l2Xl2->>dst-eth-bridge: 5. relayETH(from, to, amount)
+    dst-eth-bridge->>dst-liquidity: 6. Withdraw amount ETH
+    dst-eth-bridge->>dst-final: 7. Here are amount ETH
   end
 ```
 
 #### Initiating message
 
-1.  The user (or a contract operating on a user's behalf) calls `SuperchainWETH.sendETH` with a destination address and a chainId.
+1.  The user (or a contract operating on a user's behalf) calls `SuperchainETHBridge.sendETH` with a destination address and a chainId.
     ETH, in the amount to transfer must be attached to this call.
 
-2.  `SuperchainWETH` transfers the specified ETH amount to `ETHLiquidity`, removing it from circulation on the source chain.
+2.  `SuperchainETHBridge` transfers the specified ETH amount to `ETHLiquidity`, removing it from circulation on the source chain.
 
-3.  `SuperchainWETH` on the source chain sends a [`relayETH`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/SuperchainWETH.sol#L125-L145) message to `SuperchainWETH` on the destination chain using the [`L2ToL2CrossDomainMessenger`](/interop/message-passing).
+3.  `SuperchainETHBridge` on the source chain sends a [`relayETH`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/SuperchainETHBridge.sol) message to `SuperchainETHBridge` on the destination chain using the [`L2ToL2CrossDomainMessenger`](/interop/message-passing).
 
 #### Executing message
 
 4.  An off-chain entity submits a transaction to execute the message.
     Any address can submit this transaction, but it must have ETH on the destination chain.
     Typically, this would be the chain's autorelayer.
 
-5.  `L2ToL2CrossDomainMessenger` on the destination chain calls `SuperchainWETH` with the following details:
+5.  `L2ToL2CrossDomainMessenger` on the destination chain calls `SuperchainETHBridge` with the following details:
 
     *   Source of the ETH
     *   Destination address
     *   Amount of ETH
 
-    `SuperchainWETH` performs several sanity checks:
+    `SuperchainETHBridge` performs several sanity checks:
 
     *   The `relayETH` call must originate from `L2ToL2CrossDomainMessenger`.
-    *   The interop message must have been sent by `SuperchainWETH`
+    *   The interop message must have been sent by `SuperchainETHBridge`
 
-6.  `SuperchainWETH` withdraws the specified amount of ETH from `ETHLiquidity`.
-    Only `SuperchainWETH` can withdraw from `ETHLiquidity`, ensuring that the ETH is correctly reintroduced into circulation on the destination chain.
+6.  `SuperchainETHBridge` withdraws the specified amount of ETH from `ETHLiquidity`.
+    Only `SuperchainETHBridge` can withdraw from `ETHLiquidity`, ensuring that the ETH is correctly reintroduced into circulation on the destination chain.
 
-7.  `SuperchainWETH` uses [`SafeSend`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/universal/SafeSend.sol) to send ETH.
+7.  `SuperchainETHBridge` uses [`SafeSend`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/universal/SafeSend.sol) to send ETH.
     This ensures that even if the destination is a smart contract, its custom logic is not executed.
 This behavior differs from [standard ETH transfers](https://docs.base.org/learn/address-and-payable/address-and-payable#receiving-ether-with-payable-addresses), where smart contracts can trigger custom logic upon receiving ETH.
 
@@ -147,11 +147,11 @@ Here is an example of how this works.
     The user sends 3 ETH on L1 to the bridge, which is locked in the lockbox.
     The bridge on chain A then mints 3 ETH for the user.
 
-3.  The user sent the initiating message to `SuperchainWETH` on chain A, along with 1 ETH to bridge to chain B.
+3.  The user sent the initiating message to `SuperchainETHBridge` on chain A, along with 1 ETH to bridge to chain B.
     This 1 ETH is sent to `ETHLiquidity` on chain A.
 
 4.  Somebody (the user, a relayer action on behalf of the user, etc.) sent the corresponding executing message to chain B.
-    `SuperchainWETH` transfers 1 ETH from `ETHLiquidity` on chain B to the user.
+    `SuperchainETHBridge` transfers 1 ETH from `ETHLiquidity` on chain B to the user.
 
 5.  The user decides to withdraw 1 ETH from chain B back into L1.
     Normally, a user would do this through a third-party bridge, which is faster and usually cheaper, but for illustration purposes this user uses the standard OP bridge.

pages/interop/tutorials/bridge-crosschain-eth.mdx

@@ -30,12 +30,12 @@ import { AutorelayCallout } from '@/components/AutorelayCallout'
 <Callout>
   This tutorial provides step-by-step instructions for how to send ETH from one chain in the Superchain interop cluster to another.
   For a conceptual overview,
-  see the [interoperable ETH explainer](/interop/superchain-weth).
+  see the [interoperable ETH explainer](/interop/superchain-eth-bridge).
 </Callout>
 
 ## Overview
 
-Crosschain ETH transfers in the Superchain are facilitated through the [SuperchainWETH](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/SuperchainWETH.sol) contract.
+Crosschain ETH transfers in the Superchain are facilitated through the [SuperchainETHBridge](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/SuperchainETHBridge.sol) contract.
 This tutorial walks through how to send ETH from one chain to another.
 You can do this on [Supersim](/interop/tools/supersim), [the Interop devnet](/interop/tools/devnet), or production once it is released.
 
@@ -169,9 +169,9 @@ The tutorial uses these primary tools:
   ```sh
   DST_CHAINID=`cast chain-id --rpc-url $DST_URL`
   MY_ADDRESS=`cast wallet address $PRIVATE_KEY`
-  SUPERCHAIN_WETH=0x4200000000000000000000000000000000000024
+  SUPERCHAIN_ETH_BRIDGE=0x4200000000000000000000000000000000000024
   BEFORE=`cast balance $MY_ADDRESS --rpc-url $DST_URL | cast from-wei`          
-  cast send --rpc-url $SRC_URL --private-key $PRIVATE_KEY $SUPERCHAIN_WETH "sendETH(address,uint256)" $MY_ADDRESS $DST_CHAINID --value 0.001ether
+  cast send --rpc-url $SRC_URL --private-key $PRIVATE_KEY $SUPERCHAIN_ETH_BRIDGE "sendETH(address,uint256)" $MY_ADDRESS $DST_CHAINID --value 0.001ether
   sleep 10
   AFTER=`cast balance $MY_ADDRESS --rpc-url $DST_URL | cast from-wei`
   echo -e Balance before transfer\\t$BEFORE
@@ -195,15 +195,15 @@ The tutorial uses these primary tools:
       mkdir src
       ```
 
-  2.  Download the ABI for `SuperchainWETH`.
+  2.  Download the ABI for `SuperchainETHBridge`.
 
       ```sh
-      curl https://raw.githubusercontent.com/ethereum-optimism/optimism/refs/heads/develop/packages/contracts-bedrock/snapshots/abi/SuperchainWETH.json > src/SuperchainWETH.abi.json
+      curl https://raw.githubusercontent.com/ethereum-optimism/optimism/refs/heads/develop/packages/contracts-bedrock/snapshots/abi/SuperchainETHBridge.json > src/SuperchainETHBridge.abi.json
       ```
 
   3.  Place this in `src/transfer-eth.mts`:
 
-      ```typescript file=<rootDir>/public/tutorials/transfer-eth.mts hash=c6032f96e0fc040ad8fff7bc2892bbb6 
+      ```typescript file=<rootDir>/public/tutorials/transfer-eth.mts hash=f71ba1d6d6b4adf8cb3283792abac853 
       ```
 
       <details>
@@ -285,7 +285,7 @@ The tutorial uses these primary tools:
 
 ## Next steps
 
-*   Check out the [SuperchainWETH guide](/interop/superchain-weth) for more information.
+*   Check out the [SuperchainETHBridge guide](/interop/superchain-eth-bridge) for more information.
 *   Use the [SuperchainERC20 Starter Kit](/app-developers/starter-kit) to deploy your token across the Superchain.
 *   Review the [Superchain interop explainer](/interop/explainer) for answers to common questions about interoperability.
 

public/_redirects

@@ -195,7 +195,8 @@
 /stack/interop/predeploy     /interop/predeploy
 /stack/interop/explainer     /interop/explainer
 /stack/interop/interop-security     /interop/interop-security
-/stack/interop/superchain-weth     /interop/superchain-weth
+/stack/interop/superchain-weth     /interop/superchain-eth-bridge
+/interop/superchain-weth     /interop/superchain-eth-bridge
 /interop     /interop/explainer
 /stack/interop     /interop/get-started
 

public/tutorials/transfer-eth.mts

@@ -24,7 +24,7 @@ import {
     contracts as optimismContracts
 } from '@eth-optimism/viem'
 
-import superchainWethAbi from './SuperchainWETH.abi.json'
+import superchainEthBridgeAbi from './SuperchainETHBridge.abi.json'
 
 const supersimAddress="0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"
 const account = privateKeyToAccount(process.env.PRIVATE_KEY as `0x${string}`)
@@ -48,8 +48,8 @@ const destinationWallet = createWalletClient({
     .extend(walletActionsL2())
 
 const wethOnSource = await getContract({
-    address: optimismContracts.superchainWETH.address,
-    abi: superchainWethAbi,
+    address: optimismContracts.superchainETHBridge.address,
+    abi: superchainEthBridgeAbi,
     client: sourceWallet
 })