mriusero commited on
Commit
4c61350
·
verified ·
1 Parent(s): 337fd88

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +35 -31
README.md CHANGED
@@ -56,33 +56,35 @@ Tools used in this process:
56
  Code is available on [GitHub](https://github.com/mriusero/defi-user-behavior-clustering) and ETL process documentation is explained [here](https://github.com/mriusero/defi-user-behavior-clustering/blob/main/docs/etl_pipeline_flow.md).
57
 
58
  ---
59
- ## Subsets
60
 
61
  ### `users.parquet`
62
- This file focuses on user-level data and is aimed at answering questions related to user behavior, activity trends, and protocol interactions. Potential use cases include:
63
- - Analyzing the lifecycle of user activity in DeFi.
64
- - Identifying power users or dormant users.
65
- - Mapping the interaction between users and various protocols.
66
- ---
67
- - **`address`** *(string)*: The wallet address of the user.
68
- - **`first_seen`** *(datetime)*: The first recorded activity of the user.
69
- - **`last_seen`** *(datetime)*: The most recent activity of the user.
70
- - **`protocol_types`** *(list/string)*: Types of protocols the user interacted with.
71
- - **`protocols_used`** *(list/string)*: Specific protocols the user interacted with.
72
- - **`received_count`** *(integer)*: The total number of transactions received by the user.
73
- - **`total_received (ETH)`** *(float)*: The total amount of ETH received by the user.
74
- - **`sent_count`** *(integer)*: The total number of transactions sent by the user.
75
- - **`total_sent (ETH)`** *(float)*: The total amount of ETH sent by the user.
76
- - **`transactions`** *(integer)*: The total number of transactions the user participated in.
 
77
 
78
  ---
79
 
80
  ### `market.parquet`
81
- This file aggregates market-related data over time intervals, offering insights into protocol performance and market dynamics. Objectives include:
82
- - Understanding market trends across DeFi protocols and tokens.
83
- - Analyzing trading volumes, transaction activity, and price fluctuations.
84
- - Identifying periods of high or low activity for specific tokens or protocols.
85
- ---
 
86
  - **`timestamp`** *(datetime)*: The time when the data was recorded.
87
  - **`blockchain`** *(string)*: The blockchain network (e.g., Ethereum, Binance Smart Chain).
88
  - **`protocol_name`** *(string)*: The name of the protocol associated with the data.
@@ -114,11 +116,12 @@ This file aggregates market-related data over time intervals, offering insights
114
  ---
115
 
116
  ### `transactions.parquet`
117
- This file provides granular transaction-level data, which is crucial for understanding the flow of assets within the DeFi ecosystem. Applications include:
118
- - Tracing the movement of funds between addresses.
119
- - Analyzing transaction costs (gas) and failure rates.
120
- - Identifying anomalous or fraudulent transactions.
121
- ---
 
122
  - **`timestamp`** *(datetime)*: The time when the transaction occurred.
123
  - **`transaction_hash`** *(string)*: The unique hash identifying the transaction.
124
  - **`from`** *(string)*: The sender's wallet address.
@@ -133,11 +136,12 @@ This file provides granular transaction-level data, which is crucial for underst
133
  ---
134
 
135
  ### `contracts.parquet`
136
- This file documents details about the smart contracts associated with various DeFi protocols. It supports:
137
- - Categorizing contracts by protocol, type, and use case.
138
- - Analyzing the adoption of specific contract standards (e.g., ERC-20, ERC-721).
139
- - Exploring the relationship between contract attributes and protocol performance.
140
- ---
 
141
  - **`contract_address`** *(string)*: The unique address of the smart contract.
142
  - **`blockchain`** *(string)*: The blockchain network where the contract is deployed.
143
  - **`type`** *(string)*: The type of contract (e.g., ERC-20, ERC-721).
 
56
  Code is available on [GitHub](https://github.com/mriusero/defi-user-behavior-clustering) and ETL process documentation is explained [here](https://github.com/mriusero/defi-user-behavior-clustering/blob/main/docs/etl_pipeline_flow.md).
57
 
58
  ---
59
+ # Subsets
60
 
61
  ### `users.parquet`
62
+ This file focuses on user-level data and is aimed at answering questions related to user behavior, activity trends, and protocol interactions.
63
+ Potential use cases include:
64
+ - Analyzing the lifecycle of user activity in DeFi.
65
+ - Identifying power users or dormant users.
66
+ - Mapping the interaction between users and various protocols.
67
+
68
+ * **`address`** *(string)*: The wallet address of the user.
69
+ * **`first_seen`** *(datetime)*: The first recorded activity of the user.
70
+ * **`last_seen`** *(datetime)*: The most recent activity of the user.
71
+ * **`protocol_types`** *(list/string)*: Types of protocols the user interacted with.
72
+ * **`protocols_used`** *(list/string)*: Specific protocols the user interacted with.
73
+ * **`received_count`** *(integer)*: The total number of transactions received by the user.
74
+ * **`total_received (ETH)`** *(float)*: The total amount of ETH received by the user.
75
+ * **`sent_count`** *(integer)*: The total number of transactions sent by the user.
76
+ * **`total_sent (ETH)`** *(float)*: The total amount of ETH sent by the user.
77
+ * **`transactions`** *(integer)*: The total number of transactions the user participated in.
78
 
79
  ---
80
 
81
  ### `market.parquet`
82
+ This file aggregates market-related data over time intervals, offering insights into protocol performance and market dynamics.
83
+ Objectives include:
84
+ - Understanding market trends across DeFi protocols and tokens.
85
+ - Analyzing trading volumes, transaction activity, and price fluctuations.
86
+ - Identifying periods of high or low activity for specific tokens or protocols.
87
+
88
  - **`timestamp`** *(datetime)*: The time when the data was recorded.
89
  - **`blockchain`** *(string)*: The blockchain network (e.g., Ethereum, Binance Smart Chain).
90
  - **`protocol_name`** *(string)*: The name of the protocol associated with the data.
 
116
  ---
117
 
118
  ### `transactions.parquet`
119
+ This file provides granular transaction-level data, which is crucial for understanding the flow of assets within the DeFi ecosystem.
120
+ Applications include:
121
+ - Tracing the movement of funds between addresses.
122
+ - Analyzing transaction costs (gas) and failure rates.
123
+ - Identifying anomalous or fraudulent transactions.
124
+
125
  - **`timestamp`** *(datetime)*: The time when the transaction occurred.
126
  - **`transaction_hash`** *(string)*: The unique hash identifying the transaction.
127
  - **`from`** *(string)*: The sender's wallet address.
 
136
  ---
137
 
138
  ### `contracts.parquet`
139
+ This file documents details about the smart contracts associated with various DeFi protocols.
140
+ It supports:
141
+ - Categorizing contracts by protocol, type, and use case.
142
+ - Analyzing the adoption of specific contract standards (e.g., ERC-20, ERC-721).
143
+ - Exploring the relationship between contract attributes and protocol performance.
144
+
145
  - **`contract_address`** *(string)*: The unique address of the smart contract.
146
  - **`blockchain`** *(string)*: The blockchain network where the contract is deployed.
147
  - **`type`** *(string)*: The type of contract (e.g., ERC-20, ERC-721).