breez_sdk_spark/token_conversion/

models.rs

use std::fmt;
use std::str::FromStr;

use flashnet::{BTC_ASSET_ADDRESS, Pool};
use serde::{Deserialize, Serialize};

use crate::SdkError;

use crate::utils::serde_helpers::{serde_option_u128_as_string, serde_u128_as_string};

/// Default maximum slippage for conversions in basis points (0.1%)
pub const DEFAULT_CONVERSION_MAX_SLIPPAGE_BPS: u32 = 10;
/// Default timeout for conversion operations in seconds
pub const DEFAULT_CONVERSION_TIMEOUT_SECS: u32 = 30;
/// Default integrator pubkey used when executing conversions
pub const DEFAULT_INTEGRATOR_PUBKEY: &str =
    "037e26d9d62e0b3df2d3e66805f61de2a33914465297abf76817296a92ac3f2379";
/// Default integrator fee BPS used when simulating/executing conversions
pub const DEFAULT_INTEGRATOR_FEE_BPS: u32 = 5;

/// Fee attribution for a conversion, indicating which side of the conversion
/// (sent or received) the pool fee is denominated in. The two variants are
/// mutually exclusive — a pool fee is always denominated in one asset.
pub(crate) enum FeeSplit {
    /// Fee is on the sent (outbound/`asset_in`) payment, denominated in `asset_in`.
    Sent(u128),
    /// Fee is on the received (inbound/`asset_out`) payment, denominated in `asset_out`.
    Received(u128),
}

/// Response from estimating a conversion, used when preparing a payment that requires conversion
#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
#[derive(Debug, Clone, Serialize)]
pub struct ConversionEstimate {
    /// The conversion options used for the estimate
    pub options: ConversionOptions,
    /// The input amount for the conversion.
    /// For `FromBitcoin`: the satoshis required to produce the desired token output.
    /// For `ToBitcoin`: the token amount being converted.
    pub amount_in: u128,
    /// The estimated output amount from the conversion.
    /// For `FromBitcoin`: the estimated token amount received.
    /// For `ToBitcoin`: the estimated satoshis received.
    pub amount_out: u128,
    /// The fee estimated for the conversion.
    /// Denominated in satoshis if converting from Bitcoin, otherwise in the token base units.
    pub fee: u128,
    /// The reason the conversion amount was adjusted, if applicable.
    pub amount_adjustment: Option<AmountAdjustmentReason>,
}

/// The purpose of the conversion, which is used to provide context for the conversion
/// if its related to an ongoing payment or a self-transfer.
#[cfg_attr(feature = "uniffi", derive(uniffi::Enum))]
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub enum ConversionPurpose {
    /// Conversion is associated with an ongoing payment
    OngoingPayment {
        /// The payment request of the ongoing payment
        payment_request: String,
    },
    /// Conversion is for self-transfer
    SelfTransfer,
    /// Conversion triggered automatically
    AutoConversion,
}

/// Specifies how to determine the conversion amount.
#[derive(Debug, Clone)]
pub(crate) enum ConversionAmount {
    /// Specify the minimum output amount - the input will be calculated.
    /// Used for payment conversions where we know the required output.
    MinAmountOut(u128),
    /// Specify the exact input amount - used for auto-conversion where we know the sats balance.
    AmountIn(u128),
}

/// How an executed swap departed from the terms the client signed.
///
/// The input is spent either way, so the conversion completes rather than being
/// refunded. This records that it did not deliver what was signed for.
#[cfg_attr(feature = "uniffi", derive(uniffi::Enum))]
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
pub enum SwapDegradation {
    /// Delivered less than the minimum the intent signed.
    BelowMinimum,
    /// Delivered an asset other than the one the intent named.
    UnexpectedAsset,
    /// Accepted without naming the amount, the asset, or the transfer carrying
    /// it.
    MissingInfo,
}

impl From<flashnet::SwapDegradation> for SwapDegradation {
    fn from(d: flashnet::SwapDegradation) -> Self {
        match d {
            flashnet::SwapDegradation::BelowMinimum => Self::BelowMinimum,
            flashnet::SwapDegradation::UnexpectedAsset => Self::UnexpectedAsset,
            flashnet::SwapDegradation::MissingInfo => Self::MissingInfo,
        }
    }
}

/// The reason why a conversion amount was adjusted from the originally requested value.
#[cfg_attr(feature = "uniffi", derive(uniffi::Enum))]
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub enum AmountAdjustmentReason {
    /// The amount was increased to meet the minimum conversion limit.
    FlooredToMinLimit,
    /// The amount was increased to convert the full token balance,
    /// avoiding a remaining balance below the minimum conversion limit (token dust).
    IncreasedToAvoidDust,
}

/// The status of the conversion
#[cfg_attr(feature = "uniffi", derive(uniffi::Enum))]
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub enum ConversionStatus {
    /// Conversion is in-flight (queued or started, not yet completed)
    Pending,
    /// The conversion was successful
    Completed,
    /// The conversion failed (e.g., the initial send payment failed)
    Failed,
    /// The conversion failed and no refund was made yet, which requires action by the SDK to
    /// perform the refund. This can happen if there was a failure during the conversion process.
    RefundNeeded,
    /// The conversion failed and a refund was made
    Refunded,
}

impl fmt::Display for ConversionStatus {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ConversionStatus::Pending => write!(f, "pending"),
            ConversionStatus::Completed => write!(f, "completed"),
            ConversionStatus::Failed => write!(f, "failed"),
            ConversionStatus::RefundNeeded => write!(f, "refund_needed"),
            ConversionStatus::Refunded => write!(f, "refunded"),
        }
    }
}

impl FromStr for ConversionStatus {
    type Err = String;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "pending" => Ok(ConversionStatus::Pending),
            "completed" => Ok(ConversionStatus::Completed),
            "failed" => Ok(ConversionStatus::Failed),
            "refund_needed" => Ok(ConversionStatus::RefundNeeded),
            "refunded" => Ok(ConversionStatus::Refunded),
            _ => Err(format!("Invalid conversion status '{s}'")),
        }
    }
}

/// Details of the asset conversion attached to a payment, when the payment
/// involves a swap or cross-chain bridge in addition to the on-Spark transfer.
///
/// The variant identifies which provider handled the conversion:
/// - [`ConversionInfo::Amm`] for Spark token swaps via Flashnet AMM pools.
/// - [`ConversionInfo::Orchestra`] for cross-chain transfers via Flashnet
///   Orchestra, in either direction (Spark → external chain, or external
///   chain → Spark).
/// - [`ConversionInfo::Boltz`] for sats → stable-coin reverse swaps via Boltz.
#[cfg_attr(feature = "uniffi", derive(uniffi::Enum))]
#[derive(Clone, Serialize, Deserialize, PartialEq)]
#[serde(tag = "type")]
pub enum ConversionInfo {
    /// AMM (Flashnet pool-based) conversion — Spark ↔ Spark token swaps.
    #[serde(rename = "amm")]
    Amm {
        /// The pool id associated with the conversion
        pool_id: String,
        /// The conversion id shared by both sides of the conversion
        conversion_id: String,
        /// The status of the conversion
        status: ConversionStatus,
        /// The fee paid for the conversion.
        /// Denominated in satoshis if converting from Bitcoin, otherwise in the token base units.
        #[serde(default, with = "serde_option_u128_as_string")]
        fee: Option<u128>,
        /// The purpose of the conversion
        purpose: Option<ConversionPurpose>,
        /// The reason the conversion amount was adjusted, if applicable.
        #[serde(default)]
        amount_adjustment: Option<AmountAdjustmentReason>,
        /// How the swap departed from the signed terms, if it did. Set on a
        /// conversion that completed without delivering what was signed for.
        #[serde(default)]
        degradation: Option<SwapDegradation>,
    },
    /// Orchestra cross-chain conversion via the Flashnet orchestration API,
    /// in either direction.
    ///
    /// `chain`, `asset`, `asset_decimals` and `asset_contract` always describe
    /// the external (non-Spark) side: the destination on a send, the source on
    /// a receive. Amounts follow the direction of the transfer, so read each
    /// amount field's own denomination.
    #[serde(rename = "orchestra")]
    Orchestra {
        /// The Orchestra order id returned by `/v1/orchestration/submit`.
        order_id: String,
        /// The Orchestra quote id used to create this order.
        quote_id: String,
        /// Opaque token required for querying order status.
        #[serde(default)]
        read_token: Option<String>,

        /// Chain name (e.g. `"base"`, `"solana"`, `"tron"`).
        chain: String,
        /// Stable chain identifier (e.g. EVM `chainId` decimal string `"8453"`
        /// for Base, SLIP-44 or similar for other chains). `None` if the
        /// provider doesn't expose one for this route.
        #[serde(default)]
        chain_id: Option<String>,
        /// Asset ticker (e.g. `"USDC"`, `"USDT"`).
        #[serde(default)]
        asset: String,
        /// The target-chain address on a send, the receiving Spark address
        /// on a receive.
        recipient_address: String,
        /// Amount paid in, in `asset` base units. On a send it is the Spark
        /// amount expressed in `asset` via the rate the SDK used at prepare
        /// time. On a receive it is the deposit the sender made on `chain`.
        #[serde(default, with = "serde_option_u128_as_string")]
        asset_amount_in: Option<u128>,
        /// Estimated amount delivered to the receiving end, frozen at prepare
        /// time. In `asset` base units on a send, and in Spark-side units on
        /// a receive (sats for Bitcoin, token base units for a token).
        #[serde(with = "serde_u128_as_string")]
        estimated_out: u128,
        /// Actual delivered amount, in the same units as `estimated_out`.
        /// Unset until the order reaches a terminal state.
        #[serde(default, with = "serde_option_u128_as_string")]
        delivered_amount: Option<u128>,
        /// Transaction on `chain`, the non-Spark side of the conversion: the
        /// delivery on a send, the funding deposit on a receive. Format follows
        /// the chain (e.g. `0x`-prefixed hex on EVM, a base58 signature on
        /// Solana). Unset until that transaction exists, and on orders that
        /// failed or were refunded.
        #[serde(default)]
        external_tx_hash: Option<String>,
        status: ConversionStatus,
        /// Best-available total fee, in `asset` base units.
        /// Prepare-time estimate while pending, realized fee when Completed.
        #[serde(default, with = "serde_option_u128_as_string")]
        fee_amount: Option<u128>,
        /// Orchestra service fee.
        #[serde(
            default,
            alias = "fee",
            rename = "service_fee_amount",
            with = "serde_option_u128_as_string"
        )]
        service_fee_amount: Option<u128>,
        /// Asset the service fee is denominated in. Unset means BTC sats.
        #[serde(default)]
        service_fee_asset: Option<String>,
        /// Decimals of `service_fee_asset`, for formatting `service_fee_amount`.
        /// Unset when the fee is in sats or the provider did not report them.
        #[serde(default)]
        service_fee_asset_decimals: Option<u32>,
        /// Asset decimals (e.g. 6 for USDC).
        asset_decimals: u32,
        /// Token contract / mint address on `chain`. Unset when that side is
        /// the chain's native asset.
        #[serde(default)]
        asset_contract: Option<String>,
    },
    /// Boltz reverse swap: cross-chain conversion via Lightning hold invoice.
    ///
    /// The swap's secrets and lifecycle state live on the synced Boltz swap row
    /// keyed by `swap_id`, which also drives cross-instance recovery.
    #[serde(rename = "boltz")]
    Boltz {
        /// The Boltz swap id returned by `POST /swap/reverse`.
        swap_id: String,
        /// The BOLT11 hold invoice paid on the Spark/Lightning side.
        invoice: String,
        /// Amount of the hold invoice in sats.
        invoice_amount_sats: u64,
        /// Cross-chain bridge tracking handle for bridged swaps: a `LayerZero`
        /// message GUID for OFT (USDT0) routes, or a CCTP reference for USDC
        /// routes. `None` for same-chain (Arbitrum-direct) delivery.
        #[serde(default, alias = "lz_guid")]
        bridge_ref: Option<String>,
        /// DEX slippage tolerance (basis points) committed at prepare time.
        max_slippage_bps: u32,
        /// Whether the claim-time DEX quote drifted beyond `max_slippage_bps`.
        #[serde(default)]
        quote_degraded: bool,

        /// Chain name (e.g. `"arbitrum"`, `"solana"`, `"tron"`).
        chain: String,
        /// Stable chain identifier (e.g. EVM `chainId` decimal string `"42161"`
        /// for Arbitrum). `None` if the provider doesn't expose one for this
        /// route.
        #[serde(default)]
        chain_id: Option<String>,
        /// Asset ticker (e.g. `"USDT"`, `"USDT0"`).
        #[serde(default)]
        asset: String,
        /// Recipient address on the target chain.
        recipient_address: String,
        /// Estimated amount in the asset's base units, frozen at prepare time.
        #[serde(with = "serde_u128_as_string")]
        estimated_out: u128,
        /// Actual amount delivered. `None` until the claim receipt is processed.
        #[serde(default, with = "serde_option_u128_as_string")]
        delivered_amount: Option<u128>,
        /// Current status of the reverse swap.
        status: ConversionStatus,
        /// Amount in expressed in the cross-chain asset's base units, via the
        /// BTC/USD rate the SDK used at prepare time.
        #[serde(default, with = "serde_option_u128_as_string")]
        asset_amount_in: Option<u128>,
        /// Best-available total fee in destination asset base units.
        /// Prepare-time estimate while pending, realized fee on Completed.
        #[serde(default, with = "serde_option_u128_as_string")]
        fee_amount: Option<u128>,
        /// Boltz spread in sats.
        #[serde(
            default,
            alias = "fee",
            rename = "service_fee_amount",
            with = "serde_option_u128_as_string"
        )]
        service_fee_amount: Option<u128>,
        /// Asset service fee is denominated in. Unset means BTC sats.
        #[serde(default)]
        service_fee_asset: Option<String>,
        /// Asset decimals (e.g. 6 for USDT).
        asset_decimals: u32,
        /// Token contract / mint address on `chain`. Unset when that side is
        /// the chain's native asset.
        #[serde(default)]
        asset_contract: Option<String>,
    },
}

impl fmt::Debug for ConversionInfo {
    #[allow(clippy::too_many_lines)]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ConversionInfo::Amm {
                pool_id,
                conversion_id,
                status,
                fee,
                purpose,
                amount_adjustment,
                degradation,
            } => f
                .debug_struct("Amm")
                .field("pool_id", pool_id)
                .field("conversion_id", conversion_id)
                .field("status", status)
                .field("fee", fee)
                .field("purpose", purpose)
                .field("amount_adjustment", amount_adjustment)
                .field("degradation", degradation)
                .finish(),
            ConversionInfo::Orchestra {
                order_id,
                quote_id,
                read_token,
                chain,
                chain_id,
                asset,
                recipient_address,
                asset_amount_in,
                estimated_out,
                delivered_amount,
                external_tx_hash,
                status,
                fee_amount,
                service_fee_amount,
                service_fee_asset,
                service_fee_asset_decimals,
                asset_decimals,
                asset_contract,
            } => f
                .debug_struct("Orchestra")
                .field("order_id", order_id)
                .field("quote_id", quote_id)
                .field("read_token", &read_token.as_ref().map(|_| "<redacted>"))
                .field("chain", chain)
                .field("chain_id", chain_id)
                .field("asset", asset)
                .field("recipient_address", recipient_address)
                .field("asset_amount_in", asset_amount_in)
                .field("estimated_out", estimated_out)
                .field("delivered_amount", delivered_amount)
                .field("external_tx_hash", external_tx_hash)
                .field("status", status)
                .field("fee_amount", fee_amount)
                .field("service_fee_amount", service_fee_amount)
                .field("service_fee_asset", service_fee_asset)
                .field("service_fee_asset_decimals", service_fee_asset_decimals)
                .field("asset_decimals", asset_decimals)
                .field("asset_contract", asset_contract)
                .finish(),
            ConversionInfo::Boltz {
                swap_id,
                invoice,
                invoice_amount_sats,
                bridge_ref,
                max_slippage_bps,
                quote_degraded,
                chain,
                chain_id,
                asset,
                recipient_address,
                estimated_out,
                delivered_amount,
                status,
                asset_amount_in,
                fee_amount,
                service_fee_amount,
                service_fee_asset,
                asset_decimals,
                asset_contract,
            } => f
                .debug_struct("Boltz")
                .field("swap_id", swap_id)
                .field("invoice", invoice)
                .field("invoice_amount_sats", invoice_amount_sats)
                .field("bridge_ref", bridge_ref)
                .field("max_slippage_bps", max_slippage_bps)
                .field("quote_degraded", quote_degraded)
                .field("chain", chain)
                .field("chain_id", chain_id)
                .field("asset", asset)
                .field("recipient_address", recipient_address)
                .field("estimated_out", estimated_out)
                .field("delivered_amount", delivered_amount)
                .field("status", status)
                .field("asset_amount_in", asset_amount_in)
                .field("fee_amount", fee_amount)
                .field("service_fee_amount", service_fee_amount)
                .field("service_fee_asset", service_fee_asset)
                .field("asset_decimals", asset_decimals)
                .field("asset_contract", asset_contract)
                .finish(),
        }
    }
}

impl ConversionInfo {
    /// The current status, regardless of conversion type.
    pub fn status(&self) -> &ConversionStatus {
        match self {
            ConversionInfo::Amm { status, .. }
            | ConversionInfo::Orchestra { status, .. }
            | ConversionInfo::Boltz { status, .. } => status,
        }
    }

    /// A mutable reference to the status, for in-place updates.
    pub fn status_mut(&mut self) -> &mut ConversionStatus {
        match self {
            ConversionInfo::Amm { status, .. }
            | ConversionInfo::Orchestra { status, .. }
            | ConversionInfo::Boltz { status, .. } => status,
        }
    }

    /// Headline fee: AMM pool fee in source units, or the cross-chain total
    /// in destination-asset base units.
    pub fn fee(&self) -> Option<u128> {
        match self {
            ConversionInfo::Amm { fee, .. } => *fee,
            ConversionInfo::Orchestra { fee_amount, .. }
            | ConversionInfo::Boltz { fee_amount, .. } => *fee_amount,
        }
    }

    /// Whether this is an AMM (Flashnet pool) conversion.
    pub fn is_amm(&self) -> bool {
        matches!(self, ConversionInfo::Amm { .. })
    }

    /// Whether this is an Orchestra (cross-chain) conversion.
    pub fn is_orchestra(&self) -> bool {
        matches!(self, ConversionInfo::Orchestra { .. })
    }

    /// Whether this is a Boltz reverse swap.
    pub fn is_boltz(&self) -> bool {
        matches!(self, ConversionInfo::Boltz { .. })
    }
}

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

    #[test]
    fn every_degradation_keeps_its_meaning_across_the_boundary() {
        // A hand-written mapping: swapping two arms would silently relabel a
        // short delivery as a malformed response, which reads as a server bug
        // rather than a shortfall.
        for (from, want) in [
            (
                flashnet::SwapDegradation::BelowMinimum,
                SwapDegradation::BelowMinimum,
            ),
            (
                flashnet::SwapDegradation::UnexpectedAsset,
                SwapDegradation::UnexpectedAsset,
            ),
            (
                flashnet::SwapDegradation::MissingInfo,
                SwapDegradation::MissingInfo,
            ),
        ] {
            assert_eq!(SwapDegradation::from(from), want, "{from:?} was relabelled");
        }
    }

    #[test]
    fn boltz_conversion_info_roundtrip() {
        let original = ConversionInfo::Boltz {
            swap_id: "boltz_swap_abc".to_string(),
            chain: "solana".to_string(),
            chain_id: None,
            asset: "USDT0".to_string(),
            recipient_address: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v".to_string(),
            invoice: "lnbc1000n1pexample".to_string(),
            invoice_amount_sats: 150_000,
            asset_amount_in: Some(100_500_000),
            estimated_out: 99_000_000,
            delivered_amount: Some(98_750_000),
            bridge_ref: Some("0xdeadbeef".to_string()),
            status: ConversionStatus::Pending,
            fee_amount: Some(1_500_000),
            service_fee_amount: Some(2_500),
            service_fee_asset: None,
            max_slippage_bps: 100,
            quote_degraded: false,
            asset_decimals: 6,
            asset_contract: Some("0xdAC17F958D2ee523a2206206994597C13D831ec7".to_string()),
        };

        let json = serde_json::to_string(&original).unwrap();
        let decoded: ConversionInfo = serde_json::from_str(&json).unwrap();
        assert_eq!(decoded, original);
        assert!(decoded.is_boltz());
        assert!(!decoded.is_orchestra());
        assert!(!decoded.is_amm());
        assert_eq!(decoded.status(), &ConversionStatus::Pending);
        assert_eq!(decoded.fee(), Some(1_500_000));

        // The `"type"` tag discriminator must match the rename attribute.
        assert!(json.contains(r#""type":"boltz""#));
        // u128 fields serialize as strings, not JSON numbers.
        assert!(json.contains(r#""estimated_out":"99000000""#));
    }

    /// Pre-rename rows persisted in the wild only carried a `fee` key (the
    /// provider service fee), and lacked `asset_amount_in`, `fee_amount`,
    /// `service_fee_amount`, `service_fee_asset`. Reading such a row must:
    /// - route the legacy `fee` value into `service_fee_amount`,
    /// - default every new field to `None`,
    /// - succeed for both provider variants.
    #[test]
    fn boltz_legacy_fee_alias_deserializes_into_service_fee_amount() {
        let legacy = r#"{
            "type": "boltz",
            "swap_id": "swap_legacy",
            "invoice": "lnbc1000n1pold",
            "invoice_amount_sats": 100000,
            "max_slippage_bps": 100,
            "chain": "arbitrum",
            "asset": "USDT",
            "recipient_address": "0xrecipient",
            "estimated_out": "1450000",
            "status": "Pending",
            "fee": "1500",
            "asset_decimals": 6
        }"#;
        let decoded: ConversionInfo = serde_json::from_str(legacy).unwrap();
        let ConversionInfo::Boltz {
            asset_amount_in,
            fee_amount,
            service_fee_amount,
            service_fee_asset,
            ..
        } = &decoded
        else {
            panic!("expected Boltz variant, got: {decoded:?}");
        };
        assert_eq!(*asset_amount_in, None);
        assert_eq!(*fee_amount, None);
        assert_eq!(
            *service_fee_amount,
            Some(1500),
            "legacy `fee` key must map to `service_fee_amount`"
        );
        assert_eq!(*service_fee_asset, None);
    }

    #[test]
    fn orchestra_legacy_fee_alias_deserializes_into_service_fee_amount() {
        let legacy = r#"{
            "type": "orchestra",
            "order_id": "ord_legacy",
            "quote_id": "q_legacy",
            "chain": "base",
            "asset": "USDC",
            "recipient_address": "0xrecipient",
            "estimated_out": "99500000",
            "status": "Completed",
            "fee": "500",
            "asset_decimals": 6
        }"#;
        let decoded: ConversionInfo = serde_json::from_str(legacy).unwrap();
        let ConversionInfo::Orchestra {
            asset_amount_in,
            fee_amount,
            service_fee_amount,
            service_fee_asset,
            service_fee_asset_decimals,
            ..
        } = &decoded
        else {
            panic!("expected Orchestra variant, got: {decoded:?}");
        };
        assert_eq!(*asset_amount_in, None);
        assert_eq!(*fee_amount, None);
        assert_eq!(
            *service_fee_amount,
            Some(500),
            "legacy `fee` key must map to `service_fee_amount`"
        );
        assert_eq!(*service_fee_asset, None);
        assert_eq!(*service_fee_asset_decimals, None);
    }

    /// New writes must use the renamed `service_fee_amount` key (never the
    /// legacy `fee`), and must emit the three new fields when populated.
    #[test]
    fn new_rows_use_renamed_keys_on_serialize() {
        let info = ConversionInfo::Boltz {
            swap_id: "s".to_string(),
            chain: "arbitrum".to_string(),
            chain_id: None,
            asset: "USDT".to_string(),
            recipient_address: "0xr".to_string(),
            invoice: "lnbc".to_string(),
            invoice_amount_sats: 100,
            asset_amount_in: Some(1_500_000),
            estimated_out: 1_450_000,
            delivered_amount: None,
            bridge_ref: None,
            status: ConversionStatus::Pending,
            fee_amount: Some(50_000),
            service_fee_amount: Some(1_500),
            service_fee_asset: Some("USD".to_string()),
            max_slippage_bps: 100,
            quote_degraded: false,
            asset_decimals: 6,
            asset_contract: None,
        };
        let json = serde_json::to_string(&info).unwrap();
        assert!(
            json.contains(r#""service_fee_amount":"1500""#),
            "must serialize under the new key, got: {json}"
        );
        assert!(
            !json.contains(r#""fee":"#),
            "must not emit the legacy `fee` key, got: {json}"
        );
        assert!(json.contains(r#""asset_amount_in":"1500000""#));
        assert!(json.contains(r#""fee_amount":"50000""#));
        assert!(json.contains(r#""service_fee_asset":"USD""#));
    }

    /// Backward-compat round-trip — make sure a legacy row, once deserialized
    /// and re-serialized, stays self-consistent (the upgrade path doesn't lose
    /// the legacy value).
    #[test]
    fn legacy_row_roundtrip_after_upgrade() {
        let legacy = r#"{
            "type": "boltz",
            "swap_id": "swap_legacy",
            "invoice": "lnbc",
            "invoice_amount_sats": 100000,
            "max_slippage_bps": 100,
            "chain": "arbitrum",
            "asset": "USDT",
            "recipient_address": "0xr",
            "estimated_out": "1450000",
            "status": "Pending",
            "fee": "1500",
            "asset_decimals": 6
        }"#;
        let decoded: ConversionInfo = serde_json::from_str(legacy).unwrap();
        let re_encoded = serde_json::to_string(&decoded).unwrap();
        let re_decoded: ConversionInfo = serde_json::from_str(&re_encoded).unwrap();
        assert_eq!(
            decoded, re_decoded,
            "upgraded row must round-trip identically"
        );
    }

    #[test]
    fn boltz_status_mut_updates_status_in_place() {
        let mut info = ConversionInfo::Boltz {
            swap_id: "s1".to_string(),
            chain: "arbitrum".to_string(),
            chain_id: Some("42161".to_string()),
            asset: "USDT".to_string(),
            recipient_address: "0xdest".to_string(),
            invoice: "lnbc".to_string(),
            invoice_amount_sats: 100,
            asset_amount_in: None,
            estimated_out: 1,
            delivered_amount: None,
            bridge_ref: None,
            status: ConversionStatus::Pending,
            fee_amount: None,
            service_fee_amount: None,
            service_fee_asset: None,
            max_slippage_bps: 100,
            quote_degraded: false,
            asset_decimals: 6,
            asset_contract: None,
        };
        *info.status_mut() = ConversionStatus::Completed;
        assert_eq!(info.status(), &ConversionStatus::Completed);
    }
}

pub(crate) struct TokenConversionPool {
    pub(crate) asset_in_address: String,
    pub(crate) asset_out_address: String,
    pub(crate) pool: Pool,
}

/// A priced conversion, together with the pool it was priced against.
pub(crate) struct ResolvedConversion {
    pub(crate) conversion_pool: TokenConversionPool,
    /// The floor the swap intent will carry. For a requested output it is that
    /// request, scaled by any rise of the input above the one it derived,
    /// rather than the simulated output, which may be higher and would fail for
    /// no reason. For a supplied input it is the simulated output less slippage.
    pub(crate) min_amount_out: u128,
    pub(crate) estimate: ConversionEstimate,
}

pub(crate) struct TokenConversionResponse {
    /// The sent payment id for the conversion
    pub(crate) sent_payment_id: String,
    /// The received payment id for the conversion
    pub(crate) received_payment_id: String,
}

/// Options for conversion when fulfilling a payment. When set, the SDK will
/// perform a conversion before fulfilling the payment. If not set, the payment
/// will only be fulfilled if the wallet has sufficient balance of the required asset.
#[derive(Debug, Clone, Serialize, PartialEq)]
#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
pub struct ConversionOptions {
    /// The type of conversion to perform when fulfilling the payment
    pub conversion_type: ConversionType,
    /// The optional maximum slippage in basis points (1/100 of a percent) allowed when
    /// a conversion is needed to fulfill the payment. Defaults to 10 bps (0.1%) if not set.
    /// The conversion will fail if the actual amount received is less than
    /// `estimated_amount * (1 - max_slippage_bps / 10_000)`.
    #[cfg_attr(feature = "uniffi", uniffi(default = None))]
    pub max_slippage_bps: Option<u32>,
    /// The optional timeout in seconds to wait for the conversion to complete
    /// when fulfilling the payment. This timeout only concerns waiting for the received
    /// payment of the conversion. If the timeout is reached before the conversion
    /// is complete, the payment will fail. Defaults to 30 seconds if not set.
    #[cfg_attr(feature = "uniffi", uniffi(default = None))]
    pub completion_timeout_secs: Option<u32>,
}

#[derive(Debug, Clone, Serialize, PartialEq)]
#[cfg_attr(feature = "uniffi", derive(uniffi::Enum))]
pub enum ConversionType {
    /// Converting from Bitcoin to a token
    FromBitcoin,
    /// Converting from a token to Bitcoin
    ToBitcoin { from_token_identifier: String },
}

impl ConversionType {
    /// Returns the asset addresses for the conversion type
    ///
    /// # Arguments
    ///
    /// * `token_identifier` - The token identifier when converting from Bitcoin to a token
    ///
    /// # Returns
    ///
    /// Result containing:
    /// * (String, String): A tuple containing the asset in address and asset out address
    /// * `SdkError`: If the token identifier is required but not provided
    pub(crate) fn as_asset_addresses(
        &self,
        token_identifier: Option<&String>,
    ) -> Result<(String, String), SdkError> {
        Ok(match self {
            ConversionType::FromBitcoin => (
                BTC_ASSET_ADDRESS.to_string(),
                token_identifier
                    .ok_or(SdkError::InvalidInput(
                        "Token identifier is required for from Bitcoin conversion".to_string(),
                    ))?
                    .clone(),
            ),
            ConversionType::ToBitcoin {
                from_token_identifier,
            } => (from_token_identifier.clone(), BTC_ASSET_ADDRESS.to_string()),
        })
    }
}

#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
pub struct FetchConversionLimitsRequest {
    /// The type of conversion, either from or to Bitcoin.
    pub conversion_type: ConversionType,
    /// The token identifier when converting to a token.
    #[cfg_attr(feature = "uniffi", uniffi(default = None))]
    pub token_identifier: Option<String>,
}

#[derive(Debug, Clone, Serialize)]
#[cfg_attr(feature = "uniffi", derive(uniffi::Record))]
pub struct FetchConversionLimitsResponse {
    /// The minimum amount to be converted.
    /// Denominated in satoshis if converting from Bitcoin, otherwise in the token base units.
    pub min_from_amount: Option<u128>,
    /// The minimum amount to be received from the conversion.
    /// Denominated in satoshis if converting to Bitcoin, otherwise in the token base units.
    pub min_to_amount: Option<u128>,
}