diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..7cf7206 --- /dev/null +++ b/book.toml @@ -0,0 +1,14 @@ +[book] +authors = ["sslivkoff"] +language = "en" +multilingual = false +src = "book" +title = "cryo" +description = "field manual for cryo" + +[build] +build-dir = "target/book" + +[output.html.fold] +enable = true +level = 1 diff --git a/book/SUMMARY.md b/book/SUMMARY.md new file mode 100644 index 0000000..eca243b --- /dev/null +++ b/book/SUMMARY.md @@ -0,0 +1,68 @@ +# Summary +- [Intro](./intro/intro.md) + - [Quickstart](./intro/quickstart.md) + - [Installation](./intro/installation.md) + - [Example Usage](./intro/example_usage.md) +- [Concepts](./intro/concepts.md) + - [Interfaces: CLI, Rust Python](./intro/interfaces.md) + - [RPC Data Sources](./intro/data_sources.md) + - [Speed](./cryo_python/speed.md) +- [Basic Usage](./basic_usage/basic_usage.md) + - [Data Selection](./basic_usage/data_selection.md) + - [Data Acquisition](./basic_usage/data_acquisition.md) + - [Data Formatting](./basic_usage/data_formatting.md) + - [Data Querying](./basic_usage/data_querying.md) +- [Cryo Python](./cryo_python/overview.md) + - [Installation](./cryo_python/installation.md) + - [Example Usage](./cryo_python/example_usage.md) + - [Reference](./cryo_python/reference.md) +- [Cookbook](./cookbook/cookbook.md) + - [Reorgs](./cookbook/reorgs.md) + - [Uniswap](./cookbook/uniswap.md) +- [Contributing](./contributing/contributing.md) + - [Repository Layout](./contributing/repository_layout.md) + - [Adding a Dataset](./contributing/adding_a_dataset.md) +- [Reference](./reference/reference.md) + - [Overview of each interface](./reference/interfaces/interfaces.md) + - [cli](./reference/interfaces/cli.md) + - [python](./reference/interfaces/python.md) + - [rust](./reference/interfaces/rust.md) + - [Overview of each dataset](./datasets/dataset_reference.md) + - [address_appearances](./datasets/address_appearances.md) + - [balance_diffs](./datasets/balance_diffs.md) + - [balance_reads](./datasets/balance_reads.md) + - [balances](./datasets/balances.md) + - [blocks](./datasets/blocks.md) + - [code_diffs](./datasets/code_diffs.md) + - [code_reads](./datasets/code_reads.md) + - [codes](./datasets/codes.md) + - [contracts](./datasets/contracts.md) + - [erc20_balances](./datasets/erc20_balances.md) + - [erc20_metadata](./datasets/erc20_metadata.md) + - [erc20_supplies](./datasets/erc20_supplies.md) + - [erc20_transfers](./datasets/erc20_transfers.md) + - [erc721_metadata](./datasets/erc721_metadata.md) + - [erc721_transfers](./datasets/erc721_transfers.md) + - [eth_calls](./datasets/eth_calls.md) + - [four_byte_counts](./datasets/four_byte_counts.md) + - [geth_calls](./datasets/geth_calls.md) + - [geth_code_diffs](./datasets/geth_code_diffs.md) + - [geth_balance_diffs](./datasets/geth_balance_diffs.md) + - [geth_storage_diffs](./datasets/geth_storage_diffs.md) + - [geth_nonce_diffs](./datasets/geth_nonce_diffs.md) + - [geth_opcodes](./datasets/geth_opcodes.md) + - [javascript_traces](./datasets/javascript_traces.md) + - [logs](./datasets/logs.md) + - [native_transfers](./datasets/native_transfers.md) + - [nonce_diffs](./datasets/nonce_diffs.md) + - [nonce_reads](./datasets/nonce_reads.md) + - [nonces](./datasets/nonces.md) + - [slots](./datasets/slots.md) + - [storage_reads](./datasets/storage_reads.md) + - [slot_diffs](./datasets/slot_diffs.md) + - [slot_reads](./datasets/slot_reads.md) + - [traces](./datasets/traces.md) + - [trace_calls](./datasets/trace_calls.md) + - [transactions](./datasets/transactions.md) + - [vm_traces](./datasets/vm_traces.md) +- [Additional Reading](./additional_reading/additional_reading.md) diff --git a/book/additional_reading/additional_reading.md b/book/additional_reading/additional_reading.md new file mode 100644 index 0000000..23058c0 --- /dev/null +++ b/book/additional_reading/additional_reading.md @@ -0,0 +1,15 @@ +# Additional Reading + +### RPC Information +- [Ultimate tracing reference](https://github.com/paradigmxyz/ultimate_evm_tracing_reference) + +### Cryo Tutorials +- [cryo: Your gateway to blockchain data](https://docs.chainstack.com/docs/cryo-your-gateway-to-blockchain-data) +- [Analyzing ethereum with cryo](https://mteam88.github.io/posts/analyzing-ethereum-with-cryo/) +- [Extracting blockchain data with cryo](https://www.degencode.com/p/extracting-blockchain-data-with-cryo) +- [Getting Started with Cryo Data Analysis in AWS SageMaker](https://hackmd.io/@shield3/rJpNocEga) + +### Articles using cryo +- [Ethereum Transfers Heatmap](https://banteg.xyz/posts/heatmap/) +- [Minimal Proxy Compendium](https://banteg.xyz/posts/minimal-proxies/) + diff --git a/book/basic_usage/basic_usage.md b/book/basic_usage/basic_usage.md new file mode 100644 index 0000000..e2a86b0 --- /dev/null +++ b/book/basic_usage/basic_usage.md @@ -0,0 +1 @@ +# Basic Usage diff --git a/book/basic_usage/data_acquisition.md b/book/basic_usage/data_acquisition.md new file mode 100644 index 0000000..35a836a --- /dev/null +++ b/book/basic_usage/data_acquisition.md @@ -0,0 +1,6 @@ +# Data Acquisition + +Chapter: Data Acquisition + - Ratelimits and Concurrency Limits + - Staying Close to Tip + - Logging diff --git a/book/basic_usage/data_formatting.md b/book/basic_usage/data_formatting.md new file mode 100644 index 0000000..c384dba --- /dev/null +++ b/book/basic_usage/data_formatting.md @@ -0,0 +1,7 @@ +# Data Formatting + +Chapter: Data Output Formatting + - Formatting Binary + - Formatting u256 + - Parquet Options + - Partitioning diff --git a/book/basic_usage/data_querying.md b/book/basic_usage/data_querying.md new file mode 100644 index 0000000..6f278a6 --- /dev/null +++ b/book/basic_usage/data_querying.md @@ -0,0 +1 @@ +# Data Querying diff --git a/book/basic_usage/data_selection.md b/book/basic_usage/data_selection.md new file mode 100644 index 0000000..957f841 --- /dev/null +++ b/book/basic_usage/data_selection.md @@ -0,0 +1,7 @@ +# Data Selection + +Chapter: Data Selection + - Block queries + - Filtering rows + - Filtering columns + - Command Chaining diff --git a/book/contributing/adding_a_dataset.md b/book/contributing/adding_a_dataset.md new file mode 100644 index 0000000..3ad35b9 --- /dev/null +++ b/book/contributing/adding_a_dataset.md @@ -0,0 +1 @@ +# Adding a Dataset diff --git a/book/contributing/contributing.md b/book/contributing/contributing.md new file mode 100644 index 0000000..854139a --- /dev/null +++ b/book/contributing/contributing.md @@ -0,0 +1 @@ +# Contributing diff --git a/book/contributing/repository_layout.md b/book/contributing/repository_layout.md new file mode 100644 index 0000000..583c56b --- /dev/null +++ b/book/contributing/repository_layout.md @@ -0,0 +1,5 @@ +# Repository Layout + + + + diff --git a/book/cookbook/cookbook.md b/book/cookbook/cookbook.md new file mode 100644 index 0000000..1ae5a04 --- /dev/null +++ b/book/cookbook/cookbook.md @@ -0,0 +1,6 @@ +# Cookbook + +Chapter: Specific Protocols + - ENS + - Chainlink + - Uniswap diff --git a/book/cookbook/reorgs.md b/book/cookbook/reorgs.md new file mode 100644 index 0000000..69bc211 --- /dev/null +++ b/book/cookbook/reorgs.md @@ -0,0 +1 @@ +# Reorg Management diff --git a/book/cookbook/uniswap.md b/book/cookbook/uniswap.md new file mode 100644 index 0000000..522ee9e --- /dev/null +++ b/book/cookbook/uniswap.md @@ -0,0 +1 @@ +# Uniswap diff --git a/book/cryo_python.md b/book/cryo_python.md new file mode 100644 index 0000000..4193ef4 --- /dev/null +++ b/book/cryo_python.md @@ -0,0 +1 @@ +# Python diff --git a/book/cryo_python/example_usage.md b/book/cryo_python/example_usage.md new file mode 100644 index 0000000..a5512fd --- /dev/null +++ b/book/cryo_python/example_usage.md @@ -0,0 +1 @@ +# example usage diff --git a/book/cryo_python/installation.md b/book/cryo_python/installation.md new file mode 100644 index 0000000..ca9d2b7 --- /dev/null +++ b/book/cryo_python/installation.md @@ -0,0 +1,29 @@ + +## Installation + +There are two main options for installing `cryo_python`. + +Installing from pip is faster and does not require rust to be installed. + +Installing from source allows using the latest unreleased version of cryo. + +#### Option 1: Install from pip + +``` +pip install cryo_python +``` + +#### Option 2: Install from source + +``` +pip install maturin +git clone https://github.com/paradigmxyz/cryo +cd cryo/crates/python +maturin build --release +pip install --force-reinstall .whl +``` + +#### Other notes + +If you would like `cryo` to output results using pandas instead of polars, also install pandas: `pip install pandas` + diff --git a/book/cryo_python/overview.md b/book/cryo_python/overview.md new file mode 100644 index 0000000..4193ef4 --- /dev/null +++ b/book/cryo_python/overview.md @@ -0,0 +1 @@ +# Python diff --git a/book/cryo_python/reference.md b/book/cryo_python/reference.md new file mode 100644 index 0000000..c770408 --- /dev/null +++ b/book/cryo_python/reference.md @@ -0,0 +1 @@ +# reference diff --git a/book/cryo_python/speed.md b/book/cryo_python/speed.md new file mode 100644 index 0000000..9a012c2 --- /dev/null +++ b/book/cryo_python/speed.md @@ -0,0 +1 @@ +# Speed diff --git a/book/datasets/address_appearances.md b/book/datasets/address_appearances.md new file mode 100644 index 0000000..55c021a --- /dev/null +++ b/book/datasets/address_appearances.md @@ -0,0 +1 @@ +# address_appearances diff --git a/book/datasets/balance_diffs.md b/book/datasets/balance_diffs.md new file mode 100644 index 0000000..1fac778 --- /dev/null +++ b/book/datasets/balance_diffs.md @@ -0,0 +1 @@ +# balance_diffs diff --git a/book/datasets/balance_reads.md b/book/datasets/balance_reads.md new file mode 100644 index 0000000..4e1616e --- /dev/null +++ b/book/datasets/balance_reads.md @@ -0,0 +1 @@ +# balance_reads diff --git a/book/datasets/balances.md b/book/datasets/balances.md new file mode 100644 index 0000000..9383b5f --- /dev/null +++ b/book/datasets/balances.md @@ -0,0 +1 @@ +# balances diff --git a/book/datasets/blocks.md b/book/datasets/blocks.md new file mode 100644 index 0000000..f8ef254 --- /dev/null +++ b/book/datasets/blocks.md @@ -0,0 +1 @@ +# calls diff --git a/book/datasets/code_diffs.md b/book/datasets/code_diffs.md new file mode 100644 index 0000000..600a3af --- /dev/null +++ b/book/datasets/code_diffs.md @@ -0,0 +1 @@ +# code_diffs diff --git a/book/datasets/code_reads.md b/book/datasets/code_reads.md new file mode 100644 index 0000000..df05379 --- /dev/null +++ b/book/datasets/code_reads.md @@ -0,0 +1 @@ +# code_reads diff --git a/book/datasets/codes.md b/book/datasets/codes.md new file mode 100644 index 0000000..00f9a3d --- /dev/null +++ b/book/datasets/codes.md @@ -0,0 +1 @@ +# codes diff --git a/book/datasets/contracts.md b/book/datasets/contracts.md new file mode 100644 index 0000000..b8bdce9 --- /dev/null +++ b/book/datasets/contracts.md @@ -0,0 +1 @@ +# contracts diff --git a/book/datasets/dataset_guide.md b/book/datasets/dataset_guide.md new file mode 100644 index 0000000..6fc8f73 --- /dev/null +++ b/book/datasets/dataset_guide.md @@ -0,0 +1,9 @@ +# Dataset Reference + +- for each dataset: + - semantic description + - schema + - tips and tricks + - available options + - examples in cli and python + - possibly: byte size and collection time diff --git a/book/datasets/dataset_reference.md b/book/datasets/dataset_reference.md new file mode 100644 index 0000000..451585e --- /dev/null +++ b/book/datasets/dataset_reference.md @@ -0,0 +1 @@ +# Dataset Reference diff --git a/book/datasets/erc20_balances.md b/book/datasets/erc20_balances.md new file mode 100644 index 0000000..21434f4 --- /dev/null +++ b/book/datasets/erc20_balances.md @@ -0,0 +1 @@ +# erc20_balances diff --git a/book/datasets/erc20_metadata.md b/book/datasets/erc20_metadata.md new file mode 100644 index 0000000..c807bf0 --- /dev/null +++ b/book/datasets/erc20_metadata.md @@ -0,0 +1 @@ +# erc20_metadata diff --git a/book/datasets/erc20_supplies.md b/book/datasets/erc20_supplies.md new file mode 100644 index 0000000..70d82f3 --- /dev/null +++ b/book/datasets/erc20_supplies.md @@ -0,0 +1 @@ +# erc20_supplies diff --git a/book/datasets/erc20_transfers.md b/book/datasets/erc20_transfers.md new file mode 100644 index 0000000..83c4c34 --- /dev/null +++ b/book/datasets/erc20_transfers.md @@ -0,0 +1 @@ +# erc20_transfers diff --git a/book/datasets/erc721_metadata.md b/book/datasets/erc721_metadata.md new file mode 100644 index 0000000..67a6c0e --- /dev/null +++ b/book/datasets/erc721_metadata.md @@ -0,0 +1 @@ +# erc721_metadata diff --git a/book/datasets/erc721_transfers.md b/book/datasets/erc721_transfers.md new file mode 100644 index 0000000..50d6ecc --- /dev/null +++ b/book/datasets/erc721_transfers.md @@ -0,0 +1 @@ +# erc721_transfers diff --git a/book/datasets/eth_calls.md b/book/datasets/eth_calls.md new file mode 100644 index 0000000..1a97bc5 --- /dev/null +++ b/book/datasets/eth_calls.md @@ -0,0 +1 @@ +# eth_calls diff --git a/book/datasets/four_byte_counts.md b/book/datasets/four_byte_counts.md new file mode 100644 index 0000000..fcc4082 --- /dev/null +++ b/book/datasets/four_byte_counts.md @@ -0,0 +1 @@ +# four_byte_counts diff --git a/book/datasets/geth_balance_diffs.md b/book/datasets/geth_balance_diffs.md new file mode 100644 index 0000000..1bf49de --- /dev/null +++ b/book/datasets/geth_balance_diffs.md @@ -0,0 +1 @@ +# geth_balance_diffs diff --git a/book/datasets/geth_calls.md b/book/datasets/geth_calls.md new file mode 100644 index 0000000..d569552 --- /dev/null +++ b/book/datasets/geth_calls.md @@ -0,0 +1 @@ +# geth_calls diff --git a/book/datasets/geth_code_diffs.md b/book/datasets/geth_code_diffs.md new file mode 100644 index 0000000..b40c109 --- /dev/null +++ b/book/datasets/geth_code_diffs.md @@ -0,0 +1 @@ +# geth_code_diffs diff --git a/book/datasets/geth_nonce_diffs.md b/book/datasets/geth_nonce_diffs.md new file mode 100644 index 0000000..30fdf88 --- /dev/null +++ b/book/datasets/geth_nonce_diffs.md @@ -0,0 +1 @@ +# geth_nonce_diffs diff --git a/book/datasets/geth_opcodes.md b/book/datasets/geth_opcodes.md new file mode 100644 index 0000000..dabcf2d --- /dev/null +++ b/book/datasets/geth_opcodes.md @@ -0,0 +1 @@ +# geth_opcodes diff --git a/book/datasets/geth_storage_diffs.md b/book/datasets/geth_storage_diffs.md new file mode 100644 index 0000000..528aa2f --- /dev/null +++ b/book/datasets/geth_storage_diffs.md @@ -0,0 +1 @@ +# geth_storage_diffs diff --git a/book/datasets/javascript_traces.md b/book/datasets/javascript_traces.md new file mode 100644 index 0000000..dddf27e --- /dev/null +++ b/book/datasets/javascript_traces.md @@ -0,0 +1 @@ +# javascript_traces diff --git a/book/datasets/logs.md b/book/datasets/logs.md new file mode 100644 index 0000000..5d22875 --- /dev/null +++ b/book/datasets/logs.md @@ -0,0 +1 @@ +# logs diff --git a/book/datasets/native_transfers.md b/book/datasets/native_transfers.md new file mode 100644 index 0000000..9ad5436 --- /dev/null +++ b/book/datasets/native_transfers.md @@ -0,0 +1 @@ +# native_transfers diff --git a/book/datasets/nonce_diffs.md b/book/datasets/nonce_diffs.md new file mode 100644 index 0000000..3b4d0c0 --- /dev/null +++ b/book/datasets/nonce_diffs.md @@ -0,0 +1 @@ +# nonce_diffs diff --git a/book/datasets/nonce_reads.md b/book/datasets/nonce_reads.md new file mode 100644 index 0000000..3c7409b --- /dev/null +++ b/book/datasets/nonce_reads.md @@ -0,0 +1 @@ +# nonce_reads diff --git a/book/datasets/nonces.md b/book/datasets/nonces.md new file mode 100644 index 0000000..deafc3d --- /dev/null +++ b/book/datasets/nonces.md @@ -0,0 +1 @@ +# nonces diff --git a/book/datasets/slot_diffs.md b/book/datasets/slot_diffs.md new file mode 100644 index 0000000..262ccca --- /dev/null +++ b/book/datasets/slot_diffs.md @@ -0,0 +1 @@ +# slot_diffs diff --git a/book/datasets/slot_reads.md b/book/datasets/slot_reads.md new file mode 100644 index 0000000..35eda6a --- /dev/null +++ b/book/datasets/slot_reads.md @@ -0,0 +1 @@ +# slot_reads diff --git a/book/datasets/slots.md b/book/datasets/slots.md new file mode 100644 index 0000000..e081a45 --- /dev/null +++ b/book/datasets/slots.md @@ -0,0 +1 @@ +# slots diff --git a/book/datasets/storage_reads.md b/book/datasets/storage_reads.md new file mode 100644 index 0000000..503b919 --- /dev/null +++ b/book/datasets/storage_reads.md @@ -0,0 +1 @@ +# storage_reads diff --git a/book/datasets/trace_calls.md b/book/datasets/trace_calls.md new file mode 100644 index 0000000..c335f0f --- /dev/null +++ b/book/datasets/trace_calls.md @@ -0,0 +1 @@ +# trace_calls diff --git a/book/datasets/traces.md b/book/datasets/traces.md new file mode 100644 index 0000000..6d82ffc --- /dev/null +++ b/book/datasets/traces.md @@ -0,0 +1 @@ +# traces diff --git a/book/datasets/transactions.md b/book/datasets/transactions.md new file mode 100644 index 0000000..2959e69 --- /dev/null +++ b/book/datasets/transactions.md @@ -0,0 +1 @@ +# transactions diff --git a/book/datasets/vm_traces.md b/book/datasets/vm_traces.md new file mode 100644 index 0000000..6389424 --- /dev/null +++ b/book/datasets/vm_traces.md @@ -0,0 +1 @@ +# vm_traces diff --git a/book/intro/concepts.md b/book/intro/concepts.md new file mode 100644 index 0000000..2bbaba2 --- /dev/null +++ b/book/intro/concepts.md @@ -0,0 +1,2 @@ +# Concepts +- Time dimension: Blocks vs Transactions vs Timestamps (and Ranges) diff --git a/book/intro/data_sources.md b/book/intro/data_sources.md new file mode 100644 index 0000000..4c7519c --- /dev/null +++ b/book/intro/data_sources.md @@ -0,0 +1 @@ +# RPC Data Sources diff --git a/book/intro/example_usage.md b/book/intro/example_usage.md new file mode 100644 index 0000000..a56da81 --- /dev/null +++ b/book/intro/example_usage.md @@ -0,0 +1 @@ +# Example Usage diff --git a/book/intro/installation.md b/book/intro/installation.md new file mode 100644 index 0000000..25267fe --- /dev/null +++ b/book/intro/installation.md @@ -0,0 +1 @@ +# Installation diff --git a/book/intro/interfaces.md b/book/intro/interfaces.md new file mode 100644 index 0000000..f0b0a81 --- /dev/null +++ b/book/intro/interfaces.md @@ -0,0 +1 @@ +# Interfaces: CLI, Rust Python diff --git a/book/intro/intro.md b/book/intro/intro.md new file mode 100644 index 0000000..1e0981f --- /dev/null +++ b/book/intro/intro.md @@ -0,0 +1 @@ +# Intro diff --git a/book/intro/quickstart.md b/book/intro/quickstart.md new file mode 100644 index 0000000..acb9843 --- /dev/null +++ b/book/intro/quickstart.md @@ -0,0 +1 @@ +# Quickstart diff --git a/book/quickstart.md b/book/quickstart.md new file mode 100644 index 0000000..acb9843 --- /dev/null +++ b/book/quickstart.md @@ -0,0 +1 @@ +# Quickstart diff --git a/book/reference/interfaces/cli.md b/book/reference/interfaces/cli.md new file mode 100644 index 0000000..ecfe9df --- /dev/null +++ b/book/reference/interfaces/cli.md @@ -0,0 +1 @@ +# cli diff --git a/book/reference/interfaces/interfaces.md b/book/reference/interfaces/interfaces.md new file mode 100644 index 0000000..31897c8 --- /dev/null +++ b/book/reference/interfaces/interfaces.md @@ -0,0 +1 @@ +# Overview of each interface diff --git a/book/reference/interfaces/python.md b/book/reference/interfaces/python.md new file mode 100644 index 0000000..ebf14b2 --- /dev/null +++ b/book/reference/interfaces/python.md @@ -0,0 +1 @@ +# python diff --git a/book/reference/interfaces/rust.md b/book/reference/interfaces/rust.md new file mode 100644 index 0000000..27f2574 --- /dev/null +++ b/book/reference/interfaces/rust.md @@ -0,0 +1 @@ +# rust diff --git a/book/reference/reference.md b/book/reference/reference.md new file mode 100644 index 0000000..cf5aa07 --- /dev/null +++ b/book/reference/reference.md @@ -0,0 +1 @@ +# Reference