[FEAT]: appData is now passed in calldata and update readme

Author: Intermarch3

README.md

@@ -9,16 +9,19 @@ This repository contains the core smart contracts of **PolySwap**, a protocol th
 PolySwap lets users define CoW Swap orders that become valid only when a specific prediction market condition is met.
 The contract checks the status of a Polymarket order and activates the swap only if that order has been fully filled (indicating the prediction condition was reached).
 
-## 🧱 Contract Overview (not finished yet)
+## 🧱 Contract Overview
 
-* `IConditionalOrderGenerator`: Interface for condition-based CoW Swap orders.
-* `PolySwapOrderVerifier`: Verifies whether the Polymarket condition (order filled) is satisfied.
+* `BaseConditionalOrder`: Abstract contract to inherit for compatibility with ComposableCoW.
+* `Polyswap`: Main contract that inherits from `BaseConditionalOrder` and verifies if the Polymarket order is filled.
+* `PolySwapOrder`: Verifies if the Polyswap order parameters are correct and defines the order struct.
 
-The core logic uses the Polymarket `CTFExchange` contract to check if:
+The `Polyswap` contract uses the Polymarket `CTFExchange` contract to check, via the `getOrderStatus()` function, whether:
 
 * the order is filled or cancelled, and
 * the remaining amount is `0`.
 
+If both conditions are met, the swap is executed using the Composable CoW Swap protocol.
+
 ## 🧪 Stack
 
 * [Solidity](https://soliditylang.org)

script/SubmitSingleOrder.s.sol

@@ -19,7 +19,6 @@ import {IValueFactory} from "composable-cow/src/interfaces/IValueFactory.sol";
 import {PolyswapOrder} from "../src/PolyswapOrder.sol";
 import {Polyswap} from "../src/Polyswap.sol";
 
-
 contract SubmitSingleOrder is Script {
     using SafeLib for Safe;
 
@@ -42,7 +41,8 @@ contract SubmitSingleOrder is Script {
             minBuyAmount: 80000, // 0.08 buy token
             t0: block.timestamp,
             t: block.timestamp + 1 days,
-            polymarketOrderHash: polymarketOrderHash
+            polymarketOrderHash: polymarketOrderHash,
+            appData: bytes32(0x053e648e24f8653eb9cffe71f170227d25f8fd69c135bcf2125ae24f4d210b9b) // twap app data for the test
         });
 
         IConditionalOrder.ConditionalOrderParams memory params = IConditionalOrder.ConditionalOrderParams({
@@ -88,13 +88,7 @@ contract ApproveSellTokenOnSafe is Script {
         safe.executeSingleOwner(
             address(sellToken),
             0,
-            abi.encodeCall(
-                sellToken.approve,
-                (
-                    spender,
-                    type(uint256).max
-                )
-            ),
+            abi.encodeCall(sellToken.approve, (spender, type(uint256).max)),
             Enum.Operation.Call,
             vm.addr(deployerPrivateKey)
         );

src/PolyswapOrder.sol

@@ -37,6 +37,7 @@ library PolyswapOrder {
         uint256 t0; // start valide date of the order
         uint256 t; // maximum date for the order to be valid
         bytes32 polymarketOrderHash; // hash of the Polymarket order
+        bytes32 appData;
     }
 
     // --- functions
@@ -79,7 +80,7 @@ library PolyswapOrder {
             sellAmount: self.sellAmount,
             buyAmount: self.minBuyAmount,
             validTo: self.t.toUint32(),
-            appData: bytes32(0x053e648e24f8653eb9cffe71f170227d25f8fd69c135bcf2125ae24f4d210b9b), // need to create our own app data
+            appData: self.appData,
             feeAmount: 0,
             kind: GPv2Order.KIND_SELL,
             partiallyFillable: false,

test/MockPolymarket.sol

@@ -9,14 +9,12 @@ struct OrderStatus {
 contract MockPolymarket {
     mapping(bytes32 => OrderStatus) public orderStatus;
     // Mock function to simulate the Polymarket order status
+
     function getOrderStatus(bytes32 orderHash) public view returns (OrderStatus memory) {
-        return orderStatus[ orderHash];
+        return orderStatus[orderHash];
     }
 
     function setOrderStatus(bytes32 orderHash, bool isFilledOrCancelled, uint256 remaining) public {
-        orderStatus[orderHash] = OrderStatus({
-            isFilledOrCancelled: isFilledOrCancelled,
-            remaining: remaining
-        });
+        orderStatus[orderHash] = OrderStatus({isFilledOrCancelled: isFilledOrCancelled, remaining: remaining});
     }
 }