index.rst

Note

ctc is in beta, please report bugs to the issue tracker

These docs are also a work in progress. Some sections are not yet complete. Feel free to report any documentation-related issues to the issue tracker.

Check the Chain (ctc)

ctc is a tool for historical data analysis of Ethereum and other EVM chains

It can be used as either 1) a cli tool or 2) a python package

Features

.. hlist::
   :columns: 1

   * **data collection**: collects data from archive nodes robustly and efficiently
   * **data storage**: stores collected data on disk so that it only needs to be collected once
   * **data coding**: handles data encoding and decoding automatically by default
   * **data analysis**: computes derived metrics and other quantitative data summaries
   * **data visualization**: plots data to maximize data interpretability and sharing
   * **protocol specificity**: includes functionality for protocols like Chainlink and Uniswap
   * **command line interface**: performs many block explorer tasks in the terminal

Guide

• To install ctc, see Installation.
• To use ctc from the command line, see Command Line Interface.
• To use ctc in python, see Python Interface.
• To use ctc with specific protocols like Uniswap or Chainlink, see the Specific Protocols (cli) or Specific Protocols (python).
• To view the ctc source code, check out the GitHub Repository.

Datatypes

Datatype	CLI	Python	Source
ABIs	CLI	Python	Source
Addresses	CLI	Python	Source
Binary Data	CLI	Python	Source
Blocks	CLI	Python	Source
ERC20s	CLI	Python	Source
ETH Balances	CLI	Python	Source
Events	CLI	Python	Source
Transactions	CLI	Python	Source

Specific Protocols

Protocol	CLI	Python	Source
Aave V2	CLI	Python	Source
Balancer	CLI	Python	Source
Chainlink	CLI	Python	Source
Compound	-	Python	Source
Curve	CLI	Python	Source
ENS	CLI	Python	Source
Fei	CLI	Python	Source
Gnosis Safe	CLI	Python	Source
Multicall	CLI	Python	Source
Rari	CLI	Python	Source
Uniswap V2	CLI	Python	Source
Uniswap V3	CLI	Python	Source
Yearn	CLI	Python	Source

External Data Sources

Data Source	CLI	Python	Source
4byte	CLI	Python	Source
CoinGecko	CLI	Python	Source
Defi Llama	CLI	Python	Source
Etherscan	CLI	Python	Source

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: The Basics

   Introduction <self>

   ./overview/installation
   ./overview/dependencies
   ./overview/configuration
   ./overview/changelog
   ./overview/faq

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Data & Ops

   ./data_ops/obtaining_data
   ./data_ops/storing_data
   ./data_ops/performance
   ./data_ops/monitoring

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: Command Line Interface

   ./cli/basic_usage
   ./cli/subcommands
   ./cli/useful_aliases
   ./cli/similar_tools

.. toctree::
   :maxdepth: 4
   :hidden:
   :caption: Python Interface

   ./python/code_tour
   ./python/rpc_client
   ./python/async_code
   ./python/datatypes
   ./python/specific_protocols
   ./python/similar_tools