allow a contract to migrate itself, Require params (#64)

* allow a contract to migrate itself

* expose migrate fn in contract.rs

* Require params as part of the init message (#66)

* Require params as part of the init message

* fix JSON parsing issue on metadata params validation

---------

Co-authored-by: Burnt Val <val@burnt.com>
Co-authored-by: Justin <328965+justinbarry@users.noreply.github.com>

Author: 3 people

contracts/treasury/src/contract.rs

@@ -1,6 +1,6 @@
 use crate::error::{ContractError, ContractResult};
 use crate::execute::{revoke_allowance, update_fee_config, update_params, withdraw_coins};
-use crate::msg::{ExecuteMsg, InstantiateMsg, QueryMsg};
+use crate::msg::{ExecuteMsg, InstantiateMsg, MigrateMsg, QueryMsg};
 use crate::{execute, query, CONTRACT_NAME, CONTRACT_VERSION};
 use cosmwasm_std::{
     entry_point, to_json_binary, Binary, Deps, DepsMut, Env, MessageInfo, Response, StdResult,
@@ -27,6 +27,7 @@ pub fn instantiate(
         msg.type_urls,
         msg.grant_configs,
         msg.fee_config,
+        msg.params,
     )
 }
 
@@ -58,6 +59,10 @@ pub fn execute(
         ExecuteMsg::RevokeAllowance { grantee } => revoke_allowance(deps, env, info, grantee),
         ExecuteMsg::UpdateParams { params } => update_params(deps, info, params),
         ExecuteMsg::Withdraw { coins } => withdraw_coins(deps, info, coins),
+        ExecuteMsg::Migrate {
+            new_code_id,
+            migrate_msg,
+        } => execute::migrate(deps, env, info, new_code_id, migrate_msg),
     }
 }
 
@@ -76,3 +81,9 @@ pub fn query(deps: Deps, _env: Env, msg: QueryMsg) -> StdResult<Binary> {
         QueryMsg::Params {} => to_json_binary(&query::params(deps.storage)?),
     }
 }
+
+#[entry_point]
+pub fn migrate(_deps: DepsMut, _env: Env, _msg: MigrateMsg) -> Result<Response, ContractError> {
+    // No state migrations performed, just returned a Response
+    Ok(Response::default())
+}

contracts/treasury/src/error.rs

@@ -35,6 +35,9 @@ pub enum ContractError {
 
     #[error("grant config for {type_url} not found")]
     GrantConfigNotFound { type_url: String },
+
+    #[error(transparent)]
+    JsonError(#[from] serde_json::Error),
 }
 
 pub type ContractResult<T> = Result<T, ContractError>;

contracts/treasury/src/execute.rs

@@ -14,6 +14,7 @@ use cosmos_sdk_proto::Timestamp;
 use cosmwasm_std::BankMsg::Send;
 use cosmwasm_std::{
     Addr, AnyMsg, Binary, Coin, CosmosMsg, DepsMut, Env, Event, MessageInfo, Order, Response,
+    WasmMsg,
 };
 use url::Url;
 
@@ -24,6 +25,7 @@ pub fn init(
     type_urls: Vec<String>,
     grant_configs: Vec<GrantConfig>,
     fee_config: FeeConfig,
+    params: Params,
 ) -> ContractResult<Response> {
     let treasury_admin = match admin {
         None => info.sender,
@@ -41,6 +43,9 @@ pub fn init(
 
     FEE_CONFIG.save(deps.storage, &fee_config)?;
 
+    validate_params(&params)?;
+    PARAMS.save(deps.storage, &params)?;
+
     Ok(Response::new().add_event(
         Event::new("create_treasury_instance")
             .add_attributes(vec![("admin", treasury_admin.into_string())]),
@@ -112,6 +117,36 @@ pub fn cancel_proposed_admin(deps: DepsMut, info: MessageInfo) -> ContractResult
     ))
 }
 
+pub fn migrate(
+    deps: DepsMut,
+    env: Env,
+    info: MessageInfo,
+    new_code_id: u64,
+    migrate_msg: Binary,
+) -> ContractResult<Response> {
+    // Load the current admin
+    let admin = ADMIN.load(deps.storage)?;
+
+    // Check if the caller is the current admin
+    if admin != info.sender {
+        return Err(Unauthorized);
+    }
+
+    // this assumes that the contract's wasmd admin is itself
+    let migrate_msg = CosmosMsg::Wasm(WasmMsg::Migrate {
+        contract_addr: env.contract.address.into_string(),
+        new_code_id,
+        msg: migrate_msg,
+    });
+
+    Ok(Response::new()
+        .add_event(Event::new("migrate_treasury_instance").add_attributes(vec![
+            ("new_code_id", new_code_id.to_string()),
+            ("admin", admin.to_string()),
+        ]))
+        .add_message(migrate_msg))
+}
+
 pub fn update_grant_config(
     deps: DepsMut,
     info: MessageInfo,
@@ -177,15 +212,21 @@ pub fn update_fee_config(
     Ok(Response::new().add_event(Event::new("updated_treasury_fee_config")))
 }
 
+pub fn validate_params(params: &Params) -> ContractResult<()> {
+    Url::parse(params.redirect_url.as_str())?;
+    Url::parse(params.icon_url.as_str())?;
+    serde_json::from_str::<serde_json::Value>(&params.metadata)?;
+
+    Ok(())
+}
+
 pub fn update_params(deps: DepsMut, info: MessageInfo, params: Params) -> ContractResult<Response> {
     let admin = ADMIN.load(deps.storage)?;
     if admin != info.sender {
         return Err(Unauthorized);
     }
 
-    Url::parse(params.display_url.as_str())?;
-    Url::parse(params.redirect_url.as_str())?;
-    Url::parse(params.icon_url.as_str())?;
+    validate_params(&params)?;
 
     PARAMS.save(deps.storage, &params)?;
 

contracts/treasury/src/msg.rs

@@ -9,6 +9,7 @@ pub struct InstantiateMsg {
     pub type_urls: Vec<String>,
     pub grant_configs: Vec<GrantConfig>,
     pub fee_config: FeeConfig,
+    pub params: Params,
 }
 
 #[cw_serde]
@@ -41,6 +42,10 @@ pub enum ExecuteMsg {
     Withdraw {
         coins: Vec<Coin>,
     },
+    Migrate {
+        new_code_id: u64,
+        migrate_msg: Binary,
+    },
 }
 
 #[cw_serde]
@@ -65,3 +70,6 @@ pub enum QueryMsg {
     #[returns(Binary)]
     Params {},
 }
+
+#[cw_serde]
+pub struct MigrateMsg {}

contracts/treasury/src/state.rs

@@ -14,9 +14,9 @@ pub const PENDING_ADMIN: Item<Addr> = Item::new("pending_admin");
 
 #[cw_serde]
 pub struct Params {
-    pub display_url: String,
     pub redirect_url: String,
     pub icon_url: String,
+    pub metadata: String,
 }
 
 pub const PARAMS: Item<Params> = Item::new("params");