wayfinder-paths 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

wayfinder_paths/{vaults/templates → templates}/adapter/README.md

@@ -6,9 +6,9 @@ Adapters expose protocol-specific capabilities to strategies. They should be thi
 
 1. Copy the template:
    ```
-   cp -r wayfinder_paths/vaults/templates/adapter wayfinder_paths/vaults/adapters/my_adapter
+   cp -r wayfinder_paths/templates/adapter wayfinder_paths/adapters/my_adapter
    ```
-2. Rename `MyAdapter` in `adapter.py` and update `manifest.yaml` so the `entrypoint` matches (`vaults.adapters.my_adapter.adapter.MyAdapter`).
+2. Rename `MyAdapter` in `adapter.py` and update `manifest.yaml` so the `entrypoint` matches (`adapters.my_adapter.adapter.MyAdapter`).
 3. Declare the capabilities your adapter will provide and list any client dependencies (e.g., `PoolClient`, `LedgerClient`).
 4. Implement the public methods that fulfill those capabilities.
 
@@ -63,7 +63,7 @@ Every adapter needs a manifest describing its import path, declared capabilities
 
 ```yaml
 schema_version: "0.1"
-entrypoint: "vaults.adapters.my_adapter.adapter.MyAdapter"
+entrypoint: "adapters.my_adapter.adapter.MyAdapter"
 capabilities:
   - "pool.read"
 dependencies:
@@ -80,13 +80,13 @@ The `dependencies` list is informational today but helps reviewers understand wh
 import pytest
 from unittest.mock import AsyncMock, patch
 
-from wayfinder_paths.vaults.adapters.my_adapter.adapter import MyAdapter
+from wayfinder_paths.adapters.my_adapter.adapter import MyAdapter
 
 
 @pytest.mark.asyncio
 async def test_get_pools():
     with patch(
-        "wayfinder_paths.vaults.adapters.my_adapter.adapter.PoolClient",
+        "wayfinder_paths.adapters.my_adapter.adapter.PoolClient",
         return_value=AsyncMock(
             get_pools_by_ids=AsyncMock(return_value={"pools": []})
         ),

wayfinder_paths/{vaults/templates → templates}/adapter/manifest.yaml

@@ -1,5 +1,5 @@
 schema_version: "0.1"
-entrypoint: "vaults.adapters.my_adapter.adapter.MyAdapter"
+entrypoint: "adapters.my_adapter.adapter.MyAdapter"
 capabilities:
   - "example.op"
 dependencies:

wayfinder_paths/{vaults/templates → templates}/adapter/test_adapter.py

@@ -4,7 +4,7 @@ Quick setup:
 1. Replace MyAdapter with your actual adapter class name
 2. Implement test_basic_functionality with your adapter's core methods
 3. Add client mocking if your adapter uses external clients
-4. Run: pytest vaults/adapters/your_adapter/ -v
+4. Run: pytest wayfinder_paths/adapters/your_adapter/ -v
 
 Note: examples.json is optional for adapters (not required).
 """

wayfinder_paths/{vaults/templates → templates}/strategy/README.md

@@ -1,14 +1,14 @@
 # Strategy Template
 
-This template provides the scaffolding for a new vault strategy. It mirrors the structure in `wayfinder_paths/vaults/strategies/...` and wires into the runner via a manifest.
+This template provides the scaffolding for a new strategy. It mirrors the structure in `wayfinder_paths/strategies/...` and wires into the runner via a manifest.
 
 ## Quick Start
 
 1. Copy the template to a new folder:
    ```
-   cp -r wayfinder_paths/vaults/templates/strategy wayfinder_paths/vaults/strategies/my_strategy
+   cp -r wayfinder_paths/templates/strategy wayfinder_paths/strategies/my_strategy
    ```
-2. Rename the class in `strategy.py` and update `manifest.yaml` so `entrypoint` points to your new module (for example `vaults.strategies.my_strategy.strategy.MyStrategy`).
+2. Rename the class in `strategy.py` and update `manifest.yaml` so `entrypoint` points to your new module (for example `strategies.my_strategy.strategy.MyStrategy`).
 3. Fill out `examples.json` with sample CLI invocations and `test_strategy.py` with at least one smoke test.
 4. Implement the required strategy methods (`deposit`, `update`, `_status`, optionally override `withdraw`).
 
@@ -27,7 +27,7 @@ my_strategy/
 
 ```python
 async def deposit(self, main_token_amount: float, gas_token_amount: float) -> StatusTuple:
-    """Move funds from the main wallet into the vault wallet and prepare on-chain positions."""
+    """Move funds from the main wallet into the strategy wallet and prepare on-chain positions."""
 
 async def update(self) -> StatusTuple:
     """Periodic rebalance/update loop."""
@@ -49,7 +49,7 @@ Strategies typically:
 ```python
 from wayfinder_paths.core.services.web3_service import DefaultWeb3Service
 from wayfinder_paths.core.strategies.Strategy import StatusDict, StatusTuple, Strategy
-from wayfinder_paths.vaults.adapters.balance_adapter.adapter import BalanceAdapter
+from wayfinder_paths.adapters.balance_adapter.adapter import BalanceAdapter
 
 
 class MyStrategy(Strategy):
@@ -89,7 +89,7 @@ class MyStrategy(Strategy):
         """Surface state back to run_strategy.py."""
         success, balance = await self.balance_adapter.get_balance(
             token_id=self.config.get("token_id"),
-            wallet_address=self.config.get("vault_wallet", {}).get("address"),
+            wallet_address=self.config.get("strategy_wallet", {}).get("address"),
         )
         return {
             "portfolio_value": float(balance or 0),
@@ -104,7 +104,7 @@ Your `manifest.yaml` should define:
 
 ```yaml
 schema_version: "0.1"
-entrypoint: "vaults.strategies.my_strategy.strategy.MyStrategy"
+entrypoint: "strategies.my_strategy.strategy.MyStrategy"
 permissions:
   policy: "(wallet.id == 'FORMAT_WALLET_ID') && (eth.tx.to == '0x...')"
 adapters:
@@ -120,7 +120,7 @@ adapters:
 
 ```python
 import pytest
-from wayfinder_paths.vaults.strategies.my_strategy.strategy import MyStrategy
+from wayfinder_paths.strategies.my_strategy.strategy import MyStrategy
 
 
 @pytest.mark.asyncio
@@ -135,7 +135,8 @@ async def test_status_shape():
 ```bash
 # Install dependencies & create wallets first
 poetry install
-poetry run python wayfinder_paths/scripts/make_wallets.py --default --vault
+# Creates a main wallet (or use 'just create-strategy' which auto-creates wallets)
+poetry run python wayfinder_paths/scripts/make_wallets.py -n 1
 
 # Copy config and edit credentials
 cp wayfinder_paths/config.example.json config.json

wayfinder_paths/{vaults/templates → templates}/strategy/manifest.yaml

@@ -1,5 +1,5 @@
 schema_version: "0.1"
-entrypoint: "vaults.strategies.my_strategy.strategy.MyStrategy"
+entrypoint: "strategies.my_strategy.strategy.MyStrategy"
 name: "my_strategy"  # Unique name for this strategy instance (used for wallet lookup)
 permissions:
   policy: "(wallet.id == 'FORMAT_WALLET_ID')"

wayfinder_paths/{vaults/templates → templates}/strategy/test_strategy.py

@@ -7,14 +7,14 @@ Quick setup:
 1. Replace MyStrategy with your strategy class name
 2. Create examples.json with a 'smoke' example (see TESTING.md)
 3. Add mocking if your strategy uses adapters
-4. Run: pytest vaults/strategies/your_strategy/ -v
+4. Run: pytest wayfinder_paths/strategies/your_strategy/ -v
 """
 
 import sys
 from pathlib import Path
 
 # TODO: Replace MyStrategy with your actual strategy class name
-from wayfinder_paths.vaults.strategies.your_strategy.strategy import (
+from wayfinder_paths.strategies.your_strategy.strategy import (
     MyStrategy,  # noqa: E402
 )
 
@@ -51,13 +51,13 @@ def strategy():
     """Create a strategy instance for testing with minimal config."""
     mock_config = {
         "main_wallet": {"address": "0x1234567890123456789012345678901234567890"},
-        "vault_wallet": {"address": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd"},
+        "strategy_wallet": {"address": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd"},
     }
 
     s = MyStrategy(
         config=mock_config,
         main_wallet=mock_config["main_wallet"],
-        vault_wallet=mock_config["vault_wallet"],
+        strategy_wallet=mock_config["strategy_wallet"],
         simulation=True,
     )
 
@@ -96,19 +96,19 @@ def strategy():
 
     # Example for transaction adapters:
     # if hasattr(s, "tx_adapter") and s.tx_adapter:
-    #     s.tx_adapter.move_from_main_wallet_to_vault_wallet = AsyncMock(
+    #     s.tx_adapter.move_from_main_wallet_to_strategy_wallet = AsyncMock(
     #         return_value=(True, "Transfer successful (simulated)")
     #     )
-    #     s.tx_adapter.move_from_vault_wallet_to_main_wallet = AsyncMock(
+    #     s.tx_adapter.move_from_strategy_wallet_to_main_wallet = AsyncMock(
     #         return_value=(True, "Transfer successful (simulated)")
     #     )
 
     # Example for ledger_adapter:
     # if hasattr(s, "ledger_adapter") and s.ledger_adapter:
-    #     s.ledger_adapter.get_vault_net_deposit = AsyncMock(
+    #     s.ledger_adapter.get_strategy_net_deposit = AsyncMock(
     #         return_value=(True, {"net_deposit": 0})
     #     )
-    #     s.ledger_adapter.get_vault_transactions = AsyncMock(
+    #     s.ledger_adapter.get_strategy_transactions = AsyncMock(
     #         return_value=(True, {"transactions": []})
     #     )
 

wayfinder_paths/tests/test_test_coverage.py

@@ -7,7 +7,7 @@ import pytest
 
 def test_all_adapters_have_tests():
     """Verify that all adapters have a test_adapter.py file."""
-    adapters_dir = Path(__file__).parent.parent / "vaults" / "adapters"
+    adapters_dir = Path(__file__).parent.parent / "adapters"
 
     if not adapters_dir.exists():
         pytest.skip("Adapters directory not found")
@@ -36,7 +36,7 @@ def test_all_adapters_have_tests():
 
 def test_all_strategies_have_tests():
     """Verify that all strategies have a test_strategy.py file."""
-    strategies_dir = Path(__file__).parent.parent / "vaults" / "strategies"
+    strategies_dir = Path(__file__).parent.parent / "strategies"
 
     if not strategies_dir.exists():
         pytest.skip("Strategies directory not found")
@@ -65,7 +65,7 @@ def test_all_strategies_have_tests():
 
 def test_all_strategies_have_examples_json():
     """Verify that all strategies have an examples.json file (REQUIRED)."""
-    strategies_dir = Path(__file__).parent.parent / "vaults" / "strategies"
+    strategies_dir = Path(__file__).parent.parent / "strategies"
 
     if not strategies_dir.exists():
         pytest.skip("Strategies directory not found")
@@ -95,7 +95,7 @@ def test_all_strategies_have_examples_json():
 
 def test_strategy_tests_use_examples_json():
     """Verify that strategy test files load examples.json using the shared utility."""
-    strategies_dir = Path(__file__).parent.parent / "vaults" / "strategies"
+    strategies_dir = Path(__file__).parent.parent / "strategies"
 
     if not strategies_dir.exists():
         pytest.skip("Strategies directory not found")
@@ -167,7 +167,7 @@ def test_strategy_tests_use_examples_json():
 
 def test_strategy_examples_have_smoke():
     """Verify that all strategy examples.json files have a 'smoke' entry."""
-    strategies_dir = Path(__file__).parent.parent / "vaults" / "strategies"
+    strategies_dir = Path(__file__).parent.parent / "strategies"
 
     if not strategies_dir.exists():
         pytest.skip("Strategies directory not found")