Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove MessageInfo argument from migrate entry point #709

Merged
merged 13 commits into from
Jan 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions contracts/burner/src/contract.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,7 @@ pub fn handle(
}

#[entry_point]
pub fn migrate(
deps: DepsMut,
env: Env,
_info: MessageInfo,
msg: MigrateMsg,
) -> StdResult<MigrateResponse> {
pub fn migrate(deps: DepsMut, env: Env, msg: MigrateMsg) -> StdResult<MigrateResponse> {
// delete all state
let keys: Vec<_> = deps
.storage
Expand Down Expand Up @@ -101,8 +96,7 @@ mod tests {
let msg = MigrateMsg {
payout: payout.clone(),
};
let info = mock_info("creator", &[]);
let res = migrate(deps.as_mut(), mock_env(), info, msg).unwrap();
let res = migrate(deps.as_mut(), mock_env(), msg).unwrap();
// check payout
assert_eq!(1, res.messages.len());
let msg = res.messages.get(0).expect("no message");
Expand Down
3 changes: 1 addition & 2 deletions contracts/burner/tests/integration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,7 @@ fn migrate_cleans_up_data() {
let msg = MigrateMsg {
payout: payout.clone(),
};
let info = mock_info("creator", &[]);
let res: MigrateResponse = migrate(&mut deps, mock_env(), info, msg).unwrap();
let res: MigrateResponse = migrate(&mut deps, mock_env(), msg).unwrap();
// check payout
assert_eq!(1, res.messages.len());
let msg = res.messages.get(0).expect("no message");
Expand Down
10 changes: 2 additions & 8 deletions contracts/hackatom/src/contract.rs
Original file line number Diff line number Diff line change
Expand Up @@ -111,12 +111,7 @@ pub fn init(
Ok(ctx.try_into()?)
}

pub fn migrate(
deps: DepsMut,
_env: Env,
_info: MessageInfo,
msg: MigrateMsg,
) -> Result<MigrateResponse, HackError> {
pub fn migrate(deps: DepsMut, _env: Env, msg: MigrateMsg) -> Result<MigrateResponse, HackError> {
let data = deps
.storage
.get(CONFIG_KEY)
Expand Down Expand Up @@ -431,8 +426,7 @@ mod tests {
let msg = MigrateMsg {
verifier: new_verifier.clone(),
};
let info = mock_info(creator.as_str(), &[]);
let res = migrate(deps.as_mut(), mock_env(), info, msg).unwrap();
let res = migrate(deps.as_mut(), mock_env(), msg).unwrap();
assert_eq!(0, res.messages.len());

// check it is 'someone else'
Expand Down
3 changes: 1 addition & 2 deletions contracts/hackatom/tests/integration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,7 @@ fn migrate_verifier() {
let msg = MigrateMsg {
verifier: HumanAddr::from("someone else"),
};
let info = mock_info(creator.as_str(), &[]);
let res: MigrateResponse = migrate(&mut deps, mock_env(), info, msg).unwrap();
let res: MigrateResponse = migrate(&mut deps, mock_env(), msg).unwrap();
assert_eq!(0, res.messages.len());

// check it is 'someone else'
Expand Down
7 changes: 1 addition & 6 deletions contracts/queue/src/contract.rs
Original file line number Diff line number Diff line change
Expand Up @@ -125,12 +125,7 @@ fn handle_dequeue(deps: DepsMut) -> StdResult<HandleResponse> {
}

#[cfg_attr(not(feature = "library"), entry_point)]
pub fn migrate(
deps: DepsMut,
_env: Env,
_info: MessageInfo,
_msg: MigrateMsg,
) -> StdResult<MigrateResponse> {
pub fn migrate(deps: DepsMut, _env: Env, _msg: MigrateMsg) -> StdResult<MigrateResponse> {
// clear all
let keys: Vec<_> = deps
.storage
Expand Down
3 changes: 1 addition & 2 deletions contracts/queue/tests/integration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,7 @@ fn migrate_works() {
assert_eq!(get_sum(&mut deps), 25 + 17);

let msg = MigrateMsg {};
let info = mock_info("admin", &[]);
let res: MigrateResponse = migrate(&mut deps, mock_env(), info, msg).unwrap();
let res: MigrateResponse = migrate(&mut deps, mock_env(), msg).unwrap();
assert_eq!(res.messages.len(), 0);

assert_eq!(get_count(&mut deps), 3);
Expand Down
7 changes: 3 additions & 4 deletions packages/std/src/entry_points.rs
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@
macro_rules! create_entry_points {
(@migration; $contract:ident, true) => {
#[no_mangle]
extern "C" fn migrate(env_ptr: u32, info_ptr: u32, msg_ptr: u32) -> u32 {
do_migrate(&$contract::migrate, env_ptr, info_ptr, msg_ptr)
extern "C" fn migrate(env_ptr: u32, msg_ptr: u32) -> u32 {
do_migrate(&$contract::migrate, env_ptr, msg_ptr)
}
};

Expand Down Expand Up @@ -99,8 +99,7 @@ macro_rules! create_entry_points {
/// # type MigrateMsg = ();
/// pub fn migrate(
/// deps: DepsMut,
/// env: Env,
/// info: MessageInfo,
/// _env: Env,
/// msg: MigrateMsg,
/// ) -> Result<MigrateResponse, StdError> {
/// # Ok(Default::default())
Expand Down
17 changes: 4 additions & 13 deletions packages/std/src/exports.rs
Original file line number Diff line number Diff line change
Expand Up @@ -124,22 +124,16 @@ where
/// - `C`: custom response message type (see CosmosMsg)
/// - `E`: error type for responses
pub fn do_migrate<M, C, E>(
migrate_fn: &dyn Fn(DepsMut, Env, MessageInfo, M) -> Result<MigrateResponse<C>, E>,
migrate_fn: &dyn Fn(DepsMut, Env, M) -> Result<MigrateResponse<C>, E>,
env_ptr: u32,
info_ptr: u32,
msg_ptr: u32,
) -> u32
where
M: DeserializeOwned + JsonSchema,
C: Serialize + Clone + fmt::Debug + PartialEq + JsonSchema,
E: ToString,
{
let res = _do_migrate(
migrate_fn,
env_ptr as *mut Region,
info_ptr as *mut Region,
msg_ptr as *mut Region,
);
let res = _do_migrate(migrate_fn, env_ptr as *mut Region, msg_ptr as *mut Region);
let v = to_vec(&res).unwrap();
release_buffer(v) as u32
}
Expand Down Expand Up @@ -209,9 +203,8 @@ where
}

fn _do_migrate<M, C, E>(
migrate_fn: &dyn Fn(DepsMut, Env, MessageInfo, M) -> Result<MigrateResponse<C>, E>,
migrate_fn: &dyn Fn(DepsMut, Env, M) -> Result<MigrateResponse<C>, E>,
env_ptr: *mut Region,
info_ptr: *mut Region,
msg_ptr: *mut Region,
) -> ContractResult<MigrateResponse<C>>
where
Expand All @@ -220,15 +213,13 @@ where
E: ToString,
{
let env: Vec<u8> = unsafe { consume_region(env_ptr) };
let info: Vec<u8> = unsafe { consume_region(info_ptr) };
let msg: Vec<u8> = unsafe { consume_region(msg_ptr) };

let env: Env = try_into_contract_result!(from_slice(&env));
let info: MessageInfo = try_into_contract_result!(from_slice(&info));
let msg: M = try_into_contract_result!(from_slice(&msg));

let mut deps = make_dependencies();
migrate_fn(deps.as_mut(), env, info, msg).into()
migrate_fn(deps.as_mut(), env, msg).into()
}

fn _do_query<M, E>(
Expand Down
11 changes: 3 additions & 8 deletions packages/vm/src/calls.rs
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ where
pub fn call_migrate<A, S, Q, U>(
instance: &mut Instance<A, S, Q>,
env: &Env,
info: &MessageInfo,
msg: &[u8],
) -> VmResult<ContractResult<MigrateResponse<U>>>
where
Expand All @@ -69,8 +68,7 @@ where
U: DeserializeOwned + Clone + fmt::Debug + JsonSchema + PartialEq,
{
let env = to_vec(env)?;
let info = to_vec(info)?;
let data = call_migrate_raw(instance, &env, &info, msg)?;
let data = call_migrate_raw(instance, &env, msg)?;
let result: ContractResult<MigrateResponse<U>> = from_slice(&data)?;
Ok(result)
}
Expand All @@ -88,7 +86,6 @@ where
let env = to_vec(env)?;
let data = call_query_raw(instance, &env, msg)?;
let result: ContractResult<QueryResponse> = from_slice(&data)?;

// Ensure query response is valid JSON
if let ContractResult::Ok(binary_response) = &result {
serde_json::from_slice::<serde_json::Value>(binary_response.as_slice()).map_err(|e| {
Expand Down Expand Up @@ -138,7 +135,6 @@ where
pub fn call_migrate_raw<A, S, Q>(
instance: &mut Instance<A, S, Q>,
env: &[u8],
info: &[u8],
msg: &[u8],
) -> VmResult<Vec<u8>>
where
Expand All @@ -147,7 +143,7 @@ where
Q: Querier + 'static,
{
instance.set_storage_readonly(false);
call_raw(instance, "migrate", &[env, info, msg], MAX_LENGTH_MIGRATE)
call_raw(instance, "migrate", &[env, msg], MAX_LENGTH_MIGRATE)
}

/// Calls Wasm export "query" and returns raw data from the contract.
Expand Down Expand Up @@ -245,8 +241,7 @@ mod tests {

// change the verifier via migrate
let msg = br#"{"verifier": "someone else"}"#;
let info = mock_info("creator", &[]);
let _res = call_migrate::<_, _, _, Empty>(&mut instance, &mock_env(), &info, msg);
let _res = call_migrate::<_, _, _, Empty>(&mut instance, &mock_env(), msg);

// query the new_verifier with verifier
let msg = br#"{"verifier":{}}"#;
Expand Down
1 change: 0 additions & 1 deletion packages/vm/src/environment.rs
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@ impl<A: Api, S: Storage, Q: Querier> Environment<A, S, Q> {
let func = instance.exports.get_function(name)?;
Ok(func.clone())
})?;

func.call(args).map_err(|runtime_err| -> VmError {
self.with_wasmer_instance::<_, Never>(|instance| {
let err: VmError = match get_remaining_points(instance) {
Expand Down
3 changes: 1 addition & 2 deletions packages/vm/src/testing/calls.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ where
pub fn migrate<A, S, Q, M, U>(
instance: &mut Instance<A, S, Q>,
env: Env,
info: MessageInfo,
msg: M,
) -> ContractResult<MigrateResponse<U>>
where
Expand All @@ -71,7 +70,7 @@ where
U: DeserializeOwned + Clone + PartialEq + JsonSchema + fmt::Debug,
{
let serialized_msg = to_vec(&msg).expect("Testing error: Could not seralize request message");
call_migrate(instance, &env, &info, &serialized_msg).expect("VM error")
call_migrate(instance, &env, &serialized_msg).expect("VM error")
}

// query mimicks the call signature of the smart contracts.
Expand Down
Binary file modified packages/vm/testdata/hackatom_0.14.wasm
Binary file not shown.