Ported Migration Script to Rust (#752)

* Made some tweaks to the Hyperdrive wrappers build script in preparation of re-writing the migration script in Rust

* Ported the devnet migration script to Rust

* Updated the u256 deserialization and the docker file

* Finalized the docker updates and fixed the addresses serialization

* Tried to fix "intrinsic gas cost too high"

* Fixed the rust tests

Author: jalextowle

Cargo.lock

@@ -1,18 +1,26 @@
-### Foundry Image ###
+FROM ghcr.io/foundry-rs/foundry:master as builder
 
-FROM ghcr.io/foundry-rs/foundry:master
+# Install the Rust toolchain.
+RUN apk add clang lld curl build-base linux-headers git pkgconfig libressl-dev \
+    && curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs > rustup.sh \
+    && chmod +x ./rustup.sh \
+    && ./rustup.sh -y --default-toolchain nightly
 
+# Set the working directory to where the source code will live.
 WORKDIR /src
 
 # Use the production foundry profile.
 ENV FOUNDRY_PROFILE="production"
 
-# Copy the contract dependencies required to run the migration script.
+# Copy the dependencies required to run the migration script.
 COPY ./.git/ ./.git/
 COPY ./contracts/ ./contracts/
+COPY ./crates/ ./crates/
 COPY ./lib/ ./lib/
 COPY ./script/ ./script/
 COPY ./test/ ./test/
+COPY ./Cargo.toml ./Cargo.toml
+COPY ./Cargo.lock ./Cargo.lock
 COPY ./foundry.toml ./foundry.toml
 
 # Copy the script used to run the migrations and set its permissions.
@@ -22,10 +30,11 @@ RUN chmod a+x ./migrate.sh
 # Install the dependencies and compile the contracts.
 RUN forge install && forge build
 
+# Compile the migration script.
+Run source $HOME/.profile && cargo build -Z sparse-registry --bin migrate
+
 # Load the environment variables used in the migration script.
-ENV ETH_FROM=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
-ENV PRIVATE_KEY=ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
-ENV RPC_URL=http://localhost:8545
+ENV HYPERDRIVE_ETHEREUM_URL=http://localhost:8545
 ARG ADMIN
 ARG IS_COMPETITION_MODE
 ARG BASE_TOKEN_NAME
@@ -55,9 +64,18 @@ ARG STETH_HYPERDRIVE_TIME_STRETCH_APR
 # node and dump the state into the "./data" directory. At runtime, the consumer
 # can start anvil with the "--load-state ./data" flag to start up anvil with 
 # the post-migrations state.
-RUN anvil --dump-state ./data --balance 100000 & \
+RUN anvil --dump-state ./data & \
     ANVIL="$!" && \ 
     sleep 2 && \
-    ./migrate.sh && \
+    ./target/debug/migrate && \
     kill $ANVIL && \
     sleep 1s # HACK(jalextowle): Ensure that "./data" is written before exiting.
+
+FROM ghcr.io/foundry-rs/foundry:master
+
+# Set the working directory to where the source code will live.
+WORKDIR /src
+
+# Copy the data and artifacts from the builder stage.
+COPY --from=builder /src/data /src/data
+COPY --from=builder /src/artifacts /src/artifacts

Dockerfile

@@ -7,11 +7,16 @@ use ethers::types::Address;
 use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Default, Debug, Eq, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+#[serde(default)]
 pub struct Addresses {
     #[serde(alias = "baseToken")]
     #[serde(alias = "base_token_address")]
-    pub base: Address,
-    #[serde(alias = "mockHyperdrive")]
+    pub base_token: Address,
+    #[serde(alias = "erc4626Hyperdrive")]
     #[serde(alias = "hyperdrive_address")]
-    pub hyperdrive: Address,
+    pub erc4626_hyperdrive: Address,
+    #[serde(alias = "stethHyperdrive")]
+    pub steth_hyperdrive: Address,
+    pub factory: Address,
 }

crates/hyperdrive-addresses/src/lib.rs

@@ -7,7 +7,7 @@ mod yield_space;
 use ethers::types::{Address, I256, U256};
 use fixed_point::FixedPoint;
 use fixed_point_macros::{fixed, uint256};
-use hyperdrive_wrappers::wrappers::i_hyperdrive::{Fees, PoolConfig, PoolInfo};
+use hyperdrive_wrappers::wrappers::ihyperdrive::{Fees, PoolConfig, PoolInfo};
 pub use long::*;
 use rand::{
     distributions::{Distribution, Standard},

crates/hyperdrive-math/src/lib.rs

@@ -534,7 +534,7 @@ mod tests {
     use ethers::types::U256;
     use eyre::Result;
     use hyperdrive_wrappers::wrappers::{
-        i_hyperdrive::Checkpoint, mock_hyperdrive_math::MaxTradeParams,
+        ihyperdrive::Checkpoint, mock_hyperdrive_math::MaxTradeParams,
     };
     use rand::{thread_rng, Rng};
     use test_utils::{

crates/hyperdrive-math/src/short/max.rs

@@ -82,16 +82,9 @@ mod tests {
 
     use ethers::types::U256;
     use eyre::Result;
-    use hyperdrive_wrappers::wrappers::{
-        i_hyperdrive::Checkpoint, mock_hyperdrive_math::MaxTradeParams,
-    };
+    use hyperdrive_wrappers::wrappers::mock_hyperdrive_math::MaxTradeParams;
     use rand::{thread_rng, Rng};
-    use test_utils::{
-        agent::Agent,
-        chain::{Chain, TestChain, TestChainWithMocks},
-        constants::{FAST_FUZZ_RUNS, FUZZ_RUNS},
-    };
-    use tracing_test::traced_test;
+    use test_utils::{chain::TestChainWithMocks, constants::FAST_FUZZ_RUNS};
 
     use super::*;
 

crates/hyperdrive-math/src/short/open.rs

@@ -3,7 +3,7 @@ use eyre::Result;
 use fixed_point::FixedPoint;
 use fixed_point_macros::{fixed, uint256};
 use hyperdrive_math::{calculate_initial_bond_reserves, get_effective_share_reserves};
-use hyperdrive_wrappers::wrappers::i_hyperdrive::Checkpoint;
+use hyperdrive_wrappers::wrappers::ihyperdrive::Checkpoint;
 use rand::{thread_rng, Rng, SeedableRng};
 use rand_chacha::ChaCha8Rng;
 use test_utils::{

crates/hyperdrive-math/tests/integration_tests.rs

@@ -8,22 +8,49 @@ const TARGETS: &[&str] = &[
     // Interfaces
     "IERC20",
     "IERC4626Hyperdrive",
+    "IStETHHyperdrive",
     "IHyperdrive",
+    "IHyperdriveFactory",
     // Tokens
     "ERC20Mintable",
-    // Hyperdrive
+    "ERC20ForwarderFactory",
+    // Hyperdrive Factory
+    "HyperdriveFactory",
+    // ERC4626 Hyperdrive
     "ERC4626Hyperdrive",
+    "ERC4626HyperdriveCoreDeployer",
+    "ERC4626HyperdriveDeployerCoordinator",
     "ERC4626Target0",
     "ERC4626Target1",
     "ERC4626Target2",
     "ERC4626Target3",
     "ERC4626Target4",
+    "ERC4626Target0Deployer",
+    "ERC4626Target1Deployer",
+    "ERC4626Target2Deployer",
+    "ERC4626Target3Deployer",
+    "ERC4626Target4Deployer",
+    // stETH Hyperdrive
+    "StETHHyperdrive",
+    "StETHHyperdriveDeployerCoordinator",
+    "StETHHyperdriveCoreDeployer",
+    "StETHTarget0",
+    "StETHTarget1",
+    "StETHTarget2",
+    "StETHTarget3",
+    "StETHTarget4",
+    "StETHTarget0Deployer",
+    "StETHTarget1Deployer",
+    "StETHTarget2Deployer",
+    "StETHTarget3Deployer",
+    "StETHTarget4Deployer",
     // Test Contracts
     "ERC20Mintable",
     "EtchingVault",
     "MockERC4626",
     "MockFixedPointMath",
     "MockHyperdriveMath",
+    "MockLido",
     "MockLPMath",
     "MockYieldSpaceMath",
 ];
@@ -76,12 +103,30 @@ fn main() -> Result<()> {
     artifacts.sort_by(|a, b| a.1.cmp(&b.1));
     artifacts.dedup_by(|a, b| a.1.eq(&b.1));
     for (source, name) in artifacts {
+        let target = name
+            // Ensure that `StETH` is converted to `steth` in snake case.
+            .replace("StETH", "STETH")
+            // Ensure that `IHyperdrive` is converted to `ihyperdrive` in snake case.
+            .replace("IHyperdrive", "IHYPERDRIVE")
+            .to_snake_case();
+
         // Write the generated contract wrapper.
-        let target = name.to_snake_case();
         let target_file = generated.join(format!("{}.rs", target));
         Abigen::new(name, source)?
             .add_derive("serde::Serialize")?
             .add_derive("serde::Deserialize")?
+            // Alias the `IHyperdriveDeployerCoordinator.deploy()` to
+            // `deploy_hyperdrive()` to avoid conflicts with the builtin
+            // `deploy()` in the wrapper used to call the constructor.
+            .add_method_alias("deploy(bytes32,(address,address,bytes32,uint256,uint256,uint256,uint256,uint256,address,address,(uint256,uint256,uint256,uint256)),bytes,bytes32)", "deploy_hyperdrive")
+            // Alias the `IHyperdriveCoreDeployer.deploy()` to
+            // `deploy_hyperdrive()` to avoid conflicts with the builtin
+            // `deploy()` in the wrapper used to call the constructor.
+            .add_method_alias("deploy((address,address,bytes32,uint256,uint256,uint256,uint256,uint256,uint256,address,address,(uint256,uint256,uint256,uint256)),bytes,address,address,address,address,address,bytes32)", "deploy_hyperdrive")
+            // Alias the `IHyperdriveTarget.deploy()` to `deploy_target()`
+            // to avoid conflicts with the builtin `deploy()` in the wrapper
+            // used to call the constructor.
+            .add_method_alias("deploy((address,address,bytes32,uint256,uint256,uint256,uint256,uint256,uint256,address,address,(uint256,uint256,uint256,uint256)),bytes,bytes32)", "deploy_target")
             .generate()?
             .write_to_file(target_file)?;
 

crates/hyperdrive-wrappers/build.rs

@@ -24,6 +24,7 @@ name = "test_chain_load_crash"
 # External dependencies.
 async-trait = "0.1.73"
 dotenvy = "0.15"
+envy = "0.4.2"
 ethers = "2.0.8"
 eyre = "0.6.8"
 lazy_static = "1.4.0"

crates/test-utils/Cargo.toml

@@ -14,8 +14,8 @@ use hyperdrive_addresses::Addresses;
 use hyperdrive_math::State;
 use hyperdrive_wrappers::wrappers::{
     erc20_mintable::ERC20Mintable,
-    i_hyperdrive::{Checkpoint, IHyperdrive, IHyperdriveEvents, Options, PoolConfig},
     ierc4626_hyperdrive::IERC4626Hyperdrive,
+    ihyperdrive::{Checkpoint, IHyperdrive, IHyperdriveEvents, Options, PoolConfig},
     mock_erc4626::MockERC4626,
 };
 use rand::{Rng, SeedableRng};
@@ -165,18 +165,20 @@ impl Agent<ChainClient, ChaCha8Rng> {
         maybe_seed: Option<u64>,
     ) -> Result<Self> {
         let seed = maybe_seed.unwrap_or(17);
-        let vault = IERC4626Hyperdrive::new(addresses.hyperdrive, client.clone())
+        let vault = IERC4626Hyperdrive::new(addresses.erc4626_hyperdrive, client.clone())
             .vault()
             .call()
             .await?;
         let vault = MockERC4626::new(vault, client.clone());
-        let hyperdrive = IHyperdrive::new(addresses.hyperdrive, client.clone());
+        // TODO: Eventually, the agent should be able to support several
+        // different pools simultaneously.
+        let hyperdrive = IHyperdrive::new(addresses.erc4626_hyperdrive, client.clone());
         Ok(Self {
             address: client.address(),
             provider: client.provider().clone(),
             hyperdrive: hyperdrive.clone(),
             vault,
-            base: ERC20Mintable::new(addresses.base, client),
+            base: ERC20Mintable::new(addresses.base_token, client),
             config: hyperdrive.get_pool_config().call().await?,
             wallet: Wallet::default(),
             rng: ChaCha8Rng::seed_from_u64(seed),