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

wayfinder_paths/adapters/brap_adapter/README.md

@@ -5,118 +5,65 @@ Adapter for cross-chain swaps and bridges via the BRAP (Bridge/Router/Adapter Pr
 - **Type**: `BRAP`
 - **Module**: `wayfinder_paths.adapters.brap_adapter.adapter.BRAPAdapter`
 
-## Overview
-
-The BRAPAdapter provides:
-- Cross-chain swap quotes
-- Bridge operation quotes
-- Route comparison and optimization
-- Fee calculations
-- Swap execution
-
 ## Usage
 
 ```python
 from wayfinder_paths.adapters.brap_adapter.adapter import BRAPAdapter
 
-adapter = BRAPAdapter()
+adapter = BRAPAdapter(strategy_wallet_signing_callback=signing_callback)
 ```
 
 ## Methods
 
-### get_swap_quote
-
-Get quotes for a cross-chain swap.
-
-```python
-success, data = await adapter.get_swap_quote(
-    from_token_address="0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
-    to_token_address="0x...",
-    from_chain_id=8453,
-    to_chain_id=1,
-    from_address="0x...",
-    to_address="0x...",
-    amount="1000000000",  # Raw amount
-    slippage=0.01,        # 1%
-)
-if success:
-    best_quote = data.get("quotes", {}).get("best_quote", {})
-    print(f"Output: {best_quote.get('output_amount')}")
-```
-
-### get_best_quote
+### best_quote
 
 Get the best quote for a swap.
 
 ```python
-success, data = await adapter.get_best_quote(
+success, quote = await adapter.best_quote(
     from_token_address="0x...",
     to_token_address="0x...",
     from_chain_id=8453,
     to_chain_id=1,
     from_address="0x...",
-    to_address="0x...",
-    amount="1000000000",
-)
-```
-
-### compare_routes
-
-Compare available routes for a swap.
-
-```python
-success, data = await adapter.compare_routes(
-    from_token_address="0x...",
-    to_token_address="0x...",
-    from_chain_id=8453,
-    to_chain_id=1,
     amount="1000000000",
+    preferred_providers=["enso"],  # optional
 )
 if success:
-    print(f"Total routes: {data.get('total_routes')}")
-    for route in data.get("all_routes", []):
-        print(f"Output: {route.get('output_amount')}, Fee: {route.get('total_fee')}")
+    print(f"Output: {quote.get('output_amount')}")
 ```
 
-### calculate_swap_fees
+### swap_from_token_ids
 
-Calculate fees for a swap operation.
+Execute a swap using token IDs.
 
 ```python
-success, data = await adapter.calculate_swap_fees(
-    from_token_address="0x...",
-    to_token_address="0x...",
-    from_chain_id=8453,
-    to_chain_id=1,
+success, result = await adapter.swap_from_token_ids(
+    from_token_id="usd-coin-base",
+    to_token_id="ethereum",
+    from_address="0x...",
     amount="1000000000",
-    slippage=0.01,
+    strategy_name="my_strategy",
+    preferred_providers=["enso"],
 )
 if success:
-    print(f"Gas fee: {data.get('gas_fee')}")
-    print(f"Bridge fee: {data.get('bridge_fee')}")
-    print(f"Total fee: {data.get('total_fee')}")
+    print(f"TX: {result.get('tx_hash')}")
 ```
 
-### validate_swap_parameters
+### swap_from_quote
 
-Validate swap parameters before execution.
+Execute a swap from a pre-fetched quote.
 
 ```python
-success, data = await adapter.validate_swap_parameters(
-    from_token_address="0x...",
-    to_token_address="0x...",
-    from_chain_id=8453,
-    to_chain_id=1,
-    amount="1000000000",
+success, result = await adapter.swap_from_quote(
+    from_token=from_token_info,
+    to_token=to_token_info,
+    from_address="0x...",
+    quote=quote,
+    strategy_name="my_strategy",
 )
-if success and data.get("valid"):
-    print("Parameters are valid")
 ```
 
-## Dependencies
-
-- `BRAPClient` - Low-level API client
-
 ## Testing
 
 ```bash