rename to erc20-balances-transfers

pinax-network · Feb 27, 2025 · 2993bee · 2993bee
1 parent c72866b
commit 2993bee
Show file tree

Hide file tree

Showing 35 changed files with 69 additions and 28 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [workspace]
 members = [
-  "erc20-balances",
+  "erc20-balances-transfers",
   "clickhouse",
   "subgraphs",
 ]

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# ERC-20 Balances
+# ERC-20 Substreams
 
 > Substreams for tracking ERC-20 token balances & transfers for EVM blockchains.
 >
@@ -10,3 +10,9 @@ Includes the following:
 - [x] Apache Parquet
 - [x] Clickhouse SQL
 - [ ] Subgraphs (SpS)
+
+## Modules included
+
+- [x] ERC-20 Balances & Transfers
+- [ ] ERC-20 Contract Metadata
+- [ ] ERC-20 Supply
diff --git a/clickhouse/Cargo.toml b/clickhouse/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "erc20-balances-clickhouse"
+name = "erc20-clickhouse"
 description = { workspace = true }
 edition = { workspace = true }
 version = { workspace = true }
@@ -10,4 +10,4 @@ crate-type = ["cdylib"]
 [dependencies]
 substreams = { workspace = true }
 substreams-database-change = "2.0"
-erc20-balances = { path = "../erc20-balances" }
+erc20-balances-transfers = { path = "../erc20-balances-transfers" }
diff --git a/clickhouse/src/db_out.rs b/clickhouse/src/db_out.rs
@@ -1,4 +1,4 @@
-use erc20_balances::pb::erc20::types::v1::Events;
+use erc20_balances_transfers::pb::erc20::types::v1::Events;
 use substreams::errors::Error;
 use substreams_database_change::pb::database::DatabaseChanges;
 

diff --git a/clickhouse/substreams.yaml b/clickhouse/substreams.yaml
@@ -1,18 +1,18 @@
 specVersion: v0.1.0
 package:
-  name: erc20_balances_clickhouse
+  name: erc20_clickhouse
   version: v1.5.0
-  url: https://github.com/pinax-network/substreams-erc20-balances
+  url: https://github.com/pinax-network/substreams-erc20
 
 imports:
+  database_changes: https://github.com/streamingfast/substreams-sink-database-changes/releases/download/v2.0.0/substreams-database-change-v2.0.0.spkg
   sql: https://github.com/streamingfast/substreams-sink-sql/releases/download/protodefs-v1.0.7/substreams-sink-sql-protodefs-v1.0.7.spkg
-  database_change: https://github.com/streamingfast/substreams-sink-database-changes/releases/download/v2.0.0/substreams-database-change-v2.0.0.spkg
-  erc20_balances: https://spkg.io/pinax-network/erc20-balances-v1.5.0.spkg
+  erc20_balances: ./erc20-balances/erc20-balances-transfers-v1.5.0.spkg
 
 binaries:
   default:
     type: wasm/rust-v1
-    file: target/wasm32-unknown-unknown/release/erc20_balances_clickhouse.wasm
+    file: target/wasm32-unknown-unknown/release/erc20_clickhouse.wasm
 
 modules:
   - name: db_out

diff --git a/erc20-balances/Cargo.toml → erc20-balances-transfers/Cargo.toml b/erc20-balances/Cargo.toml → erc20-balances-transfers/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "erc20-balances"
+name = "erc20-balances-transfers"
 description = { workspace = true }
 edition = { workspace = true }
 version = { workspace = true }

diff --git a/erc20-balances/Makefile → erc20-balances-transfers/Makefile b/erc20-balances/Makefile → erc20-balances-transfers/Makefile
diff --git a/erc20-balances/README.md → erc20-balances-transfers/README.md b/erc20-balances/README.md → erc20-balances-transfers/README.md
@@ -1,9 +1,9 @@
-# Substreams ERC20 Balance Changes
+# Substreams: `ERC20 Balances & Transfers`
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 The goal of this Substreams project is to extract all ERC20 transfers from Ethereum events for the full chain.
 
-The `map_balance_changes` module will output messages of type [erc20.types.v1.BalanceChange](./proto/v1/erc20.proto#L15) defined by: 
+The `map_balance_changes` module will output messages of type [erc20.types.v1.BalanceChange](./proto/v1/erc20.proto#L15) defined by:
 
 ```proto
 message BalanceChange {

diff --git a/erc20-balances/logo.png → erc20-balances-transfers/logo.png b/erc20-balances/logo.png → erc20-balances-transfers/logo.png
diff --git a/...alances/src/algorithms/algorithm1_call.rs → ...ansfers/src/algorithms/algorithm1_call.rs b/...alances/src/algorithms/algorithm1_call.rs → ...ansfers/src/algorithms/algorithm1_call.rs
diff --git a/.../src/algorithms/algorithm2_child_calls.rs → .../src/algorithms/algorithm2_child_calls.rs b/.../src/algorithms/algorithm2_child_calls.rs → .../src/algorithms/algorithm2_child_calls.rs
diff --git a/erc20-balances/src/algorithms/fishing.rs → ...ances-transfers/src/algorithms/fishing.rs b/erc20-balances/src/algorithms/fishing.rs → ...ances-transfers/src/algorithms/fishing.rs
diff --git a/erc20-balances/src/algorithms/mod.rs → ...-balances-transfers/src/algorithms/mod.rs b/erc20-balances/src/algorithms/mod.rs → ...-balances-transfers/src/algorithms/mod.rs
diff --git a/erc20-balances/src/algorithms/scaled.rs → ...lances-transfers/src/algorithms/scaled.rs b/erc20-balances/src/algorithms/scaled.rs → ...lances-transfers/src/algorithms/scaled.rs
diff --git a/...ces/src/algorithms/total_sent_received.rs → ...ers/src/algorithms/total_sent_received.rs b/...ces/src/algorithms/total_sent_received.rs → ...ers/src/algorithms/total_sent_received.rs
diff --git a/erc20-balances/src/algorithms/utils.rs → ...alances-transfers/src/algorithms/utils.rs b/erc20-balances/src/algorithms/utils.rs → ...alances-transfers/src/algorithms/utils.rs
diff --git a/erc20-balances/src/lib.rs → erc20-balances-transfers/src/lib.rs b/erc20-balances/src/lib.rs → erc20-balances-transfers/src/lib.rs
diff --git a/erc20-balances/src/maps.rs → erc20-balances-transfers/src/maps.rs b/erc20-balances/src/maps.rs → erc20-balances-transfers/src/maps.rs
diff --git a/erc20-balances/src/pb/erc20.types.v1.rs → ...lances-transfers/src/pb/erc20.types.v1.rs b/erc20-balances/src/pb/erc20.types.v1.rs → ...lances-transfers/src/pb/erc20.types.v1.rs
diff --git a/erc20-balances/src/pb/mod.rs → erc20-balances-transfers/src/pb/mod.rs b/erc20-balances/src/pb/mod.rs → erc20-balances-transfers/src/pb/mod.rs
diff --git a/erc20-balances/src/utils.rs → erc20-balances-transfers/src/utils.rs b/erc20-balances/src/utils.rs → erc20-balances-transfers/src/utils.rs
diff --git a/erc20-balances/substreams.yaml → erc20-balances-transfers/substreams.yaml b/erc20-balances/substreams.yaml → erc20-balances-transfers/substreams.yaml
@@ -1,19 +1,19 @@
 specVersion: v0.1.0
 package:
-  name: erc20_balances
+  name: erc20_balances_transfers
   version: v1.5.0
   url: https://github.com/pinax-network/substreams-erc20-balances
 
 binaries:
   default:
     type: wasm/rust-v1
-    file: target/wasm32-unknown-unknown/release/erc20_balance.wasm
+    file: ../target/wasm32-unknown-unknown/release/erc20_balances_transfers.wasm
 
 protobuf:
   files:
     - erc20.proto
   importPaths:
-    - ./proto/v1
+    - ../proto/v1
   excludePaths:
     - sf/substreams
     - google

diff --git a/duckdb/Makefile → parquet/Makefile b/duckdb/Makefile → parquet/Makefile
diff --git a/duckdb/README.md → parquet/README.md b/duckdb/README.md → parquet/README.md
@@ -2,24 +2,37 @@
 
 ## Quickstart
 
-**Install [`substreams-sink-files`](https://github.com/streamingfast/substreams-sink-files)**
+### Install [`substreams-sink-files`](https://github.com/streamingfast/substreams-sink-files)
 
 ```bash
 brew install streamingfast/tap/substreams-sink-files
 ```
 
-**Download parquet files from Substreams**
+### Install [Duckdb](https://duckdb.org/#quickinstall)
+
+```bash
+curl https://install.duckdb.org | sh
+```
+
+### Download parquet files from Substreams
 ```bash
 substreams-sink-files run eth.substreams.pinax.network:443 \
     https://spkg.io/pinax-network/erc20-balances-v1.5.0.spkg map_events \
     "./out" 21525891:21526891 \
     --encoder parquet --file-block-count 1
 ```
 
-**Query the parquet files with DuckDB**
+Folder structure:
+
+- `./out`
+  - `./balance_changes`
+  - `./transfers`
+
+### Query the parquet files with DuckDB
+
+> Select the top sending addresses for DAI by total transferred value.
 
 ```sql
--- Select the top sending addresses for DAI by total transferred value.
 SELECT
     "from",
     count() as total_transfers,

diff --git a/...test_balances_by_contract_top_holders.sql → ...test_balances_by_contract_top_holders.sql b/...test_balances_by_contract_top_holders.sql → ...test_balances_by_contract_top_holders.sql
diff --git a/duckdb/latest_balances_by_owner.sql → parquet/latest_balances_by_owner.sql b/duckdb/latest_balances_by_owner.sql → parquet/latest_balances_by_owner.sql
diff --git a/.../missing_transfers_by_top50_contracts.sql → .../missing_transfers_by_top50_contracts.sql b/.../missing_transfers_by_top50_contracts.sql → .../missing_transfers_by_top50_contracts.sql
diff --git a/duckdb/missing_transfers_contracts.sql → parquet/missing_transfers_contracts.sql b/duckdb/missing_transfers_contracts.sql → parquet/missing_transfers_contracts.sql
diff --git a/duckdb/select_balances_by_contract.sql → parquet/select_balances_by_contract.sql b/duckdb/select_balances_by_contract.sql → parquet/select_balances_by_contract.sql
diff --git a/duckdb/select_balances_by_transaction.sql → parquet/select_balances_by_transaction.sql b/duckdb/select_balances_by_transaction.sql → parquet/select_balances_by_transaction.sql
diff --git a/duckdb/select_transfers_by_contract.sql → parquet/select_transfers_by_contract.sql b/duckdb/select_transfers_by_contract.sql → parquet/select_transfers_by_contract.sql
diff --git a/subgraphs/Cargo.toml b/subgraphs/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "erc20-balances-subgraphs"
+name = "erc20-subgraph"
 description = { workspace = true }
 edition = { workspace = true }
 version = { workspace = true }
@@ -10,4 +10,4 @@ crate-type = ["cdylib"]
 [dependencies]
 substreams = { workspace = true }
 substreams-entity-change = "2.0"
-erc20-balances = { path = "../erc20-balances" }
+erc20-balances-transfers = { path = "../erc20-balances-transfers" }
diff --git a/subgraphs/src/graph_out.rs b/subgraphs/src/graph_out.rs
@@ -1,4 +1,4 @@
-use erc20_balances::pb::erc20::types::v1::Events;
+use erc20_balances_transfers::pb::erc20::types::v1::Events;
 use substreams::errors::Error;
 use substreams_entity_change::pb::entity::EntityChanges;
 

diff --git a/subgraphs/substreams.yaml b/subgraphs/substreams.yaml
@@ -0,0 +1,22 @@
+specVersion: v0.1.0
+package:
+  name: erc20_subgraph
+  version: v1.5.0
+  url: https://github.com/pinax-network/substreams-erc20
+
+imports:
+  entity_changes: https://github.com/streamingfast/substreams-sink-entity-changes/releases/download/v2.0.0/substreams-entity-change-v2.0.0.spkg
+  erc20_balances: ./erc20-balances/erc20-balances-transfers-v1.5.0.spkg
+
+binaries:
+  default:
+    type: wasm/rust-v1
+    file: target/wasm32-unknown-unknown/release/erc20_subgraph.wasm
+
+modules:
+  - name: graph_out
+    kind: map
+    inputs:
+      - map: erc20_balances:map_events
+    output:
+      type: proto:sf.substreams.sink.entity.v1.EntityChanges