Skip to main content

Data visualization for EVM-based blockchains

Project description

Documentation Status

Welcome to Web3cat!

/docs/images/web3cat.png

Meow, fellow researcher!

Web3cat is a framework for fetching and analyzing blockchain data.

Currently, it supports only EVM chains: Ethereum, Polygon, BNB, etc.

Design philosophy

  1. Visualize the data with minimum code

  2. Free for downloading, saving, and analyzing the data however you want

  3. Cache the data to avoid re-fetching anything at all

  4. Fully decentralized, that is, depending only on the blockchain RPC

Quick demo

/docs/images/web3cat_demo.gif

Getting started

  1. Install python package

pip install web3cat
  1. Set up your archive node rpc. The easiest (and also free) way is to use Alchemy.

  2. Set initial configuration

import os
os.environ['WEB3_PROVIDER_URI'] = 'https://eth-mainnet.g.alchemy.com/v2/<YOUR_ALCHEMY_API_KEY>'
os.environ['WEB3_CACHE_PATH']="cache.sqlite3"
  1. (optional for Jupyter) Initialize bokeh for python notebooks

from bokeh.io import output_notebook

output_notebook()
  1. Run sample visualization

from web3cat.view import View
from datetime import datetime

v = View(token="DAI", start=datetime(2022, 6, 1), end = datetime(2022, 10, 30)) \
    .total_supply() \
    .balance(["0x5d3a536E4D6DbD6114cc1Ead35777bAB948E3643", "0xbEbc44782C7dB0a1A60Cb6fe97d0b483032FF1C7"])
v.show()
docs/images/view1.png
  1. Get underlying data

    v.get_data(0).transfers[["date", "block_number", "from", "to", "value"]]
    docs/images/view_getting_started1.png

Roadmap

Use framework base layers to add analytics for protocols like Uniswap, Liquity, Aave, Compound, Frax, etc.

Contributing

So far no bureaucracy here, open issues, make pull requests, and have fun!

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

web3cat-0.1.3.tar.gz (914.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

web3cat-0.1.3-py3-none-any.whl (951.6 kB view details)

Uploaded Python 3

File details

Details for the file web3cat-0.1.3.tar.gz.

File metadata

  • Download URL: web3cat-0.1.3.tar.gz
  • Upload date:
  • Size: 914.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.10.6 Darwin/20.6.0

File hashes

Hashes for web3cat-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a0e296db47fbc028585fe055461db3e55797bf2bec3714a3a64adb1bf23bf7d2
MD5 a476703918abddd86d0124d4d1432489
BLAKE2b-256 70f0cb5f4bf091453952201dda5dafea531976a1b8a2acd4b620b7642149d48c

See more details on using hashes here.

File details

Details for the file web3cat-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: web3cat-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 951.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.10.6 Darwin/20.6.0

File hashes

Hashes for web3cat-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0529882410c677bfb590abbe1508b9b0a88f2fd37be8f5d01c13c63d8b1b6b49
MD5 05bd239fdc8aa9ea81a946838f39efb1
BLAKE2b-256 d0649a5224ced80c34435a4455224ac0f07281b77df019ea14cb9f356d01d8d0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page