docs: Add architecture and sequence diagrams (#57)

Author: zguesmi

.gitignore

@@ -10,16 +10,12 @@ out/
 broadcast/*/*/run-*.json
 !broadcast/*/*/run-latest.json
 
-
-# Docs
-docs/
-
 # Dotenv file
 .env
 .last_deploy.json
 
 .idea
 .DS_Store
 /coverage
-lcov.info 
+lcov.info
 lcov.src.info

docs/Architecture-overview.drawio

@@ -0,0 +1,48 @@
+%% https://www.mermaidchart.com/play
+
+sequenceDiagram
+    actor ethUser as User on Ethereum
+    box
+        participant rlc as RLC
+        participant rlcLu as RLC Liquidity Unifier (LU)
+        participant ethBridge as LZ Bridge
+        participant ethEndpoint as LZ Ethereum Endpoint
+    end
+    box LayerZero off-chain services
+        participant dvn as DVNs
+        participant executors as Executors
+    end
+    box Arbitrum
+        participant arbEndpoint as LZ Arbitrum Endpoint
+        participant arbBridge as LZ Bridge
+        participant arbitrumRlc as RLC Crosschain Token
+    end
+    actor aUser as User on Arbitrum
+
+    rect rgb(204, 235, 255)
+        ethUser ->> rlc: approve(lzBridge, amount)
+        ethUser ->> ethBridge: send(sendParam, fee, refundAddress)
+        ethBridge ->> rlc: _debit(): transferFrom(user, LU, amount)
+        ethBridge ->> ethEndpoint: send(messagingParams, refundAddress)
+        ethEndpoint ->> ethEndpoint: emit PacketSent event
+        ethEndpoint -->> ethUser: Request submitted
+        dvn ->> ethEndpoint: detect event
+        dvn ->> arbEndpoint: verify()
+        executors ->> arbEndpoint: lzReceive()
+        arbEndpoint ->> arbBridge: lzReceive()
+        arbBridge ->> arbitrumRlc: _credit(): corsschainMint()
+        arbitrumRlc ->> arbitrumRlc: _mint()
+    end
+    rect rgb(255, 255, 204)
+        aUser ->> arbBridge: send()
+        arbBridge ->> arbitrumRlc: _debit(): crosschainBurn()
+        arbitrumRlc ->> arbitrumRlc: _burn()
+        arbBridge ->> arbEndpoint: send(messagingParams, refundAddress)
+        arbEndpoint ->> arbEndpoint: emit PacketSent event
+        dvn ->> arbEndpoint: detect event
+        dvn ->> ethEndpoint: verify()
+        executors ->> ethEndpoint: lzReceive()
+        ethEndpoint ->> ethBridge: lzReceive()
+        ethBridge ->> rlcLu: _credit(): corsschainMint()
+        rlcLu ->> rlc: transfer()
+    end

docs/Architecture-overview.png

@@ -3,13 +3,13 @@
 pragma solidity ^0.8.22;
 
 import {TestHelperOz5} from "@layerzerolabs/test-devtools-evm-foundry/contracts/TestHelperOz5.sol";
-import {RLCLiquidityUnifierV2} from "../../../../src/mocks/RLCLiquidityUnifierV2Mock.sol";
-import {RLCLiquidityUnifier} from "../../../../src/RLCLiquidityUnifier.sol";
+import {RLCLiquidityUnifierV2} from "../../src/mocks/RLCLiquidityUnifierV2Mock.sol";
+import {RLCLiquidityUnifier} from "../../src/RLCLiquidityUnifier.sol";
 import {TestUtils} from "./utils/TestUtils.sol";
-import {UpgradeUtils} from "../../../../script/lib/UpgradeUtils.sol";
+import {UpgradeUtils} from "../../script/lib/UpgradeUtils.sol";
 import {RLCMock} from "./mocks/RLCMock.sol";
 
-contract UpgradeRLCLiquidityUnifier is TestHelperOz5 {
+contract RLCLiquidityUnifierUpgradeTest is TestHelperOz5 {
     using TestUtils for *;
 
     RLCLiquidityUnifier private rlcLiquidityUnifierV1;

docs/Sequence-diagram.mermaid

@@ -9,7 +9,7 @@ import {UpgradeUtils} from "../../../../script/lib/UpgradeUtils.sol";
 import {IexecLayerZeroBridge} from "../../../../src/bridges/layerZero/IexecLayerZeroBridge.sol";
 import {RLCCrosschainToken} from "../../../../src/RLCCrosschainToken.sol";
 
-contract UpgradeLayerZeroBridgeTest is TestHelperOz5 {
+contract IexecLayerZeroBridgeUpgradeTest is TestHelperOz5 {
     using TestUtils for *;
 
     IexecLayerZeroBridge public iexecLayerZeroBridgeV1;