Skip to content

Commit 7725575

Browse files
authored
Merge pull request #1303 from IntersectMBO/mgalazyn/utxorpc-spec-update
gRPC: Update to the latest UTxO RPC v1beta spec
2 parents 423aea4 + 670894e commit 7725575

22 files changed

Lines changed: 5588 additions & 2416 deletions

File tree

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
project: cardano-rpc
2+
3+
pr: 1303
4+
5+
kind:
6+
- feature
7+
- breaking
8+
9+
description: |
10+
Update the vendored UTxO RPC v1beta proto definitions to the latest upstream utxorpc/spec (v0.19.2 plus the unreleased EvalReport optional-field flags from [utxorpc/spec#203](https://github.com/utxorpc/spec/pull/203), a wire-compatible change), including resetting FetchBlock to the upstream repeated request/response shape (the single-item variant moved to the upcoming utxorpc v1). Expose all v1beta service methods: the unimplemented ones (ReadData, ReadTx, ReadEraSummary, ReadState, ReadMempool, WaitForTx, WatchMempool, DumpHistory) respond with the UNIMPLEMENTED gRPC status. Populate the new `Tx.votes` field (governance votes, Conway onwards) and the new `TxOutput.original_cbor` field (canonical re-encoding of the output; the ledger does not retain the original on-chain TxOut bytes).

cardano-rpc/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,22 @@ It implements [UTxO RPC](https://utxorpc.org/introduction) protobuf communicatio
77

88
## UTxO RPC v1beta spec coverage
99

10+
Methods marked ⬜ or ❌ are exposed by the server but respond with the `UNIMPLEMENTED` gRPC status.
11+
Methods marked ❌ cannot be served by `cardano-node` at all: they need a whole-chain index (transaction by hash, datum by hash) that the node does not maintain, and supporting them would mean building an external chain indexer into the node.
12+
Use a dedicated chain indexing service for those.
13+
1014
### [QueryService](https://utxorpc.org/query/spec/)
1115

1216
| Method | Status |
1317
|--------|--------|
1418
| [ReadParams](https://utxorpc.org/query/spec/#readparamsrequest) | ✅ Supported |
1519
| [ReadUtxos](https://utxorpc.org/query/spec/#readutxosrequest) | ✅ Supported |
1620
| [SearchUtxos](https://utxorpc.org/query/spec/#searchutxosrequest) | ✅ Supported |
17-
| [ReadData](https://utxorpc.org/query/spec/#readdatarequest) | Not supported |
18-
| [ReadTx](https://utxorpc.org/query/spec/#queryservice) | Not supported |
21+
| [ReadData](https://utxorpc.org/query/spec/#readdatarequest) | Not supported, needs a chain indexer |
22+
| [ReadTx](https://utxorpc.org/query/spec/#queryservice) | Not supported, needs a chain indexer |
1923
| [ReadGenesis](https://utxorpc.org/query/spec/#queryservice) | ✅ Supported |
2024
| [ReadEraSummary](https://utxorpc.org/query/spec/#queryservice) | ⬜ Not supported |
25+
| [ReadState](https://utxorpc.org/query/spec/#queryservice) | ⬜ Not supported |
2126

2227
### [SubmitService](https://utxorpc.org/submit/spec/)
2328

cardano-rpc/gen/Proto/Utxorpc/V1beta/Cardano/Cardano.hs

Lines changed: 3797 additions & 1925 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cardano-rpc/gen/Proto/Utxorpc/V1beta/Cardano/Cardano_Fields.hs

Lines changed: 109 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)