defistream 1.0.1__tar.gz → 1.0.2__tar.gz

{defistream-1.0.1 → defistream-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: defistream
-Version: 1.0.1
+Version: 1.0.2
 Summary: Python client for the DeFiStream API
 Project-URL: Homepage, https://defistream.dev
 Project-URL: Documentation, https://docs.defistream.dev
@@ -158,12 +158,12 @@ df = (
     .as_df()
 )
 
-# Get liquidations for a specific user
+# Use a specific market type on ETH (Core, Prime, or EtherFi)
 df = (
-    client.aave.liquidations()
+    client.aave.deposits()
     .network("ETH")
     .block_range(21000000, 21010000)
-    .user("0x...")
+    .eth_market_type("Prime")
     .as_df()
 )
 ```
@@ -409,23 +409,20 @@ print(f"Request cost: {client.last_response.request_cost}")
 | `.time_range(start, end)` | Set both start and end times |
 | `.verbose()` | Include all metadata fields |
 
-### Filter Methods
+### Protocol-Specific Parameters
 
 | Method | Protocols | Description |
 |--------|-----------|-------------|
+| `.token(symbol)` | ERC20 | Token symbol (USDT, USDC) or contract address |
+| `.decimals(n)` | ERC20 | Token decimals when using custom address (default: 18) |
 | `.sender(addr)` | ERC20, Native | Filter by sender address |
 | `.receiver(addr)` | ERC20, Native | Filter by receiver address |
-| `.from_address(addr)` | ERC20, Native | Alias for sender |
-| `.to_address(addr)` | ERC20, Native | Alias for receiver |
 | `.min_amount(amt)` | ERC20, Native | Minimum transfer amount |
-| `.token(symbol)` | ERC20 | Token symbol (USDT, USDC, etc.) |
-| `.user(addr)` | AAVE | Filter by user |
-| `.reserve(addr)` | AAVE | Filter by reserve |
-| `.liquidator(addr)` | AAVE Liquidations | Filter by liquidator |
-| `.symbol0(sym)` | Uniswap | First token symbol |
-| `.symbol1(sym)` | Uniswap | Second token symbol |
-| `.fee(tier)` | Uniswap | Fee tier (100, 500, 3000, 10000) |
-| `.pool(addr)` | Uniswap | Pool address |
+| `.max_amount(amt)` | ERC20, Native | Maximum transfer amount |
+| `.eth_market_type(type)` | AAVE | Market type for ETH: 'Core', 'Prime', 'EtherFi' |
+| `.symbol0(sym)` | Uniswap | First token symbol (required) |
+| `.symbol1(sym)` | Uniswap | Second token symbol (required) |
+| `.fee(tier)` | Uniswap | Fee tier: 100, 500, 3000, 10000 (required) |
 
 ### Terminal Methods
 

{defistream-1.0.1 → defistream-1.0.2}/README.md

@@ -124,12 +124,12 @@ df = (
     .as_df()
 )
 
-# Get liquidations for a specific user
+# Use a specific market type on ETH (Core, Prime, or EtherFi)
 df = (
-    client.aave.liquidations()
+    client.aave.deposits()
     .network("ETH")
     .block_range(21000000, 21010000)
-    .user("0x...")
+    .eth_market_type("Prime")
     .as_df()
 )
 ```
@@ -375,23 +375,20 @@ print(f"Request cost: {client.last_response.request_cost}")
 | `.time_range(start, end)` | Set both start and end times |
 | `.verbose()` | Include all metadata fields |
 
-### Filter Methods
+### Protocol-Specific Parameters
 
 | Method | Protocols | Description |
 |--------|-----------|-------------|
+| `.token(symbol)` | ERC20 | Token symbol (USDT, USDC) or contract address |
+| `.decimals(n)` | ERC20 | Token decimals when using custom address (default: 18) |
 | `.sender(addr)` | ERC20, Native | Filter by sender address |
 | `.receiver(addr)` | ERC20, Native | Filter by receiver address |
-| `.from_address(addr)` | ERC20, Native | Alias for sender |
-| `.to_address(addr)` | ERC20, Native | Alias for receiver |
 | `.min_amount(amt)` | ERC20, Native | Minimum transfer amount |
-| `.token(symbol)` | ERC20 | Token symbol (USDT, USDC, etc.) |
-| `.user(addr)` | AAVE | Filter by user |
-| `.reserve(addr)` | AAVE | Filter by reserve |
-| `.liquidator(addr)` | AAVE Liquidations | Filter by liquidator |
-| `.symbol0(sym)` | Uniswap | First token symbol |
-| `.symbol1(sym)` | Uniswap | Second token symbol |
-| `.fee(tier)` | Uniswap | Fee tier (100, 500, 3000, 10000) |
-| `.pool(addr)` | Uniswap | Pool address |
+| `.max_amount(amt)` | ERC20, Native | Maximum transfer amount |
+| `.eth_market_type(type)` | AAVE | Market type for ETH: 'Core', 'Prime', 'EtherFi' |
+| `.symbol0(sym)` | Uniswap | First token symbol (required) |
+| `.symbol1(sym)` | Uniswap | Second token symbol (required) |
+| `.fee(tier)` | Uniswap | Fee tier: 100, 500, 3000, 10000 (required) |
 
 ### Terminal Methods
 

{defistream-1.0.1 → defistream-1.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "defistream"
-version = "1.0.1"
+version = "1.0.2"
 description = "Python client for the DeFiStream API"
 readme = "README.md"
 license = "MIT"

{defistream-1.0.1 → defistream-1.0.2}/src/defistream/__init__.py

@@ -45,7 +45,7 @@ from .models import (
 )
 from .query import AsyncQueryBuilder, QueryBuilder
 
-__version__ = "1.0.1"
+__version__ = "1.0.2"
 
 __all__ = [
     # Clients

{defistream-1.0.1 → defistream-1.0.2}/src/defistream/query.py

@@ -2,13 +2,11 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Generic, TypeVar
+from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
     from .client import BaseClient
 
-T = TypeVar("T")
-
 
 class QueryBuilder:
     """
@@ -20,7 +18,7 @@ class QueryBuilder:
     - as_file() - saves to CSV, Parquet, or JSON file
 
     Example:
-        query = client.erc20.transfers("USDT").network("ETH").start_block(24000000).end_block(24100000)
+        query = client.erc20.transfers("USDT").network("ETH").block_range(21000000, 21010000)
         query = query.min_amount(1000).sender("0x...")
         df = query.as_df()  # pandas DataFrame
         df = query.as_df("polars")  # polars DataFrame
@@ -51,7 +49,7 @@ class QueryBuilder:
 
     # Network and block range
     def network(self, network: str) -> "QueryBuilder":
-        """Set the network (ETH, ARB, BASE, OP, etc.)."""
+        """Set the network (ETH, ARB, BASE, OP, POLYGON, etc.)."""
         return self._copy_with(network=network)
 
     def start_block(self, block: int) -> "QueryBuilder":
@@ -79,13 +77,13 @@ class QueryBuilder:
         """Set both start and end times."""
         return self._copy_with(since=start, until=end)
 
-    # Common filters
+    # ERC20 and Native Token filters
     def sender(self, address: str) -> "QueryBuilder":
-        """Filter by sender address."""
+        """Filter by sender address (ERC20, Native Token)."""
         return self._copy_with(sender=address)
 
     def receiver(self, address: str) -> "QueryBuilder":
-        """Filter by receiver address."""
+        """Filter by receiver address (ERC20, Native Token)."""
         return self._copy_with(receiver=address)
 
     def from_address(self, address: str) -> "QueryBuilder":
@@ -97,52 +95,40 @@ class QueryBuilder:
         return self.receiver(address)
 
     def min_amount(self, amount: float) -> "QueryBuilder":
-        """Filter by minimum amount."""
+        """Filter by minimum amount (ERC20, Native Token)."""
         return self._copy_with(min_amount=amount)
 
+    def max_amount(self, amount: float) -> "QueryBuilder":
+        """Filter by maximum amount (ERC20, Native Token)."""
+        return self._copy_with(max_amount=amount)
+
     # ERC20 specific
     def token(self, symbol: str) -> "QueryBuilder":
-        """Set token symbol (for ERC20)."""
+        """Set token symbol or address (ERC20)."""
         return self._copy_with(token=symbol)
 
-    def owner(self, address: str) -> "QueryBuilder":
-        """Filter by owner address (for approvals)."""
-        return self._copy_with(owner=address)
-
-    def spender(self, address: str) -> "QueryBuilder":
-        """Filter by spender address (for approvals)."""
-        return self._copy_with(spender=address)
+    def decimals(self, decimals: int) -> "QueryBuilder":
+        """Set token decimals when using custom address (ERC20). Default: 18."""
+        return self._copy_with(decimals=decimals)
 
     # AAVE specific
-    def user(self, address: str) -> "QueryBuilder":
-        """Filter by user address (for AAVE)."""
-        return self._copy_with(user=address)
-
-    def reserve(self, address: str) -> "QueryBuilder":
-        """Filter by reserve address (for AAVE)."""
-        return self._copy_with(reserve=address)
-
-    def liquidator(self, address: str) -> "QueryBuilder":
-        """Filter by liquidator address (for AAVE liquidations)."""
-        return self._copy_with(liquidator=address)
+    def eth_market_type(self, market_type: str) -> "QueryBuilder":
+        """Set AAVE market type for ETH network: 'Core', 'Prime', or 'EtherFi'. Default: 'Core'."""
+        return self._copy_with(eth_market_type=market_type)
 
     # Uniswap specific
     def symbol0(self, symbol: str) -> "QueryBuilder":
-        """Set first token symbol (for Uniswap)."""
+        """Set first token symbol (Uniswap)."""
         return self._copy_with(symbol0=symbol)
 
     def symbol1(self, symbol: str) -> "QueryBuilder":
-        """Set second token symbol (for Uniswap)."""
+        """Set second token symbol (Uniswap)."""
         return self._copy_with(symbol1=symbol)
 
     def fee(self, fee_tier: int) -> "QueryBuilder":
-        """Set fee tier (for Uniswap): 100, 500, 3000, 10000."""
+        """Set fee tier (Uniswap): 100, 500, 3000, 10000."""
         return self._copy_with(fee=fee_tier)
 
-    def pool(self, address: str) -> "QueryBuilder":
-        """Set pool address (for Uniswap)."""
-        return self._copy_with(pool=address)
-
     # Verbose mode
     def verbose(self, enabled: bool = True) -> "QueryBuilder":
         """Include all metadata fields (tx_hash, tx_id, log_index, network, name)."""
@@ -161,7 +147,7 @@ class QueryBuilder:
         """
         Execute query and return results as list of dictionaries.
 
-        Uses JSON format from API.
+        Uses JSON format from API. Limited to 10,000 blocks.
 
         Returns:
             List of event dictionaries
@@ -253,7 +239,7 @@ class AsyncQueryBuilder:
     - as_file() - saves to CSV, Parquet, or JSON file
 
     Example:
-        query = client.erc20.transfers("USDT").network("ETH").start_block(24000000).end_block(24100000)
+        query = client.erc20.transfers("USDT").network("ETH").block_range(21000000, 21010000)
         df = await query.as_df()  # pandas DataFrame
         df = await query.as_df("polars")  # polars DataFrame
         await query.as_file("transfers.csv")  # save to CSV
@@ -283,7 +269,7 @@ class AsyncQueryBuilder:
 
     # Network and block range
     def network(self, network: str) -> "AsyncQueryBuilder":
-        """Set the network (ETH, ARB, BASE, OP, etc.)."""
+        """Set the network (ETH, ARB, BASE, OP, POLYGON, etc.)."""
         return self._copy_with(network=network)
 
     def start_block(self, block: int) -> "AsyncQueryBuilder":
@@ -311,13 +297,13 @@ class AsyncQueryBuilder:
         """Set both start and end times."""
         return self._copy_with(since=start, until=end)
 
-    # Common filters
+    # ERC20 and Native Token filters
     def sender(self, address: str) -> "AsyncQueryBuilder":
-        """Filter by sender address."""
+        """Filter by sender address (ERC20, Native Token)."""
         return self._copy_with(sender=address)
 
     def receiver(self, address: str) -> "AsyncQueryBuilder":
-        """Filter by receiver address."""
+        """Filter by receiver address (ERC20, Native Token)."""
         return self._copy_with(receiver=address)
 
     def from_address(self, address: str) -> "AsyncQueryBuilder":
@@ -329,52 +315,40 @@ class AsyncQueryBuilder:
         return self.receiver(address)
 
     def min_amount(self, amount: float) -> "AsyncQueryBuilder":
-        """Filter by minimum amount."""
+        """Filter by minimum amount (ERC20, Native Token)."""
         return self._copy_with(min_amount=amount)
 
+    def max_amount(self, amount: float) -> "AsyncQueryBuilder":
+        """Filter by maximum amount (ERC20, Native Token)."""
+        return self._copy_with(max_amount=amount)
+
     # ERC20 specific
     def token(self, symbol: str) -> "AsyncQueryBuilder":
-        """Set token symbol (for ERC20)."""
+        """Set token symbol or address (ERC20)."""
         return self._copy_with(token=symbol)
 
-    def owner(self, address: str) -> "AsyncQueryBuilder":
-        """Filter by owner address (for approvals)."""
-        return self._copy_with(owner=address)
-
-    def spender(self, address: str) -> "AsyncQueryBuilder":
-        """Filter by spender address (for approvals)."""
-        return self._copy_with(spender=address)
+    def decimals(self, decimals: int) -> "AsyncQueryBuilder":
+        """Set token decimals when using custom address (ERC20). Default: 18."""
+        return self._copy_with(decimals=decimals)
 
     # AAVE specific
-    def user(self, address: str) -> "AsyncQueryBuilder":
-        """Filter by user address (for AAVE)."""
-        return self._copy_with(user=address)
-
-    def reserve(self, address: str) -> "AsyncQueryBuilder":
-        """Filter by reserve address (for AAVE)."""
-        return self._copy_with(reserve=address)
-
-    def liquidator(self, address: str) -> "AsyncQueryBuilder":
-        """Filter by liquidator address (for AAVE liquidations)."""
-        return self._copy_with(liquidator=address)
+    def eth_market_type(self, market_type: str) -> "AsyncQueryBuilder":
+        """Set AAVE market type for ETH network: 'Core', 'Prime', or 'EtherFi'. Default: 'Core'."""
+        return self._copy_with(eth_market_type=market_type)
 
     # Uniswap specific
     def symbol0(self, symbol: str) -> "AsyncQueryBuilder":
-        """Set first token symbol (for Uniswap)."""
+        """Set first token symbol (Uniswap)."""
         return self._copy_with(symbol0=symbol)
 
     def symbol1(self, symbol: str) -> "AsyncQueryBuilder":
-        """Set second token symbol (for Uniswap)."""
+        """Set second token symbol (Uniswap)."""
         return self._copy_with(symbol1=symbol)
 
     def fee(self, fee_tier: int) -> "AsyncQueryBuilder":
-        """Set fee tier (for Uniswap): 100, 500, 3000, 10000."""
+        """Set fee tier (Uniswap): 100, 500, 3000, 10000."""
         return self._copy_with(fee=fee_tier)
 
-    def pool(self, address: str) -> "AsyncQueryBuilder":
-        """Set pool address (for Uniswap)."""
-        return self._copy_with(pool=address)
-
     # Verbose mode
     def verbose(self, enabled: bool = True) -> "AsyncQueryBuilder":
         """Include all metadata fields (tx_hash, tx_id, log_index, network, name)."""
@@ -393,7 +367,7 @@ class AsyncQueryBuilder:
         """
         Execute query and return results as list of dictionaries.
 
-        Uses JSON format from API.
+        Uses JSON format from API. Limited to 10,000 blocks.
 
         Returns:
             List of event dictionaries
@@ -405,8 +379,6 @@ class AsyncQueryBuilder:
         """
         Execute query and return results as DataFrame.
 
-        Uses Parquet format from API for efficiency, then converts to DataFrame.
-
         Args:
             library: DataFrame library to use - "pandas" (default) or "polars"
 

{defistream-1.0.1 → defistream-1.0.2}/tests/test_client.py

@@ -221,6 +221,12 @@ class TestBuilderPattern:
         query = client.erc20.transfers().min_amount(1000)
         assert query._params["min_amount"] == 1000
 
+    def test_max_amount_filter(self):
+        """max_amount should set param."""
+        client = DeFiStream(api_key="dsk_test")
+        query = client.erc20.transfers().max_amount(10000)
+        assert query._params["max_amount"] == 10000
+
     def test_start_time(self):
         """start_time should set since param."""
         client = DeFiStream(api_key="dsk_test")
@@ -240,6 +246,12 @@ class TestBuilderPattern:
         assert query._params["since"] == "2024-01-01"
         assert query._params["until"] == "2024-01-31"
 
+    def test_decimals_filter(self):
+        """decimals should set param."""
+        client = DeFiStream(api_key="dsk_test")
+        query = client.erc20.transfers().decimals(6)
+        assert query._params["decimals"] == 6
+
 
 class TestAsyncBuilderPattern:
     """Test async builder pattern."""
@@ -269,12 +281,6 @@ class TestUniswapBuilder:
         assert query._params["symbol1"] == "USDC"
         assert query._params["fee"] == 500
 
-    def test_pool_filter(self):
-        """pool() should set pool param."""
-        client = DeFiStream(api_key="dsk_test")
-        query = client.uniswap.swaps().pool("0x123")
-        assert query._params["pool"] == "0x123"
-
     def test_deposits_endpoint(self):
         """deposits() should use correct endpoint."""
         client = DeFiStream(api_key="dsk_test")
@@ -293,27 +299,17 @@ class TestUniswapBuilder:
         query = client.uniswap.collects("WETH", "USDC", 500)
         assert query._endpoint == "/uniswap/events/collect"
 
-
-class TestAAVEBuilder:
-    """Test AAVE-specific builder methods."""
-
-    def test_user_filter(self):
-        """user() should set user param."""
+    def test_symbol_and_fee_chain_methods(self):
+        """symbol0, symbol1, fee should work as chain methods."""
         client = DeFiStream(api_key="dsk_test")
-        query = client.aave.deposits().user("0x123")
-        assert query._params["user"] == "0x123"
+        query = client.uniswap.swaps().symbol0("WETH").symbol1("USDC").fee(3000)
+        assert query._params["symbol0"] == "WETH"
+        assert query._params["symbol1"] == "USDC"
+        assert query._params["fee"] == 3000
 
-    def test_reserve_filter(self):
-        """reserve() should set reserve param."""
-        client = DeFiStream(api_key="dsk_test")
-        query = client.aave.deposits().reserve("0x456")
-        assert query._params["reserve"] == "0x456"
 
-    def test_liquidator_filter(self):
-        """liquidator() should set liquidator param."""
-        client = DeFiStream(api_key="dsk_test")
-        query = client.aave.liquidations().liquidator("0x789")
-        assert query._params["liquidator"] == "0x789"
+class TestAAVEBuilder:
+    """Test AAVE-specific builder methods."""
 
     def test_flashloans_endpoint(self):
         """flashloans() should use correct endpoint."""
@@ -321,6 +317,12 @@ class TestAAVEBuilder:
         query = client.aave.flashloans()
         assert query._endpoint == "/aave/events/flashloan"
 
+    def test_eth_market_type_filter(self):
+        """eth_market_type should set param."""
+        client = DeFiStream(api_key="dsk_test")
+        query = client.aave.deposits().eth_market_type("Prime")
+        assert query._params["eth_market_type"] == "Prime"
+
 
 class TestQueryBuilderRepr:
     """Test QueryBuilder repr."""