Skip to content

Commit 1939fd5

Browse files
committed
fix: md linter
1 parent f77fe6f commit 1939fd5

3 files changed

Lines changed: 20 additions & 4 deletions

File tree

specs/protocol/bridges.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,11 @@ domain to be able to deposit tokens to that domain. One of these tokens can be
5555
deployed using the `OptimismMintableERC20Factory` contract.
5656

5757
## ERC20 Unlocking
58-
The `ERC20Unlocked` function is used to unlock tokens stuck due to failure in relaying prior ERC20 bridging actions. A `messageHash` must exist in the `ROLLBACK_INBOX` contract to certify the message hash corresponding to an ERC20 bridging action started from the standard bridged failed on the other domain.
58+
59+
The `ERC20Unlocked` function is used to unlock tokens stuck due to failure in
60+
relaying prior ERC20 bridging actions. A `messageHash` must exist in the `ROLLBACK_INBOX`
61+
contract to certify the message hash corresponding to an ERC20 bridging action started
62+
from the standard bridged failed on the other domain.
5963

6064
## Upgradability
6165

specs/protocol/messengers.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,14 @@ on the OptimismPortal, which calls `relayMessage` on the
8585
`L1CrossDomainMessenger` to finalize the withdrawal.
8686

8787
## Rolling a Message Back
88-
The `sendHashToRollbackInbox` function is used to send the hashes of failed and unsuccesful messages to the `ROLLBACK_INBOX` contract on the other domain after a given delay, ensuring the message corresponding to the rolled back hash is never processed in the current domain. The main purpose of this function is to inform the other domain of failed messages so contracts living in this other domain can handle the message failure. This allows functionalities such as unlocking stuck ERC20s.
88+
89+
The `sendHashToRollbackInbox` function is used to send the hashes of failed
90+
and unsuccesful messages to the `ROLLBACK_INBOX` contract on the other domain
91+
after a given delay, ensuring the message corresponding to the rolled back hash
92+
is never processed in the current domain. The main purpose of this function
93+
is to inform the other domain of failed messages so contracts living in
94+
this other domain can handle the message failure. This allows functionalities
95+
such as unlocking stuck ERC20s.
8996

9097
## Upgradability
9198

specs/protocol/rollback-inboxes.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@
1212

1313
## Overview
1414

15-
The rollback inbox contracts are responsible for storing the hashes of messages that failed on the other domain. They are built with the purpose of allowing contracts on the same domain to have the capability of handling what actions to perform when a message failed on the other domain and was rolled-back to it's origin domain.
15+
The rollback inbox contracts are responsible for storing the hashes of messages
16+
that failed on the other domain. They are built with the purpose of allowing contracts
17+
on the same domain to have the capability of handling what actions to perform when a
18+
message failed on the other domain and was rolled-back to it's origin domain.
1619

1720
The `L2RollbackInbox` is a predeploy contract located at TO BE DEFINED.
1821

@@ -29,7 +32,9 @@ interface RollbackInbox {
2932

3033
## Message Hash Reception
3134

32-
The `receiveMessageHash` function is used to receive message hashes from the other domain. It must ensure the caller is the `CrossDomainMessenger` from this domain, and that the sender is the `CrossDomainMessenger` from the other domain.
35+
The `receiveMessageHash` function is used to receive message hashes from the other domain.
36+
It must ensure the caller is the `CrossDomainMessenger` from this domain, and that the
37+
sender is the `CrossDomainMessenger` from the other domain.
3338

3439
## Upgradability
3540

0 commit comments

Comments
 (0)