feat(bridge-withdrawer): PoC astria-bridge-withdrawer implementation

.github/workflows/test.yml

@@ -115,7 +115,37 @@ jobs:
       - name: Run tests
         timeout-minutes: 20
         run: |
-          cargo nextest run --archive-file=archive.tar.zst -- --include-ignored
+          cargo nextest run --archive-file=archive.tar.zst
+
+  rust-ethereum:
+    runs-on: buildjet-8vcpu-ubuntu-2204
+    needs: run_checker
+    if: needs.run_checker.outputs.run_tests == 'true'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@1.76.0
+      - uses: Swatinem/rust-cache@v2.7.3
+        with:
+          cache-provider: "buildjet"
+      - name: Install nextest
+        uses: taiki-e/install-action@nextest
+      - uses: arduino/setup-protoc@v3
+        with:
+          version: "24.4"
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Install python and solc
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10' 
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+      - name: Run tests
+        timeout-minutes: 20
+        run: |
+          pip install solc-select 
+          solc-select install 0.8.21
+          solc-select use 0.8.21
+          cargo nextest run --package astria-bridge-withdrawer -- --include-ignored
 
   doctest:
     runs-on: buildjet-8vcpu-ubuntu-2204

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "crates/astria-bridge-withdrawer/ethereum/lib/forge-std"]
+	path = crates/astria-bridge-withdrawer/ethereum/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std

Cargo.toml

@@ -2,6 +2,7 @@
 exclude = ["tools/protobuf-compiler"]
 
 members = [
+  "crates/astria-bridge-withdrawer",
   "crates/astria-build-info",
   "crates/astria-cli",
   "crates/astria-composer",
@@ -24,6 +25,7 @@ members = [
 # Specify default members so that cargo invocations in github actions will
 # not act on lints
 default-members = [
+  "crates/astria-bridge-withdrawer",
   "crates/astria-build-info",
   "crates/astria-cli",
   "crates/astria-composer",
@@ -67,6 +69,7 @@ itertools = "0.12.1"
 itoa = "1.0.10"
 jsonrpsee = { version = "0.20" }
 once_cell = "1.17.1"
+pin-project-lite = "0.2.13"
 sha2 = "0.10"
 serde = "1"
 serde_json = "1"

crates/astria-bridge-withdrawer/Cargo.toml

@@ -0,0 +1,55 @@
+[package]
+name = "astria-bridge-withdrawer"
+version = "0.1.0"
+edition = "2021"
+rust-version = "1.73"
+license = "MIT OR Apache-2.0"
+readme = "README.md"
+repository = "https://github.com/astriaorg/astria"
+homepage = "https://astria.org"
+
+[[bin]]
+name = "astria-bridge-withdrawer"
+
+[dependencies]
+http = "0.2.9"
+
+axum = { workspace = true }
+futures = { workspace = true }
+hex = { workspace = true }
+ethers = { workspace = true, features = ["ethers-solc", "ws"] }
+hyper = { workspace = true }
+humantime = { workspace = true }
+ibc-types = { workspace = true }
+metrics = { workspace = true }
+pin-project-lite = { workspace = true }
+prost = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
+serde_json = { workspace = true }
+sha2 = { workspace = true }
+tendermint = { workspace = true }
+tracing = { workspace = true }
+tryhard = { workspace = true }
+tokio = { workspace = true, features = ["macros", "rt-multi-thread", "signal"] }
+tokio-util = { workspace = true }
+
+astria-build-info = { path = "../astria-build-info", features = ["runtime"] }
+astria-core = { path = "../astria-core", features = ["serde", "server"] }
+astria-eyre = { path = "../astria-eyre" }
+config = { package = "astria-config", path = "../astria-config" }
+sequencer-client = { package = "astria-sequencer-client", path = "../astria-sequencer-client", features = [
+  "http",
+] }
+telemetry = { package = "astria-telemetry", path = "../astria-telemetry", features = [
+  "display",
+] }
+
+[dev-dependencies]
+astria-core = { path = "../astria-core", features = ["server", "test-utils"] }
+astria-grpc-mock = { path = "../astria-grpc-mock" }
+config = { package = "astria-config", path = "../astria-config", features = [
+  "tests",
+] }
+
+[build-dependencies]
+astria-build-info = { path = "../astria-build-info", features = ["build"] }

crates/astria-bridge-withdrawer/build.rs

@@ -0,0 +1,4 @@
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    astria_build_info::emit("bridge-withdrawer-v")?;
+    Ok(())
+}

crates/astria-bridge-withdrawer/ethereum/.gitignore

@@ -0,0 +1,14 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env

crates/astria-bridge-withdrawer/ethereum/README.md

@@ -0,0 +1,38 @@
+# astria-bridge-withdrawer
+
+Forge project for the bridge withdrawer contract.
+
+Requirements:
+
+- foundry
+
+Build:
+
+```sh
+forge build
+```
+
+Copy the example .env: `cp local.example.env .env`
+
+Put your private key in `.env` and `source .env`.
+
+Deploy `AstriaWithdrawer.sol`:
+
+```sh
+forge script script/AstriaWithdrawer.s.sol:AstriaWithdrawerScript \
+   --rpc-url $RPC_URL --broadcast --sig "deploy()" -vvvv
+```
+
+Call `withdrawToSequencer` in `AstriaWithdrawer.sol`:
+
+```sh
+forge script script/AstriaWithdrawer.s.sol:AstriaWithdrawerScript \
+   --rpc-url $RPC_URL --broadcast --sig "withdrawToSequencer()" -vvvv
+```
+
+Call `withdrawToOriginChain` in `AstriaWithdrawer.sol`:
+
+```sh
+forge script script/AstriaWithdrawer.s.sol:AstriaWithdrawerScript \
+   --rpc-url $RPC_URL --broadcast --sig "withdrawToOriginChain()" -vvvv
+```

crates/astria-bridge-withdrawer/ethereum/foundry.toml

@@ -0,0 +1,6 @@
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib"]
+
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

crates/astria-bridge-withdrawer/ethereum/local.env.example

@@ -0,0 +1,20 @@
+# private key to submit txs with
+PRIVATE_KEY=0x
+
+# default local rpc url
+RPC_URL="http://localhost:8545"
+
+# divide withdrawn values by 10^ASSET_WITHDRAWAL_DECIMALS
+ASSET_WITHDRAWAL_DECIMALS=12
+
+# contract address
+ASTRIA_WITHDRAWER=0x5FbDB2315678afecb367f032d93F642f64180aa3
+
+# destination chain address to withdraw to on the sequencer
+SEQUENCER_DESTINATION_CHAIN_ADDRESS=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
+
+# destination chain address to withdraw to on the origin chain
+ORIGIN_DESTINATION_CHAIN_ADDRESS="astring"
+
+# amount to withdraw
+AMOUNT=1000000000

crates/astria-bridge-withdrawer/ethereum/script/AstriaWithdrawer.s.sol

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import {Script, console} from "forge-std/Script.sol";
+import {AstriaWithdrawer} from "../src/AstriaWithdrawer.sol";
+
+contract AstriaWithdrawerScript is Script {
+    function setUp() public {}
+
+    function deploy() public {
+        uint32 assetWithdrawalDecimals = uint32(vm.envUint("ASSET_WITHDRAWAL_DECIMALS"));
+        uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+        vm.startBroadcast(deployerPrivateKey);
+        AstriaWithdrawer astriaWithdrawer = new AstriaWithdrawer(assetWithdrawalDecimals);
+        console.logAddress(address(astriaWithdrawer));
+        vm.stopBroadcast();
+    }
+
+    function withdrawToSequencer() public {
+        uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+        vm.startBroadcast(deployerPrivateKey);
+
+        address contractAddress = vm.envAddress("ASTRIA_WITHDRAWER");
+        AstriaWithdrawer astriaWithdrawer = AstriaWithdrawer(contractAddress);
+
+        address destinationChainAddress = vm.envAddress("SEQUENCER_DESTINATION_CHAIN_ADDRESS");
+        uint256 amount = vm.envUint("AMOUNT");
+        astriaWithdrawer.withdrawToSequencer{value: amount}(destinationChainAddress);
+
+        vm.stopBroadcast();
+    }
+
+    function withdrawToOriginChain() public {
+        uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+        vm.startBroadcast(deployerPrivateKey);
+
+        address contractAddress = vm.envAddress("ASTRIA_WITHDRAWER");
+        AstriaWithdrawer astriaWithdrawer = AstriaWithdrawer(contractAddress);
+
+        string memory destinationChainAddress = vm.envString("ORIGIN_DESTINATION_CHAIN_ADDRESS");
+        uint256 amount = vm.envUint("AMOUNT");
+        astriaWithdrawer.withdrawToOriginChain{value: amount}(destinationChainAddress, "");
+
+        vm.stopBroadcast();
+    }
+}

crates/astria-bridge-withdrawer/ethereum/src/AstriaWithdrawer.sol

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: MIT or Apache-2.0
+pragma solidity ^0.8.21;
+
+// This contract facilitates withdrawals of the native asset from the rollup to the base chain.
+// 
+// Funds can be withdrawn to either the sequencer or the origin chain via IBC.
+contract AstriaWithdrawer {
+    // the number of decimal places more the asset has on the rollup versus the base chain.
+    //
+    // the amount transferred on the base chain will be divided by 10^ASSET_WITHDRAWAL_DECIMALS.
+    //
+    // for example, if the rollup specifies the asset has 18 decimal places and the base chain specifies 6,
+    // the ASSET_WITHDRAWAL_DECIMALS would be 12.
+    uint32 public immutable ASSET_WITHDRAWAL_DECIMALS;
+
+    constructor(uint32 assetWithdrawalDecimals) {
+        ASSET_WITHDRAWAL_DECIMALS = assetWithdrawalDecimals;
+    }
+
+    // emitted when a withdrawal to the sequencer is initiated
+    //
+    // the `sender` is the evm address that initiated the withdrawal
+    // the `destinationChainAddress` is the address on the sequencer the funds will be sent to
+    event SequencerWithdrawal(address indexed sender, uint256 indexed amount, address destinationChainAddress);
+
+    // emitted when a withdrawal to the origin chain is initiated.
+    // the withdrawal is sent to the origin chain via IBC from the sequencer using the denomination trace.
+    //
+    // the `sender` is the evm address that initiated the withdrawal
+    // the `destinationChainAddress` is the address on the origin chain the funds will be sent to
+    // the `memo` is an optional field that will be used as the ICS20 packet memo
+    event Ics20Withdrawal(address indexed sender, uint256 indexed amount, string destinationChainAddress, string memo);
+
+    function withdrawToSequencer(address destinationChainAddress) external payable {
+        emit SequencerWithdrawal(msg.sender, msg.value, destinationChainAddress);
+    }
+
+    function withdrawToOriginChain(string calldata destinationChainAddress, string calldata memo) external payable {
+        emit Ics20Withdrawal(msg.sender, msg.value, destinationChainAddress, memo);
+    }
+}