Skip to content

Latest commit

 

History

History
129 lines (94 loc) · 7.2 KB

Readme.md

File metadata and controls

129 lines (94 loc) · 7.2 KB
Raw

Madara Bootstrapper 👾

Coverage Status

Madara Bootstrapper is a tool that helps to deploy the Token Bridge & Eth Bridge contract between a madara/katana Appchain and another L2 or L1 network. It will also declare wallet contracts from OpenZappelin, Argent and Braavos. You can find the full list of contracts in Info

Index 📇

Currently Supported :

  • Madara App Chain <----> Ethereum / EVM based chains
  • 👷🏼 more coming soon......

Testing 🛠️

There are three test in the repository :

  • bridge deployment e2e
  • eth bridge deposit and claim
  • erc20 token bridge deposit and claim

IMP 🚨

  • You need to comment/remove the #[ignore] tags in src/tests/mod.rs file
  • Only one test can be run at one time as all the tests are e2e tests.
  • You also would need to restart both the chains after running each test.
# 1. Run madara instance with eth as settlement layer :
./target/release/madara --dev --da-layer=ethereum --da-conf=examples/da-confs/ethereum.json --settlement=Ethereum --settlement-conf=examples/da-confs/ethereum.json
# 2. Run anvil instance
~/.foundry/bin/anvil

# 3. Run tests
RUST_LOG=debug cargo test -- --nocapture

Run 🚀

Local 💻

You can provide the env variables as arguments also, or you can also provide them in .env file.

Refer .env.example file for setup

cp .env.example .env
cargo build --release
RUST_LOG=info cargo run -- --help

# If you have provided env vars in .env
RUST_LOG=info cargo run

# To run in dev mode (uses unsafe proxy and minimal setup)
RUST_LOG=info cargo run -- --dev

IMP 🚨 : It will store all the addresses in data/addresses.json

Docker 🐳

  1. You need to set up the .env file first. Fill all the variables in .env file

    cp .env.example .env

  2. You need to run docker compose command to build the image

    docker compose build

  3. Run the image

    # If both the networks are running locally
docker compose -f docker-compose-local.yml up
# If you are hosting on already deployed networks
docker compose up

IMP 🚨 : It will store all the addresses in data/addresses.json

Info ℹ️

Contract Descriptions 🗒️

Contract Source Link Local Path
Argent Account https://github.com/argentlabs/argent-contracts-starknet src/contracts/ArgentAccount.sierra.json
Braavos Account https://github.com/myBraavos/braavos-account-cairo src/contracts/BraavosAccount.sierra.json
ERC20 (starkgate) https://github.com/starknet-io/starkgate-contracts/blob/cairo-1/src/cairo/strk/erc20_lockable.cairo src/contracts/erc20.sierra.json
ERC20 (legacy : starknet) https://sepolia.starkscan.co/class/0x01b661756bf7d16210fc611626e1af4569baa1781ffc964bd018f4585ae241c1 src/contracts/erc20.json
ERC20 token bridge (starkgate) https://github.com/starknet-io/starkgate-contracts/blob/cairo-1/src/cairo/token_bridge.cairo src/contracts/token_bridge.sierra.json
OpenZeppelinAccount (legacy : starknet) https://sepolia.starkscan.co/class/0x05c478ee27f2112411f86f207605b2e2c58cdb647bac0df27f660ef2252359c6 src/contracts/OpenZeppelinAccount.json
OpenZeppelinAccount (modified : openzeppelin) src/contracts/OpenZeppelinAccountCairoOne.sierra.json src/contracts/OpenZeppelinAccountCairoOne.sierra.json
Proxy (legacy : starknet) https://sepolia.starkscan.co/class/0x00d0e183745e9dae3e4e78a8ffedcce0903fc4900beace4e0abf192d4c202da3 src/contracts/proxy_legacy.json
ETH token bridge (legacy : starkgate) https://github.com/starknet-io/starkgate-contracts/blob/update-cairo-0.9.0/src/starkware/starknet/apps/starkgate/cairo/token_bridge.cairo src/contracts/legacy_token_bridge.json
UDC (Universal Deployer Contract) https://sepolia.starkscan.co/class/0x07b3e05f48f0c69e4a65ce5e076a66271a527aff2c34ce1083ec6e1526997a69 src/contracts/udc.json

Here are some contract descriptions on why they are used in our context.

  • ERC20 (starkgate) : This ERC20 contracts works without a proxy and is used by erc20 token bridge in order to deploy the token on L2.
  • ERC20 (legacy : starknet) : This contract is used for deploying the implementation of ETH token on L2.
  • ERC20 token bridge (starkgate) : Contract for Token bridge.
  • OpenZeppelinAccount (legacy : starknet) : Contract used for declaring a temp account for declaring V1 contract that will be used to deploy the user account with provided private key in env.

Important

For testing in Github CI we are using the madara binary build with --disable-fee-flag. The source for madara code : https://github.com/karnotxyz/madara/tree/madara-ci-build