DeFiPy 1.0.1__tar.gz → 1.0.3__tar.gz

defipy-1.0.3/DeFiPy.egg-info/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.1
+Name: DeFiPy
+Version: 1.0.3
+Summary: DeFi Analytics with Python
+Home-page: http://github.com/defipy-devs/defipy
+Author: icmoore
+Author-email: defipy.devs@gmail.com
+License: Apache-2.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: scipy>=1.7.3
+Requires-Dist: bokeh==3.3.4
+Requires-Dist: uniswappy==1.7.0
+Requires-Dist: stableswappy==1.0.0
+Requires-Dist: balancerpy==1.0.1
+
+# DeFiPy: Python SDK for DeFi Analytics and Agents
+
+DeFiPy is the first unified Python SDK for DeFi analytics, simulation, and autonomous agents. Built with modularity in mind, DeFiPy lets you isolate and extend your analytics by protocol using:
+
+* [UniswapPy](https://github.com/defipy-devs/uniswappy)
+* [BalancerPy](https://github.com/defipy-devs/balancerpy)
+* [StableSwapPy](https://github.com/defipy-devs/stableswappy)
+
+For onchain event access and scripting, pair it with [Web3Scout](https://github.com/defipy-devs/web3scout) — a companion tool for [decoding pool events](https://defipy.readthedocs.io/en/latest/onchain/pool_events.html) and [interfacing with Solidity contracts](https://defipy.readthedocs.io/en/latest/onchain/testnet_sim_univ2.html). Whether you’re building dashboards, simulations, or agent-based trading systems, DeFiPy + Web3Scout deliver a uniquely powerful toolset — unlike anything else in the ecosystem.
+
+## Docs
+Visit [DeFiPy docs](https://defipy.org) for full documentation with walk-through tutorials
+
+## Install
+Must first install gmpy2 python package to handle the precision within the StableSwap protocol (requires CPython 3.7 or above). To install the latest release with pip:
+```
+> pip install gmpy2
+```
+Also, in many cases will need to have required libraries (GMP, MPFR and MPC) already installed on your system, see [gmpy2 installation docs](https://gmpy2.readthedocs.io/en/latest/install.html) for more info. Once setup, install the latest release of DeFiPy with pip:
+```
+> git clone https://github.com/defipy-devs/defipy
+> pip install .
+```
+or
+```
+> pip install defipy
+```
+
+Uniswap V2 Example
+--------------------------
+
+To setup a liquidity pool, you must first create the tokens in the pair using the `ERC20` object. Next, create a liquidity pool (LP) factory using `IFactory` object. Once this is setup, an unlimited amount of LPs can be created; the procedures for such are as follows:
+
+
+    from defipy import *
+    
+    # Step 1: Define tokens
+    tkn = ERC20("TKN", "0x111")
+    eth = ERC20("ETH", "0x999")
+    
+    # Step 2:  Initialize factory
+    factory = UniswapFactory("ETH pool factory", "0x2")
+    
+    # Step 3: Set up exchange data for V2
+    exch_data = UniswapExchangeData(tkn0=eth, tkn1=tkn, symbol="LP", address="0x3")
+    
+    # Step 4: Deploy pool
+    lp = factory.deploy(exch_data)
+    
+    # Step 5: Add initial liquidity
+    join = Join()
+    join.apply(lp, "user", 1000, 10000)
+    
+    # Step 6: Perform swap
+    swap = Swap()
+    out = swap.apply(lp, tkn, "user", 10)
+    
+    # Check reserves and liquidity
+    lp.summary()    
+
+    # OUTPUT:
+    Exchange ETH-TKN (LP)
+    Reserves: ETH = 999.00399301896, TKN = 10010.0
+    Liquidity: 3162.2776601683795 
+
+Uniswap V3 Example
+--------------------------
+
+    from defipy import *
+    
+    # Step 1: Define tokens and parameters
+    eth = ERC20("ETH", "0x93")
+    tkn = ERC20("TKN", "0x111")
+    tick_spacing = 60
+    fee = 3000  # 0.3% fee tier
+    
+    # Step 2: Set up exchange data for V3
+    exch_data = UniswapExchangeData(tkn0=eth, tkn1=tkn, symbol="LP", address="0x811", version='V3', tick_spacing=tick_spacing, fee=fee)
+    
+    # Step 3: Initialize factory
+    factory = UniswapFactory("ETH pool factory", "0x2")
+    
+    # Step 4: Deploy pool
+    lp = factory.deploy(exch_data)
+    
+    # Step 5: Add initial liquidity within tick range
+    lwr_tick = UniV3Utils.getMinTick(tick_spacing)
+    upr_tick = UniV3Utils.getMaxTick(tick_spacing)
+    join = Join()
+    join.apply(lp, "user", 1000, 10000, lwr_tick, upr_tick)
+    
+    # Step 6: Perform swap
+    swap = Swap()
+    out = swap.apply(lp, tkn, "user", 10)
+    
+    # Check reserves and liquidity
+    lp.summary()
+
+    # OUTPUT:
+    Exchange ETH-TKN (LP)
+    Real Reserves:   ETH = 999.0039930189599, TKN = 10010.0
+    Gross Liquidity: 3162.277660168379  
+    
+Balancer Example
+--------------------------   
+
+    from defipy import *
+    
+    # Step 1: Define tokens
+    dai = ERC20("DAI", "0x111")
+    usdc = ERC20("USDC", "0x999")
+    
+    # Step 2: Deposit token amounts
+    dai.deposit(None, 10000)
+    usdc.deposit(None, 20000)
+    
+    # Step 3: Setup vault
+    vault = BalancerVault()
+    vault.add_token(dai, 10)  # Denormalized weight for DAI
+    vault.add_token(usdc, 40)  # Denormalized weight for WETH
+    
+    # Step 4: Set up exchange data for Balancer
+    exch_data = BalancerExchangeData(vault=vault, symbol="BSP", address="0x3")
+    
+    # Step 5: Initialize factor for Balancer
+    bfactory = BalancerFactory("WETH pool factory", "0x2")
+    
+    # Step 6: Deploy pool
+    lp = bfactory.deploy(exch_data)
+    
+    # Step 7: Join pool with initial liquidity
+    join = Join()
+    join.apply(lp, "user", 100) # Issue 100 pool shares
+    
+    # Step 8: Perform swap
+    swap = Swap(Proc.SWAPIN)
+    out = swap.apply(lp, dai, usdc, "user", 10)
+    
+    # Check reserves and liquidity
+    lp.summary()
+
+    # OUTPUT:
+    Balancer Exchange: DAI-USDC (BSP)
+    Reserves: DAI = 9979.92478694547, USDC = 20010
+    Weights: DAI = 0.2, USDC = 0.8
+    Pool Shares: 100 
+    
+StableSwap Example
+--------------------------   
+
+    from defipy import *
+    
+    # Step 1: Define stablecoins and parameters
+    dai = ERC20("DAI", "0x111", 18)
+    usdc = ERC20("USDC", "0x222", 6)
+    AMPL_COEFF = 2000
+    
+    # Step 2: Deposit token amounts
+    dai.deposit(None, 10000)
+    usdc.deposit(None, 20000)
+    
+    # Step 3: Setup Stableswap vault and add tokens
+    sgrp = StableswapVault()
+    sgrp.add_token(dai)
+    sgrp.add_token(usdc)
+    
+    # Step 4: Set up exchange data for Stableswap
+    exch_data = StableswapExchangeData(vault = sgrp, symbol="LP", address="0x011")
+    
+    # Step 5: Initialize factor for Balancer
+    factory = StableswapFactory("Stableswap factory", "0x2")
+    
+    # Step 6: Deploy pool
+    lp = factory.deploy(exch_data)
+    
+    # Step 7: Join pool with initial liquidity
+    join = Join()
+    join.apply(lp, "user", AMPL_COEFF)
+    
+    # Step 8: Perform swap
+    swap = Swap()
+    out = swap.apply(lp, dai, usdc, "user", 10)
+    
+    # Check reserves and liquidity
+    lp.summary()
+
+    # OUTPUT:
+    Stableswap Exchange: DAI-USDC (LP)
+    Reserves: DAI = 10010, USDC = 19989.996791
+    Liquidity: 29999.063056285642 
+
+## 0x Quant Terminal
+
+This application utilizes the 0x API to produce a mock Uniswap pool which allows end-users to stress test
+the limitations of a Uniswap pool setup using live price feeds from [0x API](https://0x.org); for backend setup, see 
+[notebook](https://github.com/defipy-devs/defipy/blob/main/notebooks/quant_terminal.ipynb) 
+
+Click [dashboard.defipy.org](https://dashboard.defipy.org/) for live link; for more detail see 
+[README](https://github.com/defipy-devs/defipy/tree/main/python/application/quant_terminal#readme) 
+
+![plot](./doc/quant_terminal/screenshot.png)
+
+### Run application locally  
+
+```
+> bokeh serve --show python/application/quant_terminal/bokeh_server.py
+```    

{defipy-1.0.1 → defipy-1.0.3}/DeFiPy.egg-info/SOURCES.txt

@@ -36,7 +36,10 @@ python/prod/process/mint/__init__.py
 python/prod/process/swap/Swap.py
 python/prod/process/swap/__init__.py
 python/prod/utils/client/__init__.py
+python/prod/utils/client/contract/ExecuteScript.py
+python/prod/utils/client/contract/__init__.py
 python/prod/utils/data/__init__.py
 python/prod/utils/interfaces/__init__.py
+python/prod/utils/tools/UniswapScriptHelper.py
 python/prod/utils/tools/__init__.py
 python/prod/utils/tools/v3/__init__.py

defipy-1.0.3/LICENSE.txt

@@ -0,0 +1,120 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+
+   Subject to the terms and conditions of this License, each Contributor
+   hereby grants to You a perpetual, worldwide, non-exclusive,
+   no-charge, royalty-free, irrevocable copyright license to reproduce,
+   prepare Derivative Works of, publicly display, publicly perform,
+   sublicense, and distribute the Work and such Derivative Works in
+   Source or Object form.
+
+3. Grant of Patent License.
+
+   Subject to the terms and conditions of this License, each Contributor
+   hereby grants to You a perpetual, worldwide, non-exclusive,
+   no-charge, royalty-free, irrevocable (except as stated in this
+   section) patent license to make, have made, use, offer to sell, sell,
+   import, and otherwise transfer the Work, where such license applies
+   only to those patent claims licensable by such Contributor that are
+   necessarily infringed by their Contribution(s) alone or by combination
+   of their Contribution(s) with the Work to which such Contribution(s)
+   was submitted. If You institute patent litigation against any entity
+   (including a cross-claim or counterclaim in a lawsuit) alleging that
+   the Work or a Contribution incorporated within the Work constitutes
+   direct or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate as of
+   the date such litigation is filed.
+
+4. Redistribution.
+
+   You may reproduce and distribute copies of the Work or Derivative
+   Works thereof in any medium, with or without modifications, and in
+   Source or Object form, provided that You meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for inform

defipy-1.0.3/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.1
+Name: DeFiPy
+Version: 1.0.3
+Summary: DeFi Analytics with Python
+Home-page: http://github.com/defipy-devs/defipy
+Author: icmoore
+Author-email: defipy.devs@gmail.com
+License: Apache-2.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: scipy>=1.7.3
+Requires-Dist: bokeh==3.3.4
+Requires-Dist: uniswappy==1.7.0
+Requires-Dist: stableswappy==1.0.0
+Requires-Dist: balancerpy==1.0.1
+
+# DeFiPy: Python SDK for DeFi Analytics and Agents
+
+DeFiPy is the first unified Python SDK for DeFi analytics, simulation, and autonomous agents. Built with modularity in mind, DeFiPy lets you isolate and extend your analytics by protocol using:
+
+* [UniswapPy](https://github.com/defipy-devs/uniswappy)
+* [BalancerPy](https://github.com/defipy-devs/balancerpy)
+* [StableSwapPy](https://github.com/defipy-devs/stableswappy)
+
+For onchain event access and scripting, pair it with [Web3Scout](https://github.com/defipy-devs/web3scout) — a companion tool for [decoding pool events](https://defipy.readthedocs.io/en/latest/onchain/pool_events.html) and [interfacing with Solidity contracts](https://defipy.readthedocs.io/en/latest/onchain/testnet_sim_univ2.html). Whether you’re building dashboards, simulations, or agent-based trading systems, DeFiPy + Web3Scout deliver a uniquely powerful toolset — unlike anything else in the ecosystem.
+
+## Docs
+Visit [DeFiPy docs](https://defipy.org) for full documentation with walk-through tutorials
+
+## Install
+Must first install gmpy2 python package to handle the precision within the StableSwap protocol (requires CPython 3.7 or above). To install the latest release with pip:
+```
+> pip install gmpy2
+```
+Also, in many cases will need to have required libraries (GMP, MPFR and MPC) already installed on your system, see [gmpy2 installation docs](https://gmpy2.readthedocs.io/en/latest/install.html) for more info. Once setup, install the latest release of DeFiPy with pip:
+```
+> git clone https://github.com/defipy-devs/defipy
+> pip install .
+```
+or
+```
+> pip install defipy
+```
+
+Uniswap V2 Example
+--------------------------
+
+To setup a liquidity pool, you must first create the tokens in the pair using the `ERC20` object. Next, create a liquidity pool (LP) factory using `IFactory` object. Once this is setup, an unlimited amount of LPs can be created; the procedures for such are as follows:
+
+
+    from defipy import *
+    
+    # Step 1: Define tokens
+    tkn = ERC20("TKN", "0x111")
+    eth = ERC20("ETH", "0x999")
+    
+    # Step 2:  Initialize factory
+    factory = UniswapFactory("ETH pool factory", "0x2")
+    
+    # Step 3: Set up exchange data for V2
+    exch_data = UniswapExchangeData(tkn0=eth, tkn1=tkn, symbol="LP", address="0x3")
+    
+    # Step 4: Deploy pool
+    lp = factory.deploy(exch_data)
+    
+    # Step 5: Add initial liquidity
+    join = Join()
+    join.apply(lp, "user", 1000, 10000)
+    
+    # Step 6: Perform swap
+    swap = Swap()
+    out = swap.apply(lp, tkn, "user", 10)
+    
+    # Check reserves and liquidity
+    lp.summary()    
+
+    # OUTPUT:
+    Exchange ETH-TKN (LP)
+    Reserves: ETH = 999.00399301896, TKN = 10010.0
+    Liquidity: 3162.2776601683795 
+
+Uniswap V3 Example
+--------------------------
+
+    from defipy import *
+    
+    # Step 1: Define tokens and parameters
+    eth = ERC20("ETH", "0x93")
+    tkn = ERC20("TKN", "0x111")
+    tick_spacing = 60
+    fee = 3000  # 0.3% fee tier
+    
+    # Step 2: Set up exchange data for V3
+    exch_data = UniswapExchangeData(tkn0=eth, tkn1=tkn, symbol="LP", address="0x811", version='V3', tick_spacing=tick_spacing, fee=fee)
+    
+    # Step 3: Initialize factory
+    factory = UniswapFactory("ETH pool factory", "0x2")
+    
+    # Step 4: Deploy pool
+    lp = factory.deploy(exch_data)
+    
+    # Step 5: Add initial liquidity within tick range
+    lwr_tick = UniV3Utils.getMinTick(tick_spacing)
+    upr_tick = UniV3Utils.getMaxTick(tick_spacing)
+    join = Join()
+    join.apply(lp, "user", 1000, 10000, lwr_tick, upr_tick)
+    
+    # Step 6: Perform swap
+    swap = Swap()
+    out = swap.apply(lp, tkn, "user", 10)
+    
+    # Check reserves and liquidity
+    lp.summary()
+
+    # OUTPUT:
+    Exchange ETH-TKN (LP)
+    Real Reserves:   ETH = 999.0039930189599, TKN = 10010.0
+    Gross Liquidity: 3162.277660168379  
+    
+Balancer Example
+--------------------------   
+
+    from defipy import *
+    
+    # Step 1: Define tokens
+    dai = ERC20("DAI", "0x111")
+    usdc = ERC20("USDC", "0x999")
+    
+    # Step 2: Deposit token amounts
+    dai.deposit(None, 10000)
+    usdc.deposit(None, 20000)
+    
+    # Step 3: Setup vault
+    vault = BalancerVault()
+    vault.add_token(dai, 10)  # Denormalized weight for DAI
+    vault.add_token(usdc, 40)  # Denormalized weight for WETH
+    
+    # Step 4: Set up exchange data for Balancer
+    exch_data = BalancerExchangeData(vault=vault, symbol="BSP", address="0x3")
+    
+    # Step 5: Initialize factor for Balancer
+    bfactory = BalancerFactory("WETH pool factory", "0x2")
+    
+    # Step 6: Deploy pool
+    lp = bfactory.deploy(exch_data)
+    
+    # Step 7: Join pool with initial liquidity
+    join = Join()
+    join.apply(lp, "user", 100) # Issue 100 pool shares
+    
+    # Step 8: Perform swap
+    swap = Swap(Proc.SWAPIN)
+    out = swap.apply(lp, dai, usdc, "user", 10)
+    
+    # Check reserves and liquidity
+    lp.summary()
+
+    # OUTPUT:
+    Balancer Exchange: DAI-USDC (BSP)
+    Reserves: DAI = 9979.92478694547, USDC = 20010
+    Weights: DAI = 0.2, USDC = 0.8
+    Pool Shares: 100 
+    
+StableSwap Example
+--------------------------   
+
+    from defipy import *
+    
+    # Step 1: Define stablecoins and parameters
+    dai = ERC20("DAI", "0x111", 18)
+    usdc = ERC20("USDC", "0x222", 6)
+    AMPL_COEFF = 2000
+    
+    # Step 2: Deposit token amounts
+    dai.deposit(None, 10000)
+    usdc.deposit(None, 20000)
+    
+    # Step 3: Setup Stableswap vault and add tokens
+    sgrp = StableswapVault()
+    sgrp.add_token(dai)
+    sgrp.add_token(usdc)
+    
+    # Step 4: Set up exchange data for Stableswap
+    exch_data = StableswapExchangeData(vault = sgrp, symbol="LP", address="0x011")
+    
+    # Step 5: Initialize factor for Balancer
+    factory = StableswapFactory("Stableswap factory", "0x2")
+    
+    # Step 6: Deploy pool
+    lp = factory.deploy(exch_data)
+    
+    # Step 7: Join pool with initial liquidity
+    join = Join()
+    join.apply(lp, "user", AMPL_COEFF)
+    
+    # Step 8: Perform swap
+    swap = Swap()
+    out = swap.apply(lp, dai, usdc, "user", 10)
+    
+    # Check reserves and liquidity
+    lp.summary()
+
+    # OUTPUT:
+    Stableswap Exchange: DAI-USDC (LP)
+    Reserves: DAI = 10010, USDC = 19989.996791
+    Liquidity: 29999.063056285642 
+
+## 0x Quant Terminal
+
+This application utilizes the 0x API to produce a mock Uniswap pool which allows end-users to stress test
+the limitations of a Uniswap pool setup using live price feeds from [0x API](https://0x.org); for backend setup, see 
+[notebook](https://github.com/defipy-devs/defipy/blob/main/notebooks/quant_terminal.ipynb) 
+
+Click [dashboard.defipy.org](https://dashboard.defipy.org/) for live link; for more detail see 
+[README](https://github.com/defipy-devs/defipy/tree/main/python/application/quant_terminal#readme) 
+
+![plot](./doc/quant_terminal/screenshot.png)
+
+### Run application locally  
+
+```
+> bokeh serve --show python/application/quant_terminal/bokeh_server.py
+```