Added entry_points! macro to reduce boilerplate when writing contracts

contracts/burner/src/lib.rs

@@ -2,47 +2,4 @@ pub mod contract;
 pub mod msg;
 
 #[cfg(target_arch = "wasm32")]
-mod wasm {
-    use super::contract;
-    use cosmwasm_std::{
-        do_handle, do_init, do_migrate, do_query, ExternalApi, ExternalQuerier, ExternalStorage,
-    };
-
-    #[no_mangle]
-    extern "C" fn init(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_init(
-            &contract::init::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn handle(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_handle(
-            &contract::handle::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn migrate(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_migrate(
-            &contract::migrate::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn query(msg_ptr: u32) -> u32 {
-        do_query(
-            &contract::query::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            msg_ptr,
-        )
-    }
-
-    // Other C externs like cosmwasm_vm_version_1, allocate, deallocate are available
-    // automatically because we `use cosmwasm_std`.
-}
+cosmwasm_std::entry_points_with_migration!(contract);

contracts/hackatom/src/lib.rs

@@ -1,47 +1,4 @@
 pub mod contract;
 
 #[cfg(target_arch = "wasm32")]
-mod wasm {
-    use super::contract;
-    use cosmwasm_std::{
-        do_handle, do_init, do_migrate, do_query, ExternalApi, ExternalQuerier, ExternalStorage,
-    };
-
-    #[no_mangle]
-    extern "C" fn init(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_init(
-            &contract::init::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn handle(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_handle(
-            &contract::handle::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn migrate(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_migrate(
-            &contract::migrate::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn query(msg_ptr: u32) -> u32 {
-        do_query(
-            &contract::query::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            msg_ptr,
-        )
-    }
-
-    // Other C externs like cosmwasm_vm_version_1, allocate, deallocate are available
-    // automatically because we `use cosmwasm_std`.
-}
+cosmwasm_std::entry_points_with_migration!(contract);

contracts/queue/src/lib.rs

@@ -1,38 +1,4 @@
 pub mod contract;
 
 #[cfg(target_arch = "wasm32")]
-mod wasm {
-    use super::contract;
-    use cosmwasm_std::{
-        do_handle, do_init, do_query, ExternalApi, ExternalQuerier, ExternalStorage,
-    };
-
-    #[no_mangle]
-    extern "C" fn init(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_init(
-            &contract::init::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn handle(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_handle(
-            &contract::handle::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn query(msg_ptr: u32) -> u32 {
-        do_query(
-            &contract::query::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            msg_ptr,
-        )
-    }
-
-    // Other C externs like cosmwasm_vm_version_1, allocate, deallocate are available
-    // automatically because we `use cosmwasm_std`.
-}
+cosmwasm_std::entry_points!(contract);

contracts/reflect/src/lib.rs

@@ -6,38 +6,4 @@ pub mod state;
 pub mod testing;
 
 #[cfg(target_arch = "wasm32")]
-mod wasm {
-    use super::contract;
-    use cosmwasm_std::{
-        do_handle, do_init, do_query, ExternalApi, ExternalQuerier, ExternalStorage,
-    };
-
-    #[no_mangle]
-    extern "C" fn init(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_init(
-            &contract::init::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn handle(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_handle(
-            &contract::handle::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn query(msg_ptr: u32) -> u32 {
-        do_query(
-            &contract::query::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            msg_ptr,
-        )
-    }
-
-    // Other C externs like cosmwasm_vm_version_1, allocate, deallocate are available
-    // automatically because we `use cosmwasm_std`.
-}
+cosmwasm_std::entry_points!(contract);

contracts/staking/src/lib.rs

@@ -3,38 +3,4 @@ pub mod msg;
 pub mod state;
 
 #[cfg(target_arch = "wasm32")]
-mod wasm {
-    use super::contract;
-    use cosmwasm_std::{
-        do_handle, do_init, do_query, ExternalApi, ExternalQuerier, ExternalStorage,
-    };
-
-    #[no_mangle]
-    extern "C" fn init(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_init(
-            &contract::init::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn handle(env_ptr: u32, msg_ptr: u32) -> u32 {
-        do_handle(
-            &contract::handle::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            env_ptr,
-            msg_ptr,
-        )
-    }
-
-    #[no_mangle]
-    extern "C" fn query(msg_ptr: u32) -> u32 {
-        do_query(
-            &contract::query::<ExternalStorage, ExternalApi, ExternalQuerier>,
-            msg_ptr,
-        )
-    }
-
-    // Other C externs like cosmwasm_vm_version_1, allocate, deallocate are available
-    // automatically because we `use cosmwasm_std`.
-}
+cosmwasm_std::entry_points!(contract);

packages/std/src/entry_points.rs

@@ -0,0 +1,137 @@
+/// This macro generates the boilerplate required to call into the
+/// contract-specific logic from the entry-points to the WASM module.
+///
+/// It macro should be invoked in a global scope, and the argument to the macro
+/// should be the name of a rust module that is imported in the invocation scope.
+/// The module should export three functions with the following signatures:
+/// ```
+/// # use cosmwasm_std::{
+/// #     Storage, Api, Querier, Extern, Env, StdResult, Binary,
+/// #     InitResult, HandleResult, QueryResult,
+/// # };
+/// #
+/// # type InitMsg = ();
+/// pub fn init<S: Storage, A: Api, Q: Querier>(
+///     deps: &mut Extern<S, A, Q>,
+///     env: Env,
+///     msg: InitMsg,
+/// ) -> InitResult {
+/// #   Ok(Default::default())
+/// }
+///
+/// # type HandleMsg = ();
+/// pub fn handle<S: Storage, A: Api, Q: Querier>(
+///     deps: &mut Extern<S, A, Q>,
+///     env: Env,
+///     msg: HandleMsg,
+/// ) -> HandleResult {
+/// #   Ok(Default::default())
+/// }
+///
+/// # type QueryMsg = ();
+/// pub fn query<S: Storage, A: Api, Q: Querier>(
+///     deps: &Extern<S, A, Q>,
+///     msg: QueryMsg,
+/// ) -> QueryResult {
+/// #   Ok(Binary(Vec::new()))
+/// }
+/// ```
+/// Where `InitMsg`, `HandleMsg`, and `QueryMsg` are types that implement `DeserializeOwned + JsonSchema`
+///
+/// # Example
+///
+/// ```ignore
+/// use contract; // The contract module
+///
+/// cosmwasm_std::entry_points!(contract);
+/// ```
+#[macro_export]
+macro_rules! entry_points {
+    (@migration; $contract:ident, true) => {
+        #[no_mangle]
+        extern "C" fn migrate(env_ptr: u32, msg_ptr: u32) -> u32 {
+            do_migrate(
+                &$contract::migrate::<ExternalStorage, ExternalApi, ExternalQuerier>,
+                env_ptr,
+                msg_ptr,
+            )
+        }
+    };
+
+    (@migration; $contract:ident, false) => {};
+
+    (@inner; $contract:ident, migration = $migration:tt) => {
+        mod wasm {
+            use super::$contract;
+            use cosmwasm_std::{
+                do_handle, do_init, do_migrate, do_query, ExternalApi, ExternalQuerier,
+                ExternalStorage,
+            };
+
+            #[no_mangle]
+            extern "C" fn init(env_ptr: u32, msg_ptr: u32) -> u32 {
+                do_init(
+                    &$contract::init::<ExternalStorage, ExternalApi, ExternalQuerier>,
+                    env_ptr,
+                    msg_ptr,
+                )
+            }
+
+            #[no_mangle]
+            extern "C" fn handle(env_ptr: u32, msg_ptr: u32) -> u32 {
+                do_handle(
+                    &$contract::handle::<ExternalStorage, ExternalApi, ExternalQuerier>,
+                    env_ptr,
+                    msg_ptr,
+                )
+            }
+
+            #[no_mangle]
+            extern "C" fn query(msg_ptr: u32) -> u32 {
+                do_query(
+                    &$contract::query::<ExternalStorage, ExternalApi, ExternalQuerier>,
+                    msg_ptr,
+                )
+            }
+
+            $crate::entry_points!(@migration; $contract, $migration);
+
+            // Other C externs like cosmwasm_vm_version_1, allocate, deallocate are available
+            // automatically because we `use cosmwasm_std`.
+        }
+    };
+
+    ($contract:ident) => {
+        $crate::entry_points!(@inner; $contract, migration = false);
+    };
+}
+
+/// This macro is very similar to the `entry_points` macro, except it also requires the `migrate` method:
+/// ```
+/// # use cosmwasm_std::{
+/// #     Storage, Api, Querier, Extern, Env, StdResult, Binary, MigrateResult,
+/// # };
+/// # type MigrateMsg = ();
+/// pub fn migrate<S: Storage, A: Api, Q: Querier>(
+///     deps: &mut Extern<S, A, Q>,
+///     _env: Env,
+///     msg: MigrateMsg,
+/// ) -> MigrateResult {
+/// #   Ok(Default::default())
+/// }
+/// ```
+/// Where `MigrateMsg` is a type that implements `DeserializeOwned + JsonSchema`
+///
+/// # Example
+///
+/// ```ignore
+/// use contract; // The contract module
+///
+/// cosmwasm_std::entry_points_with_migration!(contract);
+/// ```
+#[macro_export]
+macro_rules! entry_points_with_migration {
+    ($contract:ident) => {
+        $crate::entry_points!(@inner; $contract, migration = true);
+    };
+}

packages/std/src/lib.rs

@@ -2,6 +2,7 @@
 
 mod coins;
 mod encoding;
+mod entry_points;
 mod errors;
 mod init_handle;
 #[cfg(feature = "iterator")]