wip

Author: benluelo

cosmwasm/cw-manager/src/lib.rs

@@ -38,6 +38,14 @@
 //! Since all the permissions of the managed system can be modified by the admins of this instance,
 //! it is expected that they will be highly secured (e.g., a multisig or a well-configured DAO).
 //!
+//! # Changes from original implementation
+//!
+//! This implementation attempts to be a faithful, 1:1 reimplementation of the original solidity source code. There are however some instances where this is not possible, due to fundamental differences between the EVM and `CosmWasm`:
+//!
+//! - Storage in `CosmWasm` functions quite differently than in the EVM. In solidity, it is possible to embed a mapping directly in a struct that is stored in storage, which allows for multi-level deferred storage access. To emulate this behaviour in `CosmWasm`, a separate storage item is used explicitly in these cases. See the [`state`] and [`types`] modules for examples.
+//! - `CosmWasm` does not allow for synchronous cross-contract calls, and instead uses a submessage/reply pattern. As such, nested executions can not be run inline. In the original solidity implementation, `_executionId` is used to track the currently executing call, which is set immediately before executing the subcall and reset immediately after it. To emulate this behaviour in `CosmWasm`, we instead use a list (see [`ExecutionIdStack`][crate::state::ExecutionIdStack]) and pop the id in the reply handler.  
+//! - Solidity calldata is arbitrary bytes, and selectors are `bytes4`. Since `CosmWasm` instead uses JSON for it's data transfer format with the `ExecuteMsg`/`QueryMsg` enum pattern, calldata in this implementation is JSON, and selectors are strings. See [`managed`] for more information.
+//!
 //! [am]: https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v5.4.0/contracts/access/manager/AccessManager.sol
 
 #![warn(clippy::pedantic)]