Clarify dataset description, methods and limitations

README.md

@@ -1,6 +1,6 @@
 ---
 license: odc-by
-pretty_name: "Solana swap quotes and the venues an aggregator routes them through"
+pretty_name: "Solana swap quotes and route details"
 tags:
   - solana
   - dex
@@ -16,60 +16,36 @@ size_categories:
   - 1M<n<10M
 ---
 
-# Solana DEX execution costs and routing
+# Solana DEX quotes and routing
 
-What a swap was quoted at on Solana, and which venues the aggregator split it across to get
-there.
-
-A quote is computed per request against pool state that has already changed by the time anyone
-asks again. The fill that follows may land on chain; the quote never does, and neither does the
-route the aggregator considered and rejected.
+Jupiter swap quotes at fixed SOL input sizes, with the route legs returned for each quote. The panel supports comparisons of quoted output, reported price impact and routing across sizes and observation times.
 
 ## Contents
 
-| name | one row is |
+| Table | Record |
 |---|---|
-| `e24_solana_quotes` | one pair at one size at one moment: output, price impact, dollar value, leg count |
-| `e24_solana_routes` | one leg of the chosen route: venue, amounts, and the percentage of the order it carried |
-
-## Reading it
-
-Join the two on `(round_ts, input_symbol, output_symbol, in_amount)`. A quote with `n_legs` above
-one was split, and `percent` on each leg says how the order was divided.
+| `e24_solana_quotes` | A pair and input amount, with quoted output, price impact, value and route-leg count |
+| `e24_solana_routes` | A leg of the chosen route, including venue, amounts and allocation |
 
-The size ladder is fixed at 1, 50 and 1,000 SOL so that impact is comparable over time rather
-than against a moving notional. Impact rises with size on every pair, which is the sanity check
-this table has to pass: one observation ran 0.0000%, 0.0013% and 0.065% on a thin pair against
-0.0000%, 0.000018% and 0.000068% on the deepest one.
+## Using the data
 
-Routing is the part that is hard to get elsewhere. The same pair goes through one venue at small
-size and four or five at large size, and the venue mix changes between rounds, which maps where
-routable liquidity actually sits rather than where volume was reported.
+Join quotes and routes on `(round_ts, input_symbol, output_symbol, in_amount)`. Inspect `n_legs` and each leg's `percent` when analysing split routes. The configured size ladder is 1, 50 and 1,000 SOL across five pairs, all with SOL as the input.
 
-## A column that is raw on purpose
+`price_impact_pct` is Jupiter's reported estimate. `amm_report_raw` preserves the provider's venue report as JSON. Entries may refer to amounts outside the requested pair or contain error strings; they should not be converted directly into competing-venue prices.
 
-`amm_report_raw` is the aggregator's own report on the venues it considered, stored verbatim as
-JSON rather than parsed into a comparison.
+## Limitations
 
-It is kept raw because it is NOT restricted to the pair being quoted. A request for SOL into a
-memecoin returns values on the scale of a stablecoin quote, and at least one entry has been the
-string "Pair insufficient liquidity" rather than a number. An earlier version derived a
-"chosen route versus best single venue" spread from this field and produced 340 million basis
-points, which is what exposed the mismatch. The raw object keeps the information without
-publishing a derived number that means nothing.
+- The panel records one aggregator's responses. Its selected route does not establish the best price available across the entire market.
+- Quotes are indicative and are not executed by the collector. Transaction landing, priority fees, slippage and intervening pool changes affect actual results.
+- SOL-input quotes do not provide both legs of a closed trading cycle.
+- Failed requests have explicit error rows with null measurements. Separate these from successful quotes with unusual routes.
+- Sampling captures periodic snapshots and misses changes between requests.
 
-## Before you build on this
+## Files and access
 
-- One aggregator. It is the dominant one on Solana, but a quote is what it would route, not the
-  best price obtainable anywhere.
-- Quotes are indicative. A real swap adds transaction landing risk, priority fees and slippage
-  against a moving pool, none of which a quote reflects.
-- `price_impact_pct` is the aggregator's own estimate, not something recomputed here.
-- Five pairs, all with SOL as the input. That is a slice of Solana, not a census.
-- A failed request is written as an explicit error row with the measurements null, so an
-  unavailable aggregator is distinguishable from a pair with no route.
+Data is stored as Parquet files under `dataset/YYYY/MM/`, with partitions for collection windows. Each measurement table has a fixed 7-day sample beginning at its configured collection start date. The sample windows in this repository span 2026-08-30 to 2026-09-05. Availability within each window depends on successful collection. The public sample dates remain fixed as additional history accumulates privately. Contact DataForge through the discussions tab to enquire about additional history.
 
-Partitions are parquet, one file per collection window, under `dataset/YYYY/MM/`. Every dataset here carries a FIXED 7-day sample WINDOW starting at its own first day of collection, together spanning 2026-08-30 to 2026-09-05, so you can check schema, coverage and quality before asking for more. It does not advance, so there is nothing to gain by re-downloading it. The full history is held privately, available on request.
+### Load a table
 
 ```python
 from huggingface_hub import snapshot_download
@@ -83,11 +59,8 @@ df = pd.concat(map(pd.read_parquet,
 
 ## Coverage
 
-`e0_run_manifest` lists every collection window with its poll counts and failure counts, and is
-published in full rather than windowed. Gaps between windows are real, cannot be filled in
-afterwards, and nothing here is interpolated.
+`e0_run_manifest` records collection windows, poll counts and failures. It is published in full and may cover dates beyond the fixed data sample. Collection gaps are not interpolated. Use the manifest together with table timestamps and error fields to assess coverage.
 
 ## License and contact
 
-ODC-BY: use it freely, credit "DataForge (dataforge-labs)". Questions and requests for the full
-history via the discussions tab.
+The public sample is published under ODC-BY. Attribute it to "DataForge (dataforge-labs)". For questions about the data or access to additional history, open a discussion in this repository.