You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-64Lines changed: 15 additions & 64 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,18 +6,18 @@ This project implements a cross-chain token bridge for the RLC token between Eth
6
6
7
7
The system consists of two main components:
8
8
9
-
1.**RLCAdapter (on Ethereum **Sepolia**)**: Wraps the existing RLC ERC-20 token to make it compatible with LayerZero's cross-chain messaging.
9
+
1.**RLCAdapter (on Ethereum Sepolia)**: Wraps the existing RLC ERC-20 token to make it compatible with LayerZero's cross-chain messaging.
10
10
2.**RLCOFT (on Arbitrum Sepolia)**: A new token that's minted when RLC tokens are locked in the adapter on Ethereum, and burned when tokens are sent back.
-[Foundry](https://book.getfoundry.sh/getting-started/installation.html) for contract compilation and deployment
17
17
- Ethereum wallet with Sepolia ETH and Arbitrum Sepolia ETH for gas
18
18
- RLC tokens on Sepolia testnet for bridge testing
19
19
20
-
## Setup
20
+
## Installation
21
21
22
22
1. Clone the repository
23
23
```bash
@@ -35,6 +35,13 @@ The system consists of two main components:
35
35
cp .env.template .env # and edit .env content
36
36
```
37
37
38
+
## Contract Overview
39
+
40
+
Instead of duplicating code that may become outdated, here are links to the key contracts in the repository:
41
+
42
+
- [RLCAdapter.sol](https://github.com/iExecBlockchainComputing/rlc-multichain/blob/main/src/RLCAdapter.sol) - Ethereum-side adapter that wraps the existing RLC token
43
+
- [RLCOFT.sol](https://github.com/iExecBlockchainComputing/rlc-multichain/blob/main/src/RLCOFT.sol) - Arbitrum-side token that implements the OFT standard
44
+
38
45
## Deployment
39
46
40
47
The deployment process involves four steps:
@@ -68,7 +75,7 @@ After deployment, update your `.env` file with the deployed contract addresses.
68
75
To send RLC tokens from Ethereum Sepolia to Arbitrum Sepolia:
69
76
70
77
```bash
71
-
make send-tokens
78
+
make send-tokens-to-arbitrum-sepolia
72
79
```
73
80
74
81
This will:
@@ -81,60 +88,14 @@ This will:
81
88
To send RLC tokens from Arbitrum Sepolia back to Ethereum Sepolia:
82
89
83
90
```bash
84
-
make send-tokens-arbitrum-sepolia
91
+
make send-tokens-to-sepolia
85
92
```
86
93
87
94
This will:
88
95
1. Burn RLCOFT tokens on Arbitrum
89
96
2. Send a cross-chain message to the adapter
90
97
3. Release the original RLC tokens on Ethereum
91
98
92
-
## Contract Architecture
93
-
94
-
### RLCAdapter.sol
95
-
96
-
An adapter that wraps the existing RLC token to make it compatible with LayerZero's OFT protocol. It extends:
97
-
- `OFTAdapter`: Handles the OFT cross-chain logic
98
-
- `Ownable`: Provides ownership control for administrative functions
0 commit comments