feat: Minimum solver profitability (#155)

Author: NicoMolinaOZ

Cargo.lock

@@ -153,6 +153,7 @@ oif-solver/
 
 - Validates intents and converts them to orders
 - Implements execution strategies (when to execute)
+- Evaluates order profitability against minimum thresholds
 - Generates fill and claim transactions
 - Manages order-specific logic for different protocols
 
@@ -235,6 +236,8 @@ You can also use a single configuration file. See `config/example.toml` for a co
 [solver]
 id = "oif-solver-local"
 monitoring_timeout_minutes = 5
+# Minimum profitability percentage required for order execution
+min_profitability_pct = 1.0
 
 # Networks configuration - defines supported chains and tokens
 [networks.31337]  # Origin chain
@@ -503,6 +506,7 @@ cargo run --bin solver -- --config config/demo.toml
 #### Intent Operations
 
 The demo supports two submission modes:
+
 - **Offchain**: Intents are submitted to the solver API (default)
 - **Onchain**: Intents are submitted directly to the blockchain via InputSettler.open()
 
@@ -599,14 +603,14 @@ The demo tool generates files in the `demo-output/` directory following a clear
 - **`.req.json`** - Request payloads sent to the API
 - **`.res.json`** - Responses received from the API
 
-| File | Description | Generated By |
-|------|-------------|--------------|
-| `post_intent.req.json` | Intent submission request payload | `intent build` |
-| `post_intent.res.json` | Intent submission response | `intent submit` |
-| `get_quote.req.json` | Quote request payload | `intent build` |
-| `get_quote.res.json` | Quote response with pricing | `quote get` |
-| `post_quote.req.json` | Signed quote acceptance request | `quote accept` |
-| `post_quote.res.json` | Quote acceptance response | `quote accept` |
+| File                   | Description                       | Generated By    |
+| ---------------------- | --------------------------------- | --------------- |
+| `post_intent.req.json` | Intent submission request payload | `intent build`  |
+| `post_intent.res.json` | Intent submission response        | `intent submit` |
+| `get_quote.req.json`   | Quote request payload             | `intent build`  |
+| `get_quote.res.json`   | Quote response with pricing       | `quote get`     |
+| `post_quote.req.json`  | Signed quote acceptance request   | `quote accept`  |
+| `post_quote.res.json`  | Quote acceptance response         | `quote accept`  |
 
 ### Environment Setup Details
 

README.md

@@ -10,6 +10,7 @@ include = [
 [solver]
 id = "oif-solver-demo"
 monitoring_timeout_minutes = 5
+min_profitability_pct = 1.0
 
 # ============================================================================
 # STORAGE
@@ -76,7 +77,7 @@ max_gas_price_gwei = 100
 # PRICING
 # ============================================================================
 [pricing]
-primary = "mock"
+primary = "coingecko"
 
 [pricing.implementations.mock]
 # Uses default ETH/USD price of 4615.16
@@ -87,6 +88,11 @@ primary = "mock"
 cache_duration_seconds = 60
 rate_limit_delay_ms = 1200
 
+# Custom prices for demo/test tokens (in USD)
+[pricing.implementations.coingecko.custom_prices]
+TOKA = "200.00"
+TOKB = "195.00"
+
 # ============================================================================
 # SETTLEMENT
 # ============================================================================

config/demo.toml

@@ -11,3 +11,9 @@ claim = 121995
 open = 143116
 fill = 76068
 claim = 59953
+
+[gas.flows.eip3009_escrow]
+# Gas units captured by scripts/e2e/estimate_gas_eip3009_escrow.sh on local anvil
+open = 130254
+fill = 77298 
+claim = 60084

config/demo/gas.toml

@@ -2,12 +2,14 @@
 
 include = [
     "testnet/networks.toml",
-    "testnet/api.toml"
+    "testnet/api.toml",
+    "testnet/gas.toml"
 ]
 
 [solver]
 id = "oif-solver-testnet-usdc"
 monitoring_timeout_minutes = 5
+min_profitability_pct = 1.0
 
 # ============================================================================
 # STORAGE
@@ -41,20 +43,21 @@ private_key = "solver_private_key"
 min_confirmations = 3  # Higher confirmations for testnets
 
 [delivery.implementations.evm_alloy]
-network_ids = [84532, 11155420, 421614, 11155111]
+network_ids = [84532, 11155420, 11155111, 421614]  # Include all configured networks
 
 # ============================================================================
 # DISCOVERY
 # ============================================================================
 [discovery]
 
 [discovery.implementations.onchain_eip7683]
-network_ids = [84532, 11155420, 421614, 11155111]
+network_ids = [84532, 11155420]
+polling_interval_secs = 30  # Use WebSocket subscriptions instead of polling
 
 [discovery.implementations.offchain_eip7683]
 api_host = "127.0.0.1"
 api_port = 8081
-network_ids = [84532, 11155420, 421614, 11155111]
+network_ids = [84532, 11155420]
 
 # ============================================================================
 # ORDER
@@ -69,35 +72,48 @@ primary = "simple"
 [order.strategy.implementations.simple]
 max_gas_price_gwei = 100
 
+# ============================================================================
+# PRICING
+# ============================================================================
+[pricing]
+primary = "coingecko"
+
+[pricing.implementations.mock]
+# Uses default ETH/USD price of 4615.16
+
+[pricing.implementations.coingecko]
+# Free tier configuration (no API key required)
+# api_key = "CG-YOUR-API-KEY-HERE"
+cache_duration_seconds = 60
+rate_limit_delay_ms = 1200
+
 # ============================================================================
 # SETTLEMENT
 # ============================================================================
 [settlement]
 
 [settlement.domain]
 chain_id = 1
-address = "0xB686e4A97821E259d1BB15c5bf13ec96553176d7"
+address = "0x557d6E91bAC4b2D36fB66f0231fF93db9810e203"
 
 [settlement.implementations.direct]
 order = "eip7683"
-network_ids = [84532, 11155420, 421614, 11155111]
+network_ids = [84532, 11155420]
 dispute_period_seconds = 60
 # Oracle selection strategy when multiple oracles are available (First, RoundRobin, Random)
 oracle_selection_strategy = "First"
 
 # Oracle configuration with multiple oracle support
 [settlement.implementations.direct.oracles]
 # Input oracles (on origin chains)
-input = { 84532 = ["0xDD40C9a79D813e4200795014b8E9e575317596F6"], 11155420 = ["0x6dc56CB6C61f3c5a9148cE1fD1AF7a13B8903980"], 421614 = ["0xedF6cd53008C3EA43e976214F5f6a1A8dBDc6460"], 11155111 = ["0xc04c8A84295F36B53AC109d47C041a258B788268"] }
+input = { 84532 = ["0xF92e489E524B19744DbB14f8e8daAdc43c50234d"], 11155420 = ["0xF92e489E524B19744DbB14f8e8daAdc43c50234d"] }
 # Output oracles (on destination chains)
-output = { 84532 = ["0xDD40C9a79D813e4200795014b8E9e575317596F6"], 11155420 = ["0x6dc56CB6C61f3c5a9148cE1fD1AF7a13B8903980"], 421614 = ["0xedF6cd53008C3EA43e976214F5f6a1A8dBDc6460"], 11155111 = ["0xc04c8A84295F36B53AC109d47C041a258B788268"] }
+output = { 84532 = ["0xF92e489E524B19744DbB14f8e8daAdc43c50234d"], 11155420 = ["0xF92e489E524B19744DbB14f8e8daAdc43c50234d"] }
 
 # Valid routes: from origin chain -> to destination chains
 [settlement.implementations.direct.routes]
-84532 = [11155420, 421614, 11155111]     # Base Sepolia can go to all other networks
-11155420 = [84532, 421614, 11155111]    # Optimism Sepolia can go to all other networks
-421614 = [84532, 11155420, 11155111]    # Arbitrum Sepolia can go to all other networks
-11155111 = [84532, 11155420, 421614]    # Ethereum Sepolia can go to all other networks
+84532 = [11155420]  # Can go from origin to destination
+11155420 = [84532]  # Can go from destination to origin
 
 # ============================================================================
 # DEMO SCRIPT CONFIGURATION

config/testnet.toml

@@ -1,3 +1,6 @@
+# API Server Configuration - Testnet Setup
+# Configures the HTTP API for receiving off-chain intents
+
 [api]
 enabled = true
 host = "127.0.0.1"
@@ -6,4 +9,18 @@ timeout_seconds = 30
 max_request_size = 1048576  # 1MB
 
 [api.implementations]
-discovery = "offchain_eip7683"
+discovery = "offchain_eip7683"
+
+# JWT Authentication Configuration
+[api.auth]
+enabled = false
+jwt_secret = "${JWT_SECRET:-MySuperDuperSecureSecret123!}"
+access_token_expiry_hours = 1
+refresh_token_expiry_hours = 720  # 30 days
+issuer = "oif-solver-testnet"
+
+# Quote Configuration
+[api.quote]
+# Quote validity duration in seconds
+# Default is 20 seconds. Customize as needed:
+validity_seconds = 60  # 1 minute validity

config/testnet/api.toml

@@ -0,0 +1,19 @@
+[gas]
+
+[gas.flows.compact_resource_lock]
+# Gas units captured by scripts/e2e/estimate_gas_compact.sh
+open = 0
+fill = 76068
+claim = 121995
+
+[gas.flows.permit2_escrow]
+# Gas units captured by cast estimate command
+open = 141899
+fill = 90027 
+claim = 75573
+
+[gas.flows.eip3009_escrow]
+# Gas units captured
+open = 130254
+fill = 77298 
+claim = 60084

config/testnet/gas.toml

@@ -6,6 +6,7 @@ rust-version.workspace = true
 
 [dependencies]
 regex = "1.10"
+rust_decimal = { workspace = true }
 serde = { version = "1.0", features = ["derive"] }
 solver-types = { path = "../solver-types" }
 thiserror = "1.0"

crates/solver-config/Cargo.toml

@@ -3,6 +3,8 @@
 //! This module provides utilities for constructing Config instances with
 //! sensible defaults, particularly useful for testing scenarios.
 
+use rust_decimal::Decimal;
+
 use crate::{
 	AccountConfig, ApiConfig, Config, DeliveryConfig, DiscoveryConfig, GasConfig, NetworksConfig,
 	OrderConfig, SettlementConfig, SolverConfig, StorageConfig, StrategyConfig,
@@ -16,6 +18,7 @@ use std::collections::HashMap;
 pub struct ConfigBuilder {
 	solver_id: String,
 	monitoring_timeout_minutes: u64,
+	min_profitability_pct: Decimal,
 	storage_primary: String,
 	storage_cleanup_interval_seconds: u64,
 	min_confirmations: u64,
@@ -38,6 +41,7 @@ impl ConfigBuilder {
 		Self {
 			solver_id: "test-solver".to_string(),
 			monitoring_timeout_minutes: 1,
+			min_profitability_pct: Decimal::ZERO,
 			storage_primary: "memory".to_string(),
 			storage_cleanup_interval_seconds: 60,
 			min_confirmations: 1,
@@ -109,12 +113,19 @@ impl ConfigBuilder {
 		self
 	}
 
+	/// Sets the minimum profitability percentage.
+	pub fn with_min_profitability_pct(mut self, min_profitability_pct: Decimal) -> Self {
+		self.min_profitability_pct = min_profitability_pct;
+		self
+	}
+
 	/// Builds the `Config` with the configured values.
 	pub fn build(self) -> Config {
 		Config {
 			solver: SolverConfig {
 				id: self.solver_id,
 				monitoring_timeout_minutes: self.monitoring_timeout_minutes,
+				min_profitability_pct: self.min_profitability_pct,
 			},
 			networks: self.networks.unwrap_or_default(),
 			storage: StorageConfig {

crates/solver-config/src/builders/config.rs

@@ -16,6 +16,7 @@ mod loader;
 pub use builders::config::ConfigBuilder;
 
 use regex::Regex;
+use rust_decimal::Decimal;
 use serde::{Deserialize, Serialize};
 use solver_types::{networks::deserialize_networks, NetworksConfig};
 use std::collections::HashMap;
@@ -97,6 +98,8 @@ pub struct SolverConfig {
 	/// Defaults to 480 minutes (8 hours) if not specified.
 	#[serde(default = "default_monitoring_timeout_minutes")]
 	pub monitoring_timeout_minutes: u64,
+	/// Minimum profitability percentage required to execute orders.
+	pub min_profitability_pct: Decimal,
 }
 
 /// Returns the default monitoring timeout in minutes.
@@ -708,6 +711,7 @@ mod tests {
 [solver]
 id = "${TEST_SOLVER_ID}"
 monitoring_timeout_minutes = 5
+min_profitability_pct = 1.0
 
 [networks.1]
 input_settler_address = "0x1234567890123456789012345678901234567890"
@@ -759,6 +763,10 @@ network_ids = [1, 2]
 
 		let config: Config = config_str.parse().unwrap();
 		assert_eq!(config.solver.id, "test-solver");
+		assert_eq!(
+			config.solver.min_profitability_pct,
+			Decimal::from_str("1.0").unwrap()
+		);
 
 		// Clean up
 		std::env::remove_var("TEST_SOLVER_ID");
@@ -770,6 +778,7 @@ network_ids = [1, 2]
 [solver]
 id = "test"
 monitoring_timeout_minutes = 5
+min_profitability_pct = 5.0  # Minimum profitability percentage required to execute orders
 
 [networks.1]
 input_settler_address = "0x1234567890123456789012345678901234567890"
@@ -853,6 +862,7 @@ network_ids = [2, 3]  # Network 2 overlaps with impl1
 [solver]
 id = "test"
 monitoring_timeout_minutes = 5
+min_profitability_pct = 5.0  # Minimum profitability percentage required to execute orders
 
 [networks.1]
 input_settler_address = "0x1234567890123456789012345678901234567890"
@@ -913,6 +923,7 @@ network_ids = [1, 2]
 [solver]
 id = "test"
 monitoring_timeout_minutes = 5
+min_profitability_pct = 5.0  # Minimum profitability percentage required to execute orders
 
 [networks.1]
 input_settler_address = "0x1234567890123456789012345678901234567890"
@@ -975,6 +986,7 @@ network_ids = [1, 2, 999]  # Network 999 doesn't exist
 [solver]
 id = "test"
 monitoring_timeout_minutes = 5
+min_profitability_pct = 5.0  # Minimum profitability percentage required to execute orders
 
 [networks.1]
 input_settler_address = "0x1234567890123456789012345678901234567890"