Skip to content

Commit ade88a4

Browse files
committed
Add notes about ledger state query API
1 parent 02ca597 commit ade88a4

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/api/node-to-client.md

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

9191
Query the chain's start time as a `UTCTime`.
9292

93+
> [!CAUTION]
94+
> Is this the Byron or Shelly start time?
95+
9396
```cddl
9497
{{#include cddl/local-state-query.cddl:api}}
9598
```
@@ -110,6 +113,10 @@ Example response:
110113
{{#include examples/getSystemStart/result.cbor}}
111114
```
112115

116+
> [!WARNING]
117+
> TODO: Create more realistic examples and use a tool to probabilistically verify more data.
118+
> TODO: Also use CBOR diagnostic notation for examples
119+
113120
> [!CAUTION]
114121
> 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:
115122
> ```cddl

0 commit comments

Comments
 (0)