RBudzynski commited on
Commit
d055d12
·
verified ·
1 Parent(s): 984884c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +6 -66
README.md CHANGED
@@ -16,74 +16,14 @@ tags:
16
  pretty_name: BlockDB Liquidity Pools Reserves - Sample
17
  size_categories:
18
  - 10M<n<100M
 
 
19
  ---
20
 
21
- ## Sample Notice
22
 
23
- This dataset contains **a small sample** of the full BlockDB Liquidity Pools Reserves dataset.
24
- It is provided **for evaluation, research, and interoperability testing only**.
25
 
26
- If you need full historical coverage, real-time streaming, or end-of-day (EOD) exports
27
- please contact us directly:
28
 
29
- 📧 **support@blockdb.io**
30
- 🌐 https://www.blockdb.io
31
-
32
-
33
- ## Dataset Overview
34
- Time-series of pool reserve/state snapshots across all AMM types. Each row represents a snapshot of pool state at a specific on-chain event, including reserves for constant-product pools and tick/bin data for concentrated liquidity pools (Uniswap v3/v4, Algebra, TraderJoe bins, etc.).
35
-
36
-
37
- ## Chains and Coverage
38
- ETH, BSC, Base, Arbitrum, Unichain, Avalanche, Polygon, Celo, Linea, Optimism (others on request).
39
- Full history from chain genesis; reorg-aware real-time ingestion and updates.
40
-
41
-
42
- ## Schema
43
- List of columns exactly as delivered:
44
-
45
- • id BIGINT – Unique snapshot identifier (primary key)
46
- • pool_uid BYTEA – Unique pool identifier (FK to liquidity_pools)
47
- • exchange_id INTEGER – Exchange/DEX identifier
48
- • type_id INTEGER – Pool type identifier (FK to liquidity_pool_types)
49
- • block_number BIGINT – Block when this state was observed
50
- • block_time TIMESTAMPTZ – UTC timestamp when the block was mined
51
- • tx_index INTEGER – Transaction index within the block
52
- • log_index INTEGER – Log index within the block
53
- • reserves NUMERIC(78,0)[] – Array of current reserves per token for even-style pools (raw units)
54
- • current_tick INTEGER – Current tick for concentrated-liquidity pools (e.g., Uniswap v3)
55
- • current_sqrt_price NUMERIC(49,0) – Q64.96 sqrt price as integer; decode via (value / 2^96)^2 for mid-price
56
- • current_bin INTEGER – Current bin id for bin-based AMMs (e.g., TraderJoe v2)
57
- • _tracing_id BYTEA – Tracing ID of this reserves record
58
- • _genesis_tracing_ids BYTEA[] – Tracing IDs of the genesis records leading to this record
59
- • _parent_tracing_ids BYTEA[] – Tracing IDs of the parent records leading to this record
60
- • _created_at TIMESTAMPTZ – Record creation timestamp
61
- • _updated_at TIMESTAMPTZ – Record last update timestamp
62
-
63
-
64
- ### Notes
65
- • At least one of reserves, current_tick, or current_bin is always populated.
66
- • Unique constraint: (pool_uid, block_number, tx_index, log_index) guarantees one snapshot per pool per event.
67
- • For Q64.96 sqrt price: mid_price = (current_sqrt_price / 2^96)^2, then adjust for token decimals.
68
- • Indexes on (pool_uid, block_number DESC, tx_index DESC, log_index DESC), (block_number, tx_index, log_index), and block_time support fast lookups.
69
-
70
-
71
- ## Lineage
72
- Each reserves record includes deterministic _tracing_id, _genesis_tracing_ids, and _parent_tracing_ids, providing:
73
-
74
- • Provenance tracking from raw logs to decoded reserves snapshots
75
- • Reproducible analytics and signal extraction
76
- • Cross-system consistency checks (RPC vs. indexers vs. internal warehouses)
77
-
78
-
79
- ## Common Use Cases
80
- • Reconstructing historical pool states for backtesting
81
- • TVL (Total Value Locked) calculations
82
- • Liquidity depth analysis and slippage estimation
83
- • Price impact modeling for concentrated liquidity pools
84
-
85
-
86
- ## Quality
87
- • Verifiable lineage: deterministic cryptographic hashes per row
88
- • Reorg-aware ingestion: continuity and consistency across forks
89
- • Complete historical coverage: from chain genesis to present
 
16
  pretty_name: BlockDB Liquidity Pools Reserves - Sample
17
  size_categories:
18
  - 10M<n<100M
19
+ dataset_info:
20
+ homepage: https://docs.blockdb.io/data-catalog/evm/reserves/liquidity-pools-reserves
21
  ---
22
 
23
+ *Small evaluation sample.*
24
 
25
+ **`0301`** · `blockdb_evm.b0301_liquidity_pools_reserves_v1` - Per-pool reserve snapshots at every on-chain event (one row per event).
 
26
 
27
+ **`0301`** · `blockdb_evm.b0301_liquidity_pools_reserves_details_v1` - Optional granular tick/bin/range detail rows joined via `snapshot_id`.
 
28
 
29
+ **🌐 [BlockDB docs — schema, API, WebSocket & signup](https://docs.blockdb.io/data-catalog/evm/reserves/liquidity-pools-reserves)**