# multiversx/mx-bridge-eth-sc-rs architecture

> Architecture diagram of the GitHub repository multiversx/mx-bridge-eth-sc-rs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/multiversx/mx-bridge-eth-sc-rs
- Repository: https://github.com/multiversx/mx-bridge-eth-sc-rs

## Overview

##### Main Components

a) Core Bridge Components:
- MultiversX Blockchain Side
- Bridged Tokens Wrapper Contract
- ESDT Safe Contract
- Multi-Transfer ESDT Contract
- Bridge Proxy Contract
- Multisig Contract (for governance)
- Price Aggregator Contract

- Ethereum Blockchain Side (reference only, not in this repo)
- ERC20 Contract
- Bridge Contract

b) Supporting Components:
- Relayer Network
- Fee Estimation System
- Transaction Batch Processing System

##### Key Relationships to Highlight

a) Token Flow:
- Cross-chain token movement paths
- Token locking/unlocking mechanisms

b) Control Flow:
- Multisig validation process
- Relayer interaction paths
- Fee calculation and distribution

##### Technical Details

- Smart Contract Interactions:
- EsdtSafe ↔ MultiTransferEsdt
- BridgedTokensWrapper ↔ Bridge Proxy
- Price Aggregator integration points

- Common Modules (from /common directory):
- Fee Estimator
- Transaction Processing
- Token Management
- Batch Processing

##### Implementation Notes

- Use standardized UML notation where applicable
- Notes for critical processes
- Version/upgrade paths
- Integration points with external systems

##### Specific Flows to Highlight

a) MultiversX to Ethereum:
##### Final execution

b) Ethereum to MultiversX:

## Diagram (Mermaid)

```mermaid
graph TB
    %% Style Definitions
    classDef multiversx fill:#4a90e2,color:white
    classDef ethereum fill:#9b51e0,color:white
    classDef bridge fill:#2ecc71,color:white
    classDef user fill:#e67e22,color:white
    classDef security fill:#e74c3c,color:white
    classDef common fill:#95a5a6,color:white

    %% User Layer
    subgraph User_Layer
        MXWallet["MultiversX Wallet"]:::user
        ETHWallet["Ethereum Wallet"]:::user
        xPortal["xPortal Integration"]:::user
    end

    %% Bridge Core Layer
    subgraph Bridge_Core
        RelayerNetwork["Relayer Network"]:::bridge
        TokenProcessing["Token Processing"]:::bridge
        MultisigValidation["Multisig Validation"]:::security
        FeeSystem["Fee Estimation System"]:::bridge
        BatchProcess["Transaction Batch Processing"]:::bridge
        TokenManagement["Token Management"]:::bridge
        TxProcessing["Transaction Processing"]:::bridge
        EthAddress["Ethereum Address Handler"]:::bridge
        MaxAmount["Maximum Bridge Amount Handler"]:::bridge
    end

    %% Infrastructure Layer
    subgraph MultiversX_Chain
        BTWrapper["Bridged Tokens Wrapper"]:::multiversx
        ESDTSafe["ESDT Safe Contract"]:::multiversx
        MultiTransfer["Multi-Transfer ESDT"]:::multiversx
        BridgeProxy["Bridge Proxy"]:::multiversx
        Multisig["Multisig Contract"]:::multiversx
        PriceAgg["Price Aggregator"]:::multiversx
    end

    subgraph Ethereum_Chain
        ERC20["ERC20 Contract"]:::ethereum
        ETHBridge["Bridge Contract"]:::ethereum
    end

    %% Relationships
    MXWallet --> BTWrapper
    ETHWallet --> ERC20
    xPortal --> TokenProcessing

    BTWrapper --> BridgeProxy
    ESDTSafe --> MultiTransfer
    BridgeProxy --> RelayerNetwork
    MultiTransfer --> TokenProcessing

    RelayerNetwork --> ETHBridge
    RelayerNetwork --> MultisigValidation
    MultisigValidation --> Multisig

    FeeSystem --> TokenProcessing
    BatchProcess --> TxProcessing
    TokenManagement --> TokenProcessing
    EthAddress --> TokenProcessing
    MaxAmount --> TokenProcessing

    PriceAgg --> FeeSystem

    %% Click Events
    click BTWrapper "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/bridged-tokens-wrapper/src/lib.rs"
    click ESDTSafe "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/esdt-safe/src/lib.rs"
    click MultiTransfer "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/multi-transfer-esdt/src/lib.rs"
    click BridgeProxy "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/bridge-proxy/src/bridge-proxy.rs"
    click Multisig "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/multisig/src/lib.rs"
    click PriceAgg "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/price-aggregator/multiversx-price-aggregator-sc.wasm"
    click FeeSystem "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/common/fee-estimator-module/src/lib.rs"
    click BatchProcess "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/common/tx-batch-module/src/lib.rs"
    click TokenManagement "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/common/token-module/src/lib.rs"
    click TxProcessing "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/common/transaction/src/lib.rs"
    click EthAddress "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/common/eth-address/src/lib.rs"
    click MaxAmount "https://github.com/multiversx/mx-bridge-eth-sc-rs/blob/main/common/max-bridged-amount-module/src/lib.rs"

    %% Legend
    subgraph Legend
        L1[MultiversX Components]:::multiversx
        L2[Ethereum Components]:::ethereum
        L3[Bridge Components]:::bridge
        L4[User Components]:::user
        L5[Security Components]:::security
    end
```
