diff --git a/README.md b/README.md new file mode 100644 index 0000000..c132fe0 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Level Brigde tokens based on layerzero stack + + ### Install & Run tests +```shell +forge build +forge test +``` + +## C2LevelToken.sol +- This is Level Token Contract on Arbitrum +- Only Bridge Controller allowed to mint + +## BridgeController.sol +- This contract is Bridge Controller on BNB Chain +- Lock LVL tokens sent from BNB +- Unlock LVL tokens to user if bridge request validated + +## C2BridgeController.sol +- This contract is Bridge Controller on Arbitrum +- Burn LVL tokens sent from Arbitrum +- Mint LVL tokens to user if bridge request validated + +## BridgeProxy.sol +This contract communicate with layerzero protocol (send/receive message)