RBudzynski commited on
Commit
086e3fa
·
verified ·
1 Parent(s): 23c932c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +5 -72
README.md CHANGED
@@ -16,79 +16,12 @@ tags:
16
  pretty_name: BlockDB Liquidity Pools - 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 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
- Canonical list of liquidity pools across all supported DEXes. Each row represents a unique pool with its configuration (exchange, type, tokens, factory) and identifiers (contract address for v2/v3-style pools, pool_id for v4-style pools).
35
-
36
- This table serves as the single source of truth for pool identity; child time-series tables (reserves, swaps, yields) reference pools by their pool_uid.
37
-
38
-
39
- ## Chains and Coverage
40
- ETH, BSC, Base, Arbitrum, Unichain, Avalanche, Polygon, Celo, Linea, Optimism (others on request).
41
- Full history from chain genesis; reorg-aware real-time ingestion and updates.
42
-
43
-
44
- ## Schema
45
- List of columns exactly as delivered:
46
-
47
- • pool_uid BYTEA – Unique pool identifier derived from address or pool_id (primary key)
48
- • exchange_id INTEGER – Exchange/DEX identifier
49
- • type_id INTEGER – Pool type identifier (FK to liquidity_pool_types)
50
- • block_number BIGINT – Block of the log attributed as the genesis/recognition point
51
- • block_time TIMESTAMPTZ – UTC timestamp when the block was mined
52
- • tx_index INTEGER – Transaction index within the block
53
- • log_index INTEGER – Log index within the block
54
- • factory BYTEA – 20-byte DEX factory/pool-manager address
55
- • tokens BYTEA[] – Array of 20-byte token addresses in the pool
56
- • contract_address BYTEA – 20-byte address for v2/v3-style pools (nullable for id-only v4)
57
- • pool_id BYTEA – 32-byte identifier for v4-style pools (nullable for v2/v3)
58
- • pairnum NUMERIC(6) – Pair number, if applicable
59
- • asset_managers BYTEA[] – Array of asset manager addresses, if applicable
60
- • amp NUMERIC(6) – Amplification parameter for stable pools
61
- • weights NUMERIC(6,5)[] – Token weights (0..1) for weighted pools
62
- • tick_spacing SMALLINT – Tick spacing for concentrated liquidity pools
63
- • _tracing_id BYTEA – Tracing ID of this pool record
64
- • _genesis_tracing_ids BYTEA[] – Tracing IDs of the genesis records leading to this pool record
65
- • _parent_tracing_ids BYTEA[] – Tracing IDs of the parent records leading to this pool record
66
- • _created_at TIMESTAMPTZ – Record creation timestamp
67
- • _updated_at TIMESTAMPTZ – Record last update timestamp
68
-
69
-
70
- ### Notes
71
- • At least one of contract_address or pool_id is always populated.
72
- • Indexes on block_number, factory, type_id, (factory, type_id), and tokens (GIN) support fast lookups.
73
- • Binary values can be rendered as hex via encode(column, 'hex') in SQL for display or downstream joins.
74
-
75
-
76
- ## Lineage
77
- Each pool record includes deterministic _tracing_id, _genesis_tracing_ids, and _parent_tracing_ids, providing:
78
-
79
- • Provenance tracking from raw logs to pool discovery
80
- • Reproducible analytics and signal extraction
81
- • Cross-system consistency checks (RPC vs. indexers vs. internal warehouses)
82
-
83
-
84
- ## Common Use Cases
85
- • Building DEX pool registries across multiple protocols
86
- • Pool discovery and new listing detection
87
- • Foundation for swap, reserves, and yield analytics
88
- • Cross-DEX liquidity analysis and comparison
89
-
90
-
91
- ## Quality
92
- • Verifiable lineage: deterministic cryptographic hashes per row
93
- • Reorg-aware ingestion: continuity and consistency across forks
94
- • Complete historical coverage: from chain genesis to present
 
16
  pretty_name: BlockDB Liquidity Pools - Sample
17
  size_categories:
18
  - 10M<n<100M
19
+ dataset_info:
20
+ homepage: https://docs.blockdb.io/data-catalog/evm/entities/liquidity-pools
21
  ---
22
 
23
+ *Small evaluation sample.*
24
 
25
+ **`0211`** · `blockdb_evm.b0211_liquidity_pools_v1` - Canonical list of pools; child time-series tables FK to blockdb_evm.b0211_liquidity_pools_v1(pool_uid).
 
26
 
27
+ **🌐 [BlockDB docs schema, API, WebSocket & signup](https://docs.blockdb.io/data-catalog/evm/entities/liquidity-pools)**