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.

Sign up for GitHub

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

Added entry_points! macro to reduce boilerplate when writing contracts #437

Merged
merged 7 commits into from
Jun 22, 2020
Merged

Added entry_points! macro to reduce boilerplate when writing contracts #437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1845a82
added `entry_points!` macro to reduce boilerplate when writing contracts
reuvenpo Jun 21, 2020
9252844
different macros for contracts with and without migration
reuvenpo Jun 21, 2020
30d2d73
added clarification about the custom types
reuvenpo Jun 21, 2020
37fd053
fixed small textual error
reuvenpo Jun 21, 2020
e97feec
added examples to the macro docs
reuvenpo Jun 21, 2020
0f33c07
fixed typos
reuvenpo Jun 22, 2020
0ae13e8
`entry_points*` macros renamed to `create_entry_points*`
reuvenpo Jun 22, 2020
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
45 changes: 1 addition & 44 deletions contracts/burner/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::create_entry_points_with_migration!(contract);
45 changes: 1 addition & 44 deletions contracts/hackatom/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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::create_entry_points_with_migration!(contract);
36 changes: 1 addition & 35 deletions contracts/queue/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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::create_entry_points!(contract);
36 changes: 1 addition & 35 deletions contracts/reflect/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::create_entry_points!(contract);
36 changes: 1 addition & 35 deletions contracts/staking/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::create_entry_points!(contract);
137 changes: 137 additions & 0 deletions packages/std/src/entry_points.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 should be invoked in a module scope(that is, not inside a function), and the argument to the macro
/// should be the name of a second rust module that is imported in the invocation scope.
/// The second module should export three functions with the following signatures:
/// ```
/// # use cosmwasm_std::{
/// # Storage, Api, Querier, Extern, Env, StdResult, Binary,
/// # InitResult, HandleResult, QueryResult,
/// # };
/// #
/// # type InitMsg = ();
reuvenpo marked this conversation as resolved.
Show resolved Hide resolved
/// 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::create_entry_points!(contract);
/// ```
#[macro_export]
macro_rules! create_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::create_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::create_entry_points!(@inner; $contract, migration = false);
};
}

/// This macro is very similar to the `create_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::create_entry_points_with_migration!(contract);
/// ```
#[macro_export]
macro_rules! create_entry_points_with_migration {
($contract:ident) => {
$crate::create_entry_points!(@inner; $contract, migration = true);
};
}
1 change: 1 addition & 0 deletions packages/std/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

mod coins;
mod encoding;
mod entry_points;
mod errors;
mod init_handle;
#[cfg(feature = "iterator")]
Expand Down