Skip to content

Commit 8f0f827

Browse files
committed
Add notes about ledger state query API
1 parent 594f39a commit 8f0f827

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
@@ -81,6 +81,9 @@ _Since: v9_
8181

8282
Query the chain's start time as a `UTCTime`.
8383

84+
> [!CAUTION]
85+
> Is this the Byron or Shelly start time?
86+
8487
```cddl
8588
{{#include messages.cddl:api}}
8689
```
@@ -101,6 +104,10 @@ Example response:
101104
{{#include examples/getSystemStart/result.cbor}}
102105
```
103106

107+
> [!WARNING]
108+
> TODO: Create more realistic examples and use a tool to probabilistically verify more data.
109+
> TODO: Also use CBOR diagnostic notation for examples
110+
104111
> [!CAUTION]
105112
> 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:
106113
> ```cddl

0 commit comments

Comments
 (0)