Onchain Event Framework for DeFiPy
Project description
Web3Scout: Onchain Event Framework for DeFiPy
🔗 SPDX-Anchor: anchorregistry.ai/AR-2026-5RJKqw5
Installation
> git clone https://github.com/defipy-devs/web3scout
> pip install .
or
> pip install Web3Scout
Uni V2 Swap Events (Polygon) Example
from web3scout import *
abi = ABILoad(Platform.SUSHI, JSONContract.UniswapV2Pair)
connect = ConnectW3(Net.POLYGON)
connect.apply()
rEvents = RetrieveEvents(connect, abi)
last_block = rEvents.latest_block()
start_block = last_block - 3
dict_events = rEvents.apply(EventType.SWAP, start_block=start_block, end_block=last_block)
swap at block:61,234,918 tx:0x9f16c76b6a83ac424ea736fb7dd2b1fc735888f222ee04dc1b1f7b933469faf8
swap at block:61,234,918 tx:0x9f16c76b6a83ac424ea736fb7dd2b1fc735888f222ee04dc1b1f7b933469faf8
swap at block:61,234,918 tx:0x9f16c76b6a83ac424ea736fb7dd2b1fc735888f222ee04dc1b1f7b933469faf8
swap at block:61,234,918 tx:0x9f16c76b6a83ac424ea736fb7dd2b1fc735888f222ee04dc1b1f7b933469faf8
.
dict_events
{0: {'chain': 'polygon',
'contract': 'uniswapv2pair',
'type': 'swap',
'platform': 'sushi',
'address': '0x604229c960e5cacf2aaeac8be68ac07ba9df81c3',
'tx_hash': '0x9f16c76b6a83ac424ea736fb7dd2b1fc735888f222ee04dc1b1f7b933469faf8',
'blk_num': 61234918,
'timestamp': 1725051030,
'details': {'web3_type': web3._utils.datatypes.Swap,
'token0': '0xa5E0829CaCEd8fFDD4De3c43696c57F7D7A678ff',
'token1': '0xbF6f53423F25Df43a057F42A840158D6fDdB45BF',
'amount0In': 19000000000000000000,
'amount1Out': 7889648}},
1: {'chain': 'polygon',
'contract': 'uniswapv2pair',
'type': 'swap',
'platform': 'sushi',
'address': '0x604229c960e5cacf2aaeac8be68ac07ba9df81c3',
'tx_hash': '0x9f16c76b6a83ac424ea736fb7dd2b1fc735888f222ee04dc1b1f7b933469faf8',
'blk_num': 61234918,
'timestamp': 1725051030,
'details': {'web3_type': web3._utils.datatypes.Swap,
'token0': '0xa5E0829CaCEd8fFDD4De3c43696c57F7D7A678ff',
'token1': '0xa5E0829CaCEd8fFDD4De3c43696c57F7D7A678ff',
'amount0In': 0,
'amount1Out': 0}},
2: {'chain': 'polygon',
'contract': 'uniswapv2pair',
'type': 'swap',
'platform': 'sushi',
'address': '0x3c986748414a812e455dcd5418246b8fded5c369',
'tx_hash': '0x9f16c76b6a83ac424ea736fb7dd2b1fc735888f222ee04dc1b1f7b933469faf8',
'blk_num': 61234918,
'timestamp': 1725051030,
'details': {'web3_type': web3._utils.datatypes.Swap,
'token0': '0xa5E0829CaCEd8fFDD4De3c43696c57F7D7A678ff',
'token1': '0xbF6f53423F25Df43a057F42A840158D6fDdB45BF',
'amount0In': 21176176598530377323,
'amount1Out': 796785880798504079}},
3: {'chain': 'polygon',
'contract': 'uniswapv2pair',
'type': 'swap',
'platform': 'sushi',
'address': '0x3c986748414a812e455dcd5418246b8fded5c369',
'tx_hash': '0x9f16c76b6a83ac424ea736fb7dd2b1fc735888f222ee04dc1b1f7b933469faf8',
'blk_num': 61234918,
'timestamp': 1725051030,
'details': {'web3_type': web3._utils.datatypes.Swap,
'token0': '0xa5E0829CaCEd8fFDD4De3c43696c57F7D7A678ff',
'token1': '0xa5E0829CaCEd8fFDD4De3c43696c57F7D7A678ff',
'amount0In': 0,
'amount1Out': 0}}}
Uni V3 Swap Events (Polygon) Example
from web3scout import *
abi = ABILoad(Platform.UNIV3, JSONContract.UniswapV3Pool)
connect = ConnectW3(Net.POLYGON)
connect.apply()
rEvents = RetrieveEvents(connect, abi)
last_block = rEvents.latest_block()
start_block = last_block - 15
dict_events = rEvents.apply(EventType.MINT, start_block=start_block, end_block=last_block)
mint at block:61,391,083 tx:0xe499971b5410e766d00bf4467c6b333cda04577f1068bb676debe72331254365
mint at block:61,391,092 tx:0x29d53602b1bbd67734c2e3deba8ad0a55aa84204a6244e720f24ee5160505213
.
dict_events
{0: {'chain': 'polygon',
'contract': 'uniswapv3pool',
'type': 'mint',
'platform': 'uniswap_v3',
'pool_address': '0xb6e57ed85c4c9dbfef2a68711e9d6f36c56e0fcb',
'tx_hash': '0xe499971b5410e766d00bf4467c6b333cda04577f1068bb676debe72331254365',
'blk_num': 61391083,
'timestamp': 1725401207,
'details': {'web3_type': web3._utils.datatypes.Mint,
'owner': '0xC36442b4a4522E871399CD717aBDD847Ab11FE88',
'tick_lower': -286090,
'tick_upper': -284860,
'liquidity_amount': 884887839988325,
'amount0': 39958320744269616249,
'amount1': 17912626}},
1: {'chain': 'polygon',
'contract': 'uniswapv3pool',
'type': 'mint',
'platform': 'uniswap_v3',
'pool_address': '0x960fdfe0de1079459493a7e3aa857f8ce0b34016',
'tx_hash': '0x29d53602b1bbd67734c2e3deba8ad0a55aa84204a6244e720f24ee5160505213',
'blk_num': 61391092,
'timestamp': 1725401227,
'details': {'web3_type': web3._utils.datatypes.Mint,
'owner': '0xC36442b4a4522E871399CD717aBDD847Ab11FE88',
'tick_lower': 22600,
'tick_upper': 40000,
'liquidity_amount': 7675592444129481120,
'amount0': 64052149877205455,
'amount1': 29656680135133456015}}}
Sushi Uniswap V2: Polygon
- Events (ie, Swap, Mint, Sync, Burn, Transfer): see notebook
Uniswap V3: Polygon
- Events (ie, Swap, Mint, Burn, Create): see notebook
Testing
Run the full test suite from the repo root:
> python -m pytest tests/ -v
Tests cover bug fixes and regression checks across:
- conversion — hex/bytes string conversion
- fetch_token — error handling in token metadata fetches
- deploy — contract deployment class references
- abi_load — import path corrections
- reorg_monitor — chain reorganization monitoring imports
- block_header — BlockHeader dataclass (extracted from eth_defi)
- token — ERC-20 token creation
- base_utils — port scanning utilities
Requirements
> pip install pytest
License
Web3Scout is licensed under the Apache License, Version 2.0.
See LICENSE and NOTICE for details.
Portions of this project may include code from third-party projects under compatible open-source licenses.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file web3scout-0.2.0.tar.gz.
File metadata
- Download URL: web3scout-0.2.0.tar.gz
- Upload date:
- Size: 168.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d976e7324ac9fdb3eb2cfd5908a732319c2d6d0601b03ff1d78d5f23889cbd4a
|
|
| MD5 |
26f7bcccd97d569ef56768d91eda07b5
|
|
| BLAKE2b-256 |
b955a7357fbd7ba3a9f29baa52a13013a58dadaf25ac8b0d14256e17543fbb31
|
File details
Details for the file web3scout-0.2.0-py3-none-any.whl.
File metadata
- Download URL: web3scout-0.2.0-py3-none-any.whl
- Upload date:
- Size: 189.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c0e27a1177ce1ca5f34f1f06233a94ce6228d305aab495039963622a6dd83648
|
|
| MD5 |
995218bf38b5971299e53acd6c1c9663
|
|
| BLAKE2b-256 |
d9e18f5d4911964ef5266ff94ec89fa1f72eaed2666b14740307c17d8bf6c1ce
|