Skip to content

Commit

Permalink
interop: changed event tense to present for ICrosschainERC20 (#435)
Browse files Browse the repository at this point in the history
* feat: changed event tense to present for ICrosschainERC20

* chore: typo
  • Loading branch information
0xParticle authored Oct 18, 2024
1 parent d6b979a commit 9f7226b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions specs/interop/predeploys.md
Original file line number Diff line number Diff line change
Expand Up @@ -952,15 +952,15 @@ sequenceDiagram
from->>L2SBA: sendERC20(tokenAddr, to, amount, chainID)
L2SBA->>SuperERC20_A: crosschainBurn(from, amount)
SuperERC20_A-->SuperERC20_A: emit SuperchainBurn(from, amount)
SuperERC20_A-->SuperERC20_A: emit CrosschainBurn(from, amount)
L2SBA->>Messenger_A: sendMessage(chainId, message)
Messenger_A->>L2SBA: return msgHash_
L2SBA-->L2SBA: emit SentERC20(tokenAddr, from, to, amount, destination)
L2SBA->>from: return msgHash_
Inbox->>Messenger_B: relayMessage()
Messenger_B->>L2SBB: relayERC20(tokenAddr, from, to, amount)
L2SBB->>SuperERC20_B: crosschainMint(to, amount)
SuperERC20_B-->SuperERC20_B: emit SuperchainMinted(to, amount)
SuperERC20_B-->SuperERC20_B: emit CrosschainMint(to, amount)
L2SBB-->L2SBB: emit RelayedERC20(tokenAddr, from, to, amount, source)
```

Expand Down
20 changes: 10 additions & 10 deletions specs/interop/token-bridging.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
- [`ICrosschainERC20`](#icrosschainerc20)
- [`crosschainMint`](#crosschainmint)
- [`crosschainBurn`](#crosschainburn)
- [`CrosschainMinted`](#crosschainminted)
- [`CrosschainBurnt`](#crosschainburnt)
- [`CrosschainMint`](#crosschainmint)
- [`CrosschainBurn`](#crosschainburn)
- [`SuperchainERC20Bridge`](#superchainerc20bridge)
- [Diagram](#diagram)
- [Implementation](#implementation)
Expand Down Expand Up @@ -79,20 +79,20 @@ Burns `_amount` of token from address `_account`.
crosschainBurn(address _account, uint256 _amount)
```

#### `CrosschainMinted`
#### `CrosschainMint`

MUST trigger when `crosschainMint` is called

```solidity
event CrosschainMinted(address indexed _to, uint256 _amount)
event CrosschainMint(address indexed _to, uint256 _amount)
```

#### `CrosschainBurnt`
#### `CrosschainBurn`

MUST trigger when `crosschainBurn` is called

```solidity
event CrosschainBurnt(address indexed _from, uint256 _amount)
event CrosschainBurn(address indexed _from, uint256 _amount)
```

## `SuperchainERC20Bridge`
Expand Down Expand Up @@ -133,15 +133,15 @@ sequenceDiagram
from->>L2SBA: sendERC20(tokenAddr, to, amount, chainID)
L2SBA->>SuperERC20_A: crosschainBurn(from, amount)
SuperERC20_A-->SuperERC20_A: emit CrosschainBurnt(from, amount)
SuperERC20_A-->SuperERC20_A: emit CrosschainBurn(from, amount)
L2SBA->>Messenger_A: sendMessage(chainId, message)
Messenger_A->>L2SBA: return msgHash_
L2SBA-->L2SBA: emit SentERC20(tokenAddr, from, to, amount, destination)
L2SBA->>from: return msgHash_
Inbox->>Messenger_B: relayMessage()
Messenger_B->>L2SBB: relayERC20(tokenAddr, from, to, amount)
L2SBB->>SuperERC20_B: crosschainMint(to, amount)
SuperERC20_B-->SuperERC20_B: emit CrosschainMinted(to, amount)
SuperERC20_B-->SuperERC20_B: emit CrosschainMint(to, amount)
L2SBB-->L2SBB: emit RelayedERC20(tokenAddr, from, to, amount, source)
```

Expand Down Expand Up @@ -230,14 +230,14 @@ sequenceDiagram
from->>Intermediate_A: sendWithData(data)
Intermediate_A->>L2SBA: sendERC20To(tokenAddr, to, amount, chainID)
L2SBA->>SuperERC20_A: crosschainBurn(from, amount)
SuperERC20_A-->SuperERC20_A: emit CrosschainBurnt(from, amount)
SuperERC20_A-->SuperERC20_A: emit CrosschainBurn(from, amount)
L2SBA->>Messenger_A: sendMessage(chainId, message)
L2SBA-->L2SBA: emit SentERC20(tokenAddr, from, to, amount, destination)
Intermediate_A->>Messenger_A: sendMessage(chainId, to, data)
Inbox->>Messenger_B: relayMessage()
Messenger_B->>L2SBB: relayERC20(tokenAddr, from, to, amount)
L2SBB->>SuperERC20_B: crosschainMint(to, amount)
SuperERC20_B-->SuperERC20_B: emit CrosschainMinted(to, amount)
SuperERC20_B-->SuperERC20_B: emit CrosschainMint(to, amount)
Inbox->>Messenger_B: relayMessage(): call
L2SBB-->L2SBB: emit RelayedERC20(tokenAddr, from, to, amount, source)
Messenger_B->>to: call(data)
Expand Down

0 comments on commit 9f7226b

Please sign in to comment.