Skip to content

Commit

Permalink
chore: update contract names (#488)
Browse files Browse the repository at this point in the history
* chore: update contract names

* ToC
  • Loading branch information
qbzzt authored Jan 14, 2025
1 parent 76b48c2 commit 4af94f7
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions specs/interop/predeploys.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
- [Events](#events)
- [`OptimismSuperchainERC20Created`](#optimismsuperchainerc20created)
- [Deployment Flow](#deployment-flow)
- [BeaconContract](#beaconcontract)
- [OptimismSuperchainERC20Beacon](#optimismsuperchainerc20beacon)
- [Overview](#overview-2)
- [L1Block](#l1block)
- [Static Configuration](#static-configuration)
Expand All @@ -56,7 +56,7 @@
- [`Converted`](#converted)
- [Invariants](#invariants)
- [Conversion Flow](#conversion-flow)
- [SuperchainERC20Bridge](#superchainerc20bridge)
- [SuperchainTokenBridge](#superchaintokenbridge)
- [Overview](#overview-3)
- [Functions](#functions-3)
- [`sendERC20`](#senderc20)
Expand Down Expand Up @@ -442,15 +442,15 @@ sequenceDiagram
BeaconProxy->>Implementation: initialize()
```

## BeaconContract
## OptimismSuperchainERC20Beacon

| Constant | Value |
| -------- | -------------------------------------------- |
| Address | `0x4200000000000000000000000000000000000027` |

### Overview

The `BeaconContract` predeploy gets called by the `OptimismSuperchainERC20`
The `OptimismSuperchainERC20Beacon` predeploy gets called by the `OptimismSuperchainERC20`
BeaconProxies deployed by the
[`SuperchainERC20Factory`](#optimismsuperchainerc20factory)

Expand Down Expand Up @@ -712,15 +712,15 @@ sequenceDiagram
L2StandardBridge-->L2StandardBridge: emit Converted(from, to, Alice, amount)
```

## SuperchainERC20Bridge
## SuperchainTokenBridge

| Constant | Value |
| -------- | -------------------------------------------- |
| Address | `0x4200000000000000000000000000000000000028` |

### Overview

The `SuperchainERC20Bridge` is an abstraction on top of the `L2toL2CrossDomainMessenger`
The `SuperchainTokenBridge` is an abstraction on top of the `L2toL2CrossDomainMessenger`
that facilitates token bridging using interop.
It has mint and burn rights over `SuperchainERC20` tokens
as described in the [token bridging spec](./token-bridging.md).
Expand Down Expand Up @@ -791,12 +791,12 @@ The following diagram depicts a cross-chain transfer.
```mermaid
sequenceDiagram
participant from
participant L2SBA as SuperchainERC20Bridge (Chain A)
participant L2SBA as SuperchainTokenBridge (Chain A)
participant SuperERC20_A as SuperchainERC20 (Chain A)
participant Messenger_A as L2ToL2CrossDomainMessenger (Chain A)
participant Inbox as CrossL2Inbox
participant Messenger_B as L2ToL2CrossDomainMessenger (Chain B)
participant L2SBB as SuperchainERC20Bridge (Chain B)
participant L2SBB as SuperchainTokenBridge (Chain B)
participant SuperERC20_B as SuperchainERC20 (Chain B)
from->>L2SBA: sendERC20(tokenAddr, to, amount, chainID)
Expand All @@ -815,7 +815,7 @@ sequenceDiagram

### Invariants

The bridging of `SuperchainERC20` using the `SuperchainERC20Bridge` will require the following invariants:
The bridging of `SuperchainERC20` using the `SuperchainTokenBridge` will require the following invariants:

- Conservation of bridged `amount`: The minted `amount` in `relayERC20()` should match the `amount`
that was burnt in `sendERC20()`, as long as target chain has the initiating chain in the dependency set.
Expand Down

0 comments on commit 4af94f7

Please sign in to comment.