wayfinder-paths 0.1.19__py3-none-any.whl → 0.1.21__py3-none-any.whl

wayfinder_paths/core/clients/WayfinderClient.py

@@ -11,11 +11,6 @@ from wayfinder_paths.core.constants.base import DEFAULT_HTTP_TIMEOUT
 
 class WayfinderClient:
     def __init__(self):
-        """
-        Initialize WayfinderClient.
-
-        API key is loaded from system.api_key in config.json.
-        """
         self.api_base_url = f"{get_api_base_url()}/"
         timeout = httpx.Timeout(DEFAULT_HTTP_TIMEOUT)
         self.client = httpx.AsyncClient(timeout=timeout)
@@ -25,17 +20,9 @@ class WayfinderClient:
         }
 
     def clear_auth(self) -> None:
-        """Clear X-API-KEY header."""
         self.headers.pop("X-API-KEY", None)
 
     def _load_config_credentials(self) -> dict[str, str | None]:
-        """
-        Load API key from config.json.
-        Expected shape:
-        {
-          "system": { "api_key": ... }
-        }
-        """
         try:
             with open("config.json") as f:
                 cfg = json.load(f)
@@ -50,10 +37,6 @@ class WayfinderClient:
             return {"api_key": None}
 
     def _ensure_api_key(self) -> bool:
-        """
-        Ensure X-API-KEY header is set from system.api_key in config.json.
-        Raises PermissionError if no API key found.
-        """
         if self.headers.get("X-API-KEY"):
             return True
 
@@ -80,10 +63,6 @@ class WayfinderClient:
         retry_on_401: bool = False,
         **kwargs: Any,
     ) -> httpx.Response:
-        """
-        Wrapper around httpx that injects X-API-KEY header.
-        Ensures API key is set in headers when available (for authentication and rate limiting).
-        """
         logger.debug(f"Making {method} request to {url}")
         start_time = time.time()
 
@@ -124,8 +103,5 @@ class WayfinderClient:
         headers: dict[str, str] | None = None,
         **kwargs: Any,
     ) -> httpx.Response:
-        """
-        Ensure X-API-KEY header is set (from system.api_key in config.json) and perform the request.
-        """
         self._ensure_api_key()
         return await self._request(method, url, headers=headers, **kwargs)

wayfinder_paths/core/clients/__init__.py

@@ -1,7 +1,3 @@
-"""
-Core client modules for API communication
-"""
-
 from wayfinder_paths.core.clients.BRAPClient import BRAPClient
 from wayfinder_paths.core.clients.ClientManager import ClientManager
 from wayfinder_paths.core.clients.HyperlendClient import HyperlendClient

wayfinder_paths/core/clients/protocols.py

@@ -1,12 +1,3 @@
-"""
-Protocol definitions for API clients.
-
-These protocols define the interface that all client implementations must satisfy.
-When used as an SDK, users can provide custom implementations that match these protocols.
-
-Note: Authentication is handled via X-API-KEY header in WayfinderClient base class.
-"""
-
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Protocol
@@ -37,50 +28,36 @@ if TYPE_CHECKING:
 
 
 class TokenClientProtocol(Protocol):
-    """Protocol for token-related operations"""
-
     async def get_token_details(
         self,
         query: str,
         market_data: bool = True,
         chain_id: int | None = None,
-    ) -> TokenDetails:
-        """Get token data including price from the token-details endpoint"""
-        ...
+    ) -> TokenDetails: ...
 
-    async def get_gas_token(self, chain_code: str) -> GasToken:
-        """Fetch the native gas token for a given chain code"""
-        ...
+    async def get_gas_token(self, chain_code: str) -> GasToken: ...
 
 
 class HyperlendClientProtocol(Protocol):
-    """Protocol for Hyperlend-related operations"""
-
     async def get_stable_markets(
         self,
         *,
         required_underlying_tokens: float | None = None,
         buffer_bps: int | None = None,
         min_buffer_tokens: float | None = None,
-    ) -> StableMarketsHeadroomResponse:
-        """Fetch stable markets headroom from Hyperlend"""
-        ...
+    ) -> StableMarketsHeadroomResponse: ...
 
     async def get_assets_view(
         self,
         *,
         user_address: str,
-    ) -> AssetsView:
-        """Fetch assets view for a user address from Hyperlend"""
-        ...
+    ) -> AssetsView: ...
 
     async def get_market_entry(
         self,
         *,
         token: str,
-    ) -> MarketEntry:
-        """Fetch market entry from Hyperlend"""
-        ...
+    ) -> MarketEntry: ...
 
     async def get_lend_rate_history(
         self,
@@ -88,33 +65,23 @@ class HyperlendClientProtocol(Protocol):
         token: str,
         lookback_hours: int,
         force_refresh: bool | None = None,
-    ) -> LendRateHistory:
-        """Fetch lend rate history from Hyperlend"""
-        ...
+    ) -> LendRateHistory: ...
 
 
 class LedgerClientProtocol(Protocol):
-    """Protocol for strategy transaction history and bookkeeping operations"""
-
     async def get_strategy_transactions(
         self,
         *,
         wallet_address: str,
         limit: int = 50,
         offset: int = 0,
-    ) -> StrategyTransactionList:
-        """Fetch a paginated list of transactions for a given strategy wallet"""
-        ...
+    ) -> StrategyTransactionList: ...
 
-    async def get_strategy_net_deposit(self, *, wallet_address: str) -> float:
-        """Fetch the net deposit (deposits - withdrawals) for a strategy"""
-        ...
+    async def get_strategy_net_deposit(self, *, wallet_address: str) -> float: ...
 
     async def get_strategy_latest_transactions(
         self, *, wallet_address: str
-    ) -> StrategyTransactionList:
-        """Fetch the latest transactions for a strategy"""
-        ...
+    ) -> StrategyTransactionList: ...
 
     async def add_strategy_deposit(
         self,
@@ -126,9 +93,7 @@ class LedgerClientProtocol(Protocol):
         usd_value: str | float,
         data: dict[str, Any] | None = None,
         strategy_name: str | None = None,
-    ) -> TransactionRecord:
-        """Record a deposit for a strategy"""
-        ...
+    ) -> TransactionRecord: ...
 
     async def add_strategy_withdraw(
         self,
@@ -140,9 +105,7 @@ class LedgerClientProtocol(Protocol):
         usd_value: str | float,
         data: dict[str, Any] | None = None,
         strategy_name: str | None = None,
-    ) -> TransactionRecord:
-        """Record a withdrawal for a strategy"""
-        ...
+    ) -> TransactionRecord: ...
 
     async def add_strategy_operation(
         self,
@@ -151,49 +114,35 @@ class LedgerClientProtocol(Protocol):
         operation_data: dict[str, Any],
         usd_value: str | float,
         strategy_name: str | None = None,
-    ) -> TransactionRecord:
-        """Record a strategy operation (e.g., swaps, rebalances)"""
-        ...
+    ) -> TransactionRecord: ...
 
 
 class WalletClientProtocol(Protocol):
-    """Protocol for wallet-related operations"""
-
     async def get_token_balance_for_address(
         self,
         *,
         wallet_address: str,
         query: str,
         chain_id: int | None = None,
-    ) -> AddressBalance:
-        """Fetch a balance for an address + chain + query (supports compound query formats)"""
-        ...
+    ) -> AddressBalance: ...
 
 
 class PoolClientProtocol(Protocol):
-    """Protocol for pool-related read operations"""
-
     async def get_pools_by_ids(
         self,
         *,
         pool_ids: list[str] | str,
-    ) -> PoolList:
-        """Fetch pools by pool IDs (list or comma-separated string)"""
-        ...
+    ) -> PoolList: ...
 
     async def get_pools(
         self,
         *,
         chain_id: int | None = None,
         project: str | None = None,
-    ) -> LlamaMatchesResponse:
-        """Fetch pools (optionally filtered by chain_id and project)"""
-        ...
+    ) -> LlamaMatchesResponse: ...
 
 
 class BRAPClientProtocol(Protocol):
-    """Protocol for BRAP (Bridge/Router/Adapter Protocol) quote operations"""
-
     async def get_quote(
         self,
         *,
@@ -203,14 +152,10 @@ class BRAPClientProtocol(Protocol):
         to_chain: int,
         from_wallet: str,
         from_amount: str,
-    ) -> BRAPQuoteResponse:
-        """Get a quote for a bridge/swap operation"""
-        ...
+    ) -> BRAPQuoteResponse: ...
 
 
 class HyperliquidExecutorProtocol(Protocol):
-    """Protocol for Hyperliquid order execution operations."""
-
     async def place_market_order(
         self,
         *,
@@ -222,9 +167,7 @@ class HyperliquidExecutorProtocol(Protocol):
         reduce_only: bool = False,
         cloid: Any = None,
         builder: dict[str, Any] | None = None,
-    ) -> dict[str, Any]:
-        """Place a market order."""
-        ...
+    ) -> dict[str, Any]: ...
 
     async def cancel_order(
         self,
@@ -232,9 +175,7 @@ class HyperliquidExecutorProtocol(Protocol):
         asset_id: int,
         order_id: int,
         address: str,
-    ) -> dict[str, Any]:
-        """Cancel an open order."""
-        ...
+    ) -> dict[str, Any]: ...
 
     async def update_leverage(
         self,
@@ -243,27 +184,21 @@ class HyperliquidExecutorProtocol(Protocol):
         leverage: int,
         is_cross: bool,
         address: str,
-    ) -> dict[str, Any]:
-        """Update leverage for an asset."""
-        ...
+    ) -> dict[str, Any]: ...
 
     async def transfer_spot_to_perp(
         self,
         *,
         amount: float,
         address: str,
-    ) -> dict[str, Any]:
-        """Transfer USDC from spot to perp balance."""
-        ...
+    ) -> dict[str, Any]: ...
 
     async def transfer_perp_to_spot(
         self,
         *,
         amount: float,
         address: str,
-    ) -> dict[str, Any]:
-        """Transfer USDC from perp to spot balance."""
-        ...
+    ) -> dict[str, Any]: ...
 
     async def place_stop_loss(
         self,
@@ -273,9 +208,7 @@ class HyperliquidExecutorProtocol(Protocol):
         trigger_price: float,
         size: float,
         address: str,
-    ) -> dict[str, Any]:
-        """Place a stop-loss order."""
-        ...
+    ) -> dict[str, Any]: ...
 
     async def place_limit_order(
         self,
@@ -287,18 +220,14 @@ class HyperliquidExecutorProtocol(Protocol):
         address: str,
         reduce_only: bool = False,
         builder: dict[str, Any] | None = None,
-    ) -> dict[str, Any]:
-        """Place a limit order."""
-        ...
+    ) -> dict[str, Any]: ...
 
     async def withdraw(
         self,
         *,
         amount: float,
         address: str,
-    ) -> dict[str, Any]:
-        """Withdraw USDC from Hyperliquid to Arbitrum."""
-        ...
+    ) -> dict[str, Any]: ...
 
     async def approve_builder_fee(
         self,
@@ -306,6 +235,4 @@ class HyperliquidExecutorProtocol(Protocol):
         builder: str,
         max_fee_rate: str,
         address: str,
-    ) -> dict[str, Any]:
-        """Approve a builder fee for the user."""
-        ...
+    ) -> dict[str, Any]: ...

wayfinder_paths/core/config.py

@@ -28,17 +28,6 @@ SUPPORTED_CHAINS = [
 ]
 
 
-@dataclass
-class UserConfig:
-    username: str | None = None
-    password: str | None = None
-    refresh_token: str | None = None
-    main_wallet_address: str | None = None
-    strategy_wallet_address: str | None = None
-    default_slippage: float = 0.005
-    gas_multiplier: float = 1.2
-
-
 @dataclass
 class SystemConfig:
     api_base_url: str = field(default="https://api.wayfinder.ai")
@@ -54,7 +43,6 @@ class SystemConfig:
 
 @dataclass
 class StrategyJobConfig:
-    user: UserConfig
     system: SystemConfig
     strategy_config: dict[str, Any] = field(default_factory=dict)
 
@@ -161,17 +149,6 @@ class StrategyJobConfig:
     def from_dict(
         cls, data: dict[str, Any], strategy_name: str | None = None
     ) -> "StrategyJobConfig":
-        user_data = data.get("user", {})
-        user_cfg = UserConfig(
-            username=user_data.get("username"),
-            password=user_data.get("password"),
-            refresh_token=user_data.get("refresh_token"),
-            main_wallet_address=user_data.get("main_wallet_address"),
-            strategy_wallet_address=user_data.get("strategy_wallet_address"),
-            default_slippage=user_data.get("default_slippage", 0.005),
-            gas_multiplier=user_data.get("gas_multiplier", 1.2),
-        )
-
         system_data = data.get("system", {})
         sys_cfg = SystemConfig(
             api_base_url=system_data.get("api_base_url", "https://api.wayfinder.ai"),
@@ -189,7 +166,6 @@ class StrategyJobConfig:
         if strategy_name:
             strategy_config["_strategy_name"] = strategy_name
         return cls(
-            user=user_cfg,
             system=sys_cfg,
             strategy_config=strategy_config,
         )

wayfinder_paths/core/constants/__init__.py

@@ -1,10 +1,3 @@
-"""Constants package for wayfinder-paths.
-
-This package contains all constants used across the system, organized by category:
-- base: Fundamental constants (addresses, chain mappings, gas defaults)
-- erc20_abi: ERC20 token ABI definitions for smart contract interactions
-"""
-
 from .base import (
     CHAIN_CODE_TO_ID,
     DEFAULT_NATIVE_GAS_UNITS,

wayfinder_paths/core/constants/base.py

@@ -1,10 +1,3 @@
-"""Base constants for adapters and strategies.
-
-This module contains fundamental constants used across the wayfinder-paths system,
-including address constants, chain mappings, and gas-related defaults.
-"""
-
-# Address constants
 ZERO_ADDRESS = "0x0000000000000000000000000000000000000000"
 
 # Chain code to EVM chain id mapping
@@ -21,7 +14,7 @@ CHAIN_CODE_TO_ID = {
 DEFAULT_NATIVE_GAS_UNITS = 21000
 # Fallback gas limit used only when RPC gas estimation fails for non-revert reasons.
 # Must be high enough for typical DeFi interactions (lending, swaps, etc.).
-GAS_BUFFER_MULTIPLIER = 1.1  # 10% buffer for native sends
+GAS_BUFFER_MULTIPLIER = 1.1
 ONE_GWEI = 1_000_000_000
 DEFAULT_SLIPPAGE = 0.005
 
@@ -42,4 +35,4 @@ ADAPTER_LEDGER = "LEDGER"
 ADAPTER_HYPERLEND = "HYPERLEND"
 
 # Pagination defaults
-DEFAULT_PAGINATION_LIMIT = 50  # Default limit for paginated API responses
+DEFAULT_PAGINATION_LIMIT = 50

wayfinder_paths/core/constants/erc20_abi.py

@@ -1,8 +1,3 @@
-"""
-ERC20 ABI constants for consistent use across the codebase.
-This centralizes ABI definitions to avoid duplication and improve maintainability.
-"""
-
 # Standard ERC20 ABI - includes common functions needed for token operations
 ERC20_ABI = [
     {

wayfinder_paths/core/constants/hyperlend_abi.py

@@ -1,10 +1,3 @@
-"""
-HyperLend ABI constants for smart contract interactions.
-
-This module contains ABI definitions for HyperLend protocol contracts,
-including Pool, Protocol Data Provider, Wrapped Token Gateway, and WETH contracts.
-"""
-
 # Minimal Pool ABI for supply and deposit operations
 POOL_ABI = [
     {

wayfinder_paths/core/constants/moonwell_abi.py

@@ -1,10 +1,3 @@
-"""
-Moonwell ABI constants for smart contract interactions.
-
-This module contains ABI definitions for Moonwell protocol contracts,
-including mToken (ERC20 Delegator), Comptroller, and Reward Distributor contracts.
-"""
-
 # mToken (CErc20Delegator) ABI - for lending, borrowing, and position management
 MTOKEN_ABI = [
     # Lend (supply) tokens by minting mTokens
@@ -47,7 +40,6 @@ MTOKEN_ABI = [
         "inputs": [{"name": "repayAmount", "type": "uint256"}],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get mToken balance
     {
         "name": "balanceOf",
         "type": "function",
@@ -55,7 +47,6 @@ MTOKEN_ABI = [
         "inputs": [{"name": "owner", "type": "address"}],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get underlying balance (including accrued interest)
     {
         "name": "balanceOfUnderlying",
         "type": "function",
@@ -63,7 +54,6 @@ MTOKEN_ABI = [
         "inputs": [{"name": "owner", "type": "address"}],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get current borrow balance (including interest)
     {
         "name": "borrowBalanceCurrent",
         "type": "function",
@@ -71,7 +61,6 @@ MTOKEN_ABI = [
         "inputs": [{"name": "account", "type": "address"}],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get stored borrow balance (without accruing interest first)
     {
         "name": "borrowBalanceStored",
         "type": "function",
@@ -79,7 +68,6 @@ MTOKEN_ABI = [
         "inputs": [{"name": "account", "type": "address"}],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get exchange rate between mToken and underlying
     {
         "name": "exchangeRateCurrent",
         "type": "function",
@@ -87,7 +75,6 @@ MTOKEN_ABI = [
         "inputs": [],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get stored exchange rate
     {
         "name": "exchangeRateStored",
         "type": "function",
@@ -95,7 +82,6 @@ MTOKEN_ABI = [
         "inputs": [],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get underlying token address
     {
         "name": "underlying",
         "type": "function",
@@ -103,7 +89,6 @@ MTOKEN_ABI = [
         "inputs": [],
         "outputs": [{"name": "", "type": "address"}],
     },
-    # Get supply rate per timestamp
     {
         "name": "supplyRatePerTimestamp",
         "type": "function",
@@ -111,7 +96,6 @@ MTOKEN_ABI = [
         "inputs": [],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get borrow rate per timestamp
     {
         "name": "borrowRatePerTimestamp",
         "type": "function",
@@ -119,7 +103,6 @@ MTOKEN_ABI = [
         "inputs": [],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get total borrows
     {
         "name": "totalBorrows",
         "type": "function",
@@ -127,7 +110,6 @@ MTOKEN_ABI = [
         "inputs": [],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get total supply of mTokens
     {
         "name": "totalSupply",
         "type": "function",
@@ -135,7 +117,6 @@ MTOKEN_ABI = [
         "inputs": [],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get cash (available liquidity)
     {
         "name": "getCash",
         "type": "function",
@@ -151,7 +132,6 @@ MTOKEN_ABI = [
         "inputs": [],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get decimals
     {
         "name": "decimals",
         "type": "function",
@@ -179,7 +159,6 @@ COMPTROLLER_ABI = [
         "inputs": [{"name": "mTokenAddress", "type": "address"}],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get account liquidity (error, liquidity, shortfall)
     {
         "name": "getAccountLiquidity",
         "type": "function",
@@ -191,7 +170,6 @@ COMPTROLLER_ABI = [
             {"name": "shortfall", "type": "uint256"},
         ],
     },
-    # Get market info (isListed, collateralFactorMantissa)
     {
         "name": "markets",
         "type": "function",
@@ -202,7 +180,6 @@ COMPTROLLER_ABI = [
             {"name": "collateralFactorMantissa", "type": "uint256"},
         ],
     },
-    # Check if account has entered a market
     {
         "name": "checkMembership",
         "type": "function",
@@ -213,7 +190,6 @@ COMPTROLLER_ABI = [
         ],
         "outputs": [{"name": "", "type": "bool"}],
     },
-    # Get all markets an account has entered
     {
         "name": "getAssetsIn",
         "type": "function",
@@ -221,7 +197,6 @@ COMPTROLLER_ABI = [
         "inputs": [{"name": "account", "type": "address"}],
         "outputs": [{"name": "", "type": "address[]"}],
     },
-    # Get all listed markets
     {
         "name": "getAllMarkets",
         "type": "function",
@@ -229,7 +204,6 @@ COMPTROLLER_ABI = [
         "inputs": [],
         "outputs": [{"name": "", "type": "address[]"}],
     },
-    # Get hypothetical account liquidity
     {
         "name": "getHypotheticalAccountLiquidity",
         "type": "function",
@@ -246,7 +220,6 @@ COMPTROLLER_ABI = [
             {"name": "shortfall", "type": "uint256"},
         ],
     },
-    # Get close factor
     {
         "name": "closeFactorMantissa",
         "type": "function",
@@ -254,7 +227,6 @@ COMPTROLLER_ABI = [
         "inputs": [],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get liquidation incentive
     {
         "name": "liquidationIncentiveMantissa",
         "type": "function",
@@ -293,7 +265,6 @@ REWARD_DISTRIBUTOR_ABI = [
         ],
         "outputs": [],
     },
-    # Get reward token address
     {
         "name": "rewardToken",
         "type": "function",
@@ -301,7 +272,6 @@ REWARD_DISTRIBUTOR_ABI = [
         "inputs": [],
         "outputs": [{"name": "", "type": "address"}],
     },
-    # Get pending rewards (accrued but not yet claimed)
     {
         "name": "rewardAccrued",
         "type": "function",
@@ -309,8 +279,6 @@ REWARD_DISTRIBUTOR_ABI = [
         "inputs": [{"name": "holder", "type": "address"}],
         "outputs": [{"name": "", "type": "uint256"}],
     },
-    # Get outstanding rewards for a user across all markets
-    # Returns array of (mToken, [(rewardToken, totalReward, supplySide, borrowSide)])
     {
         "name": "getOutstandingRewardsForUser",
         "type": "function",
@@ -336,7 +304,6 @@ REWARD_DISTRIBUTOR_ABI = [
             }
         ],
     },
-    # Get outstanding rewards for a user for a specific mToken
     {
         "name": "getOutstandingRewardsForUser",
         "type": "function",
@@ -358,8 +325,6 @@ REWARD_DISTRIBUTOR_ABI = [
             }
         ],
     },
-    # Get all market configurations for an mToken
-    # Returns array of (mToken, rewardToken, supplyEmissionsPerSec, borrowEmissionsPerSec, ...)
     {
         "name": "getAllMarketConfigs",
         "type": "function",