Skip to content

Commit 1c044d3

Browse files
dev-distdev-dist
authored
Data Streams: V7 Report Schema (#2963)
* init, shared report schema dropdown * added ds report schema info and fixed report schema tabs * minor updates * report schema nit * exchange-rate-feeds * self review changes * lintfix * relative links -> absolute links
1 parent 2e68788 commit 1c044d3

File tree

15 files changed

+187
-228
lines changed

15 files changed

+187
-228
lines changed

‎src/config/sidebar.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,16 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
388388
},
389389
],
390390
},
391+
{
392+
title: "Exchange Rate Streams",
393+
url: "data-streams/exchange-rate-streams",
394+
children: [
395+
{
396+
title: "Report Schema v7",
397+
url: "data-streams/reference/report-schema-v7",
398+
},
399+
],
400+
},
391401
{
392402
title: "Real World Asset (RWA) Streams",
393403
url: "data-streams/rwa-streams",

‎src/content/data-streams/exchange-rate-streams/index.mdx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
section: dataStreams
3+
title: "Data Streams Exchange Rate streams"
4+
datafeedtype: streamsCrypto
5+
metadata:
6+
title: "Data Streams Exchange Rate streams"
7+
description: "A list of available Data Streams exchange rate streams and their ID."
8+
date: Last Modified
9+
isIndex: true
10+
---
11+
12+
import FeedPage from "@features/feeds/components/FeedPage.astro"
13+
14+
<FeedPage dataFeedType="streamsExRate" initialNetwork="arbitrum" />

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

Lines changed: 26 additions & 44 deletions
Large diffs are not rendered by default.

‎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: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
section: dataStreams
3+
date: Last Modified
4+
title: "Report Schemas"
5+
metadata:
6+
title: "Exchange Rate Report Schema (v7) | Chainlink Data Streams"
7+
description: "Learn about Chainlink Data Streams exchange rate report schema (v7), including fields, encoding, and examples to integrate exchange rate data into your applications."
8+
keywords: ["Report Schema", "Exchange Rate", "v7 Schema", "Data Format", "Report Structure", "Exchange Rate Data"]
9+
---
10+
11+
import DataStreams from "@features/data-streams/common/DataStreams.astro"
12+
import ReportSchemaTabs from "@features/data-streams/common/ReportSchemaTabs.astro"
13+
14+
<DataStreams section="dsNotes" />
15+
16+
<ReportSchemaTabs />
17+
18+
Exchange Rate streams adhere to the report schema outlined below.
19+
20+
## Schema Fields
21+
22+
| Field | Type | Description |
23+
| ----------------------- | --------- | ---------------------------------------------------- |
24+
| `feedId` | `bytes32` | Unique identifier for the Data Streams feed |
25+
| `validFromTimestamp` | `uint32` | Earliest timestamp when the price is valid (seconds) |
26+
| `observationsTimestamp` | `uint32` | Latest timestamp when the price is valid (seconds) |
27+
| `nativeFee` | `uint192` | Cost to verify report onchain (native token) |
28+
| `linkFee` | `uint192` | Cost to verify report onchain (LINK) |
29+
| `expiresAt` | `uint32` | Expiration date of the report (seconds) |
30+
| `exchangeRate` | `int192` | DON's consensus median exchange rate |
31+
32+
**Notes**:
33+
34+
- Future Exchange Rate 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

0 commit comments

Comments
 (0)