DeFiPy 1.0.9__py3-none-any.whl

defipy/__init__.py

@@ -0,0 +1,51 @@
+# This file participates in a symbolic cognition substrate.
+
+from defipy.erc import *
+from defipy.math.basic import *
+from defipy.math.interest import *
+from defipy.math.interest.ips import *
+from defipy.math.interest.ips.aggregate import *
+from defipy.math.model import *
+from defipy.math.risk import *
+from defipy.process import *
+from defipy.process.burn import *
+from defipy.process.deposit import *
+from defipy.process.liquidity import *
+from defipy.process.mint import *
+from defipy.process.swap import *
+from defipy.process.join import *
+from defipy.analytics.simulate import *
+from defipy.analytics.risk import *
+from defipy.utils.interfaces import *
+from defipy.utils.data import *
+from defipy.utils.client import *
+from defipy.utils.client.contract import *
+from defipy.utils.tools import *
+from defipy.agents.config import *
+from defipy.agents.data import *
+from defipy.agents import *
+
+from uniswappy.cpt.exchg import *
+from uniswappy.cpt.factory import *
+from uniswappy.cpt.index import *
+from uniswappy.cpt.quote import *
+from uniswappy.cpt.vault import *
+from uniswappy.cpt.wallet import *
+from uniswappy.utils.tools.v3 import *
+
+from stableswappy.quote import *
+from stableswappy.vault import *
+from stableswappy.cst.factory import *
+from stableswappy.cst.exchg import *
+from stableswappy.utils.data import StableswapExchangeData
+
+from balancerpy.quote import *
+from balancerpy.vault import *
+from balancerpy.cwpt.factory import *
+from balancerpy.cwpt.exchg import *
+from balancerpy.enums import *
+from balancerpy.utils.data import BalancerExchangeData
+
+
+
+  

defipy/agents/ImpermanentLossAgent.py

@@ -0,0 +1,182 @@
+# ─────────────────────────────────────────────────────────────────────────────
+# Apache 2.0 License (DeFiPy)
+# ─────────────────────────────────────────────────────────────────────────────
+# Copyright 2023–2025 Ian Moore
+# Email: defipy.devs@gmail.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pydantic import BaseModel
+from web3scout.utils.connect import ConnectW3
+from web3scout.abi.abi_load import ABILoad
+from web3scout.event.process.retrieve_events import RetrieveEvents
+from web3scout.token.fetch.fetch_token import FetchToken
+from .config import ImpermanentLossConfig
+from .data import UniswapPoolData
+from uniswappy import * 
+from web3 import Web3
+
+class ImpermanentLossAgent:
+    def __init__(self, config: ImpermanentLossConfig, verbose: bool = False):
+        self.config = config
+        self.abi = ABILoad(self.config.platform, self.config.abi_name)  # Load ABI here  
+        self.connector = ConnectW3(self.config.provider_url)  # Web3Scout setup
+        self.connector.apply()
+        self.verbose = verbose
+        self.user_position = config.user_position
+        self.exit_percentage = config.exit_percentage
+        self.iLoss = None
+        self.lp_contract = None
+        self.lp_data = None
+        self.lp_state = None
+
+    def init(self):
+        self.lp_contract = self._init_lp_contract()
+        
+        reserves = self.lp_contract.functions.getReserves().call()
+        token0_address = self.lp_contract.functions.token0().call()
+        token1_address = self.lp_contract.functions.token1().call()
+        reserve0 = reserves[0]; reserve1 = reserves[1]
+
+        w3 = self.connector.get_w3()
+        FetchERC20 = FetchToken(w3)
+        TKN0 = FetchERC20.apply(token0_address)
+        TKN1 = FetchERC20.apply(token1_address)
+
+        self.lp_data = UniswapPoolData(TKN0, TKN1, reserves)
+
+    def get_connector(self):
+        return self.connector
+
+    def get_abi(self):
+        return self.abi
+
+    def get_w3(self):
+        return self.connector.get_w3() 
+
+    def get_contract_instance(self):
+        return self.lp_contract
+
+    def get_lp_data(self):
+        return self.lp_data
+
+    def get_iloss(self):
+        return self.iLoss
+
+    def prime_mock_pool(self, start_block, user_nm = None):
+        w3 = self.get_w3() 
+        fetch_tkn = FetchToken(w3)
+        
+        lp_contract = self._init_lp_contract()
+        tkn0_addr = lp_contract.functions.token0().call()
+        tkn1_addr = lp_contract.functions.token1().call()
+        total_supply = lp_contract.functions.totalSupply().call(block_identifier=start_block)
+        reserves = lp_contract.functions.getReserves().call(block_identifier=start_block)
+        
+        # Step 2: Define tokens
+        tkn0 = fetch_tkn.apply(tkn0_addr)
+        tkn1 = fetch_tkn.apply(tkn1_addr)
+        
+        amt0 = fetch_tkn.amt_to_decimal(tkn0, reserves[0])
+        amt1 = fetch_tkn.amt_to_decimal(tkn1, reserves[1])
+        
+        # Step 3:  Initialize factory
+        factory = UniswapFactory("Pool factory", "0x2")
+        
+        # Step 4: Set up exchange data for V2
+        exch_data = UniswapExchangeData(tkn0=tkn0, tkn1=tkn1, symbol="LP", address=self.config.pool_address)
+        
+        # Step 5: Deploy pool
+        self.lp_state = factory.deploy(exch_data)
+        
+        # Step 6: Add initial liquidity
+        join = Join()
+        join.apply(self.lp_state, user_nm, amt0, amt1)
+        self.lp_state.total_supply = total_supply # override total supply
+    
+        return self.lp_state
+
+    def update_mock_pool(self, lp, cur_block):
+        w3 = self.get_w3() 
+        fetch_tkn = FetchToken(w3)
+        
+        lp_contract = self._init_lp_contract()
+        tkn0_addr = lp_contract.functions.token0().call()
+        tkn1_addr = lp_contract.functions.token1().call()
+        total_supply = lp_contract.functions.totalSupply().call(block_identifier=int(cur_block))
+        reserves = lp_contract.functions.getReserves().call(block_identifier=int(cur_block))
+        
+        tkn0 = self.get_lp_data().tkn0
+        tkn1 = self.get_lp_data().tkn1
+        amt0 = fetch_tkn.amt_to_decimal(tkn0, reserves[0])
+        amt1 = fetch_tkn.amt_to_decimal(tkn1, reserves[1])
+        
+        prev_total_supply = lp.total_supply
+        lp.reserve0 = lp.convert_to_machine(amt0)      # override reserve0
+        lp.reserve1 = lp.convert_to_machine(amt1)      # override reserve1
+        lp.total_supply = total_supply                 # override total supply
+        lp.last_liquidity_deposit = abs(prev_total_supply - lp.total_supply)
+
+    def run_batch(self, lp, tkn, user_nm, events: dict):
+        """Process batched Sync events to check TVL and trigger exits."""
+        if not events:
+            print("No Sync events found in range.")
+            return
+        for k in events:
+            block_num = events[k]['blockNumber']
+            self.apply(lp, tkn, user_nm, block_num)
+
+    def apply(self, lp, tkn, user_nm, block_num):
+        """Execute liquidity exit if condition met."""
+        self.update_mock_pool(lp, block_num)
+        if self.check_condition(tkn, self.config.il_threshold):
+            val = self.get_current_position_value(tkn)
+            print(f"Block {block_num}: Value ({tkn.token_name}) = {val}, outside loss threshold {self.config.il_threshold}")
+            return val
+        else:
+            print(f"Block {block_num}: Value threshold condition met for {lp.name} LP")
+            return None
+    
+    def take_mock_position(self, lp, tkn, user_nm, amt):
+        SwapDeposit().apply(lp, tkn, user_nm, amt)
+        self.mock_lp_pos_amt = lp.get_last_liquidity_deposit()
+        self.iLoss = UniswapImpLoss(lp, self.mock_lp_pos_amt)
+        return self.mock_lp_pos_amt
+
+    def get_impermanent_loss(self) -> float:
+        """Calculate impermanent loss percentage based on initial and current reserves."""
+        returns_calc = self.iLoss.apply(fees = True)
+        return returns_calc
+
+    def get_current_position_value(self, tkn) -> float:
+        current_position_value = self.iLoss.current_position_value(tkn)
+        return current_position_value
+
+    def check_condition(self, tkn, threshold):
+        """Check if TVL is below threshold."""
+        position_value = self.get_current_position_value(tkn)
+        return position_value < threshold
+
+    def withdraw_mock_position(self, lp, tkn, user_nm, lp_amt = None):
+        assert self.mock_lp_pos_amt != None, 'TVLBasedLiquidityExitAgent: MOCK_POSITION_UNAVAILABLE' 
+        lp_amt = self.mock_lp_pos_amt if lp_amt == None else lp_amt
+        tkn_amt = LPQuote(False).get_amount_from_lp(lp, tkn0, lp_amt)
+        amount_out = WithdrawSwap().apply(lp, tkn0, user_nm, tkn_amt)
+        return amount_out
+        
+    def _init_lp_contract(self): 
+        pair_address = self.config.pool_address
+        w3 = self.get_w3()       
+        abi_obj = self.get_abi()
+        lp_contract = abi_obj.apply(w3, pair_address)   
+        return lp_contract

defipy/agents/PriceThresholdSwapAgent.py

@@ -0,0 +1,169 @@
+# ─────────────────────────────────────────────────────────────────────────────
+# Apache 2.0 License (DeFiPy)
+# ─────────────────────────────────────────────────────────────────────────────
+# Copyright 2023–2025 Ian Moore
+# Email: defipy.devs@gmail.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from web3scout.event.process.retrieve_events import RetrieveEvents
+from web3scout.utils.connect import ConnectW3
+from web3scout.abi.abi_load import ABILoad
+from web3scout.event.process.retrieve_events import RetrieveEvents
+from web3scout.token.fetch.fetch_token import FetchToken
+from web3scout.enums.event_type_enum import EventTypeEnum as EventType
+from .config import PriceThresholdConfig
+from .data import UniswapPoolData
+from uniswappy import * 
+
+class PriceThresholdSwapAgent:
+    def __init__(self, config: PriceThresholdConfig, verbose: bool = False):
+        self.config = config
+        self.abi = ABILoad(self.config.platform, self.config.abi_name)  # Load ABI here  
+        self.connector = ConnectW3(self.config.provider_url)  # Web3Scout setup
+        self.connector.apply()
+        self.verbose = verbose
+        self.lp_contract = None
+        self.lp_data = None
+        self.lp_state = None
+        
+    def apply(self):
+        self.lp_contract = self._init_lp_contract()
+        
+        reserves = self.lp_contract.functions.getReserves().call()
+        token0_address = self.lp_contract.functions.token0().call()
+        token1_address = self.lp_contract.functions.token1().call()
+        reserve0 = reserves[0]; reserve1 = reserves[1]
+
+        w3 = self.connector.get_w3()
+        FetchERC20 = FetchToken(w3)
+        TKN0 = FetchERC20.apply(token0_address)
+        TKN1 = FetchERC20.apply(token1_address)
+
+        self.lp_data = UniswapPoolData(TKN0, TKN1, reserves)
+
+    def run_batch(self, tkn, events):
+        start_block = events[0]['blockNumber']
+        lp = self.prime_pool_state(start_block, 'user')
+
+        """Fetch batch of Sync events and process sequentially."""
+        if not events:
+            print("No Sync events found in range.")
+            return
+        for k in events:
+            reserve0 = events[k]['args']['reserve0']
+            reserve1 = events[k]['args']['reserve1']
+            block_num = events[k]['blockNumber']
+            event_price = self.calc_price(reserve0, reserve1, tkn1_over_tkn0 = True)
+            self.execute_action(lp, tkn, event_price, block_num)
+    
+    def prime_pool_state(self, start_block, user_nm = None):
+        w3 = self.get_w3() 
+        fetch_tkn = FetchToken(w3)
+        
+        lp_contract = self._init_lp_contract()
+        tkn0_addr = lp_contract.functions.token0().call()
+        tkn1_addr = lp_contract.functions.token1().call()
+        total_supply = lp_contract.functions.totalSupply().call(block_identifier=start_block)
+        reserves = lp_contract.functions.getReserves().call(block_identifier=start_block)
+        
+        # Step 2: Define tokens
+        tkn0 = fetch_tkn.apply(tkn0_addr)
+        tkn1 = fetch_tkn.apply(tkn1_addr)
+        
+        amt0 = fetch_tkn.amt_to_decimal(tkn0, reserves[0])
+        amt1 = fetch_tkn.amt_to_decimal(tkn1, reserves[1])
+        
+        # Step 3:  Initialize factory
+        factory = UniswapFactory("Pool factory", "0x2")
+        
+        # Step 4: Set up exchange data for V2
+        exch_data = UniswapExchangeData(tkn0=tkn0, tkn1=tkn1, symbol="LP", address=self.config.pool_address)
+        
+        # Step 5: Deploy pool
+        self.lp_state = factory.deploy(exch_data)
+        
+        # Step 6: Add initial liquidity
+        join = Join()
+        join.apply(self.lp_state, user_nm, amt0, amt1)
+        self.lp_state.total_supply = total_supply # override total supply
+    
+        return self.lp_state
+
+    def execute_action(self, lp, tkn, price, block_num, tkn1_over_tkn0 = True):
+
+        tkn0 = self.lp_data.tkn0
+        tkn1 = self.lp_data.tkn1
+        
+        """Execute swap if condition met (simulated or live)."""
+        if self.check_condition(block_num = block_num, tkn1_over_tkn0 = tkn1_over_tkn0):
+            try:
+                out = Swap().apply(lp, tkn, "test_action", self.config.swap_amount)  
+                print(f"Block {block_num}: Swapped {self.config.swap_amount} {tkn0.token_name} for {out} {tkn1.token_name}")
+            except Exception as e:
+                print(f"Block {block_number}: Swap failed: {e}")
+
+    def get_token_price(self, tkn1_over_tkn0 = True, block_num = None):
+        
+        if(block_num == None):
+            reserves = self.lp_data.reserves
+        else:
+            lp_contract = self._init_lp_contract()
+            reserves = lp_contract.functions.getReserves().call(block_identifier=block_num)
+            
+        price = self.calc_price(reserves[0], reserves[1], tkn1_over_tkn0)
+    
+        return price
+
+    def calc_price(self, reserve0, reserve1, tkn1_over_tkn0 = True):
+        tkn0 = self.lp_data.tkn0
+        tkn1 = self.lp_data.tkn1
+        tkn0_decimal = tkn0.token_decimal
+        tkn1_decimal = tkn1.token_decimal
+        
+        if(tkn1_over_tkn0):
+            price = (reserve0 / reserve1) * (10 ** (tkn1_decimal - tkn0_decimal))
+            if(self.verbose): print(f"{tkn1.token_name} Price in {tkn0.token_name}: {price}")
+        else:
+            price = (reserve1 / reserve0) * (10 ** (tkn0_decimal - tkn1_decimal))
+            if(self.verbose): print(f"{tkn0.token_name} Price in {tkn1.token_name}: {price}")
+                
+        return price
+    
+    def check_condition(self, threshold = None, tkn1_over_tkn0 = True, block_num = None):
+        self.config.threshold = self.config.threshold if threshold == None else threshold;
+        self.apply()
+        price = self.get_token_price(tkn1_over_tkn0, block_num)
+        return price > self.config.threshold
+
+    def get_connector(self):
+        return self.connector
+
+    def get_abi(self):
+        return self.abi
+
+    def get_w3(self):
+        return self.connector.get_w3() 
+
+    def get_contract_instance(self):
+        return self.lp_contract
+
+    def get_lp_data(self):
+        return self.lp_data
+
+    def _init_lp_contract(self): 
+        pair_address = self.config.pool_address
+        w3 = self.get_w3()       
+        abi_obj = self.get_abi()
+        lp_contract = abi_obj.apply(w3, pair_address)   
+        return lp_contract

defipy/agents/TVLBasedLiquidityExitAgent.py

@@ -0,0 +1,174 @@
+# ─────────────────────────────────────────────────────────────────────────────
+# Apache 2.0 License (DeFiPy)
+# ─────────────────────────────────────────────────────────────────────────────
+# Copyright 2023–2025 Ian Moore
+# Email: defipy.devs@gmail.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from pydantic import BaseModel
+from web3scout.utils.connect import ConnectW3
+from web3scout.abi.abi_load import ABILoad
+from web3scout.event.process.retrieve_events import RetrieveEvents
+from web3scout.token.fetch.fetch_token import FetchToken
+from .config import TVLExitConfig
+from .data import UniswapPoolData
+from uniswappy import * 
+from web3 import Web3
+
+class TVLBasedLiquidityExitAgent:
+    def __init__(self, config: TVLExitConfig, verbose: bool = False):
+        self.config = config
+        self.abi = ABILoad(self.config.platform, self.config.abi_name)  # Load ABI here  
+        self.connector = ConnectW3(self.config.provider_url)  # Web3Scout setup
+        self.connector.apply()
+        self.verbose = verbose
+        self.lp_contract = None
+        self.mock_lp_pos_amt = None
+        self.lp_data = None
+        self.lp_state = None
+
+    def init(self):
+        self.lp_contract = self._init_lp_contract()
+        
+        reserves = self.lp_contract.functions.getReserves().call()
+        token0_address = self.lp_contract.functions.token0().call()
+        token1_address = self.lp_contract.functions.token1().call()
+        reserve0 = reserves[0]; reserve1 = reserves[1]
+
+        w3 = self.connector.get_w3()
+        FetchERC20 = FetchToken(w3)
+        TKN0 = FetchERC20.apply(token0_address)
+        TKN1 = FetchERC20.apply(token1_address)
+
+        self.lp_data = UniswapPoolData(TKN0, TKN1, reserves)
+    
+    def run_batch(self, lp, tkn, user_nm, events: dict):
+        """Process batched Sync events to check TVL and trigger exits."""
+        if not events:
+            print("No Sync events found in range.")
+            return
+        for k in events:
+            block_num = events[k]['blockNumber']
+            self.apply(lp, tkn, user_nm, block_num)
+
+    def apply(self, lp, tkn, user_nm, block_num):
+        """Execute liquidity exit if condition met."""
+        if self.check_condition(lp, tkn, self.config.tvl_threshold, block_num):
+            amount_out = self.withdraw_mock_position(lp, tkn, user_nm)
+            print(f"Block {block_num}: Withdrawing {amount_out} {tkn.token_name} from {lp.name} LP")
+            return amount_out
+        else:
+            print(f"Block {block_num}: TVL threshold condition met for {lp.name} LP")
+            return None
+
+    def check_condition(self, lp, tkn, threshold, block_num = None):
+        """Check if TVL is below threshold."""
+        block_num = self.get_w3().eth.block_number if block_num == None else block_num
+        tvl = self.get_pool_tvl(lp, tkn, block_num)
+        return tvl < threshold
+
+    def get_pool_tvl(self, lp, tkn, block_num):
+        """Calculate TVL from reserves (sum in USD, assuming base_token normalization)."""
+        lp = self.update_mock_pool(lp, block_num)
+        tot_lp = lp.get_liquidity()
+        tvl = LPQuote(False).get_amount_from_lp(lp, tkn, tot_lp)
+        return tvl
+
+    def take_mock_position(self, lp, tkn, user_nm, amt):
+        SwapDeposit().apply(lp, tkn, user_nm, amt)
+        self.mock_lp_pos_amt = lp.get_last_liquidity_deposit()
+        return self.mock_lp_pos_amt
+
+    def withdraw_mock_position(self, lp, tkn, user_nm, lp_amt = None):
+        assert self.mock_lp_pos_amt != None, 'TVLBasedLiquidityExitAgent: MOCK_POSITION_UNAVAILABLE' 
+        lp_amt = self.mock_lp_pos_amt if lp_amt == None else lp_amt
+        tkn_amt = LPQuote(False).get_amount_from_lp(lp, tkn0, lp_amt)
+        amount_out = WithdrawSwap().apply(lp, tkn0, user_nm, tkn_amt)
+        return amount_out
+    
+    def update_mock_pool(self, lp, cur_block):
+        w3 = self.get_w3() 
+        fetch_tkn = FetchToken(w3)
+        
+        lp_contract = self._init_lp_contract()
+        tkn0_addr = lp_contract.functions.token0().call()
+        tkn1_addr = lp_contract.functions.token1().call()
+        total_supply = lp_contract.functions.totalSupply().call(block_identifier=cur_block)
+        reserves = lp_contract.functions.getReserves().call(block_identifier=cur_block)
+        
+        tkn0 = self.get_lp_data().tkn0
+        tkn1 = self.get_lp_data().tkn1
+        amt0 = fetch_tkn.amt_to_decimal(tkn0, reserves[0])
+        amt1 = fetch_tkn.amt_to_decimal(tkn1, reserves[1])
+        
+        lp.reserve0 = lp.convert_to_machine(amt0)      # override reserve0
+        lp.reserve1 = lp.convert_to_machine(amt1)      # override reserve1
+        lp.total_supply = total_supply                 # override total supply
+        
+        return lp
+
+    def prime_mock_pool(self, start_block, user_nm = None):
+        w3 = self.get_w3() 
+        fetch_tkn = FetchToken(w3)
+        
+        lp_contract = self._init_lp_contract()
+        tkn0_addr = lp_contract.functions.token0().call()
+        tkn1_addr = lp_contract.functions.token1().call()
+        total_supply = lp_contract.functions.totalSupply().call(block_identifier=start_block)
+        reserves = lp_contract.functions.getReserves().call(block_identifier=start_block)
+        
+        # Step 2: Define tokens
+        tkn0 = fetch_tkn.apply(tkn0_addr)
+        tkn1 = fetch_tkn.apply(tkn1_addr)
+        
+        amt0 = fetch_tkn.amt_to_decimal(tkn0, reserves[0])
+        amt1 = fetch_tkn.amt_to_decimal(tkn1, reserves[1])
+        
+        # Step 3:  Initialize factory
+        factory = UniswapFactory("Pool factory", "0x2")
+        
+        # Step 4: Set up exchange data for V2
+        exch_data = UniswapExchangeData(tkn0=tkn0, tkn1=tkn1, symbol="LP", address=self.config.pool_address)
+        
+        # Step 5: Deploy pool
+        self.lp_state = factory.deploy(exch_data)
+        
+        # Step 6: Add initial liquidity
+        join = Join()
+        join.apply(self.lp_state, user_nm, amt0, amt1)
+        self.lp_state.total_supply = total_supply # override total supply
+    
+        return self.lp_state
+
+    def get_connector(self):
+        return self.connector
+
+    def get_abi(self):
+        return self.abi
+
+    def get_w3(self):
+        return self.connector.get_w3() 
+
+    def get_contract_instance(self):
+        return self.lp_contract
+
+    def get_lp_data(self):
+        return self.lp_data
+
+    def _init_lp_contract(self): 
+        pair_address = self.config.pool_address
+        w3 = self.get_w3()       
+        abi_obj = self.get_abi()
+        lp_contract = abi_obj.apply(w3, pair_address)   
+        return lp_contract