finish initial toc

paradigmxyz · Dec 30, 2023 · e063d50 · e063d50
1 parent d5e01ac
commit e063d50
Show file tree

Hide file tree

Showing 11 changed files with 75 additions and 44 deletions.
diff --git a/book/SUMMARY.md b/book/SUMMARY.md
@@ -2,60 +2,67 @@
 - [Intro](./intro/intro.md)
     - [Quickstart](./intro/quickstart.md)
     - [Installation](./intro/installation.md)
-    - [Concepts](./intro/concepts.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)
-- [Python](./cryo_python/overview.md)
+- [Cryo Python](./cryo_python/overview.md)
     - [Installation](./cryo_python/installation.md)
     - [Example Usage](./cryo_python/example_usage.md)
-    - [Speed](./cryo_python/speed.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)
-
----
-
-- [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)
+- [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
@@ -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/cookbook/reorgs.md b/book/cookbook/reorgs.md
@@ -0,0 +1 @@
+# Reorg Management
diff --git a/book/cookbook/uniswap.md b/book/cookbook/uniswap.md
@@ -0,0 +1 @@
+# Uniswap
diff --git a/book/intro/data_sources.md 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
@@ -0,0 +1 @@
+# Example Usage
diff --git a/book/reference/interfaces/cli.md b/book/reference/interfaces/cli.md
@@ -0,0 +1 @@
+# cli
diff --git a/book/reference/interfaces/interfaces.md 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
@@ -0,0 +1 @@
+# python
diff --git a/book/reference/interfaces/rust.md b/book/reference/interfaces/rust.md
@@ -0,0 +1 @@
+# rust
diff --git a/book/reference/reference.md b/book/reference/reference.md
@@ -0,0 +1 @@
+# Reference