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

wayfinder_paths/adapters/ledger_adapter/adapter.py

@@ -12,16 +12,6 @@ from wayfinder_paths.core.strategies.Strategy import StatusDict
 
 
 class LedgerAdapter(BaseAdapter):
-    """
-    Ledger adapter for strategy transaction history and bookkeeping operations.
-
-    Provides high-level operations for:
-    - Fetching strategy transaction history
-    - Getting net deposit amounts
-    - Getting last rotation time
-    - Recording deposits, withdrawals, and operations
-    """
-
     adapter_type: str = "LEDGER"
 
     def __init__(
@@ -35,17 +25,6 @@ class LedgerAdapter(BaseAdapter):
     async def get_strategy_transactions(
         self, wallet_address: str, limit: int = 50, offset: int = 0
     ) -> tuple[bool, StrategyTransactionList | str]:
-        """
-        Get paginated strategy transaction history.
-
-        Args:
-            wallet_address: Strategy wallet address
-            limit: Maximum number of transactions to return
-            offset: Number of transactions to skip
-
-        Returns:
-            Tuple of (success, data) where data is transaction list or error message
-        """
         try:
             data = await self.ledger_client.get_strategy_transactions(
                 wallet_address=wallet_address, limit=limit, offset=offset
@@ -58,15 +37,6 @@ class LedgerAdapter(BaseAdapter):
     async def get_strategy_net_deposit(
         self, wallet_address: str
     ) -> tuple[bool, NetDeposit | str]:
-        """
-        Get net deposit amount (deposits - withdrawals) for a strategy.
-
-        Args:
-            wallet_address: Strategy wallet address
-
-        Returns:
-            Tuple of (success, data) where data contains net_deposit or error message
-        """
         try:
             data = await self.ledger_client.get_strategy_net_deposit(
                 wallet_address=wallet_address
@@ -79,15 +49,6 @@ class LedgerAdapter(BaseAdapter):
     async def get_strategy_latest_transactions(
         self, wallet_address: str
     ) -> tuple[bool, StrategyTransactionList | str]:
-        """
-        Get the latest transactions for a strategy.
-
-        Args:
-            wallet_address: Strategy wallet address
-
-        Returns:
-            Tuple of (success, data) where data contains latest transactions or error message
-        """
         try:
             data = await self.ledger_client.get_strategy_latest_transactions(
                 wallet_address=wallet_address
@@ -107,21 +68,6 @@ class LedgerAdapter(BaseAdapter):
         data: dict[str, Any] | None = None,
         strategy_name: str | None = None,
     ) -> tuple[bool, TransactionRecord | str]:
-        """
-        Record a strategy deposit transaction.
-
-        Args:
-            wallet_address: Strategy wallet address
-            chain_id: Blockchain chain ID
-            token_address: Token contract address
-            token_amount: Amount deposited (in token units)
-            usd_value: USD value of the deposit
-            data: Additional transaction data
-            strategy_name: Name of the strategy making the deposit
-
-        Returns:
-            Tuple of (success, data) where data is transaction record or error message
-        """
         try:
             result = await self.ledger_client.add_strategy_deposit(
                 wallet_address=wallet_address,
@@ -147,21 +93,6 @@ class LedgerAdapter(BaseAdapter):
         data: dict[str, Any] | None = None,
         strategy_name: str | None = None,
     ) -> tuple[bool, TransactionRecord | str]:
-        """
-        Record a strategy withdrawal transaction.
-
-        Args:
-            wallet_address: Strategy wallet address
-            chain_id: Blockchain chain ID
-            token_address: Token contract address
-            token_amount: Amount withdrawn (in token units)
-            usd_value: USD value of the withdrawal
-            data: Additional transaction data
-            strategy_name: Name of the strategy making the withdrawal
-
-        Returns:
-            Tuple of (success, data) where data is transaction record or error message
-        """
         try:
             result = await self.ledger_client.add_strategy_withdraw(
                 wallet_address=wallet_address,
@@ -184,18 +115,6 @@ class LedgerAdapter(BaseAdapter):
         usd_value: str | float,
         strategy_name: str | None = None,
     ) -> tuple[bool, TransactionRecord | str]:
-        """
-        Record a strategy operation (e.g., swaps, rebalances) for bookkeeping.
-
-        Args:
-            wallet_address: Strategy wallet address
-            operation_data: Operation model (SWAP, LEND, BORROW, etc.)
-            usd_value: USD value of the operation
-            strategy_name: Name of the strategy performing the operation
-
-        Returns:
-            Tuple of (success, data) where data is operation record or error message
-        """
         try:
             result = await self.ledger_client.add_strategy_operation(
                 wallet_address=wallet_address,
@@ -211,16 +130,6 @@ class LedgerAdapter(BaseAdapter):
     async def get_transaction_summary(
         self, wallet_address: str, limit: int = 10
     ) -> tuple[bool, Any]:
-        """
-        Get a summary of recent strategy transactions.
-
-        Args:
-            wallet_address: Strategy wallet address
-            limit: Number of recent transactions to include
-
-        Returns:
-            Tuple of (success, data) where data is transaction summary or error message
-        """
         try:
             success, transactions_data = await self.get_strategy_transactions(
                 wallet_address=wallet_address, limit=limit
@@ -231,7 +140,6 @@ class LedgerAdapter(BaseAdapter):
 
             transactions = transactions_data.get("transactions", [])
 
-            # Create summary
             summary = {
                 "total_transactions": len(transactions),
                 "recent_transactions": transactions[:limit],
@@ -260,20 +168,6 @@ class LedgerAdapter(BaseAdapter):
     async def record_strategy_snapshot(
         self, wallet_address: str, strategy_status: StatusDict
     ) -> tuple[bool, None | str]:
-        """
-        Record a strategy snapshot with current state.
-
-        Args:
-            wallet_address: Strategy wallet address
-            strat_portfolio_value: Current portfolio value
-            net_deposit: Net deposit amount
-            strategy_status: Current strategy status dictionary
-            gas_available: Available gas amount
-            gassed_up: Whether the strategy is gassed up
-
-        Returns:
-            Tuple of (success, None) on success or (False, error_message) on failure
-        """
         try:
             await self.ledger_client.strategy_snapshot(
                 wallet_address=wallet_address,

wayfinder_paths/adapters/ledger_adapter/test_adapter.py

@@ -6,24 +6,19 @@ from wayfinder_paths.adapters.ledger_adapter.adapter import LedgerAdapter
 
 
 class TestLedgerAdapter:
-    """Test cases for LedgerAdapter"""
-
     @pytest.fixture
     def mock_ledger_client(self):
-        """Mock LedgerClient for testing"""
         mock_client = AsyncMock()
         return mock_client
 
     @pytest.fixture
     def adapter(self, mock_ledger_client):
-        """Create a LedgerAdapter instance with mocked client for testing"""
         adapter = LedgerAdapter()
         adapter.ledger_client = mock_ledger_client
         return adapter
 
     @pytest.mark.asyncio
     async def test_get_strategy_transactions_success(self, adapter, mock_ledger_client):
-        """Test successful strategy transaction retrieval"""
         mock_response = {
             "transactions": [
                 {
@@ -55,7 +50,6 @@ class TestLedgerAdapter:
 
     @pytest.mark.asyncio
     async def test_get_strategy_transactions_failure(self, adapter, mock_ledger_client):
-        """Test strategy transaction retrieval failure"""
         mock_ledger_client.get_strategy_transactions = AsyncMock(
             side_effect=Exception("API Error")
         )
@@ -69,7 +63,6 @@ class TestLedgerAdapter:
 
     @pytest.mark.asyncio
     async def test_get_strategy_net_deposit_success(self, adapter, mock_ledger_client):
-        """Test successful strategy net deposit retrieval"""
         mock_response = {
             "net_deposit": "1000.00",
             "total_deposits": "1500.00",
@@ -92,7 +85,6 @@ class TestLedgerAdapter:
 
     @pytest.mark.asyncio
     async def test_record_deposit_success(self, adapter, mock_ledger_client):
-        """Test successful deposit recording"""
         mock_response = {
             "transaction_id": "tx_456",
             "status": "recorded",
@@ -124,7 +116,6 @@ class TestLedgerAdapter:
 
     @pytest.mark.asyncio
     async def test_record_withdrawal_success(self, adapter, mock_ledger_client):
-        """Test successful withdrawal recording"""
         mock_response = {
             "transaction_id": "tx_789",
             "status": "recorded",
@@ -147,7 +138,6 @@ class TestLedgerAdapter:
 
     @pytest.mark.asyncio
     async def test_record_operation_success(self, adapter, mock_ledger_client):
-        """Test successful operation recording"""
         from wayfinder_paths.core.adapters.models import SWAP
 
         mock_response = {
@@ -182,7 +172,6 @@ class TestLedgerAdapter:
 
     @pytest.mark.asyncio
     async def test_get_transaction_summary_success(self, adapter, mock_ledger_client):
-        """Test successful transaction summary generation"""
         mock_transactions = {
             "transactions": [
                 {"operation": "DEPOSIT", "amount": "1000000000000000000"},
@@ -204,5 +193,4 @@ class TestLedgerAdapter:
         assert data["operations"]["operations"] == 1
 
     def test_adapter_type(self, adapter):
-        """Test adapter has adapter_type"""
         assert adapter.adapter_type == "LEDGER"

wayfinder_paths/adapters/moonwell_adapter/README.md

@@ -1,90 +1,109 @@
 # Moonwell Adapter
 
-Adapter for interacting with the [Moonwell](https://moonwell.fi/) lending protocol on Base chain.
+Adapter for the [Moonwell](https://moonwell.fi/) lending protocol on Base.
 
-- Entrypoint: `adapters.moonwell_adapter.adapter.MoonwellAdapter`
-- Tests: `test_adapter.py`
-
-## Capabilities
-
-The adapter provides the following capabilities:
-
-- Lending: Supply and withdraw tokens
-- Borrowing: Borrow and repay tokens
-- Collateral management: Enable/disable markets as collateral
-- Rewards: Claim WELL token rewards
-- Position & market queries: Get balances, APYs, and liquidity info
+- **Type**: `MOONWELL`
+- **Module**: `wayfinder_paths.adapters.moonwell_adapter.adapter.MoonwellAdapter`
 
 ## Overview
 
-The MoonwellAdapter provides functionality for:
-
-- **Lending**: Supply tokens to earn yield
-- **Borrowing**: Borrow against collateral
-- **Collateral Management**: Enable/disable markets as collateral
-- **Rewards**: Claim WELL token rewards
-- **Position Queries**: Get balances, APYs, and liquidity info
+The MoonwellAdapter provides:
+- Lending (supply/withdraw)
+- Borrowing (borrow/repay)
+- Collateral management
+- WELL rewards claiming
+- Position and market queries
 
-## Supported Markets (Base Chain)
+## Supported Markets (Base)
 
-| Token  | mToken Address                               | Underlying Address                           |
-| ------ | -------------------------------------------- | -------------------------------------------- |
-| USDC   | `0xEdc817A28E8B93B03976FBd4a3dDBc9f7D176c22` | `0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913` |
-| WETH   | `0x628ff693426583D9a7FB391E54366292F509D457` | `0x4200000000000000000000000000000000000006` |
+| Token | mToken Address | Underlying Address |
+|-------|----------------|-------------------|
+| USDC | `0xEdc817A28E8B93B03976FBd4a3dDBc9f7D176c22` | `0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913` |
+| WETH | `0x628ff693426583D9a7FB391E54366292F509D457` | `0x4200000000000000000000000000000000000006` |
 | wstETH | `0x627Fe393Bc6EdDA28e99AE648fD6fF362514304b` | `0xc1CBa3fCea344f92D9239c08C0568f6F2F0ee452` |
 
-## Protocol Addresses (Base Chain)
+## Protocol Addresses (Base)
 
 - **Comptroller**: `0xfbb21d0380bee3312b33c4353c8936a0f13ef26c`
 - **Reward Distributor**: `0xe9005b078701e2a0948d2eac43010d35870ad9d2`
 - **WELL Token**: `0xA88594D404727625A9437C3f886C7643872296AE`
 
-## Construction
+## Usage
 
 ```python
 from wayfinder_paths.adapters.moonwell_adapter import MoonwellAdapter
 
 config = {
-    "strategy_wallet": {"address": "0x...your_wallet..."},
+    "strategy_wallet": {"address": "0x..."},
     "moonwell_adapter": {
-        "chain_id": 8453,  # Base chain (default)
+        "chain_id": 8453,
     }
 }
 adapter = MoonwellAdapter(config=config)
 ```
 
-## Usage
+## Methods
+
+### Lending
 
 ```python
 # Supply tokens
 await adapter.lend(
-    mtoken="0xEdc817A28E8B93B03976FBd4a3dDBc9f7D176c22",  # mUSDC
-    underlying_token="0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",  # USDC
-    amount=1000 * 10**6,  # 1000 USDC
+    mtoken="0xEdc817A28E8B93B03976FBd4a3dDBc9f7D176c22",
+    underlying_token="0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
+    amount=1000 * 10**6,
 )
 
-# Enable as collateral
-await adapter.set_collateral(
-    mtoken="0x627Fe393Bc6EdDA28e99AE648fD6fF362514304b",  # mwstETH
+# Withdraw tokens
+await adapter.unlend(
+    mtoken="0xEdc817A28E8B93B03976FBd4a3dDBc9f7D176c22",
+    amount=500 * 10**6,
 )
+```
+
+### Borrowing
 
+```python
 # Borrow
 await adapter.borrow(
-    mtoken="0x628ff693426583D9a7FB391E54366292F509D457",  # mWETH
+    mtoken="0x628ff693426583D9a7FB391E54366292F509D457",
     amount=10**17,  # 0.1 WETH
 )
 
-# Get position info
+# Repay
+await adapter.repay(
+    mtoken="0x628ff693426583D9a7FB391E54366292F509D457",
+    underlying_token="0x4200000000000000000000000000000000000006",
+    amount=10**17,
+)
+```
+
+### Collateral Management
+
+```python
+# Enable as collateral
+await adapter.set_collateral(
+    mtoken="0x627Fe393Bc6EdDA28e99AE648fD6fF362514304b",
+)
+
+# Disable collateral
+await adapter.remove_collateral(
+    mtoken="0x627Fe393Bc6EdDA28e99AE648fD6fF362514304b",
+)
+```
+
+### Position Queries
+
+```python
+# Get position data
 success, position = await adapter.get_pos(
     mtoken="0xEdc817A28E8B93B03976FBd4a3dDBc9f7D176c22",
 )
-# Returns: {mtoken_balance, underlying_balance, borrow_balance, exchange_rate, balances}
 
 # Get collateral factor
 success, cf = await adapter.get_collateral_factor(
     mtoken="0x627Fe393Bc6EdDA28e99AE648fD6fF362514304b",
 )
-# Returns: 0.75 (75% LTV)
 
 # Get APY
 success, apy = await adapter.get_apy(
@@ -92,81 +111,23 @@ success, apy = await adapter.get_apy(
     apy_type="supply",  # or "borrow"
 )
 
-# Claim rewards
-await adapter.claim_rewards()
+# Get max borrowable
+success, amount = await adapter.get_borrowable_amount(account="0x...")
 ```
 
-## API Reference
-
-### Lending Operations
-
-| Method                                   | Description                   |
-| ---------------------------------------- | ----------------------------- |
-| `lend(mtoken, underlying_token, amount)` | Supply tokens to earn yield   |
-| `unlend(mtoken, amount)`                 | Withdraw by redeeming mTokens |
-
-### Borrowing Operations
-
-| Method                                    | Description              |
-| ----------------------------------------- | ------------------------ |
-| `borrow(mtoken, amount)`                  | Borrow underlying tokens |
-| `repay(mtoken, underlying_token, amount)` | Repay borrowed tokens    |
-
-### Collateral Management
-
-| Method                      | Description                                |
-| --------------------------- | ------------------------------------------ |
-| `set_collateral(mtoken)`    | Enable market as collateral (enterMarkets) |
-| `remove_collateral(mtoken)` | Disable market as collateral (exitMarket)  |
-
-### Position & Market Data
-
-| Method                                     | Description                                        |
-| ------------------------------------------ | -------------------------------------------------- |
-| `get_pos(mtoken, account)`                 | Get position data (balances, debt, rewards)        |
-| `get_collateral_factor(mtoken)`            | Get collateral factor (LTV)                        |
-| `get_apy(mtoken, apy_type)`                | Get supply or borrow APY                           |
-| `get_borrowable_amount(account)`           | Get max borrowable in USD                          |
-| `max_withdrawable_mtoken(mtoken, account)` | Calculate safe withdrawal amount via binary search |
-
 ### Rewards
 
-| Method                           | Description                                   |
-| -------------------------------- | --------------------------------------------- |
-| `claim_rewards(min_rewards_usd)` | Claim WELL rewards (skips if below threshold) |
-
-### Utilities
+```python
+# Claim WELL rewards
+await adapter.claim_rewards(min_rewards_usd=1.0)
+```
 
-| Method             | Description      |
-| ------------------ | ---------------- |
-| `wrap_eth(amount)` | Wrap ETH to WETH |
+## Return Format
 
-All methods return `(success: bool, payload: Any)` tuples. On failure the payload is an error string.
+All methods return `(success: bool, data: Any)` tuples.
 
 ## Testing
 
 ```bash
 poetry run pytest wayfinder_paths/adapters/moonwell_adapter/ -v
 ```
-
-## Configuration
-
-The adapter can be configured via the `moonwell_adapter` config key:
-
-```python
-config = {
-    "strategy_wallet": {"address": "0x..."},
-    "moonwell_adapter": {
-        "chain_id": 8453,  # Chain ID (default: Base)
-        "comptroller": "0x...",  # Override comptroller address
-        "reward_distributor": "0x...",  # Override reward distributor
-        "m_usdc": "0x...",  # Override mUSDC address
-        "m_weth": "0x...",  # Override mWETH address
-        "m_wsteth": "0x...",  # Override mwstETH address
-    }
-}
-```
-
-## Error handling
-
-Any exception raised by the underlying web3 calls is caught and returned as a `(False, "message")` tuple. The inherited `health_check()` method reports adapter status, making it safe to call from `Strategy.health_check`.

wayfinder_paths/adapters/moonwell_adapter/__init__.py

@@ -1,7 +1,3 @@
-"""
-Moonwell Adapter
-"""
-
 from wayfinder_paths.adapters.moonwell_adapter.adapter import MoonwellAdapter
 
 __all__ = ["MoonwellAdapter"]