imp: add support for ParamChange migration (backport #509) (#510)

Co-authored-by: Aditya <[email protected]>
Co-authored-by: srdtrk <[email protected]>
Co-authored-by: srdtrk <[email protected]>

Author: 3 people

e2e/interchaintestv8/wasm/cw_ics08_wasm_eth.wasm.gz

@@ -2,8 +2,8 @@
 
 use cosmwasm_std::{entry_point, Binary, Deps, DepsMut, Env, MessageInfo, Response};
 
-use crate::msg::{ExecuteMsg, InstantiateMsg, QueryMsg, SudoMsg};
-use crate::{custom_query::EthereumCustomQuery, instantiate, msg::MigrateMsg, query};
+use crate::msg::{ExecuteMsg, InstantiateMsg, MigrateMsg, Migration, QueryMsg, SudoMsg};
+use crate::{custom_query::EthereumCustomQuery, instantiate, query, state};
 use crate::{sudo, ContractError};
 
 /// The version of the contracts state.
@@ -109,9 +109,23 @@ pub fn migrate(
     // Check if the state version is older than the current one and update it
     cw2::ensure_from_older_version(deps.storage, CONTRACT_NAME, STATE_VERSION)?;
 
-    // Re-initialize the client if needed.
-    if let Some(instantiate_msg) = msg.instantiate_msg {
-        instantiate::client(deps.storage, instantiate_msg)?;
+    // Perform the migration
+    match msg.migration {
+        Migration::CodeOnly => {} // do nothing here
+        Migration::Reinstantiate(instantiate_msg) => {
+            // Re-instantiate the client
+            instantiate::client(deps.storage, instantiate_msg)?;
+        }
+        Migration::UpdateForkParameters(fork_parameters) => {
+            // Change the fork parameters
+            let mut client_state = state::get_eth_client_state(deps.storage)?;
+            client_state.fork_parameters = fork_parameters;
+            let client_state_bz: Vec<u8> = serde_json::to_vec(&client_state)
+                .map_err(ContractError::SerializeClientStateFailed)?;
+            let mut wasm_client_state = state::get_wasm_client_state(deps.storage)?;
+            wasm_client_state.data = client_state_bz;
+            state::store_client_state(deps.storage, &wasm_client_state)?;
+        }
     }
 
     Ok(Response::default())
@@ -283,8 +297,8 @@ mod tests {
         use crate::{
             contract::{instantiate, migrate, query, sudo},
             msg::{
-                Height, InstantiateMsg, MerklePath, MigrateMsg, QueryMsg, SudoMsg, UpdateStateMsg,
-                UpdateStateResult, VerifyClientMessageMsg, VerifyMembershipMsg,
+                Height, InstantiateMsg, MerklePath, MigrateMsg, Migration, QueryMsg, SudoMsg,
+                UpdateStateMsg, UpdateStateResult, VerifyClientMessageMsg, VerifyMembershipMsg,
             },
             state::HOST_CLIENT_STATE_KEY,
             test::mk_deps,
@@ -311,7 +325,7 @@ mod tests {
             let client_state_bz: Vec<u8> = serde_json::to_vec(&client_state).unwrap();
             let consensus_state_bz: Vec<u8> = serde_json::to_vec(&consensus_state).unwrap();
 
-            let msg = crate::msg::InstantiateMsg {
+            let msg = InstantiateMsg {
                 client_state: Binary::from(client_state_bz),
                 consensus_state: Binary::from(consensus_state_bz),
                 checksum: b"checksum".into(),
@@ -412,7 +426,7 @@ mod tests {
             let client_state_bz: Vec<u8> = serde_json::to_vec(&client_state).unwrap();
             let consensus_state_bz: Vec<u8> = serde_json::to_vec(&consensus_state).unwrap();
 
-            let msg = crate::msg::InstantiateMsg {
+            let msg = InstantiateMsg {
                 client_state: Binary::from(client_state_bz),
                 consensus_state: Binary::from(consensus_state_bz),
                 checksum: b"checksum".into(),
@@ -583,7 +597,7 @@ mod tests {
                 let client_state_bz: Vec<u8> = serde_json::to_vec(&client_state).unwrap();
                 let consensus_state_bz: Vec<u8> = serde_json::to_vec(&consensus_state).unwrap();
 
-                let msg = crate::msg::InstantiateMsg {
+                let msg = InstantiateMsg {
                     client_state: Binary::from(client_state_bz),
                     consensus_state: Binary::from(consensus_state_bz),
                     checksum: b"checksum".into(),
@@ -632,7 +646,7 @@ mod tests {
             let client_state_bz: Vec<u8> = serde_json::to_vec(&client_state).unwrap();
             let consensus_state_bz: Vec<u8> = serde_json::to_vec(&consensus_state).unwrap();
 
-            let msg = crate::msg::InstantiateMsg {
+            let msg = InstantiateMsg {
                 client_state: Binary::from(client_state_bz),
                 consensus_state: Binary::from(consensus_state_bz),
                 checksum: b"checksum".into(),
@@ -733,7 +747,7 @@ mod tests {
             let client_state_bz: Vec<u8> = serde_json::to_vec(&client_state).unwrap();
             let consensus_state_bz: Vec<u8> = serde_json::to_vec(&consensus_state).unwrap();
 
-            let msg = crate::msg::InstantiateMsg {
+            let msg = InstantiateMsg {
                 client_state: Binary::from(client_state_bz),
                 consensus_state: Binary::from(consensus_state_bz),
                 checksum: b"checksum".into(),
@@ -901,7 +915,7 @@ mod tests {
             let client_state_bz: Vec<u8> = serde_json::to_vec(&client_state).unwrap();
             let consensus_state_bz: Vec<u8> = serde_json::to_vec(&consensus_state).unwrap();
 
-            let msg = crate::msg::InstantiateMsg {
+            let msg = InstantiateMsg {
                 client_state: Binary::from(client_state_bz),
                 consensus_state: Binary::from(consensus_state_bz),
                 checksum: b"checksum".into(),
@@ -913,8 +927,8 @@ mod tests {
             migrate(
                 deps.as_mut(),
                 mock_env(),
-                crate::msg::MigrateMsg {
-                    instantiate_msg: None,
+                MigrateMsg {
+                    migration: Migration::CodeOnly,
                 },
             )
             .unwrap();
@@ -1008,7 +1022,7 @@ mod tests {
             };
 
             let migrate_msg = MigrateMsg {
-                instantiate_msg: Some(msg.clone()),
+                migration: Migration::Reinstantiate(msg.clone()),
             };
 
             // Migrate without any changes (i.e. same state version)
@@ -1026,5 +1040,128 @@ mod tests {
                 client_state.latest_slot
             );
         }
+
+        #[allow(clippy::too_many_lines)]
+        #[test]
+        fn test_migrate_with_fork_parameters() {
+            let mut deps = mk_deps();
+            let creator = deps.api.addr_make("creator");
+            let info = message_info(&creator, &coins(1, "uatom"));
+
+            let client_state = EthClientState {
+                chain_id: 0,
+                genesis_validators_root: B256::from([0; 32]),
+                min_sync_committee_participants: 0,
+                genesis_time: 0,
+                genesis_slot: 0,
+                fork_parameters: ForkParameters {
+                    genesis_fork_version: FixedBytes([0; 4]),
+                    genesis_slot: 0,
+                    altair: Fork {
+                        version: FixedBytes([0; 4]),
+                        epoch: 0,
+                    },
+                    bellatrix: Fork {
+                        version: FixedBytes([0; 4]),
+                        epoch: 0,
+                    },
+                    capella: Fork {
+                        version: FixedBytes([0; 4]),
+                        epoch: 0,
+                    },
+                    deneb: Fork {
+                        version: FixedBytes([0; 4]),
+                        epoch: 0,
+                    },
+                    electra: Fork {
+                        version: FixedBytes([0; 4]),
+                        epoch: 0,
+                    },
+                },
+                sync_committee_size: 512,
+                seconds_per_slot: 10,
+                slots_per_epoch: 8,
+                epochs_per_sync_committee_period: 0,
+                latest_slot: 42,
+                latest_execution_block_number: 38,
+                ibc_commitment_slot: U256::from(0),
+                ibc_contract_address: Address::default(),
+                is_frozen: false,
+            };
+            let client_state_bz: Vec<u8> = serde_json::to_vec(&client_state).unwrap();
+
+            let consensus_state = EthConsensusState {
+                slot: 42,
+                state_root: B256::from([0; 32]),
+                storage_root: B256::from([0; 32]),
+                timestamp: 0,
+                current_sync_committee: SummarizedSyncCommittee::default(),
+                next_sync_committee: None,
+            };
+            let consensus_state_bz: Vec<u8> = serde_json::to_vec(&consensus_state).unwrap();
+
+            let msg = InstantiateMsg {
+                client_state: client_state_bz.into(),
+                consensus_state: consensus_state_bz.into(),
+                checksum: b"checksum".into(),
+            };
+            let msg_copy = msg.clone();
+
+            let res = instantiate(deps.as_mut(), mock_env(), info, msg).unwrap();
+            assert_eq!(0, res.messages.len());
+
+            let migrate_msg = MigrateMsg {
+                migration: Migration::UpdateForkParameters(ForkParameters {
+                    genesis_fork_version: FixedBytes([0; 4]),
+                    genesis_slot: 0,
+                    altair: Fork {
+                        version: FixedBytes([0; 4]),
+                        epoch: 0,
+                    },
+                    bellatrix: Fork {
+                        version: FixedBytes([0; 4]),
+                        epoch: 0,
+                    },
+                    capella: Fork {
+                        version: FixedBytes([0; 4]),
+                        epoch: 0,
+                    },
+                    deneb: Fork {
+                        version: FixedBytes([0; 4]),
+                        epoch: 0,
+                    },
+                    electra: Fork {
+                        version: FixedBytes([0; 4]),
+                        epoch: 5000,
+                    },
+                }),
+            };
+
+            // Migrate without any changes and without reinitializing (i.e. same state version)
+            migrate(deps.as_mut(), mock_env(), migrate_msg).unwrap();
+
+            let actual_wasm_client_state_any_bz =
+                deps.storage.get(HOST_CLIENT_STATE_KEY.as_bytes()).unwrap();
+            let actual_wasm_client_state_any =
+                Any::decode(actual_wasm_client_state_any_bz.as_slice()).unwrap();
+            let wasm_client_state =
+                WasmClientState::decode(actual_wasm_client_state_any.value.as_slice()).unwrap();
+            // verify checksum hasn't changed
+            assert_eq!(msg_copy.checksum, wasm_client_state.checksum);
+            // verify latest height hasn't changed
+            assert_eq!(
+                wasm_client_state.latest_height.unwrap().revision_height,
+                client_state.latest_slot
+            );
+            // verify fork parameters have changed
+            let eth_client_state: EthClientState =
+                serde_json::from_slice(&wasm_client_state.data).unwrap();
+            assert_eq!(eth_client_state.latest_slot, client_state.latest_slot);
+            assert_ne!(
+                eth_client_state.fork_parameters.electra.epoch,
+                client_state.fork_parameters.electra.epoch
+            );
+            assert_eq!(eth_client_state.fork_parameters.electra.epoch, 5000);
+        }
     }
 }

programs/cw-ics08-wasm-eth/src/contract.rs

@@ -4,6 +4,7 @@
 use cosmwasm_schema::{cw_serde, QueryResponses};
 use cosmwasm_std::Binary;
 use ethereum_light_client::header::ActiveSyncCommittee;
+use ethereum_types::consensus::fork::ForkParameters;
 use ethereum_types::consensus::light_client_header::LightClientUpdate;
 
 /// The message to instantiate the contract
@@ -62,8 +63,20 @@ pub enum QueryMsg {
 /// The message to migrate the contract
 #[cw_serde]
 pub struct MigrateMsg {
-    /// The optional instantiate msg to re-initialize the client
-    pub instantiate_msg: Option<InstantiateMsg>,
+    /// Migration enum that defines the type of migration
+    /// and any additional data needed for the migration
+    pub migration: Migration,
+}
+
+/// The supported migration types
+#[cw_serde]
+pub enum Migration {
+    /// Migrate only the contract code not state
+    CodeOnly,
+    /// Migrate the contract code and reinitialize state
+    Reinstantiate(InstantiateMsg),
+    /// Migrate the contract code and update fork parameters
+    UpdateForkParameters(ForkParameters),
 }
 
 /// Verify membership message