cow_composable/

types.rs

//! Types for `CoW` Protocol composable (conditional) orders.

use std::fmt;

use alloy_primitives::{Address, B256, U256};
use serde::{Deserialize, Serialize};

use cow_types::OrderKind;

// ── Handler addresses ─────────────────────────────────────────────────────────

/// `ComposableCow` factory contract — same address on all supported chains.
///
/// `0xfdaFc9d1902f4e0b84f65F49f244b32b31013b74`
pub const COMPOSABLE_COW_ADDRESS: Address = Address::new([
    0xfd, 0xaf, 0xc9, 0xd1, 0x90, 0x2f, 0x4e, 0x0b, 0x84, 0xf6, 0x5f, 0x49, 0xf2, 0x44, 0xb3, 0x2b,
    0x31, 0x01, 0x3b, 0x74,
]);

/// Default `TWAP` handler contract address.
///
/// `0x6cF1e9cA41f7611dEf408122793c358a3d11E5a5`
pub const TWAP_HANDLER_ADDRESS: Address = Address::new([
    0x6c, 0xf1, 0xe9, 0xca, 0x41, 0xf7, 0x61, 0x1d, 0xef, 0x40, 0x81, 0x22, 0x79, 0x3c, 0x35, 0x8a,
    0x3d, 0x11, 0xe5, 0xa5,
]);

/// `CurrentBlockTimestampFactory` contract address.
///
/// Used as the `ContextFactory` when a `TWAP` order has `start_time =
/// AtMiningTime` (`t0 = 0`). The factory reads `block.timestamp` at order
/// creation and writes it into the `ComposableCow` cabinet so that every part
/// is measured from the same anchor.
///
/// `0x52eD56Da04309Aca4c3FECC595298d80C2f16BAc`
pub const CURRENT_BLOCK_TIMESTAMP_FACTORY_ADDRESS: Address = Address::new([
    0x52, 0xed, 0x56, 0xda, 0x04, 0x30, 0x9a, 0xca, 0x4c, 0x3f, 0xec, 0xc5, 0x95, 0x29, 0x8d, 0x80,
    0xc2, 0xf1, 0x6b, 0xac,
]);

/// Maximum allowed `part_duration` in seconds (1 year).
///
/// Mirrors `MAX_FREQUENCY` from the `TypeScript` SDK.
pub const MAX_FREQUENCY: u32 = 365 * 24 * 60 * 60; // 31_536_000 s

// ── ConditionalOrderParams ────────────────────────────────────────────────────

/// ABI-encoded parameters identifying a conditional order on-chain.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct ConditionalOrderParams {
    /// Address of the handler contract that validates the order.
    pub handler: Address,
    /// 32-byte salt providing uniqueness per order.
    pub salt: B256,
    /// ABI-encoded static input consumed by the handler.
    pub static_input: Vec<u8>,
}

impl ConditionalOrderParams {
    /// Construct [`ConditionalOrderParams`] from its three constituent fields.
    ///
    /// # Arguments
    ///
    /// * `handler` - Address of the handler contract that validates the order.
    /// * `salt` - 32-byte salt providing uniqueness per order.
    /// * `static_input` - ABI-encoded static input consumed by the handler.
    ///
    /// # Returns
    ///
    /// A new [`ConditionalOrderParams`] instance.
    #[must_use]
    pub const fn new(handler: Address, salt: B256, static_input: Vec<u8>) -> Self {
        Self { handler, salt, static_input }
    }

    /// Override the handler contract address.
    ///
    /// # Arguments
    ///
    /// * `handler` - The new handler contract address.
    ///
    /// # Returns
    ///
    /// The modified [`ConditionalOrderParams`] with the updated handler (builder pattern).
    #[must_use]
    pub const fn with_handler(mut self, handler: Address) -> Self {
        self.handler = handler;
        self
    }

    /// Override the 32-byte salt.
    ///
    /// # Arguments
    ///
    /// * `salt` - The new 32-byte salt value.
    ///
    /// # Returns
    ///
    /// The modified [`ConditionalOrderParams`] with the updated salt (builder pattern).
    #[must_use]
    pub const fn with_salt(mut self, salt: B256) -> Self {
        self.salt = salt;
        self
    }

    /// Override the ABI-encoded static input.
    ///
    /// # Arguments
    ///
    /// * `static_input` - The new ABI-encoded static input bytes.
    ///
    /// # Returns
    ///
    /// The modified [`ConditionalOrderParams`] with the updated static input (builder pattern).
    #[must_use]
    pub fn with_static_input(mut self, static_input: Vec<u8>) -> Self {
        self.static_input = static_input;
        self
    }

    /// Returns `true` if the static input bytes are empty.
    ///
    /// # Returns
    ///
    /// `true` if the `static_input` field contains zero bytes, `false` otherwise.
    #[must_use]
    pub const fn is_empty_static_input(&self) -> bool {
        self.static_input.is_empty()
    }

    /// Returns the length of the static input bytes.
    ///
    /// # Returns
    ///
    /// The number of bytes in the `static_input` field.
    #[must_use]
    pub const fn static_input_len(&self) -> usize {
        self.static_input.len()
    }

    /// Returns a reference to the 32-byte salt.
    ///
    /// ```
    /// use alloy_primitives::{Address, B256};
    /// use cow_composable::ConditionalOrderParams;
    ///
    /// let params = ConditionalOrderParams::new(Address::ZERO, B256::ZERO, vec![]);
    /// assert_eq!(params.salt_ref(), &B256::ZERO);
    /// ```
    #[must_use]
    pub const fn salt_ref(&self) -> &B256 {
        &self.salt
    }
}

impl fmt::Display for ConditionalOrderParams {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "params(handler={:#x})", self.handler)
    }
}

// ── TWAP ──────────────────────────────────────────────────────────────────────

/// Start time specification for a `TWAP` order.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum TwapStartTime {
    /// Start immediately at the block containing the order creation tx.
    AtMiningTime,
    /// Start at a specific Unix timestamp.
    At(u32),
}

impl TwapStartTime {
    /// Returns a human-readable string label for the start time.
    ///
    /// # Returns
    ///
    /// `"at-mining-time"` for [`AtMiningTime`](Self::AtMiningTime), or
    /// `"at-unix"` for [`At`](Self::At).
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::AtMiningTime => "at-mining-time",
            Self::At(_) => "at-unix",
        }
    }

    /// Returns `true` if the order starts at the block it is mined in.
    ///
    /// # Returns
    ///
    /// `true` for [`AtMiningTime`](Self::AtMiningTime), `false` for [`At`](Self::At).
    #[must_use]
    pub const fn is_at_mining_time(self) -> bool {
        matches!(self, Self::AtMiningTime)
    }

    /// Returns `true` if the order starts at a fixed Unix timestamp.
    ///
    /// # Returns
    ///
    /// `true` for [`At`](Self::At), `false` for [`AtMiningTime`](Self::AtMiningTime).
    #[must_use]
    pub const fn is_fixed(self) -> bool {
        matches!(self, Self::At(_))
    }

    /// Return the fixed start timestamp, or `None` for [`AtMiningTime`](Self::AtMiningTime).
    ///
    /// # Returns
    ///
    /// `Some(ts)` containing the Unix timestamp for [`At`](Self::At),
    /// or `None` for [`AtMiningTime`](Self::AtMiningTime).
    #[must_use]
    pub const fn timestamp(self) -> Option<u32> {
        match self {
            Self::At(ts) => Some(ts),
            Self::AtMiningTime => None,
        }
    }
}

impl fmt::Display for TwapStartTime {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::AtMiningTime => f.write_str("at-mining-time"),
            Self::At(ts) => write!(f, "at-unix-{ts}"),
        }
    }
}

impl From<u32> for TwapStartTime {
    /// Convert a Unix timestamp into a [`TwapStartTime`].
    ///
    /// `0` maps to [`TwapStartTime::AtMiningTime`]; any other value maps to
    /// [`TwapStartTime::At`].  This mirrors the on-chain `t0` field encoding.
    fn from(ts: u32) -> Self {
        if ts == 0 { Self::AtMiningTime } else { Self::At(ts) }
    }
}

impl From<TwapStartTime> for u32 {
    /// Encode a [`TwapStartTime`] as the on-chain `t0` field.
    ///
    /// [`TwapStartTime::AtMiningTime`] encodes as `0`; [`TwapStartTime::At`]
    /// encodes as the contained Unix timestamp.
    fn from(t: TwapStartTime) -> Self {
        match t {
            TwapStartTime::AtMiningTime => 0,
            TwapStartTime::At(ts) => ts,
        }
    }
}

impl From<Option<u32>> for TwapStartTime {
    /// Convert an optional Unix timestamp to a [`TwapStartTime`].
    ///
    /// `Some(ts)` maps to [`TwapStartTime::At`];
    /// `None` maps to [`TwapStartTime::AtMiningTime`].
    fn from(ts: Option<u32>) -> Self {
        match ts {
            Some(t) => Self::At(t),
            None => Self::AtMiningTime,
        }
    }
}

/// Duration constraint for each individual `TWAP` part.
///
/// - [`DurationOfPart::Auto`] encodes `span = 0` on-chain, meaning each part is valid for the
///   entire `part_duration` window.
/// - [`DurationOfPart::LimitDuration`] encodes `span = duration`, restricting each part to a
///   shorter window within the overall interval.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
pub enum DurationOfPart {
    /// Each part is valid for the full `part_duration` window (default).
    #[default]
    Auto,
    /// Each part is valid only for `duration` seconds within the window.
    LimitDuration {
        /// Active window for the part, in seconds. Must be ≤ `part_duration`.
        duration: u32,
    },
}

impl DurationOfPart {
    /// Return the limit duration in seconds, or `None` for [`Auto`](Self::Auto).
    #[must_use]
    pub const fn duration(self) -> Option<u32> {
        match self {
            Self::LimitDuration { duration } => Some(duration),
            Self::Auto => None,
        }
    }

    /// Returns `true` if the part spans the full `part_duration` window.
    #[must_use]
    pub const fn is_auto(self) -> bool {
        matches!(self, Self::Auto)
    }

    /// Construct a [`LimitDuration`](Self::LimitDuration) variant.
    ///
    /// ```
    /// use cow_composable::DurationOfPart;
    ///
    /// let d = DurationOfPart::limit(1_800);
    /// assert!(!d.is_auto());
    /// assert_eq!(d.duration(), Some(1_800));
    /// ```
    #[must_use]
    pub const fn limit(duration: u32) -> Self {
        Self::LimitDuration { duration }
    }

    /// Returns `true` if this is a [`LimitDuration`](Self::LimitDuration) variant.
    ///
    /// ```
    /// use cow_composable::DurationOfPart;
    ///
    /// assert!(DurationOfPart::limit(600).is_limit_duration());
    /// assert!(!DurationOfPart::Auto.is_limit_duration());
    /// ```
    #[must_use]
    pub const fn is_limit_duration(self) -> bool {
        matches!(self, Self::LimitDuration { .. })
    }
}

impl fmt::Display for DurationOfPart {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Auto => f.write_str("auto"),
            Self::LimitDuration { duration } => write!(f, "limit-duration({duration}s)"),
        }
    }
}

impl From<Option<u32>> for DurationOfPart {
    /// Convert an optional duration to a [`DurationOfPart`].
    ///
    /// `Some(d)` maps to [`DurationOfPart::LimitDuration`];
    /// `None` maps to [`DurationOfPart::Auto`].
    fn from(d: Option<u32>) -> Self {
        match d {
            Some(duration) => Self::LimitDuration { duration },
            None => Self::Auto,
        }
    }
}

/// Parameters for a Time-Weighted Average Price (`TWAP`) order.
///
/// A `TWAP` order splits a large trade into `num_parts` equal parts executed
/// over `num_parts × part_duration` seconds, reducing market impact.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TwapData {
    /// Token to sell.
    pub sell_token: Address,
    /// Token to buy.
    pub buy_token: Address,
    /// Address to receive bought tokens (use [`Address::ZERO`] for the order owner).
    pub receiver: Address,
    /// Total amount to sell across all parts.
    pub sell_amount: U256,
    /// Minimum total amount to buy across all parts.
    pub buy_amount: U256,
    /// When to start the `TWAP`.
    pub start_time: TwapStartTime,
    /// Duration of each part in seconds.
    pub part_duration: u32,
    /// Number of parts to split the order into.
    pub num_parts: u32,
    /// App-data hash (use [`B256::ZERO`] for none).
    pub app_data: B256,
    /// Whether each individual part may be partially filled.
    pub partially_fillable: bool,
    /// Order kind (`Sell` or `Buy`).
    pub kind: OrderKind,
    /// How long each part remains valid within its window.
    ///
    /// Defaults to [`DurationOfPart::Auto`] (full window, `span = 0`).
    #[serde(default)]
    pub duration_of_part: DurationOfPart,
}

impl fmt::Display for TwapData {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "TWAP {} × {}s [{}] sell {} {:#x} → buy ≥ {} {:#x}",
            self.num_parts,
            self.part_duration,
            self.start_time,
            self.sell_amount,
            self.sell_token,
            self.buy_amount,
            self.buy_token,
        )
    }
}

impl TwapData {
    /// Total duration of the `TWAP` order in seconds.
    ///
    /// Equals `num_parts × part_duration`.
    ///
    /// # Returns
    ///
    /// The total duration in seconds as a `u64`.
    #[must_use]
    pub const fn total_duration_secs(&self) -> u64 {
        self.num_parts as u64 * self.part_duration as u64
    }

    /// Absolute Unix timestamp at which the last part expires, if the start
    /// time is known.
    ///
    /// # Returns
    ///
    /// `Some(end_timestamp)` when `start_time` is [`TwapStartTime::At`], computed
    /// as `start + total_duration_secs()`. Returns `None` when `start_time` is
    /// [`TwapStartTime::AtMiningTime`] (the exact start is only known at mining time).
    #[must_use]
    pub const fn end_time(&self) -> Option<u64> {
        match self.start_time {
            TwapStartTime::At(ts) => Some(ts as u64 + self.total_duration_secs()),
            TwapStartTime::AtMiningTime => None,
        }
    }

    /// Returns `true` if this is a sell-direction `TWAP` order.
    ///
    /// ```
    /// use alloy_primitives::{Address, U256};
    /// use cow_composable::TwapData;
    ///
    /// let twap = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 4, 3_600);
    /// assert!(twap.is_sell());
    /// assert!(!twap.is_buy());
    /// ```
    #[must_use]
    pub const fn is_sell(&self) -> bool {
        self.kind.is_sell()
    }

    /// Returns `true` if this is a buy-direction `TWAP` order.
    ///
    /// ```
    /// use alloy_primitives::{Address, U256};
    /// use cow_composable::{TwapData, TwapStartTime};
    /// use cow_types::OrderKind;
    ///
    /// let mut twap = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 4, 3_600);
    /// twap.kind = OrderKind::Buy;
    /// assert!(twap.is_buy());
    /// assert!(!twap.is_sell());
    /// ```
    #[must_use]
    pub const fn is_buy(&self) -> bool {
        self.kind.is_buy()
    }

    /// Returns `true` if the `TWAP` has fully expired at the given Unix timestamp.
    ///
    /// Returns `false` when `start_time` is [`TwapStartTime::AtMiningTime`]
    /// (the end time is not yet known).
    ///
    /// ```
    /// use alloy_primitives::{Address, U256};
    /// use cow_composable::{TwapData, TwapStartTime};
    ///
    /// let twap = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 4, 3_600)
    ///     .with_start_time(TwapStartTime::At(1_000_000));
    /// // ends at 1_000_000 + 4 × 3600 = 1_014_400
    /// assert!(!twap.is_expired(1_014_399));
    /// assert!(twap.is_expired(1_014_400));
    /// ```
    #[must_use]
    pub const fn is_expired(&self, timestamp: u64) -> bool {
        match self.end_time() {
            Some(end) => timestamp >= end,
            None => false,
        }
    }

    /// Create a minimal sell-kind TWAP order.
    ///
    /// Defaults: `receiver = Address::ZERO`, `buy_amount = U256::ZERO` (no min),
    /// `start_time = TwapStartTime::AtMiningTime`, `app_data = B256::ZERO`,
    /// `partially_fillable = false`, `duration_of_part = DurationOfPart::Auto`.
    ///
    /// Use the `with_*` builder methods to set optional fields.
    ///
    /// # Arguments
    ///
    /// * `sell_token` - Address of the token to sell.
    /// * `buy_token` - Address of the token to buy.
    /// * `sell_amount` - Total amount of `sell_token` to sell across all parts.
    /// * `num_parts` - Number of parts to split the order into.
    /// * `part_duration` - Duration of each part in seconds.
    ///
    /// # Returns
    ///
    /// A new [`TwapData`] configured as a sell order with sensible defaults.
    #[must_use]
    pub const fn sell(
        sell_token: Address,
        buy_token: Address,
        sell_amount: U256,
        num_parts: u32,
        part_duration: u32,
    ) -> Self {
        Self {
            sell_token,
            buy_token,
            receiver: Address::ZERO,
            sell_amount,
            buy_amount: U256::ZERO,
            start_time: TwapStartTime::AtMiningTime,
            part_duration,
            num_parts,
            app_data: B256::ZERO,
            partially_fillable: false,
            kind: OrderKind::Sell,
            duration_of_part: DurationOfPart::Auto,
        }
    }

    /// Create a minimal buy-kind TWAP order.
    ///
    /// Defaults: `receiver = Address::ZERO`, `sell_amount = U256::MAX` (unlimited),
    /// `start_time = TwapStartTime::AtMiningTime`, `app_data = B256::ZERO`,
    /// `partially_fillable = false`, `duration_of_part = DurationOfPart::Auto`.
    ///
    /// Use the `with_*` builder methods to set optional fields.
    ///
    /// # Arguments
    ///
    /// * `sell_token` - Address of the token to sell.
    /// * `buy_token` - Address of the token to buy.
    /// * `buy_amount` - Minimum total amount of `buy_token` to receive across all parts.
    /// * `num_parts` - Number of parts to split the order into.
    /// * `part_duration` - Duration of each part in seconds.
    ///
    /// # Returns
    ///
    /// A new [`TwapData`] configured as a buy order with sensible defaults.
    #[must_use]
    pub const fn buy(
        sell_token: Address,
        buy_token: Address,
        buy_amount: U256,
        num_parts: u32,
        part_duration: u32,
    ) -> Self {
        Self {
            sell_token,
            buy_token,
            receiver: Address::ZERO,
            sell_amount: U256::MAX,
            buy_amount,
            start_time: TwapStartTime::AtMiningTime,
            part_duration,
            num_parts,
            app_data: B256::ZERO,
            partially_fillable: false,
            kind: OrderKind::Buy,
            duration_of_part: DurationOfPart::Auto,
        }
    }

    /// Set the receiver address for bought tokens.
    ///
    /// [`Address::ZERO`] means the order owner (default).
    ///
    /// # Returns
    ///
    /// The modified [`TwapData`] with the updated receiver (builder pattern).
    #[must_use]
    pub const fn with_receiver(mut self, receiver: Address) -> Self {
        self.receiver = receiver;
        self
    }

    /// Set the minimum amount of `buy_token` to receive across all parts.
    ///
    /// Useful when building a sell-kind order to set a price floor.
    ///
    /// # Returns
    ///
    /// The modified [`TwapData`] with the updated buy amount (builder pattern).
    #[must_use]
    pub const fn with_buy_amount(mut self, buy_amount: U256) -> Self {
        self.buy_amount = buy_amount;
        self
    }

    /// Set the maximum amount of `sell_token` to sell across all parts.
    ///
    /// Useful when building a buy-kind order to cap spending.
    ///
    /// # Returns
    ///
    /// The modified [`TwapData`] with the updated sell amount (builder pattern).
    #[must_use]
    pub const fn with_sell_amount(mut self, sell_amount: U256) -> Self {
        self.sell_amount = sell_amount;
        self
    }

    /// Set when the TWAP order starts executing.
    ///
    /// # Returns
    ///
    /// The modified [`TwapData`] with the updated start time (builder pattern).
    #[must_use]
    pub const fn with_start_time(mut self, start_time: TwapStartTime) -> Self {
        self.start_time = start_time;
        self
    }

    /// Attach an app-data hash to the order.
    ///
    /// # Returns
    ///
    /// The modified [`TwapData`] with the updated app-data hash (builder pattern).
    #[must_use]
    pub const fn with_app_data(mut self, app_data: B256) -> Self {
        self.app_data = app_data;
        self
    }

    /// Allow each individual part to be partially filled.
    ///
    /// # Returns
    ///
    /// The modified [`TwapData`] with the updated partial-fill setting (builder pattern).
    #[must_use]
    pub const fn with_partially_fillable(mut self, partially_fillable: bool) -> Self {
        self.partially_fillable = partially_fillable;
        self
    }

    /// Restrict each part to a shorter validity window within its overall interval.
    ///
    /// # Returns
    ///
    /// The modified [`TwapData`] with the updated duration-of-part setting (builder pattern).
    #[must_use]
    pub const fn with_duration_of_part(mut self, duration_of_part: DurationOfPart) -> Self {
        self.duration_of_part = duration_of_part;
        self
    }

    /// Returns `true` if a non-zero app-data hash is attached.
    ///
    /// The zero hash (`B256::ZERO`) means no app-data was set.
    ///
    /// ```
    /// use alloy_primitives::{Address, B256, U256};
    /// use cow_composable::TwapData;
    ///
    /// let twap = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 4, 3_600);
    /// assert!(!twap.has_app_data());
    ///
    /// let with_data = twap.with_app_data(B256::repeat_byte(0x01));
    /// assert!(with_data.has_app_data());
    /// ```
    #[must_use]
    pub fn has_app_data(&self) -> bool {
        !self.app_data.is_zero()
    }
}

/// On-chain `TwapStruct` representation with per-part amounts.
///
/// This mirrors the Solidity struct passed to the handler as `staticInput`.
/// Use [`TwapData`] for the user-facing SDK type; use `TwapStruct` only when
/// you need direct access to the ABI-level fields.
#[derive(Debug, Clone)]
pub struct TwapStruct {
    /// Token to sell.
    pub sell_token: Address,
    /// Token to buy.
    pub buy_token: Address,
    /// Receiver of bought tokens.
    pub receiver: Address,
    /// Amount of `sell_token` to sell in **each** part (not total).
    pub part_sell_amount: U256,
    /// Minimum amount of `buy_token` to buy in **each** part.
    pub min_part_limit: U256,
    /// Start timestamp (`0` = use `CurrentBlockTimestampFactory`).
    pub t0: u32,
    /// Number of parts.
    pub n: u32,
    /// Duration of each part in seconds.
    pub t: u32,
    /// Part validity window in seconds (`0` = full window).
    pub span: u32,
    /// App-data hash.
    pub app_data: B256,
}

impl TwapStruct {
    /// Returns `true` if a non-zero app-data hash is set.
    ///
    /// The zero hash (`B256::ZERO`) means no app-data was attached.
    ///
    /// # Returns
    ///
    /// `true` if the `app_data` field is not [`B256::ZERO`], `false` otherwise.
    #[must_use]
    pub fn has_app_data(&self) -> bool {
        !self.app_data.is_zero()
    }

    /// Returns `true` if the receiver is not the zero address.
    ///
    /// When `receiver == Address::ZERO`, the settlement contract uses the order
    /// owner as the effective receiver.
    ///
    /// # Returns
    ///
    /// `true` if `receiver` is not [`Address::ZERO`], `false` otherwise.
    #[must_use]
    pub fn has_custom_receiver(&self) -> bool {
        !self.receiver.is_zero()
    }

    /// Returns `true` if a fixed start timestamp is set (`t0 != 0`).
    ///
    /// When `t0 == 0`, the order uses `CurrentBlockTimestampFactory` to
    /// determine the start time at mining time.
    ///
    /// # Returns
    ///
    /// `true` if `t0` is non-zero, `false` otherwise.
    #[must_use]
    pub const fn start_is_fixed(&self) -> bool {
        self.t0 != 0
    }
}

impl TryFrom<&TwapData> for TwapStruct {
    type Error = cow_errors::CowError;

    /// Convert a high-level [`TwapData`] into the ABI-level [`TwapStruct`].
    ///
    /// Delegates to [`crate::data_to_struct`].
    fn try_from(d: &TwapData) -> Result<Self, Self::Error> {
        crate::data_to_struct(d)
    }
}

impl From<&TwapStruct> for TwapData {
    /// Convert an ABI-level [`TwapStruct`] back into a high-level [`TwapData`].
    ///
    /// Delegates to [`crate::struct_to_data`].
    fn from(s: &TwapStruct) -> Self {
        crate::struct_to_data(s)
    }
}

impl fmt::Display for TwapStruct {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "twap-struct {} × {}s sell {} {:#x} → ≥{} {:#x}",
            self.n,
            self.t,
            self.part_sell_amount,
            self.sell_token,
            self.min_part_limit,
            self.buy_token,
        )
    }
}

// ── GpV2OrderStruct ───────────────────────────────────────────────────────────

/// Raw on-chain `GPv2Order.DataStruct` as emitted by the `GPv2Settlement` contract.
///
/// Unlike [`UnsignedOrder`](cow_signing::types::UnsignedOrder), the
/// `kind`, `sell_token_balance`, and `buy_token_balance` fields are stored as
/// `keccak256` hashes rather than typed enums.
///
/// Use [`from_struct_to_order`](crate::from_struct_to_order) to
/// decode them into a fully typed
/// [`UnsignedOrder`](cow_signing::types::UnsignedOrder).
///
/// Mirrors `GPv2Order.DataStruct` from the `@cowprotocol/composable` SDK.
#[derive(Debug, Clone)]
pub struct GpV2OrderStruct {
    /// Token to sell.
    pub sell_token: Address,
    /// Token to buy.
    pub buy_token: Address,
    /// Address that receives the bought tokens.
    pub receiver: Address,
    /// Amount of `sell_token` to sell (in atoms).
    pub sell_amount: U256,
    /// Minimum amount of `buy_token` to receive (in atoms).
    pub buy_amount: U256,
    /// Order expiry as a Unix timestamp.
    pub valid_to: u32,
    /// App-data hash (`bytes32`).
    pub app_data: B256,
    /// Protocol fee included in `sell_amount` (in atoms).
    pub fee_amount: U256,
    /// `keccak256("sell")` or `keccak256("buy")`.
    pub kind: B256,
    /// Whether the order may be partially filled.
    pub partially_fillable: bool,
    /// `keccak256("erc20")`, `keccak256("external")`, or `keccak256("internal")`.
    pub sell_token_balance: B256,
    /// `keccak256("erc20")`, `keccak256("external")`, or `keccak256("internal")`.
    pub buy_token_balance: B256,
}
impl fmt::Display for GpV2OrderStruct {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "gpv2-order({:#x} sell={} → {:#x} buy={})",
            self.sell_token, self.sell_amount, self.buy_token, self.buy_amount
        )
    }
}

impl GpV2OrderStruct {
    /// Returns `true` if the receiver is not the zero address.
    ///
    /// When `receiver == Address::ZERO`, the settlement contract uses the order
    /// owner as the effective receiver.
    ///
    /// # Returns
    ///
    /// `true` if `receiver` is not [`Address::ZERO`], `false` otherwise.
    #[must_use]
    pub fn has_custom_receiver(&self) -> bool {
        !self.receiver.is_zero()
    }

    /// Returns `true` if this order allows partial fills.
    ///
    /// # Returns
    ///
    /// `true` if `partially_fillable` is set, `false` for fill-or-kill orders.
    #[must_use]
    pub const fn is_partially_fillable(&self) -> bool {
        self.partially_fillable
    }
}

impl TryFrom<&GpV2OrderStruct> for cow_signing::types::UnsignedOrder {
    type Error = cow_errors::CowError;

    /// Decode a raw [`GpV2OrderStruct`] into a fully typed `UnsignedOrder`.
    ///
    /// Resolves the hashed `kind`, `sell_token_balance`, and `buy_token_balance`
    /// fields back into their enum representations via
    /// [`crate::from_struct_to_order`].
    fn try_from(s: &GpV2OrderStruct) -> Result<Self, Self::Error> {
        crate::from_struct_to_order(s)
    }
}

// ── PollResult ────────────────────────────────────────────────────────────────

/// Result returned when polling a conditional order for tradability.
///
/// On `Success`, contains the on-chain order struct and the pre-signature bytes
/// ready for submission to the orderbook.
#[derive(Debug, Clone)]
pub enum PollResult {
    /// The order is valid and can be submitted now.
    ///
    /// When returned by a full signing poll, `order` and `signature` are set to
    /// the resolved `GPv2Order.Data` struct and the ABI-encoded signature.
    /// When returned by an offline validity check (e.g. `TwapOrder::poll_validate`),
    /// both fields are `None`.
    Success {
        /// The resolved order ready for submission (`None` for offline checks).
        order: Option<cow_signing::types::UnsignedOrder>,
        /// Hex-encoded signature bytes, `0x`-prefixed (`None` for offline checks).
        signature: Option<String>,
    },
    /// Retry on the next block.
    TryNextBlock,
    /// Retry once the given block number is reached.
    TryOnBlock {
        /// Target block number.
        block_number: u64,
    },
    /// Retry once the given Unix timestamp is reached.
    TryAtEpoch {
        /// Target Unix timestamp in seconds.
        epoch: u64,
    },
    /// An unexpected error occurred.
    UnexpectedError {
        /// Human-readable error description.
        message: String,
    },
    /// This order should never be polled again.
    DontTryAgain {
        /// Reason the order is permanently inactive.
        reason: String,
    },
}

impl PollResult {
    /// Returns `true` if the order is ready to be submitted.
    ///
    /// # Returns
    ///
    /// `true` for the [`Success`](Self::Success) variant, `false` for all others.
    #[must_use]
    pub const fn is_success(&self) -> bool {
        matches!(self, Self::Success { .. })
    }

    /// Returns `true` if polling should be retried in a future block or epoch.
    ///
    /// # Returns
    ///
    /// `true` for [`TryNextBlock`](Self::TryNextBlock), [`TryOnBlock`](Self::TryOnBlock),
    /// or [`TryAtEpoch`](Self::TryAtEpoch); `false` otherwise.
    #[must_use]
    pub const fn is_retryable(&self) -> bool {
        matches!(self, Self::TryNextBlock | Self::TryOnBlock { .. } | Self::TryAtEpoch { .. })
    }

    /// Returns `true` if this order should never be polled again.
    ///
    /// # Returns
    ///
    /// `true` for the [`DontTryAgain`](Self::DontTryAgain) variant, `false` otherwise.
    #[must_use]
    pub const fn is_terminal(&self) -> bool {
        matches!(self, Self::DontTryAgain { .. })
    }

    /// Returns `true` if polling should retry on the very next block.
    ///
    /// # Returns
    ///
    /// `true` for the [`TryNextBlock`](Self::TryNextBlock) variant, `false` otherwise.
    #[must_use]
    pub const fn is_try_next_block(&self) -> bool {
        matches!(self, Self::TryNextBlock)
    }

    /// Returns `true` if polling should retry once a specific block is reached.
    ///
    /// # Returns
    ///
    /// `true` for the [`TryOnBlock`](Self::TryOnBlock) variant, `false` otherwise.
    #[must_use]
    pub const fn is_try_on_block(&self) -> bool {
        matches!(self, Self::TryOnBlock { .. })
    }

    /// Returns `true` if polling should retry once a specific Unix epoch is reached.
    ///
    /// # Returns
    ///
    /// `true` for the [`TryAtEpoch`](Self::TryAtEpoch) variant, `false` otherwise.
    #[must_use]
    pub const fn is_try_at_epoch(&self) -> bool {
        matches!(self, Self::TryAtEpoch { .. })
    }

    /// Returns `true` if an unexpected error occurred during polling.
    ///
    /// # Returns
    ///
    /// `true` for the [`UnexpectedError`](Self::UnexpectedError) variant, `false` otherwise.
    #[must_use]
    pub const fn is_unexpected_error(&self) -> bool {
        matches!(self, Self::UnexpectedError { .. })
    }

    /// Returns `true` if this order should never be polled again (terminal failure).
    ///
    /// # Returns
    ///
    /// `true` for the [`DontTryAgain`](Self::DontTryAgain) variant, `false` otherwise.
    #[must_use]
    pub const fn is_dont_try_again(&self) -> bool {
        matches!(self, Self::DontTryAgain { .. })
    }

    /// Extract the target block number from a [`TryOnBlock`](Self::TryOnBlock) variant.
    ///
    /// Returns `None` for all other variants.
    ///
    /// ```
    /// use cow_composable::PollResult;
    ///
    /// let r = PollResult::TryOnBlock { block_number: 12_345_678 };
    /// assert_eq!(r.get_block_number(), Some(12_345_678));
    /// assert_eq!(PollResult::TryNextBlock.get_block_number(), None);
    /// ```
    #[must_use]
    pub const fn get_block_number(&self) -> Option<u64> {
        if let Self::TryOnBlock { block_number } = self { Some(*block_number) } else { None }
    }

    /// Extract the target Unix epoch from a [`TryAtEpoch`](Self::TryAtEpoch) variant.
    ///
    /// Returns `None` for all other variants.
    ///
    /// ```
    /// use cow_composable::PollResult;
    ///
    /// let r = PollResult::TryAtEpoch { epoch: 1_700_000_000 };
    /// assert_eq!(r.get_epoch(), Some(1_700_000_000));
    /// assert_eq!(PollResult::TryNextBlock.get_epoch(), None);
    /// ```
    #[must_use]
    pub const fn get_epoch(&self) -> Option<u64> {
        if let Self::TryAtEpoch { epoch } = self { Some(*epoch) } else { None }
    }

    /// Extract the resolved [`UnsignedOrder`](cow_signing::types::UnsignedOrder)
    /// from a [`PollResult::Success`] variant, if present.
    ///
    /// Returns `None` for all other variants, or when `order` is `None`
    /// inside `Success` (e.g. an offline validity check result).
    #[must_use]
    pub const fn order_ref(&self) -> Option<&cow_signing::types::UnsignedOrder> {
        if let Self::Success { order, .. } = self { order.as_ref() } else { None }
    }

    /// Extract the error message from an [`UnexpectedError`](Self::UnexpectedError)
    /// or [`DontTryAgain`](Self::DontTryAgain) variant.
    ///
    /// Returns `None` for all other variants.
    #[must_use]
    pub const fn as_error_message(&self) -> Option<&str> {
        match self {
            Self::UnexpectedError { message } => Some(message.as_str()),
            Self::DontTryAgain { reason } => Some(reason.as_str()),
            Self::Success { .. } |
            Self::TryNextBlock |
            Self::TryOnBlock { .. } |
            Self::TryAtEpoch { .. } => None,
        }
    }
}

impl fmt::Display for PollResult {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Success { .. } => f.write_str("success"),
            Self::TryNextBlock => f.write_str("try-next-block"),
            Self::TryOnBlock { block_number } => write!(f, "try-on-block({block_number})"),
            Self::TryAtEpoch { epoch } => write!(f, "try-at-epoch({epoch})"),
            Self::UnexpectedError { message } => write!(f, "unexpected-error({message})"),
            Self::DontTryAgain { reason } => write!(f, "dont-try-again({reason})"),
        }
    }
}

// ── ProofLocation ─────────────────────────────────────────────────────────────

/// Where the Merkle proof for a conditional order is stored / communicated.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
#[repr(u8)]
pub enum ProofLocation {
    /// Proof is kept private; only the owner polls.
    #[default]
    Private = 0,
    /// Proof emitted as an on-chain event.
    Emitted = 1,
    /// Proof stored on Swarm.
    Swarm = 2,
    /// Proof communicated via Waku.
    Waku = 3,
    /// Reserved for future use.
    Reserved = 4,
    /// Proof stored on IPFS.
    Ipfs = 5,
}

impl ProofLocation {
    /// Returns a lowercase string label for the proof location.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Private => "private",
            Self::Emitted => "emitted",
            Self::Swarm => "swarm",
            Self::Waku => "waku",
            Self::Reserved => "reserved",
            Self::Ipfs => "ipfs",
        }
    }

    /// Returns `true` if the proof is kept private (owner-polled only).
    #[must_use]
    pub const fn is_private(self) -> bool {
        matches!(self, Self::Private)
    }

    /// Returns `true` if the proof is emitted as an on-chain event.
    #[must_use]
    pub const fn is_emitted(self) -> bool {
        matches!(self, Self::Emitted)
    }

    /// Returns `true` if the proof is stored on Swarm.
    #[must_use]
    pub const fn is_swarm(self) -> bool {
        matches!(self, Self::Swarm)
    }

    /// Returns `true` if the proof is communicated via Waku.
    #[must_use]
    pub const fn is_waku(self) -> bool {
        matches!(self, Self::Waku)
    }

    /// Returns `true` if this location is the reserved (future-use) discriminant.
    #[must_use]
    pub const fn is_reserved(self) -> bool {
        matches!(self, Self::Reserved)
    }

    /// Returns `true` if the proof is stored on IPFS.
    #[must_use]
    pub const fn is_ipfs(self) -> bool {
        matches!(self, Self::Ipfs)
    }
}

impl fmt::Display for ProofLocation {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_str())
    }
}

impl TryFrom<u8> for ProofLocation {
    type Error = cow_errors::CowError;

    /// Parse a [`ProofLocation`] from its on-chain `uint8` discriminant.
    fn try_from(n: u8) -> Result<Self, Self::Error> {
        match n {
            0 => Ok(Self::Private),
            1 => Ok(Self::Emitted),
            2 => Ok(Self::Swarm),
            3 => Ok(Self::Waku),
            4 => Ok(Self::Reserved),
            5 => Ok(Self::Ipfs),
            other => Err(cow_errors::CowError::Parse {
                field: "ProofLocation",
                reason: format!("unknown discriminant: {other}"),
            }),
        }
    }
}

impl TryFrom<&str> for ProofLocation {
    type Error = cow_errors::CowError;

    /// Parse a [`ProofLocation`] from its string label.
    fn try_from(s: &str) -> Result<Self, Self::Error> {
        match s {
            "private" => Ok(Self::Private),
            "emitted" => Ok(Self::Emitted),
            "swarm" => Ok(Self::Swarm),
            "waku" => Ok(Self::Waku),
            "reserved" => Ok(Self::Reserved),
            "ipfs" => Ok(Self::Ipfs),
            other => Err(cow_errors::CowError::Parse {
                field: "ProofLocation",
                reason: format!("unknown value: {other}"),
            }),
        }
    }
}

impl From<ProofLocation> for u8 {
    /// Encode a [`ProofLocation`] as its on-chain `uint8` discriminant.
    ///
    /// This is the inverse of [`TryFrom<u8>`] for [`ProofLocation`].
    fn from(loc: ProofLocation) -> Self {
        loc as Self
    }
}

impl ProofStruct {
    /// Construct a [`ProofStruct`] with the given location and data bytes.
    ///
    /// # Arguments
    ///
    /// * `location` - Where the Merkle proof is stored or communicated.
    /// * `data` - Location-specific proof bytes (empty for private or emitted proofs).
    ///
    /// # Returns
    ///
    /// A new [`ProofStruct`] instance.
    #[must_use]
    pub const fn new(location: ProofLocation, data: Vec<u8>) -> Self {
        Self { location, data }
    }

    /// A private proof (no location data needed).
    ///
    /// # Returns
    ///
    /// A [`ProofStruct`] with [`ProofLocation::Private`] and empty data.
    #[must_use]
    pub const fn private() -> Self {
        Self { location: ProofLocation::Private, data: Vec::new() }
    }

    /// An emitted proof (no location data needed — the proof is in the tx log).
    ///
    /// # Returns
    ///
    /// A [`ProofStruct`] with [`ProofLocation::Emitted`] and empty data.
    #[must_use]
    pub const fn emitted() -> Self {
        Self { location: ProofLocation::Emitted, data: Vec::new() }
    }

    /// Override the proof location.
    ///
    /// # Returns
    ///
    /// The modified [`ProofStruct`] with the updated location (builder pattern).
    #[must_use]
    pub const fn with_location(mut self, location: ProofLocation) -> Self {
        self.location = location;
        self
    }

    /// Override the location-specific proof data bytes.
    ///
    /// # Returns
    ///
    /// The modified [`ProofStruct`] with the updated data (builder pattern).
    #[must_use]
    pub fn with_data(mut self, data: Vec<u8>) -> Self {
        self.data = data;
        self
    }

    /// Returns `true` if the proof location is [`ProofLocation::Private`].
    ///
    /// # Returns
    ///
    /// `true` if `location` is [`ProofLocation::Private`], `false` otherwise.
    #[must_use]
    pub const fn is_private(&self) -> bool {
        self.location.is_private()
    }

    /// Returns `true` if the proof location is [`ProofLocation::Emitted`].
    ///
    /// # Returns
    ///
    /// `true` if `location` is [`ProofLocation::Emitted`], `false` otherwise.
    #[must_use]
    pub const fn is_emitted(&self) -> bool {
        self.location.is_emitted()
    }

    /// Returns `true` if the proof location is [`ProofLocation::Swarm`].
    ///
    /// # Returns
    ///
    /// `true` if `location` is [`ProofLocation::Swarm`], `false` otherwise.
    #[must_use]
    pub const fn is_swarm(&self) -> bool {
        self.location.is_swarm()
    }

    /// Returns `true` if the proof location is [`ProofLocation::Waku`].
    ///
    /// # Returns
    ///
    /// `true` if `location` is [`ProofLocation::Waku`], `false` otherwise.
    #[must_use]
    pub const fn is_waku(&self) -> bool {
        self.location.is_waku()
    }

    /// Returns `true` if the proof location is [`ProofLocation::Ipfs`].
    ///
    /// # Returns
    ///
    /// `true` if `location` is [`ProofLocation::Ipfs`], `false` otherwise.
    #[must_use]
    pub const fn is_ipfs(&self) -> bool {
        self.location.is_ipfs()
    }

    /// Returns `true` if the proof location is [`ProofLocation::Reserved`].
    ///
    /// # Returns
    ///
    /// `true` if `location` is [`ProofLocation::Reserved`], `false` otherwise.
    #[must_use]
    pub const fn is_reserved(&self) -> bool {
        self.location.is_reserved()
    }

    /// Returns `true` if this proof has non-empty data bytes.
    ///
    /// [`ProofLocation::Private`] and [`ProofLocation::Emitted`] proofs carry no
    /// data; IPFS, Swarm, and Waku proofs carry location-specific bytes.
    #[must_use]
    pub const fn has_data(&self) -> bool {
        !self.data.is_empty()
    }

    /// Returns `true` if this proof has no data bytes (complement of [`has_data`](Self::has_data)).
    #[must_use]
    pub const fn is_empty(&self) -> bool {
        self.data.is_empty()
    }

    /// Returns the number of data bytes in this proof.
    #[must_use]
    pub const fn data_len(&self) -> usize {
        self.data.len()
    }
}

impl fmt::Display for ProofStruct {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "proof({})", self.location)
    }
}

// ── Tests ─────────────────────────────────────────────────────────────────────

#[cfg(test)]
mod tests {
    use super::*;

    // ── Constants ────────────────────────────────────────────────────────────

    #[test]
    fn composable_cow_address_matches() {
        assert_eq!(
            format!("{COMPOSABLE_COW_ADDRESS:#x}"),
            "0xfdafc9d1902f4e0b84f65f49f244b32b31013b74"
        );
    }

    #[test]
    fn twap_handler_address_matches() {
        assert_eq!(
            format!("{TWAP_HANDLER_ADDRESS:#x}"),
            "0x6cf1e9ca41f7611def408122793c358a3d11e5a5"
        );
    }

    #[test]
    fn current_block_timestamp_factory_address_matches() {
        assert_eq!(
            format!("{CURRENT_BLOCK_TIMESTAMP_FACTORY_ADDRESS:#x}"),
            "0x52ed56da04309aca4c3fecc595298d80c2f16bac"
        );
    }

    #[test]
    fn max_frequency_is_one_year() {
        assert_eq!(MAX_FREQUENCY, 365 * 24 * 60 * 60);
        assert_eq!(MAX_FREQUENCY, 31_536_000);
    }

    // ── ConditionalOrderParams ──────────────────────────────────────────────

    #[test]
    fn conditional_order_params_new() {
        let p = ConditionalOrderParams::new(Address::ZERO, B256::ZERO, vec![1, 2, 3]);
        assert_eq!(p.handler, Address::ZERO);
        assert_eq!(p.salt, B256::ZERO);
        assert_eq!(p.static_input, vec![1, 2, 3]);
    }

    #[test]
    fn conditional_order_params_with_handler() {
        let p = ConditionalOrderParams::new(Address::ZERO, B256::ZERO, vec![])
            .with_handler(TWAP_HANDLER_ADDRESS);
        assert_eq!(p.handler, TWAP_HANDLER_ADDRESS);
    }

    #[test]
    fn conditional_order_params_with_salt() {
        let salt = B256::repeat_byte(0xAB);
        let p = ConditionalOrderParams::new(Address::ZERO, B256::ZERO, vec![]).with_salt(salt);
        assert_eq!(p.salt, salt);
    }

    #[test]
    fn conditional_order_params_with_static_input() {
        let p = ConditionalOrderParams::new(Address::ZERO, B256::ZERO, vec![])
            .with_static_input(vec![0xDE, 0xAD]);
        assert_eq!(p.static_input, vec![0xDE, 0xAD]);
    }

    #[test]
    fn conditional_order_params_empty_static_input() {
        let empty = ConditionalOrderParams::new(Address::ZERO, B256::ZERO, vec![]);
        assert!(empty.is_empty_static_input());
        assert_eq!(empty.static_input_len(), 0);

        let non_empty = empty.with_static_input(vec![1]);
        assert!(!non_empty.is_empty_static_input());
        assert_eq!(non_empty.static_input_len(), 1);
    }

    #[test]
    fn conditional_order_params_salt_ref() {
        let salt = B256::repeat_byte(0x42);
        let p = ConditionalOrderParams::new(Address::ZERO, salt, vec![]);
        assert_eq!(p.salt_ref(), &salt);
    }

    #[test]
    fn conditional_order_params_display() {
        let p = ConditionalOrderParams::new(TWAP_HANDLER_ADDRESS, B256::ZERO, vec![]);
        let s = p.to_string();
        assert!(s.starts_with("params(handler=0x"));
    }

    // ── TwapStartTime ───────────────────────────────────────────────────────

    #[test]
    fn twap_start_time_as_str() {
        assert_eq!(TwapStartTime::AtMiningTime.as_str(), "at-mining-time");
        assert_eq!(TwapStartTime::At(100).as_str(), "at-unix");
    }

    #[test]
    fn twap_start_time_is_at_mining_time() {
        assert!(TwapStartTime::AtMiningTime.is_at_mining_time());
        assert!(!TwapStartTime::At(42).is_at_mining_time());
    }

    #[test]
    fn twap_start_time_is_fixed() {
        assert!(TwapStartTime::At(42).is_fixed());
        assert!(!TwapStartTime::AtMiningTime.is_fixed());
    }

    #[test]
    fn twap_start_time_timestamp() {
        assert_eq!(TwapStartTime::AtMiningTime.timestamp(), None);
        assert_eq!(TwapStartTime::At(1_000).timestamp(), Some(1_000));
    }

    #[test]
    fn twap_start_time_display() {
        assert_eq!(TwapStartTime::AtMiningTime.to_string(), "at-mining-time");
        assert_eq!(TwapStartTime::At(1_700_000_000).to_string(), "at-unix-1700000000");
    }

    #[test]
    fn twap_start_time_from_u32() {
        assert_eq!(TwapStartTime::from(0u32), TwapStartTime::AtMiningTime);
        assert_eq!(TwapStartTime::from(42u32), TwapStartTime::At(42));
    }

    #[test]
    fn twap_start_time_into_u32() {
        let zero: u32 = TwapStartTime::AtMiningTime.into();
        assert_eq!(zero, 0);
        let ts: u32 = TwapStartTime::At(999).into();
        assert_eq!(ts, 999);
    }

    #[test]
    fn twap_start_time_from_option_u32() {
        assert_eq!(TwapStartTime::from(None), TwapStartTime::AtMiningTime);
        assert_eq!(TwapStartTime::from(Some(123)), TwapStartTime::At(123));
    }

    // ── DurationOfPart ──────────────────────────────────────────────────────

    #[test]
    fn duration_of_part_auto_defaults() {
        let d = DurationOfPart::default();
        assert!(d.is_auto());
        assert!(!d.is_limit_duration());
        assert_eq!(d.duration(), None);
    }

    #[test]
    fn duration_of_part_limit() {
        let d = DurationOfPart::limit(1_800);
        assert!(!d.is_auto());
        assert!(d.is_limit_duration());
        assert_eq!(d.duration(), Some(1_800));
    }

    #[test]
    fn duration_of_part_display() {
        assert_eq!(DurationOfPart::Auto.to_string(), "auto");
        assert_eq!(DurationOfPart::limit(600).to_string(), "limit-duration(600s)");
    }

    #[test]
    fn duration_of_part_from_option() {
        assert_eq!(DurationOfPart::from(None), DurationOfPart::Auto);
        assert_eq!(
            DurationOfPart::from(Some(300)),
            DurationOfPart::LimitDuration { duration: 300 }
        );
    }

    // ── TwapData constructors ───────────────────────────────────────────────

    #[test]
    fn twap_data_sell_constructor() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::from(1000u64), 4, 3600);
        assert!(t.is_sell());
        assert!(!t.is_buy());
        assert_eq!(t.sell_amount, U256::from(1000u64));
        assert_eq!(t.buy_amount, U256::ZERO);
        assert_eq!(t.receiver, Address::ZERO);
        assert_eq!(t.num_parts, 4);
        assert_eq!(t.part_duration, 3600);
        assert!(t.start_time.is_at_mining_time());
        assert!(!t.partially_fillable);
        assert!(t.duration_of_part.is_auto());
        assert!(!t.has_app_data());
    }

    #[test]
    fn twap_data_buy_constructor() {
        let t = TwapData::buy(Address::ZERO, Address::ZERO, U256::from(500u64), 2, 1800);
        assert!(t.is_buy());
        assert!(!t.is_sell());
        assert_eq!(t.sell_amount, U256::MAX);
        assert_eq!(t.buy_amount, U256::from(500u64));
        assert_eq!(t.num_parts, 2);
        assert_eq!(t.part_duration, 1800);
    }

    // ── TwapData computed fields ────────────────────────────────────────────

    #[test]
    fn twap_data_total_duration_secs() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 4, 3600);
        assert_eq!(t.total_duration_secs(), 14_400);
    }

    #[test]
    fn twap_data_end_time_fixed() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 4, 3600)
            .with_start_time(TwapStartTime::At(1_000_000));
        assert_eq!(t.end_time(), Some(1_000_000 + 14_400));
    }

    #[test]
    fn twap_data_end_time_at_mining() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 4, 3600);
        assert_eq!(t.end_time(), None);
    }

    #[test]
    fn twap_data_is_expired() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 4, 3600)
            .with_start_time(TwapStartTime::At(1_000_000));
        // end = 1_014_400
        assert!(!t.is_expired(1_014_399));
        assert!(t.is_expired(1_014_400));
        assert!(t.is_expired(2_000_000));
    }

    #[test]
    fn twap_data_is_expired_at_mining_time_always_false() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 4, 3600);
        assert!(!t.is_expired(u64::MAX));
    }

    // ── TwapData builders ───────────────────────────────────────────────────

    #[test]
    fn twap_data_with_receiver() {
        let recv = Address::repeat_byte(0x01);
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 1, 1).with_receiver(recv);
        assert_eq!(t.receiver, recv);
    }

    #[test]
    fn twap_data_with_buy_amount() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 1, 1)
            .with_buy_amount(U256::from(42u64));
        assert_eq!(t.buy_amount, U256::from(42u64));
    }

    #[test]
    fn twap_data_with_sell_amount() {
        let t = TwapData::buy(Address::ZERO, Address::ZERO, U256::ZERO, 1, 1)
            .with_sell_amount(U256::from(99u64));
        assert_eq!(t.sell_amount, U256::from(99u64));
    }

    #[test]
    fn twap_data_with_start_time() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 1, 1)
            .with_start_time(TwapStartTime::At(12345));
        assert_eq!(t.start_time, TwapStartTime::At(12345));
    }

    #[test]
    fn twap_data_with_app_data() {
        let hash = B256::repeat_byte(0xAA);
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 1, 1).with_app_data(hash);
        assert!(t.has_app_data());
        assert_eq!(t.app_data, hash);
    }

    #[test]
    fn twap_data_has_app_data_zero_is_false() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 1, 1);
        assert!(!t.has_app_data());
    }

    #[test]
    fn twap_data_with_partially_fillable() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 1, 1)
            .with_partially_fillable(true);
        assert!(t.partially_fillable);
    }

    #[test]
    fn twap_data_with_duration_of_part() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::ZERO, 1, 1)
            .with_duration_of_part(DurationOfPart::limit(900));
        assert!(t.duration_of_part.is_limit_duration());
        assert_eq!(t.duration_of_part.duration(), Some(900));
    }

    // ── TwapData display ────────────────────────────────────────────────────

    #[test]
    fn twap_data_display_at_mining_time() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::from(24_000u64), 24, 3_600)
            .with_buy_amount(U256::from(1_000u64));
        let s = t.to_string();
        assert!(s.contains("24 × 3600s"), "got: {s}");
        assert!(s.contains("at-mining-time"), "got: {s}");
        assert!(s.contains("24000"), "got: {s}");
        assert!(s.contains("1000"), "got: {s}");
    }

    #[test]
    fn twap_data_display_fixed_start() {
        let t = TwapData::sell(Address::ZERO, Address::ZERO, U256::from(1_000u64), 6, 7_200)
            .with_start_time(TwapStartTime::At(1_700_000_000));
        let s = t.to_string();
        assert!(s.contains("at-unix-1700000000"), "got: {s}");
    }

    // ── TwapStruct ──────────────────────────────────────────────────────────

    fn make_twap_struct() -> TwapStruct {
        TwapStruct {
            sell_token: Address::ZERO,
            buy_token: Address::ZERO,
            receiver: Address::ZERO,
            part_sell_amount: U256::from(250u64),
            min_part_limit: U256::from(100u64),
            t0: 0,
            n: 4,
            t: 3600,
            span: 0,
            app_data: B256::ZERO,
        }
    }

    #[test]
    fn twap_struct_has_app_data() {
        let mut s = make_twap_struct();
        assert!(!s.has_app_data());
        s.app_data = B256::repeat_byte(0x01);
        assert!(s.has_app_data());
    }

    #[test]
    fn twap_struct_has_custom_receiver() {
        let mut s = make_twap_struct();
        assert!(!s.has_custom_receiver());
        s.receiver = Address::repeat_byte(0x01);
        assert!(s.has_custom_receiver());
    }

    #[test]
    fn twap_struct_start_is_fixed() {
        let mut s = make_twap_struct();
        assert!(!s.start_is_fixed());
        s.t0 = 1_000_000;
        assert!(s.start_is_fixed());
    }

    #[test]
    fn twap_struct_display() {
        let s = make_twap_struct();
        let d = s.to_string();
        assert!(d.contains("twap-struct"), "got: {d}");
        assert!(d.contains("4 × 3600s"), "got: {d}");
    }

    // ── TwapData <-> TwapStruct conversions ─────────────────────────────────

    #[test]
    fn twap_struct_try_from_twap_data() {
        let data = TwapData::sell(Address::ZERO, Address::ZERO, U256::from(1000u64), 4, 3600)
            .with_buy_amount(U256::from(400u64))
            .with_start_time(TwapStartTime::At(5000))
            .with_duration_of_part(DurationOfPart::limit(1800));
        let s = TwapStruct::try_from(&data).unwrap();
        assert_eq!(s.part_sell_amount, U256::from(250u64));
        assert_eq!(s.min_part_limit, U256::from(100u64));
        assert_eq!(s.t0, 5000);
        assert_eq!(s.n, 4);
        assert_eq!(s.t, 3600);
        assert_eq!(s.span, 1800);
    }

    #[test]
    fn twap_struct_try_from_twap_data_zero_parts_errors() {
        let mut data = TwapData::sell(Address::ZERO, Address::ZERO, U256::from(1000u64), 4, 3600);
        data.num_parts = 0;
        assert!(TwapStruct::try_from(&data).is_err());
    }

    #[test]
    fn twap_data_from_twap_struct() {
        let s = TwapStruct {
            sell_token: Address::ZERO,
            buy_token: Address::ZERO,
            receiver: Address::ZERO,
            part_sell_amount: U256::from(250u64),
            min_part_limit: U256::from(100u64),
            t0: 5000,
            n: 4,
            t: 3600,
            span: 1800,
            app_data: B256::ZERO,
        };
        let data = TwapData::from(&s);
        assert_eq!(data.sell_amount, U256::from(1000u64));
        assert_eq!(data.buy_amount, U256::from(400u64));
        assert_eq!(data.start_time, TwapStartTime::At(5000));
        assert_eq!(data.num_parts, 4);
        assert_eq!(data.part_duration, 3600);
        assert!(data.duration_of_part.is_limit_duration());
        assert_eq!(data.duration_of_part.duration(), Some(1800));
    }

    #[test]
    fn twap_data_from_twap_struct_at_mining_time() {
        let mut s = make_twap_struct();
        s.t0 = 0;
        s.span = 0;
        let data = TwapData::from(&s);
        assert!(data.start_time.is_at_mining_time());
        assert!(data.duration_of_part.is_auto());
    }

    // ── GpV2OrderStruct ─────────────────────────────────────────────────────

    fn make_gpv2_order() -> GpV2OrderStruct {
        GpV2OrderStruct {
            sell_token: Address::ZERO,
            buy_token: Address::ZERO,
            receiver: Address::ZERO,
            sell_amount: U256::from(1000u64),
            buy_amount: U256::from(500u64),
            valid_to: 1_700_000_000,
            app_data: B256::ZERO,
            fee_amount: U256::ZERO,
            kind: B256::ZERO,
            partially_fillable: false,
            sell_token_balance: B256::ZERO,
            buy_token_balance: B256::ZERO,
        }
    }

    #[test]
    fn gpv2_order_has_custom_receiver() {
        let mut o = make_gpv2_order();
        assert!(!o.has_custom_receiver());
        o.receiver = Address::repeat_byte(0x01);
        assert!(o.has_custom_receiver());
    }

    #[test]
    fn gpv2_order_is_partially_fillable() {
        let mut o = make_gpv2_order();
        assert!(!o.is_partially_fillable());
        o.partially_fillable = true;
        assert!(o.is_partially_fillable());
    }

    #[test]
    fn gpv2_order_display() {
        let o = make_gpv2_order();
        let s = o.to_string();
        assert!(s.contains("gpv2-order"), "got: {s}");
        assert!(s.contains("1000"), "got: {s}");
        assert!(s.contains("500"), "got: {s}");
    }

    // ── PollResult ──────────────────────────────────────────────────────────

    #[test]
    fn poll_result_success() {
        let r = PollResult::Success { order: None, signature: None };
        assert!(r.is_success());
        assert!(!r.is_retryable());
        assert!(!r.is_terminal());
        assert!(r.order_ref().is_none());
        assert!(r.as_error_message().is_none());
    }

    #[test]
    fn poll_result_try_next_block() {
        let r = PollResult::TryNextBlock;
        assert!(r.is_try_next_block());
        assert!(r.is_retryable());
        assert!(!r.is_success());
        assert_eq!(r.get_block_number(), None);
        assert_eq!(r.get_epoch(), None);
    }

    #[test]
    fn poll_result_try_on_block() {
        let r = PollResult::TryOnBlock { block_number: 42 };
        assert!(r.is_try_on_block());
        assert!(r.is_retryable());
        assert_eq!(r.get_block_number(), Some(42));
    }

    #[test]
    fn poll_result_try_at_epoch() {
        let r = PollResult::TryAtEpoch { epoch: 1_700_000_000 };
        assert!(r.is_try_at_epoch());
        assert!(r.is_retryable());
        assert_eq!(r.get_epoch(), Some(1_700_000_000));
    }

    #[test]
    fn poll_result_unexpected_error() {
        let r = PollResult::UnexpectedError { message: "boom".into() };
        assert!(r.is_unexpected_error());
        assert!(!r.is_retryable());
        assert_eq!(r.as_error_message(), Some("boom"));
    }

    #[test]
    fn poll_result_dont_try_again() {
        let r = PollResult::DontTryAgain { reason: "expired".into() };
        assert!(r.is_dont_try_again());
        assert!(r.is_terminal());
        assert!(!r.is_retryable());
        assert_eq!(r.as_error_message(), Some("expired"));
    }

    #[test]
    fn poll_result_display() {
        assert_eq!(PollResult::Success { order: None, signature: None }.to_string(), "success");
        assert_eq!(PollResult::TryNextBlock.to_string(), "try-next-block");
        assert_eq!(PollResult::TryOnBlock { block_number: 10 }.to_string(), "try-on-block(10)");
        assert_eq!(PollResult::TryAtEpoch { epoch: 99 }.to_string(), "try-at-epoch(99)");
        assert_eq!(
            PollResult::UnexpectedError { message: "x".into() }.to_string(),
            "unexpected-error(x)"
        );
        assert_eq!(
            PollResult::DontTryAgain { reason: "y".into() }.to_string(),
            "dont-try-again(y)"
        );
    }

    // ── ProofLocation ───────────────────────────────────────────────────────

    #[test]
    fn proof_location_as_str() {
        assert_eq!(ProofLocation::Private.as_str(), "private");
        assert_eq!(ProofLocation::Emitted.as_str(), "emitted");
        assert_eq!(ProofLocation::Swarm.as_str(), "swarm");
        assert_eq!(ProofLocation::Waku.as_str(), "waku");
        assert_eq!(ProofLocation::Reserved.as_str(), "reserved");
        assert_eq!(ProofLocation::Ipfs.as_str(), "ipfs");
    }

    #[test]
    fn proof_location_predicates() {
        assert!(ProofLocation::Private.is_private());
        assert!(ProofLocation::Emitted.is_emitted());
        assert!(ProofLocation::Swarm.is_swarm());
        assert!(ProofLocation::Waku.is_waku());
        assert!(ProofLocation::Reserved.is_reserved());
        assert!(ProofLocation::Ipfs.is_ipfs());
        // Negative checks
        assert!(!ProofLocation::Private.is_emitted());
        assert!(!ProofLocation::Ipfs.is_private());
    }

    #[test]
    fn proof_location_default_is_private() {
        assert_eq!(ProofLocation::default(), ProofLocation::Private);
    }

    #[test]
    fn proof_location_display() {
        assert_eq!(ProofLocation::Ipfs.to_string(), "ipfs");
        assert_eq!(ProofLocation::Waku.to_string(), "waku");
    }

    #[test]
    fn proof_location_try_from_u8() {
        assert_eq!(ProofLocation::try_from(0u8).unwrap(), ProofLocation::Private);
        assert_eq!(ProofLocation::try_from(1u8).unwrap(), ProofLocation::Emitted);
        assert_eq!(ProofLocation::try_from(5u8).unwrap(), ProofLocation::Ipfs);
        assert!(ProofLocation::try_from(6u8).is_err());
        assert!(ProofLocation::try_from(255u8).is_err());
    }

    #[test]
    fn proof_location_try_from_str() {
        assert_eq!(ProofLocation::try_from("private").unwrap(), ProofLocation::Private);
        assert_eq!(ProofLocation::try_from("ipfs").unwrap(), ProofLocation::Ipfs);
        assert!(ProofLocation::try_from("unknown").is_err());
    }

    #[test]
    fn proof_location_into_u8() {
        let v: u8 = ProofLocation::Private.into();
        assert_eq!(v, 0);
        let v: u8 = ProofLocation::Ipfs.into();
        assert_eq!(v, 5);
    }

    // ── ProofStruct ─────────────────────────────────────────────────────────

    #[test]
    fn proof_struct_new() {
        let p = ProofStruct::new(ProofLocation::Swarm, vec![1, 2, 3]);
        assert!(p.is_swarm());
        assert!(p.has_data());
        assert_eq!(p.data_len(), 3);
    }

    #[test]
    fn proof_struct_private() {
        let p = ProofStruct::private();
        assert!(p.is_private());
        assert!(p.is_empty());
        assert!(!p.has_data());
        assert_eq!(p.data_len(), 0);
    }

    #[test]
    fn proof_struct_emitted() {
        let p = ProofStruct::emitted();
        assert!(p.is_emitted());
        assert!(p.is_empty());
    }

    #[test]
    fn proof_struct_with_location() {
        let p = ProofStruct::private().with_location(ProofLocation::Ipfs);
        assert!(p.is_ipfs());
    }

    #[test]
    fn proof_struct_with_data() {
        let p = ProofStruct::private().with_data(vec![0xCA, 0xFE]);
        assert!(p.has_data());
        assert_eq!(p.data_len(), 2);
    }

    #[test]
    fn proof_struct_delegated_predicates() {
        assert!(ProofStruct::new(ProofLocation::Waku, vec![]).is_waku());
        assert!(ProofStruct::new(ProofLocation::Reserved, vec![]).is_reserved());
    }

    #[test]
    fn proof_struct_display() {
        let p = ProofStruct::private();
        assert_eq!(p.to_string(), "proof(private)");
        let p = ProofStruct::new(ProofLocation::Ipfs, vec![1]);
        assert_eq!(p.to_string(), "proof(ipfs)");
    }

    // ── ProofLocation try_from exhaustive ────────────────────────────────

    #[test]
    fn proof_location_try_from_str_all() {
        for (s, expected) in [
            ("emitted", ProofLocation::Emitted),
            ("swarm", ProofLocation::Swarm),
            ("waku", ProofLocation::Waku),
            ("reserved", ProofLocation::Reserved),
        ] {
            assert_eq!(ProofLocation::try_from(s).unwrap(), expected);
        }
    }

    #[test]
    fn proof_location_try_from_u8_all() {
        assert_eq!(ProofLocation::try_from(2u8).unwrap(), ProofLocation::Swarm);
        assert_eq!(ProofLocation::try_from(3u8).unwrap(), ProofLocation::Waku);
        assert_eq!(ProofLocation::try_from(4u8).unwrap(), ProofLocation::Reserved);
    }

    // ── TwapData serde roundtrip ────────────────────────────────────────

    #[test]
    fn twap_data_serde_roundtrip() {
        let data = TwapData::sell(
            Address::repeat_byte(0x11),
            Address::repeat_byte(0x22),
            U256::from(1000u64),
            4,
            3600,
        )
        .with_buy_amount(U256::from(800u64))
        .with_start_time(TwapStartTime::At(1_000_000))
        .with_duration_of_part(DurationOfPart::limit(900));

        let json = serde_json::to_string(&data).unwrap();
        let back: TwapData = serde_json::from_str(&json).unwrap();
        assert_eq!(back.sell_amount, data.sell_amount);
        assert_eq!(back.buy_amount, data.buy_amount);
        assert_eq!(back.num_parts, data.num_parts);
        assert_eq!(back.part_duration, data.part_duration);
    }

    // ── ConditionalOrderParams serde roundtrip ──────────────────────────

    #[test]
    fn conditional_order_params_serde_roundtrip() {
        let params = ConditionalOrderParams::new(
            TWAP_HANDLER_ADDRESS,
            B256::repeat_byte(0xAB),
            vec![0xDE, 0xAD, 0xBE, 0xEF],
        );
        let json = serde_json::to_string(&params).unwrap();
        let back: ConditionalOrderParams = serde_json::from_str(&json).unwrap();
        assert_eq!(back.handler, params.handler);
        assert_eq!(back.salt, params.salt);
        assert_eq!(back.static_input, params.static_input);
    }

    // ── BlockInfo ───────────────────────────────────────────────────────

    #[test]
    fn block_info_new() {
        let b = BlockInfo { block_number: 100, block_timestamp: 1_700_000_000 };
        assert_eq!(b.block_number, 100);
        assert_eq!(b.block_timestamp, 1_700_000_000);
    }

    // ── GpV2OrderStruct try_from coverage ────────────────────────────────

    #[test]
    fn gpv2_order_try_from_bad_kind_fails() {
        let o = make_gpv2_order();
        // kind is B256::ZERO which is neither sell nor buy hash
        let result = cow_signing::types::UnsignedOrder::try_from(&o);
        assert!(result.is_err());
    }
}

// ── ProofStruct ───────────────────────────────────────────────────────────────

/// On-chain `Proof` argument passed to `ComposableCow::setRoot`.
///
/// Bundles the proof location discriminant with location-specific data
/// (e.g. an IPFS CID, Swarm hash, or Waku message).  Pass `data: vec![]` for
/// [`ProofLocation::Private`] or [`ProofLocation::Emitted`].
#[derive(Debug, Clone)]
pub struct ProofStruct {
    /// Where the Merkle proof is stored/communicated.
    pub location: ProofLocation,
    /// Location-specific proof bytes (empty for private or emitted proofs).
    pub data: Vec<u8>,
}

// ── Block info ──────────────────────────────────────────────────────────────

/// Block information used for conditional order validation.
///
/// Mirrors `BlockInfo` from the `TypeScript` SDK.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct BlockInfo {
    /// Block number.
    pub block_number: u64,
    /// Block timestamp (Unix seconds).
    pub block_timestamp: u64,
}

impl BlockInfo {
    /// Construct a new [`BlockInfo`].
    ///
    /// # Arguments
    ///
    /// * `block_number` - The block number.
    /// * `block_timestamp` - The block timestamp in Unix seconds.
    ///
    /// # Returns
    ///
    /// A new [`BlockInfo`] instance.
    #[must_use]
    pub const fn new(block_number: u64, block_timestamp: u64) -> Self {
        Self { block_number, block_timestamp }
    }
}

impl fmt::Display for BlockInfo {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "block(#{}, ts={})", self.block_number, self.block_timestamp)
    }
}

// ── IsValidResult ───────────────────────────────────────────────────────────

/// Result of validating a conditional order.
///
/// Mirrors the `IsValidResult` union type from the `TypeScript` SDK.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum IsValidResult {
    /// The order is valid.
    Valid,
    /// The order is invalid, with a reason.
    Invalid {
        /// Human-readable reason why the order is invalid.
        reason: String,
    },
}

/// Type alias for the valid variant, mirroring the `TypeScript` SDK's `IsValid` interface.
pub type IsValid = ();

/// Type alias for the invalid variant, mirroring the `TypeScript` SDK's `IsNotValid` interface.
pub type IsNotValid = String;

impl IsValidResult {
    /// Returns `true` if the result represents a valid order.
    ///
    /// # Returns
    ///
    /// `true` for the [`Valid`](Self::Valid) variant, `false` for [`Invalid`](Self::Invalid).
    #[must_use]
    pub const fn is_valid(&self) -> bool {
        matches!(self, Self::Valid)
    }

    /// Returns the reason string if the result represents an invalid order.
    ///
    /// # Returns
    ///
    /// `Some(reason)` for the [`Invalid`](Self::Invalid) variant, `None` for
    /// [`Valid`](Self::Valid).
    #[must_use]
    pub fn reason(&self) -> Option<&str> {
        match self {
            Self::Valid => None,
            Self::Invalid { reason } => Some(reason),
        }
    }

    /// Create a valid result.
    ///
    /// # Returns
    ///
    /// An [`IsValidResult::Valid`] instance.
    #[must_use]
    pub const fn valid() -> Self {
        Self::Valid
    }

    /// Create an invalid result with the given reason.
    ///
    /// # Arguments
    ///
    /// * `reason` - A human-readable explanation of why the order is invalid.
    ///
    /// # Returns
    ///
    /// An [`IsValidResult::Invalid`] instance containing the reason.
    #[must_use]
    pub fn invalid(reason: impl Into<String>) -> Self {
        Self::Invalid { reason: reason.into() }
    }
}

impl fmt::Display for IsValidResult {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Valid => f.write_str("valid"),
            Self::Invalid { reason } => write!(f, "invalid: {reason}"),
        }
    }
}

// ── Test helpers ────────────────────────────────────────────────────────────

/// Default parameters for a test conditional order.
///
/// Mirrors `DEFAULT_ORDER_PARAMS` from the `TypeScript` SDK test helper.
pub const DEFAULT_TEST_HANDLER: &str = "0x910d00a310f7Dc5B29FE73458F47f519be547D3d";

/// Default salt for test conditional orders.
pub const DEFAULT_TEST_SALT: &str =
    "0x9379a0bf532ff9a66ffde940f94b1a025d6f18803054c1aef52dc94b15255bbe";

/// Parameters for creating a test conditional order.
///
/// Mirrors `TestConditionalOrderParams` from the `TypeScript` SDK.
#[derive(Debug, Clone)]
pub struct TestConditionalOrderParams {
    /// Handler contract address.
    pub handler: Address,
    /// 32-byte salt.
    pub salt: B256,
    /// Static input data.
    pub static_input: Vec<u8>,
    /// Whether this is a single order (true) or part of a Merkle tree (false).
    pub is_single_order: bool,
}

impl Default for TestConditionalOrderParams {
    fn default() -> Self {
        Self {
            handler: DEFAULT_TEST_HANDLER.parse().map_or(Address::ZERO, |a| a),
            salt: DEFAULT_TEST_SALT.parse().map_or(B256::ZERO, |s| s),
            static_input: Vec::new(),
            is_single_order: true,
        }
    }
}

/// Create a test [`ConditionalOrderParams`] with optional overrides.
///
/// Mirrors `createTestConditionalOrder` from the `TypeScript` SDK.
/// Useful in tests to quickly construct valid conditional order params.
///
/// # Example
///
/// ```rust
/// use cow_composable::create_test_conditional_order;
///
/// let params = create_test_conditional_order(None);
/// assert!(!params.handler.is_zero());
/// ```
#[must_use]
pub fn create_test_conditional_order(
    overrides: Option<TestConditionalOrderParams>,
) -> ConditionalOrderParams {
    let test = overrides.unwrap_or_default();
    ConditionalOrderParams {
        handler: test.handler,
        salt: test.salt,
        static_input: test.static_input,
    }
}

#[cfg(test)]
#[allow(clippy::tests_outside_test_module, reason = "inner module pattern")]
mod post_definition_tests {
    use super::*;

    // ── BlockInfo ───────────────────────────────────────────────────────

    #[test]
    fn block_info_constructor_sets_fields() {
        let b = BlockInfo::new(42, 1_700_000_000);
        assert_eq!(b.block_number, 42);
        assert_eq!(b.block_timestamp, 1_700_000_000);
    }

    #[test]
    fn block_info_display_contains_number_and_timestamp() {
        let b = BlockInfo::new(123, 456);
        let rendered = format!("{b}");
        assert!(rendered.contains("#123"));
        assert!(rendered.contains("456"));
    }

    // ── IsValidResult ───────────────────────────────────────────────────

    #[test]
    fn is_valid_result_constructors_and_predicates() {
        let ok = IsValidResult::valid();
        assert!(ok.is_valid());
        assert_eq!(ok.reason(), None);

        let bad = IsValidResult::invalid("price too low");
        assert!(!bad.is_valid());
        assert_eq!(bad.reason(), Some("price too low"));
    }

    #[test]
    fn is_valid_result_display_renders_both_variants() {
        assert_eq!(format!("{}", IsValidResult::valid()), "valid");
        let rendered = format!("{}", IsValidResult::invalid("bad strike"));
        assert!(rendered.starts_with("invalid"));
        assert!(rendered.contains("bad strike"));
    }

    // ── TestConditionalOrderParams / create_test_conditional_order ─────

    #[test]
    fn test_conditional_order_params_default_resolves_constants() {
        let defaults = TestConditionalOrderParams::default();
        // The default handler must parse to a non-zero address, and the salt
        // must parse to a non-zero B256 — guarding against a regression
        // where the fallback branches kick in silently.
        assert_ne!(defaults.handler, Address::ZERO);
        assert_ne!(defaults.salt, B256::ZERO);
        assert!(defaults.static_input.is_empty());
        assert!(defaults.is_single_order);
    }

    #[test]
    fn create_test_conditional_order_uses_defaults_when_none() {
        let params = create_test_conditional_order(None);
        let defaults = TestConditionalOrderParams::default();
        assert_eq!(params.handler, defaults.handler);
        assert_eq!(params.salt, defaults.salt);
        assert_eq!(params.static_input, defaults.static_input);
    }

    #[test]
    fn create_test_conditional_order_accepts_overrides() {
        let overrides = TestConditionalOrderParams {
            handler: Address::repeat_byte(0xAB),
            salt: B256::repeat_byte(0xCD),
            static_input: vec![1, 2, 3, 4],
            is_single_order: false,
        };
        let params = create_test_conditional_order(Some(overrides.clone()));
        assert_eq!(params.handler, overrides.handler);
        assert_eq!(params.salt, overrides.salt);
        assert_eq!(params.static_input, overrides.static_input);
    }
}