Skip to content

Commit 700b783

Browse files
dev-distdev-dist
authored
updated report schemas to specify timestamp format (#2942)
1 parent fafe9a3 commit 700b783

File tree

6 files changed

+30
-30
lines changed

6 files changed

+30
-30
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,17 @@ Chainlink Backed xStock Data Streams adhere to the report schema outlined below.
4949
| Field | Type | Description |
5050
| ----------------------- | --------- | -------------------------------------------------------------------------------------------------------------------- |
5151
| `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 |
52+
| `validFromTimestamp` | `uint32` | Earliest timestamp when the price is valid (seconds) |
53+
| `observationsTimestamp` | `uint32` | Latest timestamp when the price is valid (seconds) |
5454
| `nativeFee` | `uint192` | Cost to verify report onchain (native token) |
5555
| `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 |
56+
| `expiresAt` | `uint32` | Expiration date of the report (seconds) |
57+
| `lastUpdateTimestamp` | `uint64` | Timestamp of the last valid price update (nanoseconds) |
5858
| `price` | `int192` | Last traded price from the real-world equity market |
5959
| `marketStatus` | `uint32` | Status of the real-world equity market. <br/> Possible values: `0` (Unknown), `1` (Closed), `2` (Open), `3` (Halted) |
6060
| `currentMultiplier` | `int192` | Currently applied multiplier accounting for past corporate actions |
6161
| `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) |
62+
| `activationDateTime` | `uint32` | When the next corporate action takes effect <br/> (set to `0` if none is scheduled) (seconds) |
6363
| `tokenizedPrice` | `int192` | 24/7 tokenized equity price as traded on supported exchanges <br/> (In development; currently returns `0`). |
6464

6565
**Notes:**

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ DEX State Price streams adhere to the report schema outlined below.
4343
| Field | Type | Description |
4444
| ----------------------- | --------- | ---------------------------------------------------------------------------------------------------------- |
4545
| `feedID` | `bytes32` | Unique identifier for the data stream |
46-
| `validFromTimestamp` | `uint32` | Start timestamp of price validity period |
47-
| `observationsTimestamp` | `uint32` | End timestamp of price validity period |
46+
| `validFromTimestamp` | `uint32` | Start timestamp of price validity period (seconds) |
47+
| `observationsTimestamp` | `uint32` | End timestamp of price validity period (seconds) |
4848
| `nativeFee` | `uint192` | Verification cost in native blockchain tokens |
4949
| `linkFee` | `uint192` | Verification cost in LINK tokens |
50-
| `expiresAt` | `uint32` | Timestamp when this report expires |
50+
| `expiresAt` | `uint32` | Timestamp when this report expires (seconds) |
5151
| `price` | `int192` | DON consensus median [DEX state price](/data-streams/concepts/dex-state-price-streams) (18 decimal places) |
5252
| `bid` | `int192` | N/A, equals `price`. |
5353
| `ask` | `int192` | N/A, equals `price`. |

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,16 @@ Cryptocurrency streams adhere to the report schema outlined below.
4747

4848
## Schema Fields
4949

50-
| Field | Type | Description |
51-
| ----------------------- | --------- | ------------------------------------------------- |
52-
| `feedID` | `bytes32` | Unique identifier for the data stream |
53-
| `validFromTimestamp` | `uint32` | Start timestamp of price validity period |
54-
| `observationsTimestamp` | `uint32` | End timestamp of price validity period |
55-
| `nativeFee` | `uint192` | Verification cost in native blockchain tokens |
56-
| `linkFee` | `uint192` | Verification cost in LINK tokens |
57-
| `expiresAt` | `uint32` | Timestamp when this report expires |
58-
| `price` | `int192` | DON consensus median price |
59-
| `bid` | `int192` | Simulated buy impact price at X% liquidity depth |
60-
| `ask` | `int192` | Simulated sell impact price at X% liquidity depth |
50+
| Field | Type | Description |
51+
| ----------------------- | --------- | -------------------------------------------------- |
52+
| `feedID` | `bytes32` | Unique identifier for the data stream |
53+
| `validFromTimestamp` | `uint32` | Start timestamp of price validity period (seconds) |
54+
| `observationsTimestamp` | `uint32` | End timestamp of price validity period (seconds) |
55+
| `nativeFee` | `uint192` | Verification cost in native blockchain tokens |
56+
| `linkFee` | `uint192` | Verification cost in LINK tokens |
57+
| `expiresAt` | `uint32` | Timestamp when this report expires (seconds) |
58+
| `price` | `int192` | DON consensus median price |
59+
| `bid` | `int192` | Simulated buy impact price at X% liquidity depth |
60+
| `ask` | `int192` | Simulated sell impact price at X% liquidity depth |
6161

6262
**Note**: Future Cryptocurrency streams may use different report schemas.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,11 @@ Real World Asset (RWA) streams adhere to the report schema outlined below.
5858
| Field | Type | Description |
5959
| ----------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------- |
6060
| `feedID` | `bytes32` | The unique identifier for the stream |
61-
| `validFromTimestamp` | `uint32` | The earliest timestamp during which the price is valid |
62-
| `observationsTimestamp` | `uint32` | The latest timestamp during which the price is valid |
61+
| `validFromTimestamp` | `uint32` | The earliest timestamp during which the price is valid (seconds) |
62+
| `observationsTimestamp` | `uint32` | The latest timestamp during which the price is valid (seconds) |
6363
| `nativeFee` | `uint192` | The cost to verify this report onchain when paying with the blockchain's native token |
6464
| `linkFee` | `uint192` | The cost to verify this report onchain when paying with LINK |
65-
| `expiresAt` | `uint32` | The expiration date of this report |
65+
| `expiresAt` | `uint32` | The expiration date of this report (seconds) |
6666
| `price` | `int192` | The DON's consensus median price |
6767
| `marketStatus` | `uint32` | The DON's consensus on whether the market is currently open. Possible values: `0` (`Unknown`), `1` (`Closed`), `2` (`Open`). |
6868

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ RWA streams adhere to the report schema outlined below.
4949
| Value | Type | Description |
5050
| ----------------------- | --------- | ----------------------------------------------------------------------------------------------------------- |
5151
| `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 |
52+
| `validFromTimestamp` | `uint32` | Earliest timestamp when the price is valid (seconds) |
53+
| `observationsTimestamp` | `uint32` | Latest timestamp when the price is valid (seconds) |
5454
| `nativeFee` | `uint192` | Cost to verify report onchain (native token) |
5555
| `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 |
56+
| `expiresAt` | `uint32` | Expiration date of the report (seconds) |
57+
| `lastUpdateTimestamp` | `uint64` | Timestamp of the last valid price update (nanoseconds) |
5858
| `midPrice` | `int192` | DON's consensus median price |
5959
| `marketStatus` | `uint32` | [Market status](/data-streams/market-hours). Possible values: `0` (`Unknown`), `1` (`Closed`), `2` (`Open`) |

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ Chainlink NAV Data Streams streams adhere to the report schema outlined below.
4949
| Value | Type | Description |
5050
| ----------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
5151
| `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 |
52+
| `validFromTimestamp` | `uint32` | Earliest timestamp when the price is valid (seconds) |
53+
| `observationsTimestamp` | `uint32` | Latest timestamp when the price is valid (seconds) |
5454
| `nativeFee` | `uint192` | Cost to verify report onchain (native token) |
5555
| `linkFee` | `uint192` | Cost to verify report onchain (LINK) |
56-
| `expiresAt` | `uint32` | Expiration date of the report |
56+
| `expiresAt` | `uint32` | Expiration date of the report (seconds) |
5757
| `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 |
58+
| `navDate` | `uint64` | Timestamp for the date the publication of NAV Report (nanoseconds) |
5959
| `aum` | `int192` | DON consensus Total USD value of Assets Under Management |
6060
| `ripcord` | `uint32` | Whether the provider paused NAV reporting <br/> Possible values: `0` (normal state), `1` (paused state) <br/> [More details](#ripcord-status) |
6161

0 commit comments

Comments
 (0)