Installation

DeFiPy requires Python 3.10 or later. Install via pip:

pip install defipy

The core install is the pure analytics engine — AMM math, primitives, State Twin, and all 21 typed analytics functions. It has zero web3 dependencies and zero LLM dependencies. No chain reads, no RPC calls, no MCP. Chain reads come from Web3Scout (via the [chain] or [book] extras); MCP tool serving comes from the [mcp] extra. Both are optional.

Note

zsh users. Wrap install specs that use square brackets in single quotes — e.g. pip install 'defipy[chain]' — so zsh doesn’t try to glob the brackets. Bash users can use either form.

MCP install (Claude Desktop / Claude Code demo)

To run the MCP server that exposes DeFiPy’s primitives as tools to Claude Desktop, Claude Code, or any MCP-compatible client, install the [mcp] extra:

pip install 'defipy[mcp]'

This adds the mcp Python SDK on top of the core install. The MCP server itself lives at python/mcp/defipy_mcp_server.py; see Binding to Claude for Claude Desktop and Claude Code configuration snippets.

Chain install (LiveProvider — v2.1+)

To use LiveProvider for chain reads against any web3-compatible RPC, install the [chain] extra:

pip install 'defipy[chain]'

This adds web3scout and web3.py on top of the core install. LiveProvider constructs V2PoolSnapshot and V3PoolSnapshot objects from real on-chain state — block-pinned reads, decimal-adjusted reserves, ERC20 metadata via FetchToken, Multicall3 batching for V3. See LiveProvider on defipy.org for the full surface.

Note

[chain] pins web3 < 7.0 because web3scout 0.2.0 depends on eth_utils.abi.get_abi_input_types, which was removed in web3 7.x. If web3 7.x is already installed for other reasons, pip install 'defipy[chain]' will downgrade it. Tracking upstream as v2.2 work.

Agentic install (full agentic-DeFi stack)

The canonical install for the “Python SDK for Agentic DeFi” use case — composes [chain] and [mcp] so LLM-driven systems can analyze live chain state out of the box:

pip install 'defipy[agentic]'

Equivalent to pip install 'defipy[chain,mcp]' but spelled with intent. The capability extras ([chain], [mcp]) keep their single-purpose semantics; [agentic] is a persona-named bundle for the canonical full-stack install.

Book install (chapter 9 agents)

Chapter 9 of Hands-On AMMs with Python — Building Autonomous DeFi Agents — uses live chain integration via web3scout. To run those examples, install the [book] extra:

pip install 'defipy[book]'

This pulls in web3scout on top of the core install, enabling the chain event monitoring, ABI loading, and token-fetching utilities that chapter 9’s agents require. Other chapters work with the core install alone.

Anvil install (local Foundry workflows)

If you’re using ExecuteScript or UniswapScriptHelper against a local Anvil node and don’t need the full web3scout event-monitoring stack, the lighter [anvil] extra just adds web3.py:

pip install 'defipy[anvil]'

[book] already includes everything in [anvil], so book readers only need [book].

Source install

To install from source:

git clone https://github.com/defipy-devs/defipy
cd defipy
pip install .

System libraries for gmpy2

DeFiPy depends on gmpy2 for high-precision arithmetic in StableSwap math. On most platforms, pip will install gmpy2 from a prebuilt wheel and no further setup is needed. If the install fails, you may need the GMP, MPFR, and MPC system libraries installed before pip install:

macOS (Homebrew):

brew install gmp mpfr libmpc

Linux (Debian / Ubuntu):

sudo apt install libgmp-dev libmpfr-dev libmpc-dev

See the gmpy2 installation docs for other platforms.