Skip to content

Commit 74823b3

Browse files
committed
Add notes about ledger state query API
1 parent 5b0e2e0 commit 74823b3

File tree

1 file changed

+7
-0
lines changed
  • src/client/node-to-client/state-query

1 file changed

+7
-0
lines changed

src/client/node-to-client/state-query/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ _Since: v9_
7979

8080
Query the chain's start time as a `UTCTime`.
8181

82+
> [!CAUTION]
83+
> Is this the Byron or Shelly start time?
84+
8285
```cddl
8386
{{#include messages.cddl:api}}
8487
```
@@ -99,6 +102,10 @@ Example response:
99102
{{#include examples/getSystemStart/result.cbor}}
100103
```
101104

105+
> [!WARNING]
106+
> TODO: Create more realistic examples and use a tool to probabilistically verify more data.
107+
> TODO: Also use CBOR diagnostic notation for examples
108+
102109
> [!CAUTION]
103110
> FIXME: While I experimented in using the network / consensus cddl parts above, `time` would be defined in the CDDL prelude (a number, assuming seconds since epoch), but is actually incorrect and the result is serialized using `ToCBOR UTCTime` following this cddl:
104111
>

0 commit comments

Comments
 (0)