feat: add migration logic based on semver comparison (#130)

* add hpl-utils * apply migrator (hpl-mailbox) * apply migrator (hpl-va) * apply migrator (hpl-hook-aggregate) * chore: fmt * apply migrator (hpl-hooks-fee) * apply migrator (hpl-hooks-merkle) * apply migrator (hpl-hooks-pausable) * merge & simplify * apply migrator (hpl-hook-routing) * apply migrator (hpl-hook-routing-custom) * apply migrator (hpl-hook-routing-fallback) * apply migrator (hpl-igp) * apply migrator (hpl-igp-oracle) * apply migrator (hpl-ism-aggregate) * apply migrator (hpl-ism-multisig) * apply migrator (hpl-ism-pausable) * apply migrator (hpl-ism-routing) * apply migrator (hpl-test-mock-hook) * apply migrator (hpl-test-mock-ism) * apply migrator (hpl-test-mock-msg-receiver) * apply migrator (hpl-warp-cw20) * apply migrator (hpl-warp-native) * allow & fmt
many-things · May 16, 2024 · 00f64a9 · 00f64a9
1 parent df8a25c
commit 00f64a9
Show file tree

Hide file tree

Showing 54 changed files with 333 additions and 73 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -55,6 +55,7 @@ cw20 = "1.1.2"
 cw20-base = { version = "1.1.2", features = ["library"] }
 
 # utilities
+semver = "1.0.23"
 thiserror = { version = "1.0.37" }
 anyhow = { version = "1.0.71", features = ["backtrace"] }
 eyre = { version = "0.6.8" }
@@ -115,3 +116,4 @@ hpl-ownable = { path = "./packages/ownable" }
 hpl-pausable = { path = "./packages/pausable" }
 hpl-router = { path = "./packages/router" }
 hpl-interface = { path = "./packages/interface" }
+hpl-utils = { path = "./packages/utils" }
diff --git a/contracts/core/mailbox/Cargo.toml b/contracts/core/mailbox/Cargo.toml
@@ -33,6 +33,7 @@ bech32.workspace = true
 
 thiserror.workspace = true
 
+hpl-utils.workspace = true
 hpl-ownable.workspace = true
 hpl-interface.workspace = true
 

diff --git a/contracts/core/mailbox/src/contract.rs b/contracts/core/mailbox/src/contract.rs
@@ -96,7 +96,8 @@ pub fn query(deps: Deps, env: Env, msg: QueryMsg) -> Result<QueryResponse, Contr
 }
 
 #[cfg_attr(not(feature = "library"), entry_point)]
-pub fn migrate(_deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, ContractError> {
+pub fn migrate(deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, ContractError> {
+    hpl_utils::migrate(deps.storage, CONTRACT_NAME, CONTRACT_VERSION)?;
     Ok(Response::default())
 }
 

diff --git a/contracts/core/mailbox/src/error.rs b/contracts/core/mailbox/src/error.rs
@@ -18,6 +18,9 @@ pub enum ContractError {
     #[error("{0}")]
     CoinsError(#[from] cosmwasm_std::CoinsError),
 
+    #[error("{0}")]
+    MigrationError(#[from] hpl_utils::MigrationError),
+
     #[error("unauthorized")]
     Unauthorized {},
 

diff --git a/contracts/core/mailbox/src/execute.rs b/contracts/core/mailbox/src/execute.rs
@@ -1,8 +1,7 @@
 use cosmwasm_std::{
-    ensure, ensure_eq, to_json_binary, wasm_execute, Coin, Coins, DepsMut, Env,
-    HexBinary, MessageInfo, Response,
+    ensure, ensure_eq, to_json_binary, wasm_execute, Coin, Coins, DepsMut, Env, HexBinary,
+    MessageInfo, Response,
 };
-use cw_utils::PaymentError::MissingDenom;
 use hpl_interface::{
     core::{
         mailbox::{DispatchMsg, DispatchResponse},
@@ -123,7 +122,7 @@ pub fn dispatch(
 
     let mut funds = Coins::try_from(info.funds.clone())?;
     for coin in required_hook_fees.iter() {
-        if let Err(_) = funds.sub(coin.clone()) {
+        if funds.sub(coin.clone()).is_err() {
             return Err(ContractError::HookPayment {
                 wanted: required_hook_fees,
                 received: info.funds,
@@ -233,8 +232,8 @@ mod tests {
     use cosmwasm_std::{
         coin, from_json,
         testing::{mock_dependencies, mock_env, mock_info, MockApi, MockQuerier, MockStorage},
-        to_json_binary, Addr, ContractResult, CosmosMsg, OwnedDeps, QuerierResult,
-        SystemResult, WasmMsg, WasmQuery,
+        to_json_binary, Addr, ContractResult, CosmosMsg, OwnedDeps, QuerierResult, SystemResult,
+        WasmMsg, WasmQuery,
     };
 
     use hpl_interface::{

diff --git a/contracts/core/va/Cargo.toml b/contracts/core/va/Cargo.toml
@@ -36,6 +36,7 @@ serde.workspace = true
 
 thiserror.workspace = true
 
+hpl-utils.workspace = true
 hpl-interface.workspace = true
 
 [dev-dependencies]

diff --git a/contracts/core/va/src/contract.rs b/contracts/core/va/src/contract.rs
@@ -216,8 +216,9 @@ fn announce(
 }
 
 #[cfg_attr(not(feature = "library"), entry_point)]
-pub fn migrate(_deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, ContractError> {
-    Ok(Response::new())
+pub fn migrate(deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, ContractError> {
+    hpl_utils::migrate(deps.storage, CONTRACT_NAME, CONTRACT_VERSION)?;
+    Ok(Response::default())
 }
 
 #[cfg(test)]

diff --git a/contracts/core/va/src/error.rs b/contracts/core/va/src/error.rs
@@ -9,6 +9,9 @@ pub enum ContractError {
     #[error("{0}")]
     RecoverPubkeyError(#[from] RecoverPubkeyError),
 
+    #[error("{0}")]
+    MigrationError(#[from] hpl_utils::MigrationError),
+
     #[error("unauthorized. reason: {0}")]
     Unauthorized(String),
 

diff --git a/contracts/hooks/aggregate/Cargo.toml b/contracts/hooks/aggregate/Cargo.toml
@@ -32,6 +32,7 @@ serde-json-wasm.workspace = true
 
 thiserror.workspace = true
 
+hpl-utils.workspace = true
 hpl-ownable.workspace = true
 hpl-interface.workspace = true
 

diff --git a/contracts/hooks/aggregate/src/error.rs b/contracts/hooks/aggregate/src/error.rs
diff --git a/contracts/hooks/aggregate/src/lib.rs b/contracts/hooks/aggregate/src/lib.rs
@@ -1,13 +1,10 @@
-mod error;
-
 #[cfg(not(feature = "library"))]
 use cosmwasm_std::entry_point;
 use cosmwasm_std::{
-    ensure_eq, Addr, Coins, CosmosMsg, Deps, DepsMut, Env, Event, HexBinary, MessageInfo,
-    QueryResponse, Response, StdResult,
+    ensure_eq, Addr, Coins, CosmosMsg, Deps, DepsMut, Empty, Env, Event, HexBinary, MessageInfo,
+    QueryResponse, Response, StdError, StdResult,
 };
 use cw_storage_plus::Item;
-use error::ContractError;
 use hpl_interface::{
     hook::{
         aggregate::{AggregateHookQueryMsg, ExecuteMsg, HooksResponse, InstantiateMsg, QueryMsg},
@@ -19,6 +16,24 @@ use hpl_interface::{
 };
 use hpl_ownable::get_owner;
 
+#[derive(thiserror::Error, Debug, PartialEq)]
+pub enum ContractError {
+    #[error("{0}")]
+    Std(#[from] StdError),
+
+    #[error("{0}")]
+    PaymentError(#[from] cw_utils::PaymentError),
+
+    #[error("{0}")]
+    CoinsError(#[from] cosmwasm_std::CoinsError),
+
+    #[error("{0}")]
+    MigrationError(#[from] hpl_utils::MigrationError),
+
+    #[error("unauthorized")]
+    Unauthorized {},
+}
+
 // version info for migration info
 pub const CONTRACT_NAME: &str = env!("CARGO_PKG_NAME");
 pub const CONTRACT_VERSION: &str = env!("CARGO_PKG_VERSION");
@@ -178,3 +193,9 @@ fn get_hooks(deps: Deps) -> Result<HooksResponse, ContractError> {
             .collect(),
     })
 }
+
+#[cfg_attr(not(feature = "library"), entry_point)]
+pub fn migrate(deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, ContractError> {
+    hpl_utils::migrate(deps.storage, CONTRACT_NAME, CONTRACT_VERSION)?;
+    Ok(Response::default())
+}
diff --git a/contracts/hooks/fee/Cargo.toml b/contracts/hooks/fee/Cargo.toml
@@ -32,6 +32,7 @@ serde-json-wasm.workspace = true
 
 thiserror.workspace = true
 
+hpl-utils.workspace = true
 hpl-ownable.workspace = true
 hpl-interface.workspace = true
 

diff --git a/contracts/hooks/fee/src/lib.rs b/contracts/hooks/fee/src/lib.rs
@@ -1,7 +1,7 @@
 #[cfg(not(feature = "library"))]
 use cosmwasm_std::entry_point;
 use cosmwasm_std::{
-    ensure, ensure_eq, BankMsg, Coin, CosmosMsg, Deps, DepsMut, Env, Event, MessageInfo,
+    ensure, ensure_eq, BankMsg, Coin, CosmosMsg, Deps, DepsMut, Empty, Env, Event, MessageInfo,
     QueryResponse, Response, StdError,
 };
 use cw_storage_plus::Item;
@@ -21,6 +21,9 @@ pub enum ContractError {
     #[error("{0}")]
     PaymentError(#[from] cw_utils::PaymentError),
 
+    #[error("{0}")]
+    MigrationError(#[from] hpl_utils::MigrationError),
+
     #[error("unauthorized")]
     Unauthorized {},
 
@@ -150,6 +153,12 @@ fn quote_dispatch(deps: Deps) -> Result<QuoteDispatchResponse, ContractError> {
     Ok(QuoteDispatchResponse { fees: vec![fee] })
 }
 
+#[cfg_attr(not(feature = "library"), entry_point)]
+pub fn migrate(deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, ContractError> {
+    hpl_utils::migrate(deps.storage, CONTRACT_NAME, CONTRACT_VERSION)?;
+    Ok(Response::default())
+}
+
 #[cfg(test)]
 mod test {
     use cosmwasm_schema::serde::{de::DeserializeOwned, Serialize};
@@ -258,7 +267,9 @@ mod test {
             deps.as_mut(),
             mock_env(),
             mock_info(sender.as_str(), &[]),
-            ExecuteMsg::FeeHook(FeeHookMsg::Claim { recipient: recipient.clone() }),
+            ExecuteMsg::FeeHook(FeeHookMsg::Claim {
+                recipient: recipient.clone(),
+            }),
         )
         .map_err(|e| e.to_string())
         .unwrap();

diff --git a/contracts/hooks/merkle/Cargo.toml b/contracts/hooks/merkle/Cargo.toml
@@ -32,6 +32,7 @@ serde-json-wasm.workspace = true
 
 thiserror.workspace = true
 
+hpl-utils.workspace = true
 hpl-ownable.workspace = true
 hpl-interface.workspace = true
 

diff --git a/contracts/hooks/merkle/src/lib.rs b/contracts/hooks/merkle/src/lib.rs
@@ -26,6 +26,9 @@ pub enum ContractError {
     #[error("unauthorized. reason: {0}")]
     Unauthorized(String),
 
+    #[error("{0}")]
+    MigrationError(#[from] hpl_utils::MigrationError),
+
     #[error("hook paused")]
     Paused {},
 }
@@ -191,8 +194,9 @@ fn get_tree_checkpoint(deps: Deps) -> Result<merkle::CheckPointResponse, Contrac
 }
 
 #[cfg_attr(not(feature = "library"), entry_point)]
-pub fn migrate(_deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, ContractError> {
-    Ok(Response::new())
+pub fn migrate(deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, ContractError> {
+    hpl_utils::migrate(deps.storage, CONTRACT_NAME, CONTRACT_VERSION)?;
+    Ok(Response::default())
 }
 
 #[cfg(test)]

diff --git a/contracts/hooks/pausable/Cargo.toml b/contracts/hooks/pausable/Cargo.toml
@@ -32,6 +32,7 @@ serde-json-wasm.workspace = true
 
 thiserror.workspace = true
 
+hpl-utils.workspace = true
 hpl-ownable.workspace = true
 hpl-pausable.workspace = true
 hpl-interface.workspace = true

diff --git a/contracts/hooks/pausable/src/lib.rs b/contracts/hooks/pausable/src/lib.rs
@@ -1,7 +1,7 @@
 #[cfg(not(feature = "library"))]
 use cosmwasm_std::entry_point;
 use cosmwasm_std::{
-    ensure, Deps, DepsMut, Env, Event, MessageInfo, QueryResponse, Response, StdError,
+    ensure, Deps, DepsMut, Empty, Env, Event, MessageInfo, QueryResponse, Response, StdError,
 };
 use hpl_interface::{
     hook::{
@@ -19,6 +19,9 @@ pub enum ContractError {
     #[error("{0}")]
     PaymentError(#[from] cw_utils::PaymentError),
 
+    #[error("{0}")]
+    MigrationError(#[from] hpl_utils::MigrationError),
+
     #[error("unauthorized")]
     Unauthorized {},
 
@@ -99,6 +102,12 @@ fn quote_dispatch() -> Result<QuoteDispatchResponse, ContractError> {
     Ok(QuoteDispatchResponse { fees: vec![] })
 }
 
+#[cfg_attr(not(feature = "library"), entry_point)]
+pub fn migrate(deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, ContractError> {
+    hpl_utils::migrate(deps.storage, CONTRACT_NAME, CONTRACT_VERSION)?;
+    Ok(Response::default())
+}
+
 #[cfg(test)]
 mod test {
     use cosmwasm_schema::serde::{de::DeserializeOwned, Serialize};

diff --git a/contracts/hooks/routing-custom/Cargo.toml b/contracts/hooks/routing-custom/Cargo.toml
@@ -32,6 +32,7 @@ serde-json-wasm.workspace = true
 
 thiserror.workspace = true
 
+hpl-utils.workspace = true
 hpl-ownable.workspace = true
 hpl-router.workspace = true
 hpl-interface.workspace = true

diff --git a/contracts/hooks/routing-custom/src/lib.rs b/contracts/hooks/routing-custom/src/lib.rs
@@ -1,7 +1,7 @@
 #[cfg(not(feature = "library"))]
 use cosmwasm_std::entry_point;
 use cosmwasm_std::{
-    ensure_eq, wasm_execute, Addr, Deps, DepsMut, Env, Event, HexBinary, MessageInfo,
+    ensure_eq, wasm_execute, Addr, Deps, DepsMut, Empty, Env, Event, HexBinary, MessageInfo,
     QueryResponse, Response, StdError, StdResult, Storage,
 };
 
@@ -29,6 +29,9 @@ pub enum ContractError {
     #[error("{0}")]
     PaymentError(#[from] cw_utils::PaymentError),
 
+    #[error("{0}")]
+    MigrationError(#[from] hpl_utils::MigrationError),
+
     #[error("unauthorized")]
     Unauthorized {},
 
@@ -312,6 +315,12 @@ fn quote_dispatch(
     Ok(resp)
 }
 
+#[cfg_attr(not(feature = "library"), entry_point)]
+pub fn migrate(deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, ContractError> {
+    hpl_utils::migrate(deps.storage, CONTRACT_NAME, CONTRACT_VERSION)?;
+    Ok(Response::default())
+}
+
 #[cfg(test)]
 mod test {
     use cosmwasm_std::{

diff --git a/contracts/hooks/routing-fallback/Cargo.toml b/contracts/hooks/routing-fallback/Cargo.toml
@@ -32,6 +32,7 @@ serde-json-wasm.workspace = true
 
 thiserror.workspace = true
 
+hpl-utils.workspace = true
 hpl-ownable.workspace = true
 hpl-router.workspace = true
 hpl-interface.workspace = true

diff --git a/contracts/hooks/routing-fallback/src/lib.rs b/contracts/hooks/routing-fallback/src/lib.rs
@@ -1,7 +1,7 @@
 #[cfg(not(feature = "library"))]
 use cosmwasm_std::entry_point;
 use cosmwasm_std::{
-    ensure_eq, wasm_execute, Addr, Deps, DepsMut, Env, Event, HexBinary, MessageInfo,
+    ensure_eq, wasm_execute, Addr, Deps, DepsMut, Empty, Env, Event, HexBinary, MessageInfo,
     QueryResponse, Response, StdError, Storage,
 };
 
@@ -25,6 +25,9 @@ pub enum ContractError {
     #[error("{0}")]
     PaymentError(#[from] cw_utils::PaymentError),
 
+    #[error("{0}")]
+    MigrationError(#[from] hpl_utils::MigrationError),
+
     #[error("unauthorized")]
     Unauthorized {},
 }
@@ -154,6 +157,12 @@ pub fn quote_dispatch(
     Ok(resp)
 }
 
+#[cfg_attr(not(feature = "library"), entry_point)]
+pub fn migrate(deps: DepsMut, _env: Env, _msg: Empty) -> Result<Response, ContractError> {
+    hpl_utils::migrate(deps.storage, CONTRACT_NAME, CONTRACT_VERSION)?;
+    Ok(Response::default())
+}
+
 #[cfg(test)]
 mod test {
     use cosmwasm_std::{

diff --git a/contracts/hooks/routing/Cargo.toml b/contracts/hooks/routing/Cargo.toml
@@ -32,6 +32,7 @@ serde-json-wasm.workspace = true
 
 thiserror.workspace = true
 
+hpl-utils.workspace = true
 hpl-ownable.workspace = true
 hpl-router.workspace = true
 hpl-interface.workspace = true