Skip to content

Commit d777606

Browse files
dev-distdev-dist
authored
Data Streams: Schema v9 and v10 release (#2907)
* update schema ref, sidebar, tables, nav * updated tutorials. TODO: review/test each * bumped versions * stream table fix * rwa->nav in dropdowns * update feedlist for nav streams * updated table * lint fix * update table formatting * temp v10 * lint fix * table updates * table fix 2 * updated table with latest schema * schema updates * rename * sidebar+schema update * updated note about tokenizedPrice * hide name field for backed streams * broken link fix * update highlight as current
1 parent 180b8b2 commit d777606

26 files changed

+2087
-25
lines changed

‎src/config/sidebar.ts‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -367,6 +367,26 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
367367
},
368368
],
369369
},
370+
{
371+
title: "Net Asset Value (NAV) Streams",
372+
url: "data-streams/nav-streams",
373+
children: [
374+
{
375+
title: "Report Schema v9",
376+
url: "data-streams/reference/report-schema-v9",
377+
},
378+
],
379+
},
380+
{
381+
title: "Backed xStock Streams",
382+
url: "data-streams/backed-streams",
383+
children: [
384+
{
385+
title: "Report Schema v10",
386+
url: "data-streams/reference/report-schema-v10",
387+
},
388+
],
389+
},
370390
{
371391
title: "Market Hours",
372392
url: "data-streams/market-hours",
@@ -387,6 +407,8 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
387407
"data-streams/tutorials/api-rust",
388408
"data-streams/tutorials/api-rwa-go",
389409
"data-streams/tutorials/api-rwa-rust",
410+
"data-streams/tutorials/api-nav-rust",
411+
"data-streams/tutorials/api-nav-go",
390412
],
391413
},
392414
{
@@ -396,6 +418,8 @@ export const SIDEBAR: Partial<Record<Sections, SectionEntry[]>> = {
396418
"data-streams/tutorials/ws-rust",
397419
"data-streams/tutorials/ws-rwa-go",
398420
"data-streams/tutorials/ws-rwa-rust",
421+
"data-streams/tutorials/ws-nav-go",
422+
"data-streams/tutorials/ws-nav-rust",
399423
],
400424
},
401425
{

‎src/content/data-streams/backed-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 Backed xStock streams"
4+
datafeedtype: streamsBacked
5+
metadata:
6+
title: "Data Streams Backed xStock streams"
7+
description: "A list of available Data Streams backed xStock 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="streamsBacked" initialNetwork="arbitrum" />

‎src/content/data-streams/nav-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 Net Asset Value streams"
4+
datafeedtype: streamsNav
5+
metadata:
6+
title: "Data Streams NAV streams"
7+
description: "A list of available Data Streams Net Asset Value 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="streamsNav" initialNetwork="arbitrum" />

‎src/content/data-streams/reference/data-streams-api/rust-sdk.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ Add the SDK to your project by including it in your `Cargo.toml`:
5757

5858
```toml
5959
[dependencies]
60-
chainlink-data-streams-sdk = "1.0.0"
61-
chainlink-data-streams-report = "1.0.0"
60+
chainlink-data-streams-sdk = "1.0.3"
61+
chainlink-data-streams-report = "1.0.3"
6262
```
6363

6464
### Feature Flags

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

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
section: dataStreams
3+
date: Last Modified
4+
title: "Backed xStock Report Schema (v10)"
5+
metadata:
6+
title: "Backed xStock Report Schema (v10) | Chainlink Data Streams"
7+
description: "Learn about Chainlink Backed xStock report schema (v10), including fields, encoding, and examples for integrating tokenized asset data in your applications."
8+
keywords: ["Report Schema", "Tokenized Assets", "Backed xStock", "v10 Schema", "Data Format", "Report Structure"]
9+
---
10+
11+
import DataStreams from "@features/data-streams/common/DataStreams.astro"
12+
import { PageTabs } from "@components"
13+
14+
<DataStreams section="dsNotes" />
15+
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+
/>
44+
45+
Chainlink Backed xStock Data Streams adhere to the report schema outlined below.
46+
47+
### Schema Fields
48+
49+
| Field | Type | Description |
50+
| ----------------------- | --------- | -------------------------------------------------------------------------------------------------------------------- |
51+
| `feedId` | `bytes32` | Unique identifier for the Data Streams feed |
52+
| `validFromTimestamp` | `uint32` | Earliest timestamp when the price is valid |
53+
| `observationsTimestamp` | `uint32` | Latest timestamp when the price is valid |
54+
| `nativeFee` | `uint192` | Cost to verify report onchain (native token) |
55+
| `linkFee` | `uint192` | Cost to verify report onchain (LINK) |
56+
| `expiresAt` | `uint32` | Expiration date of the report |
57+
| `lastUpdateTimestamp` | `uint64` | Timestamp of the last valid price update |
58+
| `price` | `int192` | Last traded price from the real-world equity market |
59+
| `marketStatus` | `uint32` | Status of the real-world equity market. <br/> Possible values: `0` (Unknown), `1` (Closed), `2` (Open), `3` (Halted) |
60+
| `currentMultiplier` | `int192` | Currently applied multiplier accounting for past corporate actions |
61+
| `newMultiplier` | `int192` | Multiplier to be applied at the activationDateTime <br/> (set to `0` if none is scheduled) |
62+
| `activationDateTime` | `uint32` | When the next corporate action takes effect <br/> (set to `0` if none is scheduled) |
63+
| `tokenizedPrice` | `int192` | 24/7 tokenized equity price as traded on supported exchanges <br/> (In development; currently returns `0`). |
64+
65+
**Notes:**
66+
67+
- `price` updates in real time during market open, but may become stale during market closed periods.
68+
- `tokenizedPrice` will be available in an upcoming release of Backed xStock Data Streams. Currently, it will always return `0`.
69+
- `currentMultiplier` reflects all past corporate actions and is updated only when a new action is activated.
70+
- `activationDateTime` and `newMultiplier` provide advance notice of upcoming corporate actions, allowing protocols to prepare.

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ import { PageTabs } from "@components"
2323
name: "RWA Report Schema (v8)",
2424
url: "/data-streams/reference/report-schema-v8",
2525
},
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+
},
2634
]}
2735
headerTitle="Available Report Schemas"
2836
headerDescription="Choose the schema version you want to explore."

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,15 @@ import { PageTabs } from "@components"
2828
{
2929
name: "RWA Report Schema (v8)",
3030
url: "/data-streams/reference/report-schema-v8",
31-
}
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+
},
3240

3341
]}
3442
headerTitle="Available Report Schemas"

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ import { Aside, PageTabs } from "@components"
3232
name: "RWA Report Schema (v8)",
3333
url: "/data-streams/reference/report-schema-v8",
3434
},
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+
},
3543

3644
]}
3745
headerTitle="Available Report Schemas"

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,15 @@ import { PageTabs } from "@components"
2727
{
2828
name: "RWA Report Schema (v8)",
2929
url: "/data-streams/reference/report-schema-v8",
30-
}
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+
},
3139

3240
]}
3341
headerTitle="Available Report Schemas"

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

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
section: dataStreams
3+
date: Last Modified
4+
title: "Report Schemas"
5+
metadata:
6+
title: "NAV Data Streams Report Schema (v9) | Chainlink Data Streams"
7+
description: "Learn about Chainlink NAV Data Streams report schema (v9), including fields, encoding, and examples for integrating NAV data in your applications."
8+
keywords: ["Report Schema", "NAV", "Net Asset Value", "v9 Schema", "Data Format", "Report Structure"]
9+
---
10+
11+
import DataStreams from "@features/data-streams/common/DataStreams.astro"
12+
import { PageTabs } from "@components"
13+
14+
<DataStreams section="dsNotes" />
15+
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+
/>
44+
45+
Chainlink NAV Data Streams streams adhere to the report schema outlined below.
46+
47+
### Schema Fields
48+
49+
| Value | Type | Description |
50+
| ----------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
51+
| `feedID` | `bytes32` | Unique identifier for the Data Streams feed |
52+
| `validFromTimestamp` | `uint32` | Earliest timestamp when the price is valid |
53+
| `observationsTimestamp` | `uint32` | Latest timestamp when the price is valid |
54+
| `nativeFee` | `uint192` | Cost to verify report onchain (native token) |
55+
| `linkFee` | `uint192` | Cost to verify report onchain (LINK) |
56+
| `expiresAt` | `uint32` | Expiration date of the report |
57+
| `navPerShare` | `int192` | DON consensus NAV Per Share value as reported by the Fund Manager |
58+
| `navDate` | `uint64` | Timestamp for the date the publication of NAV Report |
59+
| `aum` | `int192` | DON consensus Total USD value of Assets Under Management |
60+
| `ripcord` | `uint32` | Whether the provider paused NAV reporting <br/> Possible values: `0` (normal state), `1` (paused state) <br/> [More details](#ripcord-status) |
61+
62+
**Notes:**
63+
64+
##### `ripcord` Status
65+
66+
- 0 (false) - **Data Provider is OK**. This indicates that the Fund’s data provider and data accuracy is reporting as expected.
67+
- 1 (true) - **Data Provider is flagging a Pause**. This indicates that the Fund’s data provider detected outliers, deviated thresholds, management or operational related pause. **During `ripcord=1`, do not consume any NAV data**.

0 commit comments

Comments
 (0)