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

wayfinder_paths/abis/generic/erc20.json

@@ -0,0 +1,383 @@
+[
+    {
+        "constant": true,
+        "inputs": [
+            {
+                "name": "owner",
+                "type": "address"
+            },
+            {
+                "name": "spender",
+                "type": "address"
+            }
+        ],
+        "name": "allowance",
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ],
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [
+            {
+                "name": "account",
+                "type": "address"
+            }
+        ],
+        "name": "balanceOf",
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint256"
+            }
+        ],
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [],
+        "name": "decimals",
+        "outputs": [
+            {
+                "name": "",
+                "type": "uint8"
+            }
+        ],
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [],
+        "name": "name",
+        "outputs": [
+            {
+                "name": "",
+                "type": "string"
+            }
+        ],
+        "type": "function"
+    },
+    {
+        "constant": true,
+        "inputs": [],
+        "name": "symbol",
+        "outputs": [
+            {
+                "name": "",
+                "type": "string"
+            }
+        ],
+        "type": "function"
+    },
+    {
+        "constant": false,
+        "inputs": [
+            {
+                "name": "recipient",
+                "type": "address"
+            },
+            {
+                "name": "amount",
+                "type": "uint256"
+            }
+        ],
+        "name": "transfer",
+        "outputs": [
+            {
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "type": "function"
+    },
+    {
+        "constant": false,
+        "inputs": [
+            {
+                "name": "spender",
+                "type": "address"
+            },
+            {
+                "name": "amount",
+                "type": "uint256"
+            }
+        ],
+        "name": "approve",
+        "outputs": [
+            {
+                "name": "",
+                "type": "bool"
+            }
+        ],
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "address",
+                "name": "tokenA",
+                "type": "address"
+            },
+            {
+                "internalType": "address",
+                "name": "tokenB",
+                "type": "address"
+            },
+            {
+                "internalType": "bool",
+                "name": "stable",
+                "type": "bool"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountADesired",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountBDesired",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountAMin",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountBMin",
+                "type": "uint256"
+            },
+            {
+                "internalType": "address",
+                "name": "to",
+                "type": "address"
+            },
+            {
+                "internalType": "uint256",
+                "name": "deadline",
+                "type": "uint256"
+            }
+        ],
+        "name": "addLiquidity",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "amountA",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountB",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "liquidity",
+                "type": "uint256"
+            }
+        ],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "address",
+                "name": "tokenA",
+                "type": "address"
+            },
+            {
+                "internalType": "address",
+                "name": "tokenB",
+                "type": "address"
+            },
+            {
+                "internalType": "bool",
+                "name": "stable",
+                "type": "bool"
+            },
+            {
+                "internalType": "address",
+                "name": "_factory",
+                "type": "address"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountADesired",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountBDesired",
+                "type": "uint256"
+            }
+        ],
+        "name": "quoteAddLiquidity",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "amountA",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountB",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "liquidity",
+                "type": "uint256"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [],
+        "name": "defaultFactory",
+        "outputs": [
+            {
+                "internalType": "address",
+                "name": "",
+                "type": "address"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "address",
+                "name": "tokenA",
+                "type": "address"
+            },
+            {
+                "internalType": "address",
+                "name": "tokenB",
+                "type": "address"
+            },
+            {
+                "internalType": "bool",
+                "name": "stable",
+                "type": "bool"
+            },
+            {
+                "internalType": "address",
+                "name": "_factory",
+                "type": "address"
+            },
+            {
+                "internalType": "uint256",
+                "name": "liquidity",
+                "type": "uint256"
+            }
+        ],
+        "name": "quoteRemoveLiquidity",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "amountA",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountB",
+                "type": "uint256"
+            }
+        ],
+        "stateMutability": "view",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "address",
+                "name": "tokenA",
+                "type": "address"
+            },
+            {
+                "internalType": "address",
+                "name": "tokenB",
+                "type": "address"
+            },
+            {
+                "internalType": "bool",
+                "name": "stable",
+                "type": "bool"
+            },
+            {
+                "internalType": "uint256",
+                "name": "liquidity",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountAMin",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountBMin",
+                "type": "uint256"
+            },
+            {
+                "internalType": "address",
+                "name": "to",
+                "type": "address"
+            },
+            {
+                "internalType": "uint256",
+                "name": "deadline",
+                "type": "uint256"
+            }
+        ],
+        "name": "removeLiquidity",
+        "outputs": [
+            {
+                "internalType": "uint256",
+                "name": "amountA",
+                "type": "uint256"
+            },
+            {
+                "internalType": "uint256",
+                "name": "amountB",
+                "type": "uint256"
+            }
+        ],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "uint256",
+                "name": "_amount",
+                "type": "uint256"
+            }
+        ],
+        "name": "deposit",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    },
+    {
+        "inputs": [
+            {
+                "internalType": "uint256",
+                "name": "_shares",
+                "type": "uint256"
+            }
+        ],
+        "name": "withdraw",
+        "outputs": [],
+        "stateMutability": "nonpayable",
+        "type": "function"
+    }
+]

wayfinder_paths/core/strategies/Strategy.py

@@ -6,6 +6,7 @@ from typing import Any, TypedDict
 from loguru import logger
 
 from wayfinder_paths.core.services.base import Web3Service
+from wayfinder_paths.core.strategies.descriptors import StratDescriptor
 
 
 class StatusDict(TypedDict):
@@ -19,8 +20,7 @@ StatusTuple = tuple[bool, str]
 
 class Strategy(ABC):
     name: str = None
-    description: str = None
-    summary: str = None
+    INFO: StratDescriptor = None
 
     def __init__(
         self,
@@ -90,7 +90,7 @@ class Strategy(ABC):
         pass
 
     @staticmethod
-    def policies() -> list[str]:
+    async def policies() -> list[str]:
         """Return policy strings for this strategy (Django-compatible)."""
         raise NotImplementedError
 

wayfinder_paths/core/strategies/descriptors.py

@@ -0,0 +1,80 @@
+from enum import Enum
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class Volatility(Enum):
+    LOW = "low"
+    MEDIUM = "medium"
+    HIGH = "high"
+
+
+class Frequency(Enum):
+    LOW = "low"
+    MEDIUM = "medium"
+    HIGH = "high"
+
+
+class Directionality(Enum):
+    LONG = "Long"
+    SHORT = "Short"
+    MARKET_NEUTRAL = "market_neutral"
+    DELTA_NEUTRAL = "delta_neutral"
+
+
+class Complexity(Enum):
+    LOW = "low"
+    MEDIUM = "medium"
+    HIGH = "high"
+
+
+class TokenExposure(Enum):
+    STABLECOINS = "Stablecoins"
+    MAJORS = "Majors"
+    ALTS = "Alts"
+
+
+# Default token rewards for all strategies
+DEFAULT_TOKEN_REWARDS = [
+    {
+        "symbol": "B3",
+        "name": "B3",
+        "address": "0xB3B3B3B3B3B3B3B3B3B3B3B3B3B3B3B3B3B3B3B3",
+        "image_url": "https://storage.googleapis.com/prod-wayfinder-app-assets/asset-icons/B3.png",
+    },
+]
+
+
+class StratDescriptor(BaseModel):
+    description: str
+
+    summary: str
+
+    gas_token_symbol: str
+    gas_token_id: str
+    deposit_token_id: str
+    minimum_net_deposit: float
+    gas_maximum: float
+    gas_threshold: float
+
+    available_rewards: dict[str, Any] = {
+        "token_rewards": DEFAULT_TOKEN_REWARDS,
+        "point_rewards": None,
+    }
+
+    # risk indicators
+    volatility: Volatility
+    volatility_description_short: str
+    directionality: Directionality
+    directionality_description: str
+    complexity: Complexity
+    complexity_description: str
+    token_exposure: TokenExposure
+    token_exposure_description: str
+    frequency: Frequency
+    frequency_description: str
+
+    return_drivers: list[str]
+
+    config: dict[str, Any]

wayfinder_paths/core/utils/evm_helpers.py

@@ -5,7 +5,9 @@ This module provides reusable functions for EVM-related operations that are shar
 across multiple adapters, extracted from evm_transaction_adapter.
 """
 
+import json
 import os
+from pathlib import Path
 from typing import Any
 
 from loguru import logger
@@ -163,3 +165,40 @@ def resolve_private_key_for_from_address(
 
     # Fallback to environment variables
     return os.getenv("PRIVATE_KEY_VAULT") or os.getenv("PRIVATE_KEY")
+
+
+async def _get_abi(chain_id: int, address: str) -> str | None:
+    os.makedirs(f"abis/{chain_id}/", exist_ok=True)
+
+    abi_file = f"abis/{chain_id}/{address}.json"
+    if not os.path.exists(abi_file):
+        raise ValueError(
+            f"There is no downloaded ABI for {address} on chain {chain_id} -- please download it to ({abi_file})  (make sure to get the implementation if this address is a proxy)"
+        )
+
+    with open(abi_file) as f:
+        abi = f.read()
+
+    return abi
+
+
+# We filter ABIs for Privy Policy since most of the abi is useless, and we don't wanna upload big ABIs for both size and readability reasons.
+async def get_abi_filtered(
+    chain_id: int, address: str, function_names: list[str]
+) -> list | None:
+    full_abi = await _get_abi(chain_id, address)
+    if full_abi is None:
+        raise Exception("Could not pull ABI, get_abi returned None")
+    abi_json = json.loads(full_abi)
+    filtered_abi = [
+        item
+        for item in abi_json
+        if item.get("type") == "function" and item.get("name") in function_names
+    ]
+    return filtered_abi
+
+
+with open(Path(__file__).parent.parent.parent.joinpath("abis/generic/erc20.json")) as f:
+    erc20_abi_raw = f.read()
+
+ERC20_ABI = json.loads(erc20_abi_raw)

wayfinder_paths/vaults/policies/enso.py

@@ -0,0 +1,17 @@
+from wayfinder_paths.vaults.policies.util import allow_functions
+
+ENSO_ROUTER = "0xf75584ef6673ad213a685a1b58cc0330b8ea22cf"
+
+
+async def enso_swap():
+    return await allow_functions(
+        policy_name="Allow Enso Swap",
+        abi_chain_id=8453,
+        address=ENSO_ROUTER,
+        function_names=[
+            "routeMulti",
+            "routeSingle",
+            "safeRouteMulti",
+            "safeRouteSingle",
+        ],
+    )

wayfinder_paths/vaults/policies/erc20.py

@@ -0,0 +1,34 @@
+from wayfinder_paths.core.utils.evm_helpers import ERC20_ABI
+
+
+def any_erc20_function(token_address: str) -> dict:
+    return {
+        "name": "Allow Any ERC20 Transfer To Address",
+        "method": "eth_signTransaction",
+        "action": "ALLOW",
+        "conditions": [
+            {
+                "field_source": "ethereum_transaction",
+                "field": "to",
+                "operator": "eq",
+                "value": token_address,
+            }
+        ],
+    }
+
+
+def erc20_spender_for_any_token(spender_address: str) -> dict:
+    return {
+        "name": "Allow Any ERC20 Approve To Spender",
+        "method": "eth_signTransaction",
+        "action": "ALLOW",
+        "conditions": [
+            {
+                "field_source": "ethereum_calldata",
+                "field": "approve.spender",
+                "abi": ERC20_ABI,
+                "operator": "eq",
+                "value": spender_address,
+            },
+        ],
+    }

wayfinder_paths/vaults/policies/evm.py

@@ -0,0 +1,21 @@
+def native_transfer(destination_address: str, value: int) -> dict:
+    # TODO THIS FUNCTION IS NOT DONE CAUSE POLICIES DONT KNOW THE WALLET ADDRESS YET.
+    return {
+        "name": "Allow Native Transfer To Address",
+        "method": "eth_signTransaction",
+        "action": "ALLOW",
+        "conditions": [
+            {
+                "field_source": "ethereum_transaction",
+                "field": "to",
+                "operator": "eq",
+                "value": destination_address,
+            },
+            {
+                "field_source": "ethereum_transaction",
+                "field": "value",
+                "operator": "eq",
+                "value": hex(value),
+            },
+        ],
+    }

wayfinder_paths/vaults/policies/hyper_evm.py

@@ -0,0 +1,19 @@
+from wayfinder_paths.vaults.policies.evm import native_transfer
+from wayfinder_paths.vaults.policies.util import allow_functions
+
+WHYPE_TOKEN = "0x5555555555555555555555555555555555555555"
+HYPERCORE_SENTINEL_ADDRESS = "0x2222222222222222222222222222222222222222"
+HYPERCORE_SENTINEL_VALUE = 100_000_000_000
+
+
+def hypecore_sentinel_deposit():
+    return native_transfer(HYPERCORE_SENTINEL_ADDRESS, HYPERCORE_SENTINEL_VALUE)
+
+
+async def whype_deposit_and_withdraw():
+    return await allow_functions(
+        policy_name="Allow WHYPE Deposit and Withdraw",
+        abi_chain_id=999,
+        address=WHYPE_TOKEN,
+        function_names=["deposit", "withdraw"],
+    )

wayfinder_paths/vaults/policies/hyperlend.py

@@ -0,0 +1,12 @@
+from wayfinder_paths.vaults.policies.util import allow_functions
+
+HYPERLEND_POOL = "0x00A89d7a5A02160f20150EbEA7a2b5E4879A1A8b"
+
+
+async def hyperlend_supply_and_withdraw():
+    return await allow_functions(
+        policy_name="Allow Hyperlend Supply and Withdraw",
+        abi_chain_id=999,
+        address=HYPERLEND_POOL,
+        function_names=["supply", "withdraw"],
+    )

wayfinder_paths/vaults/policies/hyperliquid.py

@@ -0,0 +1,30 @@
+def any_hyperliquid_l1_payload():
+    return {
+        "name": "Allow Hypecore L1 Payload",
+        "method": "eth_signTypedData_v4",
+        "action": "ALLOW",
+        "conditions": [
+            {
+                "field": "chainId",
+                "field_source": "ethereum_typed_data_domain",
+                "operator": "eq",
+                "value": "1337",
+            }
+        ],
+    }
+
+
+def any_hyperliquid_user_payload():
+    return {
+        "name": "Allow User Signed Payload",
+        "method": "eth_signTypedData_v4",
+        "action": "ALLOW",
+        "conditions": [
+            {
+                "field": "chainId",
+                "field_source": "ethereum_typed_data_domain",
+                "operator": "eq",
+                "value": "421614",
+            }
+        ],
+    }