Skip to content

Commit

Permalink
chore: improve readme (#165)
Browse files Browse the repository at this point in the history
-------
Co-authored-by: Joxes <91908708+Joxess@users.noreply.github.com>
Co-authored-by: Hex <165055168+hexshire@users.noreply.github.com>
  • Loading branch information
0xDiscotech authored Sep 11, 2024
2 parents 0041869 + 906eb0d commit 8869b78
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,27 @@ _`L2OpUSDCBridgeAdapter`_ - Contract that allows for the transfer of USDC from t

![image](https://github.com/defi-wonderland/opUSDC/assets/165055168/eaf55522-e768-463f-830b-b9305cec1e79)

For a user to make a deposit, the process is the following:

### Deposits
1. Users approve the `L1OpUSDCBridgeAdapter` to spend USDC.
2. Users proceed to deposit USDC by calling the contract.
3. The `L1OpUSDCBridgeAdapter` sends the message to the appointed CrossDomainMessenger.
4. The message is digested and included by the sequencer.
5. The `L1OpUSDCBridgeAdapter` mints the specified amount of `bridgedUSDC` to the user.

Similarly, for withdrawals:

### Withdrawals
1. Users send `bridgedUSDC` to the `L2OpUSDCBridgeAdapter`.
2. The `L2OpUSDCBridgeAdapter` burns the token.
3. The `L2OpUSDCBridgeAdapter` sends the message to the appointed CrossDomainMessenger.
4. The message is eventually included and proven on L1.
5. Wait for the challenge period (at least 7 days).
6. The receiving user (or relayers) withdraws the message after the challenge period, which is then forwarded to the `L1OpUSDCBridgeAdapter` that releases the specified amount of USDC to the user.

> **You can test the bridging flows using [Brid.gg in Sepolia](https://testnet.brid.gg/op-sepolia?amount=1&originChainId=11155111&token=USDC).**
## Migrating from Bridged USDC to Native USDC

![image](https://github.com/user-attachments/assets/291aae4c-e9fb-43a5-a11d-71bb3fc78311)
Expand Down

0 comments on commit 8869b78

Please sign in to comment.