Skip to content

Commit 72aa4b2

Browse files
dev-distdev-dist
committed
init, shared report schema dropdown
1 parent 155d543 commit 72aa4b2

File tree

9 files changed

+90
-203
lines changed

9 files changed

+90
-203
lines changed

‎src/content/data-streams/reference/report-schema-overview.mdx‎

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,11 @@ title: "Overview"
55
---
66

77
import DataStreams from "@features/data-streams/common/DataStreams.astro"
8-
import { PageTabs } from "@components"
8+
import ReportSchemaTabs from "@features/data-streams/common/ReportSchemaTabs.astro"
99

1010
<DataStreams section="dsNotes" />
1111

12-
<PageTabs
13-
pages={[
14-
{
15-
name: "Cryptocurrency Report Schema (v3)",
16-
url: "/data-streams/reference/report-schema",
17-
},
18-
{
19-
name: "DEX State Price Report Schema (v3)",
20-
url: "/data-streams/reference/report-schema-v3-dex",
21-
},
22-
{
23-
name: "RWA Report Schema (v8)",
24-
url: "/data-streams/reference/report-schema-v8",
25-
},
26-
{
27-
name: "NAV Report Schema (v9)",
28-
url: "/data-streams/reference/report-schema-v9",
29-
},
30-
{
31-
name: "Backed xStock Report Schema (v10)",
32-
url: "/data-streams/reference/report-schema-v10",
33-
},
34-
]}
35-
headerTitle="Available Report Schemas"
36-
headerDescription="Choose the schema version you want to explore."
37-
/>
12+
<ReportSchemaTabs />
3813

3914
## Available Report Schemas
4015

‎src/content/data-streams/reference/report-schema-v10.mdx‎

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -9,38 +9,11 @@ metadata:
99
---
1010

1111
import DataStreams from "@features/data-streams/common/DataStreams.astro"
12-
import { PageTabs } from "@components"
12+
import ReportSchemaTabs from "@features/data-streams/common/ReportSchemaTabs.astro"
1313

1414
<DataStreams section="dsNotes" />
1515

16-
<PageTabs
17-
pages={[
18-
19-
{
20-
name: "Cryptocurrency Report Schema (v3)",
21-
url: "/data-streams/reference/report-schema-v3",
22-
},
23-
{
24-
name: "DEX State Price Report Schema (v3)",
25-
url: "/data-streams/reference/report-schema-v3-dex",
26-
},
27-
{
28-
name: "RWA Report Schema (v8)",
29-
url: "/data-streams/reference/report-schema-v8",
30-
},
31-
{
32-
name: "NAV Report Schema (v9)",
33-
url: "/data-streams/reference/report-schema-v9",
34-
},
35-
{
36-
name: "Backed xStock Report Schema (v10)",
37-
url: "/data-streams/reference/report-schema-v10",
38-
},
39-
40-
]}
41-
headerTitle="Available Report Schemas"
42-
headerDescription="Choose the schema version you want to explore."
43-
/>
16+
<ReportSchemaTabs />
4417

4518
Chainlink Backed xStock Data Streams adhere to the report schema outlined below.
4619

‎src/content/data-streams/reference/report-schema-v3-dex.mdx‎

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,11 @@ title: "Report Schemas"
55
---
66

77
import DataStreams from "@features/data-streams/common/DataStreams.astro"
8-
import { PageTabs } from "@components"
8+
import ReportSchemaTabs from "@features/data-streams/common/ReportSchemaTabs.astro"
99

1010
<DataStreams section="dsNotes" />
1111

12-
<PageTabs
13-
pages={[
14-
{
15-
name: "Cryptocurrency Report Schema (v3)",
16-
url: "/data-streams/reference/report-schema",
17-
},
18-
{
19-
name: "DEX State Price Report Schema (v3)",
20-
url: "/data-streams/reference/report-schema-v3-dex",
21-
},
22-
{
23-
name: "RWA Report Schema (v8)",
24-
url: "/data-streams/reference/report-schema-v8",
25-
},
26-
{
27-
name: "NAV Report Schema (v9)",
28-
url: "/data-streams/reference/report-schema-v9",
29-
},
30-
{
31-
name: "Backed xStock Report Schema (v10)",
32-
url: "/data-streams/reference/report-schema-v10",
33-
},
34-
]}
35-
headerTitle="Available Report Schemas"
36-
headerDescription="Choose the schema version you want to explore."
37-
/>
12+
<ReportSchemaTabs />
3813

3914
DEX State Price streams adhere to the report schema outlined below.
4015

‎src/content/data-streams/reference/report-schema-v3.mdx‎

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -10,38 +10,11 @@ metadata:
1010
---
1111

1212
import DataStreams from "@features/data-streams/common/DataStreams.astro"
13-
import { PageTabs } from "@components"
13+
import ReportSchemaTabs from "@features/data-streams/common/ReportSchemaTabs.astro"
1414

1515
<DataStreams section="dsNotes" />
1616

17-
<PageTabs
18-
pages={[
19-
20-
{
21-
name: "Cryptocurrency Report Schema (v3)",
22-
url: "/data-streams/reference/report-schema-v3",
23-
},
24-
{
25-
name: "DEX State Price Report Schema (v3)",
26-
url: "/data-streams/reference/report-schema-v3-dex",
27-
},
28-
{
29-
name: "RWA Report Schema (v8)",
30-
url: "/data-streams/reference/report-schema-v8",
31-
},
32-
{
33-
name: "NAV Report Schema (v9)",
34-
url: "/data-streams/reference/report-schema-v9",
35-
},
36-
{
37-
name: "Backed xStock Report Schema (v10)",
38-
url: "/data-streams/reference/report-schema-v10",
39-
},
40-
41-
]}
42-
headerTitle="Available Report Schemas"
43-
headerDescription="Choose the schema version you want to explore."
44-
/>
17+
<ReportSchemaTabs />
4518

4619
Cryptocurrency streams adhere to the report schema outlined below.
4720

‎src/content/data-streams/reference/report-schema-v4.mdx‎

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -9,42 +9,12 @@ metadata:
99
---
1010

1111
import DataStreams from "@features/data-streams/common/DataStreams.astro"
12-
import { Aside, PageTabs } from "@components"
12+
import ReportSchemaTabs from "@features/data-streams/common/ReportSchemaTabs.astro"
13+
import { Aside } from "@components"
1314

1415
<DataStreams section="dsNotes" />
1516

16-
<PageTabs
17-
pages={[
18-
19-
{
20-
name: "Cryptocurrency Report Schema (v3)",
21-
url: "/data-streams/reference/report-schema-v3",
22-
},
23-
{
24-
name: "DEX State Price Report Schema (v3)",
25-
url: "/data-streams/reference/report-schema-v3-dex",
26-
},
27-
{
28-
name: "(Deprecated) RWA Report Schema (v4)",
29-
url: "/data-streams/reference/report-schema-v4",
30-
},
31-
{
32-
name: "RWA Report Schema (v8)",
33-
url: "/data-streams/reference/report-schema-v8",
34-
},
35-
{
36-
name: "NAV Report Schema (v9)",
37-
url: "/data-streams/reference/report-schema-v9",
38-
},
39-
{
40-
name: "Backed xStock Report Schema (v10)",
41-
url: "/data-streams/reference/report-schema-v10",
42-
},
43-
44-
]}
45-
headerTitle="Available Report Schemas"
46-
headerDescription="Choose the schema version you want to explore."
47-
/>
17+
<ReportSchemaTabs />
4818

4919
<Aside type="danger">
5020
The v4 report schema is deprecated. View the [v8 report schema](/data-streams/reference/report-schema-v8) for the

‎src/content/data-streams/reference/report-schema-v7.mdx‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
section: dataStreams
3+
date: Last Modified
4+
title: "Report Schemas"
5+
metadata:
6+
title: "Cryptocurrency Report Schema (v3) | Chainlink Data Streams"
7+
description: "Learn about Chainlink Data Streams cryptocurrency report schema (v3), including fields, encoding, and examples to integrate market data into your applications."
8+
keywords:
9+
["Report Schema", "Cryptocurrency", "v3 Schema", "Data Format", "Report Structure", "Liquidity-Weighted", "Bid-Ask"]
10+
---
11+
12+
import DataStreams from "@features/data-streams/common/DataStreams.astro"
13+
import ReportSchemaTabs from "@features/data-streams/common/ReportSchemaTabs.astro"
14+
15+
<DataStreams section="dsNotes" />
16+
17+
<ReportSchemaTabs />
18+
19+
Cryptocurrency streams adhere to the report schema outlined below.
20+
21+
## Schema Fields
22+
23+
| Field | Type | Description |
24+
| ----------------------- | --------- | -------------------------------------------------- |
25+
| `feedID` | `bytes32` | Unique identifier for the data stream |
26+
| `validFromTimestamp` | `uint32` | Start timestamp of price validity period (seconds) |
27+
| `observationsTimestamp` | `uint32` | End timestamp of price validity period (seconds) |
28+
| `nativeFee` | `uint192` | Verification cost in native blockchain tokens |
29+
| `linkFee` | `uint192` | Verification cost in LINK tokens |
30+
| `expiresAt` | `uint32` | Timestamp when this report expires (seconds) |
31+
| `price` | `int192` | DON consensus median price |
32+
| `bid` | `int192` | Simulated buy impact price at X% liquidity depth |
33+
| `ask` | `int192` | Simulated sell impact price at X% liquidity depth |
34+
35+
**Note**: Future Cryptocurrency streams may use different report schemas.

‎src/content/data-streams/reference/report-schema-v8.mdx‎

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -9,38 +9,11 @@ metadata:
99
---
1010

1111
import DataStreams from "@features/data-streams/common/DataStreams.astro"
12-
import { PageTabs } from "@components"
12+
import ReportSchemaTabs from "@features/data-streams/common/ReportSchemaTabs.astro"
1313

1414
<DataStreams section="dsNotes" />
1515

16-
<PageTabs
17-
pages={[
18-
19-
{
20-
name: "Cryptocurrency Report Schema (v3)",
21-
url: "/data-streams/reference/report-schema-v3",
22-
},
23-
{
24-
name: "DEX State Price Report Schema (v3)",
25-
url: "/data-streams/reference/report-schema-v3-dex",
26-
},
27-
{
28-
name: "RWA Report Schema (v8)",
29-
url: "/data-streams/reference/report-schema-v8",
30-
},
31-
{
32-
name: "NAV Report Schema (v9)",
33-
url: "/data-streams/reference/report-schema-v9",
34-
},
35-
{
36-
name: "Backed xStock Report Schema (v10)",
37-
url: "/data-streams/reference/report-schema-v10",
38-
},
39-
40-
]}
41-
headerTitle="Available Report Schemas"
42-
headerDescription="Choose the schema version you want to explore."
43-
/>
16+
<ReportSchemaTabs />
4417

4518
RWA streams adhere to the report schema outlined below.
4619

‎src/content/data-streams/reference/report-schema-v9.mdx‎

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -9,38 +9,11 @@ metadata:
99
---
1010

1111
import DataStreams from "@features/data-streams/common/DataStreams.astro"
12-
import { PageTabs } from "@components"
12+
import ReportSchemaTabs from "@features/data-streams/common/ReportSchemaTabs.astro"
1313

1414
<DataStreams section="dsNotes" />
1515

16-
<PageTabs
17-
pages={[
18-
19-
{
20-
name: "Cryptocurrency Report Schema (v3)",
21-
url: "/data-streams/reference/report-schema-v3",
22-
},
23-
{
24-
name: "DEX State Price Report Schema (v3)",
25-
url: "/data-streams/reference/report-schema-v3-dex",
26-
},
27-
{
28-
name: "RWA Report Schema (v8)",
29-
url: "/data-streams/reference/report-schema-v8",
30-
},
31-
{
32-
name: "NAV Report Schema (v9)",
33-
url: "/data-streams/reference/report-schema-v9",
34-
},
35-
{
36-
name: "Backed xStock Report Schema (v10)",
37-
url: "/data-streams/reference/report-schema-v10",
38-
},
39-
40-
]}
41-
headerTitle="Available Report Schemas"
42-
headerDescription="Choose the schema version you want to explore."
43-
/>
16+
<ReportSchemaTabs />
4417

4518
Chainlink NAV Data Streams streams adhere to the report schema outlined below.
4619

‎src/features/data-streams/common/ReportSchemaTabs.astro‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
import { PageTabs } from "@components"
3+
4+
const reportSchemaPages = [
5+
{
6+
name: "Cryptocurrency Report Schema (v3)",
7+
url: "/data-streams/reference/report-schema-v3",
8+
},
9+
{
10+
name: "DEX State Price Report Schema (v3)",
11+
url: "/data-streams/reference/report-schema-v3-dex",
12+
},
13+
{
14+
name: "(Deprecated) RWA Report Schema (v4)",
15+
url: "/data-streams/reference/report-schema-v4",
16+
},
17+
{
18+
name: "Exchange Rate Report Schema (v7)",
19+
url: "/data-streams/reference/report-schema-v7",
20+
},
21+
{
22+
name: "RWA Report Schema (v8)",
23+
url: "/data-streams/reference/report-schema-v8",
24+
},
25+
{
26+
name: "NAV Report Schema (v9)",
27+
url: "/data-streams/reference/report-schema-v9",
28+
},
29+
{
30+
name: "Backed xStock Report Schema (v10)",
31+
url: "/data-streams/reference/report-schema-v10",
32+
},
33+
]
34+
---
35+
36+
<PageTabs
37+
pages={reportSchemaPages}
38+
headerTitle="Available Report Schemas"
39+
headerDescription="Choose the schema version you want to explore."
40+
/>

0 commit comments

Comments
 (0)