refactor code & add cw20-ics20-msg package

Author: ducphamle2

Cargo.lock

@@ -22,6 +22,7 @@ cosmwasm-schema = { version = "1.1.0" }
 cw-utils = "0.16.0"
 cw2 = { path = "../../packages/cw2", version = "0.16.0" }
 cw20 = { path = "../../packages/cw20", version = "0.16.0" }
+cw20-ics20-msg = { path = "../../packages/cw20-ics20-msg", version = "0.0.1" }
 cosmwasm-std = { version = "1.1.0", features = ["stargate"] }
 cw-storage-plus = "0.16.0"
 cw-controllers = { path = "../../packages/controllers", version = "0.16.0" }

contracts/cw-ics20-latest/Cargo.toml

@@ -10,7 +10,6 @@ use cw2::{get_contract_version, set_contract_version};
 use cw20::{Cw20Coin, Cw20ReceiveMsg};
 use cw_storage_plus::Bound;
 
-use crate::amount::Amount;
 use crate::error::ContractError;
 use crate::ibc::Ics20Packet;
 use crate::migrations::{v1, v2};
@@ -25,6 +24,7 @@ use crate::state::{
     Cw20MappingMetadata, ADMIN, ALLOW_LIST, CHANNEL_INFO, CHANNEL_STATE, CONFIG, CW20_ISC20_DENOM,
     NATIVE_ALLOW_LIST,
 };
+use cw20_ics20_msg::amount::Amount;
 use cw_utils::{maybe_addr, nonpayable, one_coin};
 
 // version info for migration info
@@ -481,7 +481,7 @@ pub fn query_channel(deps: Deps, id: String) -> StdResult<ChannelResponse> {
         })
         .collect::<StdResult<Vec<_>>>()?;
     // we want (Vec<outstanding>, Vec<total>)
-    let (balances, total_sent) = state.into_iter().unzip();
+    let (balances, total_sent): (Vec<Amount>, Vec<Amount>) = state.into_iter().unzip();
 
     Ok(ChannelResponse {
         info,

contracts/cw-ics20-latest/src/contract.rs

@@ -1,25 +1,23 @@
-use std::ops::Div;
-
+use cw20_ics20_msg::DelegateCw20Msg;
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
 use cosmwasm_schema::cw_serde;
 use cosmwasm_std::{
-    attr, entry_point, from_binary, to_binary, Addr, BankMsg, Binary, CosmosMsg, Decimal, Deps,
-    DepsMut, Env, IbcBasicResponse, IbcChannel, IbcChannelCloseMsg, IbcChannelConnectMsg,
-    IbcChannelOpenMsg, IbcEndpoint, IbcOrder, IbcPacket, IbcPacketAckMsg, IbcPacketReceiveMsg,
-    IbcPacketTimeoutMsg, IbcReceiveResponse, Reply, Response, Storage, SubMsg, SubMsgResult,
-    Uint128, WasmMsg,
+    attr, entry_point, from_binary, to_binary, Addr, BankMsg, Binary, CosmosMsg, Deps, DepsMut,
+    Env, IbcBasicResponse, IbcChannel, IbcChannelCloseMsg, IbcChannelConnectMsg, IbcChannelOpenMsg,
+    IbcEndpoint, IbcOrder, IbcPacket, IbcPacketAckMsg, IbcPacketReceiveMsg, IbcPacketTimeoutMsg,
+    IbcReceiveResponse, Reply, Response, Storage, SubMsg, SubMsgResult, Uint128, WasmMsg,
 };
 
-use crate::amount::Amount;
 use crate::error::{ContractError, Never};
 use crate::state::{
     get_key_ics20_ibc_denom, increase_channel_balance, reduce_channel_balance,
     undo_reduce_channel_balance, ChannelInfo, ReplyArgs, ALLOW_LIST, CHANNEL_INFO, CONFIG,
     CW20_ISC20_DENOM, NATIVE_ALLOW_LIST, REPLY_ARGS,
 };
 use cw20::Cw20ExecuteMsg;
+use cw20_ics20_msg::amount::Amount;
 
 pub const ICS20_VERSION: &str = "ics20-1";
 pub const ICS20_ORDERING: IbcOrder = IbcOrder::Unordered;
@@ -325,14 +323,20 @@ fn handle_ibc_packet_receive_native_remote_chain(
         return Err(ContractError::CustomContractRevoked {});
     }
 
-    let to_send = Amount::from_parts(
-        cw20_mapping.cw20_denom,
-        msg.amount.div(Uint128::from(
-            10u64.pow((cw20_mapping.remote_decimals - 6) as u32), // TODO: get cw20 decimal instead of hardcode. Also, need to check safe sub to prevent negative
-        )),
-    );
-
-    let cosmos_msg = send_amount(to_send, msg.receiver.clone(), Some(packet.data.clone()));
+    let to_send = Amount::from_parts(cw20_mapping.cw20_denom, msg.amount);
+
+    // send token to the custom contract for further handling
+    let cosmos_msg: CosmosMsg = WasmMsg::Execute {
+        contract_addr: msg.receiver.clone(),
+        msg: to_binary(&DelegateCw20Msg {
+            token: to_send,
+            from_decimals: cw20_mapping.remote_decimals,
+            data: packet.data.clone(),
+        })
+        .unwrap(),
+        funds: vec![],
+    }
+    .into();
     let sub_msg = SubMsg::new(cosmos_msg);
 
     let res = IbcReceiveResponse::new()

contracts/cw-ics20-latest/src/ibc.rs

@@ -11,7 +11,6 @@ For more information on this contract, please check out the
 [README](https://github.com/CosmWasm/cw-plus/blob/main/contracts/cw20-ics20/README.md).
 */
 
-pub mod amount;
 pub mod contract;
 mod error;
 pub mod ibc;

contracts/cw-ics20-latest/src/lib.rs

@@ -16,11 +16,11 @@ pub mod v1 {
 
 // v2 format is anything older than 0.13.1 when we only updated the internal balances on success ack
 pub mod v2 {
-    use crate::amount::Amount;
     use crate::state::{ChannelState, CHANNEL_INFO, CHANNEL_STATE};
     use crate::ContractError;
     use cosmwasm_std::{to_binary, Addr, DepsMut, Env, Order, StdResult, WasmQuery};
     use cw20::{BalanceResponse, Cw20QueryMsg};
+    use cw20_ics20_msg::amount::Amount;
 
     pub fn update_balances(mut deps: DepsMut, env: &Env) -> Result<(), ContractError> {
         let channels = CHANNEL_INFO

contracts/cw-ics20-latest/src/migrations.rs

@@ -2,8 +2,8 @@ use cosmwasm_schema::{cw_serde, QueryResponses};
 use cosmwasm_std::{Addr, Binary, IbcEndpoint};
 use cw20::Cw20ReceiveMsg;
 
-use crate::amount::Amount;
 use crate::state::{ChannelInfo, Cw20MappingMetadata};
+use cw20_ics20_msg::amount::Amount;
 
 #[cw_serde]
 pub struct InitMsg {

contracts/cw-ics20-latest/src/msg.rs

@@ -0,0 +1,3 @@
+[alias]
+wasm = "build --release --target wasm32-unknown-unknown"
+wasm-debug = "build --target wasm32-unknown-unknown"

packages/cw20-ics20-msg/.cargo/config

@@ -0,0 +1,17 @@
+[package]
+name = "cw20-ics20-msg"
+version = "0.0.1"
+authors = ["Oraichain Labs"]
+edition = "2021"
+description = "Definition and types for the cw20-ics20-msg interface"
+license = "Apache-2.0"
+repository = "https://github.com/Oraichain/ibc-bridge-wasm"
+homepage = "https://orai.io"
+
+[dependencies]
+cosmwasm-schema = "1.0.0"
+cosmwasm-std = { version = "1.0.0", default-features = false }
+cw-storage-plus = "0.16.0"
+cw20 = { path = "../cw20", version = "0.16.0" }
+schemars = "0.8.1"
+serde = { version = "1.0.103", default-features = false, features = ["derive"] }

packages/cw20-ics20-msg/Cargo.toml

@@ -0,0 +1,58 @@
+# CW2 Spec: Contract Info
+
+Most of the CW* specs are focused on the *public interfaces*
+of the contract. The APIs used for `ExecuteMsg` or `QueryMsg`.
+However, when we wish to migrate or inspect smart contract info,
+we need some form of smart contract information embedded on state.
+
+This is where CW2 comes in. It specifies a special Item to
+be stored on disk by all contracts on `instantiate`. 
+
+`ContractInfo` must be stored under the `"contract_info"` key which translates 
+to `"636F6E74726163745F696E666F"` in hex format.
+Since the state is well defined, we do not need to support any "smart queries".
+We do provide a helper to construct a "raw query" to read the ContractInfo
+of any CW2-compliant contract.
+
+You can query using:
+```shell
+wasmd query wasm contract-state raw [contract_addr] 636F6E74726163745F696E666F --node $RPC
+```
+
+When the `migrate` function is called, then the new contract
+can read that data andsee if this is an expected contract we can 
+migrate from. And also contain extra version information if we 
+support multiple migrate paths.
+
+### Data structures
+
+**Required**
+
+All CW2-compliant contracts must store the following data:
+
+* key: `contract_info`
+* data: Json-serialized `ContractVersion`
+
+```rust
+pub struct ContractVersion {
+    /// contract is a globally unique identifier for the contract.
+    /// it should build off standard namespacing for whichever language it is in,
+    /// and prefix it with the registry we use.
+    /// For rust we prefix with `crates.io:`, to give us eg. `crates.io:cw20-base`
+    pub contract: String,
+    /// version is any string that this implementation knows. It may be simple counter "1", "2".
+    /// or semantic version on release tags "v0.7.0", or some custom feature flag list.
+    /// the only code that needs to understand the version parsing is code that knows how to
+    /// migrate from the given contract (and is tied to it's implementation somehow)
+    pub version: String,
+}
+```
+
+Thus, an serialized example may looks like:
+
+```json
+{
+    "contract": "crates.io:cw20-base",
+    "version": "v0.1.0"
+}
+```

packages/cw20-ics20-msg/README.md

@@ -1,6 +1,5 @@
-use crate::error::ContractError;
 use cosmwasm_schema::cw_serde;
-use cosmwasm_std::{Coin, Uint128};
+use cosmwasm_std::{Coin, StdError, Uint128};
 use cw20::Cw20Coin;
 use std::convert::TryInto;
 
@@ -53,8 +52,12 @@ impl Amount {
     }
 
     /// convert the amount into u64
-    pub fn u64_amount(&self) -> Result<u64, ContractError> {
-        Ok(self.amount().u128().try_into()?)
+    pub fn u64_amount(&self) -> Result<u64, StdError> {
+        Ok(self
+            .amount()
+            .u128()
+            .try_into()
+            .map_err(|_| StdError::generic_err("error casting to u64 from u128".to_string()))?)
     }
 
     pub fn is_empty(&self) -> bool {

contracts/cw-ics20-latest/src/amount.rs renamed to packages/cw20-ics20-msg/src/amount.rs

@@ -0,0 +1,19 @@
+/*!
+Shared msgs for the cw20-ics20 and other contracts that interact with it
+*/
+
+pub mod amount;
+
+use amount::Amount;
+use cosmwasm_schema::cw_serde;
+use cosmwasm_std::Binary;
+
+#[cw_serde]
+pub struct DelegateCw20Msg {
+    /// token from the remote chain
+    pub token: Amount,
+    /// the decimals of the native token, popular is 18 or 6
+    pub from_decimals: u8,
+    /// additional data from the memo of the IBC transfer packet
+    pub data: Binary,
+}