feat(zkgm): introduce solve kind for token order (#4988)

Author: hussein-aitlahcen

cosmwasm/cw-escrow-vault/src/contract.rs

@@ -130,6 +130,16 @@ pub fn execute(
                     channel_id: packet.destination_channel_id,
                 })?;
 
+            let quote_token = String::from_utf8(Vec::from(order.quote_token))
+                .map_err(|_| Error::InvalidQuoteToken)?;
+
+            if quote_token != fungible_lane.escrowed_denom {
+                return Err(Error::InvalidFill {
+                    quote_token,
+                    escrowed_denom: fungible_lane.escrowed_denom,
+                });
+            }
+
             let mut messages = Vec::<CosmosMsg>::with_capacity(2);
             let mut push_transfer = |to, amount: Uint128| -> StdResult<()> {
                 if !amount.is_zero() {

cosmwasm/cw-escrow-vault/src/error.rs

@@ -27,4 +27,13 @@ pub enum Error {
 
     #[error("the lane has not been configured to be fungible")]
     LaneIsNotFungible { channel_id: ChannelId },
+
+    #[error("the quote token must be a valid utf8 denom")]
+    InvalidQuoteToken,
+
+    #[error("the order quote token must match the previously escrowed denom: quote_token={quote_token} != escrowed_denom={escrowed_denom}")]
+    InvalidFill {
+        quote_token: String,
+        escrowed_denom: String,
+    },
 }

cosmwasm/ibc-union/app/ucs03-zkgm/src/com.rs

@@ -28,6 +28,7 @@ pub const FILL_TYPE_MARKETMAKER: U256 = U256::from_be_slice(&[0xD1, 0xCE, 0xC4,
 pub const TOKEN_ORDER_KIND_INITIALIZE: u8 = 0x00;
 pub const TOKEN_ORDER_KIND_ESCROW: u8 = 0x01;
 pub const TOKEN_ORDER_KIND_UNESCROW: u8 = 0x02;
+pub const TOKEN_ORDER_KIND_SOLVE: u8 = 0x03;
 
 pub const FORWARD_SALT_MAGIC: U256 = U256::from_be_slice(&[
     0xC0, 0xDE, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
@@ -100,6 +101,12 @@ alloy_sol_types::sol! {
         bytes initializer;
     }
 
+    #[derive(Debug, PartialEq)]
+    struct SolverMetadata {
+        bytes solverAddress;
+        bytes metadata;
+    }
+
     #[derive(Debug, PartialEq)]
     struct Stake {
         uint256 token_id;

cosmwasm/ibc-union/app/ucs03-zkgm/src/contract.rs

@@ -26,16 +26,17 @@ use unionlabs::{
 
 use crate::{
     com::{
-        Ack, Batch, BatchAck, Call, Forward, Instruction, Stake, TokenMetadata, TokenOrderAck,
-        TokenOrderV1, TokenOrderV2, Unstake, UnstakeAck, WithdrawRewards, WithdrawRewardsAck,
-        WithdrawStake, WithdrawStakeAck, ZkgmPacket, ACK_ERR_ONLY_MAKER, FILL_TYPE_MARKETMAKER,
-        FILL_TYPE_PROTOCOL, FORWARD_SALT_MAGIC, INSTR_VERSION_0, INSTR_VERSION_1, INSTR_VERSION_2,
-        OP_BATCH, OP_CALL, OP_FORWARD, OP_STAKE, OP_TOKEN_ORDER, OP_UNSTAKE, OP_WITHDRAW_REWARDS,
-        OP_WITHDRAW_STAKE, TAG_ACK_FAILURE, TAG_ACK_SUCCESS, TOKEN_ORDER_KIND_ESCROW,
-        TOKEN_ORDER_KIND_INITIALIZE, TOKEN_ORDER_KIND_UNESCROW,
+        Ack, Batch, BatchAck, Call, Forward, Instruction, SolverMetadata, Stake, TokenMetadata,
+        TokenOrderAck, TokenOrderV1, TokenOrderV2, Unstake, UnstakeAck, WithdrawRewards,
+        WithdrawRewardsAck, WithdrawStake, WithdrawStakeAck, ZkgmPacket, ACK_ERR_ONLY_MAKER,
+        FILL_TYPE_MARKETMAKER, FILL_TYPE_PROTOCOL, FORWARD_SALT_MAGIC, INSTR_VERSION_0,
+        INSTR_VERSION_1, INSTR_VERSION_2, OP_BATCH, OP_CALL, OP_FORWARD, OP_STAKE, OP_TOKEN_ORDER,
+        OP_UNSTAKE, OP_WITHDRAW_REWARDS, OP_WITHDRAW_STAKE, TAG_ACK_FAILURE, TAG_ACK_SUCCESS,
+        TOKEN_ORDER_KIND_ESCROW, TOKEN_ORDER_KIND_INITIALIZE, TOKEN_ORDER_KIND_SOLVE,
+        TOKEN_ORDER_KIND_UNESCROW,
     },
     msg::{
-        Config, ExecuteMsg, InitMsg, PredictWrappedTokenResponse, QueryMsg, SolverMsg, SolverQuery,
+        Config, ExecuteMsg, InitMsg, PredictWrappedTokenResponse, QueryMsg, SolverMsg,
         V1ToV2Migration, ZkgmMsg,
     },
     state::{
@@ -1776,11 +1777,12 @@ fn solver_market_maker_fill_v2(
     order: TokenOrderV2,
     intent: bool,
 ) -> Result<Response, ContractError> {
-    let quote_token_str = String::from_utf8(Vec::from(order.quote_token.clone()))
-        .map_err(|_| ContractError::InvalidQuoteToken)?;
+    let metadata = SolverMetadata::abi_decode_params_validate(&order.metadata)?;
+    let solver = String::from_utf8(Vec::from(metadata.solverAddress))
+        .map_err(|_| ContractError::InvalidSolverAddress)?;
     Ok(Response::new().add_submessage(SubMsg::reply_always(
         wasm_execute(
-            quote_token_str.clone(),
+            solver,
             &SolverMsg::DoSolve {
                 packet,
                 order: order.into(),
@@ -1810,35 +1812,14 @@ fn market_maker_fill_v2(
     order: TokenOrderV2,
     intent: bool,
 ) -> Result<Response, ContractError> {
-    let quote_token_str = String::from_utf8(order.quote_token.clone().into())
-        .map_err(|_| ContractError::InvalidQuoteToken)?;
-    let is_solver = deps
-        .querier
-        .query_wasm_smart::<()>(quote_token_str.clone(), &SolverQuery::IsSolver)
-        .is_ok();
-    let allow_market_maker = deps
-        .querier
-        .query_wasm_smart::<bool>(quote_token_str.clone(), &SolverQuery::AllowMarketMakers)
-        .unwrap_or(false);
-    let (relayer_fill_for_solver, arbitrary_relayer_payload) =
-        match <(bool, alloy_primitives::Bytes)>::abi_decode_params(&relayer_msg) {
-            Ok((x, y)) => (x, y),
-            Err(_) => (false, relayer_msg.into_vec().into()),
-        };
-    let arbitrary_relayer_payload = arbitrary_relayer_payload.0.to_vec().into();
-    if is_solver && (!allow_market_maker || !relayer_fill_for_solver) {
-        solver_market_maker_fill_v2(
-            caller,
-            relayer,
-            arbitrary_relayer_payload,
-            path,
-            packet,
-            order,
-            intent,
-        )
-    } else {
-        MARKET_MAKER.save(deps.storage, &arbitrary_relayer_payload)?;
-        relayer_market_maker_fill_v2(deps, env, funds, caller, minter, order)
+    match order.kind {
+        TOKEN_ORDER_KIND_SOLVE => {
+            solver_market_maker_fill_v2(caller, relayer, relayer_msg, path, packet, order, intent)
+        }
+        _ => {
+            MARKET_MAKER.save(deps.storage, &relayer_msg)?;
+            relayer_market_maker_fill_v2(deps, env, funds, caller, minter, order)
+        }
     }
 }
 
@@ -2082,7 +2063,7 @@ fn execute_fungible_asset_order_v2(
         .map_err(|_| ContractError::UnableToValidateReceiver)?;
 
     // For intent packets, only market maker can fill
-    if intent {
+    if intent || order.kind == TOKEN_ORDER_KIND_SOLVE {
         let minter = TOKEN_MINTER.load(deps.storage)?;
         return market_maker_fill_v2(
             deps,

cosmwasm/ibc-union/app/ucs03-zkgm/src/lib.rs

@@ -47,6 +47,8 @@ pub enum ContractError {
     AmountOverflow,
     #[error("the quote token must be a valid utf8 denom")]
     InvalidQuoteToken,
+    #[error("the solver must be a bech32 encoded contract address")]
+    InvalidSolverAddress,
     #[error("the base token must be a valid utf8 denom")]
     InvalidBaseToken,
     #[error("invalid channel balance, counterparty has been taken over?")]

cosmwasm/ibc-union/app/ucs03-zkgm/src/tests.rs

@@ -1649,6 +1649,7 @@ fn test_recv_packet_native_base_dont_cover_quote_only_maker() {
     assert!(st.app.contract_data(&quote_token_addr).is_err());
     let (_, msg, _) = IncomingOrderBuilder::new(quote_token_addr.clone().into())
         .with_base_token(base_token)
+        .with_kind(TOKEN_ORDER_KIND_ESCROW)
         .with_destination_channel_id(destination_channel_id)
         .with_path(path)
         // Base not covering the quote

cosmwasm/ucs03-zkgm-token-minter-api/src/lib.rs

@@ -35,7 +35,10 @@ pub fn new_wrapped_token_event(
             EVENT_WRAPPED_TOKEN_ATTR_BASE_TOKEN,
             Bytes::<HexPrefixed>::from(base_token).to_string(),
         )
-        .add_attribute(EVENT_WRAPPED_TOKEN_ATTR_QUOTE_TOKEN, quote_token_denom)
+        .add_attribute(
+            EVENT_WRAPPED_TOKEN_ATTR_QUOTE_TOKEN,
+            Bytes::<HexPrefixed>::from(quote_token_denom.as_bytes()).to_string(),
+        )
         .add_attribute(
             EVENT_WRAPPED_TOKEN_ATTR_METADATA,
             Bytes::<HexPrefixed>::from(metadata).to_string(),

deployments/deployments.json

@@ -55,8 +55,8 @@
     "core": {
       "address": "bbn1hnuj8f6d3wy3fcprt55vddv7v2650t6uudnvd2hukqrteeam8wjqnlye9f",
       "height": 714672,
-      "commit": "e6d7b21598b95b2244bf82b242d97606585e6c25",
-      "code_id": 566
+      "commit": "6609d7359e46d6bf3de739056b27666c7de322b0",
+      "code_id": 811
     },
     "lightclient": {
       "cometbls": {
@@ -94,8 +94,8 @@
       "ucs03": {
         "address": "bbn1336jj8ertl8h7rdvnz4dh5rqahd09cy0x43guhsxx6xyrztx292q77945h",
         "height": 714737,
-        "commit": "dirty",
-        "code_id": 808,
+        "commit": "8394c0d5f90649ed3d2bf2b5745592312888d359",
+        "code_id": 815,
         "minter": {
           "type": "cw20",
           "address": "bbn1sakazthycqgzer50nqgr5ta4vy3gwz8wxla3s8rd8pql4ctmz5qssg39sf",
@@ -461,7 +461,7 @@
       "ucs03": {
         "address": "0x5fbe74a283f7954f10aa04c2edf55578811aeb03",
         "height": 8088109,
-        "commit": "623ccb60b217c45ac5f2d1cdd6e5f8e5681bb3a8"
+        "commit": "1e67026e83bc299d8766625a921f86d422ee427d"
       }
     }
   },
@@ -501,7 +501,7 @@
       "ucs03": {
         "address": "0x5fbe74a283f7954f10aa04c2edf55578811aeb03",
         "height": 3646606,
-        "commit": "623ccb60b217c45ac5f2d1cdd6e5f8e5681bb3a8"
+        "commit": "1e67026e83bc299d8766625a921f86d422ee427d"
       }
     }
   },
@@ -788,8 +788,8 @@
       "ucs03": {
         "address": "union1336jj8ertl8h7rdvnz4dh5rqahd09cy0x43guhsxx6xyrztx292qpe64fh",
         "height": 354920,
-        "commit": "48aff3edbff5edf36542570a15f42e9777340f16",
-        "code_id": 147,
+        "commit": "9f3d326626cdc2f8477e2135b2a2ce2026d823f8",
+        "code_id": 154,
         "minter": {
           "type": "cw20",
           "address": "union1t5awl707x54k6yyx7qfkuqp890dss2pqgwxh07cu44x5lrlvt4rs8hqmk0",

evm/contracts/U.sol

@@ -5,7 +5,6 @@ import "@openzeppelin-upgradeable/contracts/proxy/utils/Initializable.sol";
 import "@openzeppelin-upgradeable/contracts/proxy/utils/UUPSUpgradeable.sol";
 import
     "@openzeppelin-upgradeable/contracts/access/manager/AccessManagedUpgradeable.sol";
-import "@openzeppelin/contracts/utils/introspection/ERC165.sol";
 
 import "solady/utils/LibBytes.sol";
 
@@ -19,8 +18,7 @@ contract U is
     AccessManagedUpgradeable,
     ERC20Upgradeable,
     Versioned,
-    ISolver,
-    ERC165
+    ISolver
 {
     using LibBytes for *;
 
@@ -29,6 +27,7 @@ contract U is
     error U_CounterpartyIsNotFungible();
     error U_BaseAmountMustCoverQuoteAmount();
     error U_InvalidCounterpartyBeneficiary();
+    error U_Fool();
 
     bytes32 internal constant U_STORAGE_SLOT = keccak256(
         abi.encode(uint256(keccak256("union.storage.zkgm.u")) - 1)
@@ -173,6 +172,10 @@ contract U is
             revert U_CounterpartyIsNotFungible();
         }
 
+        if (!order.quoteToken.eq(abi.encodePacked(address(this)))) {
+            revert U_Fool();
+        }
+
         if (order.quoteAmount > order.baseAmount) {
             revert U_BaseAmountMustCoverQuoteAmount();
         }
@@ -192,13 +195,6 @@ contract U is
         return counterparty.beneficiary;
     }
 
-    function supportsInterface(
-        bytes4 interfaceId
-    ) public view override returns (bool) {
-        return interfaceId == type(ISolver).interfaceId
-            || super.supportsInterface(interfaceId);
-    }
-
     modifier onlyZkgm() {
         if (msg.sender != _getUStorage().zkgm) {
             revert U_OnlyZkgm();

evm/contracts/apps/ucs/03-zkgm/Lib.sol

@@ -29,6 +29,7 @@ library ZkgmLib {
     uint8 public constant TOKEN_ORDER_KIND_INITIALIZE = 0x00;
     uint8 public constant TOKEN_ORDER_KIND_ESCROW = 0x01;
     uint8 public constant TOKEN_ORDER_KIND_UNESCROW = 0x02;
+    uint8 public constant TOKEN_ORDER_KIND_SOLVE = 0x03;
 
     // Public instructions
     uint8 public constant OP_FORWARD = 0x00;
@@ -125,6 +126,16 @@ library ZkgmLib {
         return meta;
     }
 
+    function decodeSolverMetadata(
+        bytes calldata stream
+    ) internal pure returns (SolverMetadata calldata) {
+        SolverMetadata calldata meta;
+        assembly {
+            meta := stream.offset
+        }
+        return meta;
+    }
+
     function decodeUnstakeAck(
         bytes calldata stream
     ) internal pure returns (UnstakeAck calldata) {
@@ -412,6 +423,12 @@ library ZkgmLib {
         return abi.encode(meta.implementation, meta.initializer);
     }
 
+    function encodeSolverMetadata(
+        SolverMetadata memory meta
+    ) internal pure returns (bytes memory) {
+        return abi.encode(meta.solverAddress, meta.metadata);
+    }
+
     function decodeTokenOrderV1(
         bytes calldata stream
     ) internal pure returns (TokenOrderV1 calldata) {
@@ -627,10 +644,4 @@ library ZkgmLib {
     ) internal pure returns (bool) {
         return instruction.opcode == opcode && instruction.version == version;
     }
-
-    function isSolver(
-        address token
-    ) internal view returns (bool) {
-        return ERC165Checker.supportsInterface(token, type(ISolver).interfaceId);
-    }
 }