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.1.tar.gz (905.2 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.1-py3-none-any.whl (940.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: web3cat-0.1.1.tar.gz
  • Upload date:
  • Size: 905.2 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.1.tar.gz
Algorithm Hash digest
SHA256 912cf326bec3e6ebf149ba8291660e1a455558a6e025152197f503096f037ff5
MD5 f3a9f90a077d2f14f3547e07764a788e
BLAKE2b-256 fd28cc0e910c4940953d4733c6962b45086de4d4d281bc8fe19c4faf3db1b025

See more details on using hashes here.

File details

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

File metadata

  • Download URL: web3cat-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 940.4 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 82bac12ebb83538a67201253f0a7e70778dee627421017e73ac396ebe7372964
MD5 d2282b92e155ec057ffac5403c8dc7be
BLAKE2b-256 575edab2110eec01a6ec9754d71032d11a71d26f4abcef57a28cc969116141bd

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