Repository navigation
Add grpcurl transaction submission example to cardano-rpc README - #1371
Open
carbolymer wants to merge 1 commit into
Open
carbolymer wants to merge 1 commit into
carbolymer wants to merge 1 commit into
Conversation
carbolymer
force-pushed
the
mgalazyn/feature/grpcurl-submit-example
branch
from
October 7, 2026 06:51
d7f4687 to
82e7b06
Compare
carbolymer
marked this pull request as ready for review
October 7, 2026 06:51
carbolymer
requested review from
a team,
CarlosLopezDeLara,
Jimbo4350,
disassembler,
erikd and
palas
as code owners
October 7, 2026 06:51
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documented request format and response decoding match the protobuf schema and server implementation.
Review effort: Balanced
Findings: None
What changed in this PR
Adds a practical grpcurl transaction-submission example to the cardano-rpc quickstart.
Changes:
- Documents transaction encoding, submission, and transaction-ID decoding.
- Adds
jqandxxdto quickstart tooling. - Adds the required documentation changelog fragment.
| File | Description |
|---|---|
cardano-rpc/README.md |
Adds the grpcurl submission walkthrough. |
cardano-rpc/quickstart/shell.nix |
Provides tools required by the example. |
.changes/20261007_cardano_rpc_readme_grpcurl_submit.yml |
Records the documentation update. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
The cardano-rpc README walks through read-only calls with grpcurl and buf, but it had no example of submitting a transaction, which is the first thing a user coming from cardano-submit-api looks for.
This PR adds a "Submit a transaction" subsection to the "Make your first call" section.
It shows how to turn a transaction signed with cardano-cli into a SubmitTx request and how to decode the returned reference into the usual hex transaction id.
It also notes that the transaction must be built for the node's current era, and that a rejected transaction comes back as a gRPC error carrying the ledger's reason.
The quickstart shell and the ad hoc tool line now also provide jq and xxd, which the example uses.
How to trust this PR
Documentation only, no code changes.
The submission was exercised against a throwaway three-node cardano-testnet cluster started with the gRPC HTTP listener.
The call returned a reference, the decoded reference matched the output of
cardano-cli transaction txidbyte for byte, the output appeared on chain, and submitting the same transaction again returned a gRPC error with the ledger's "All inputs are spent" message.The README's pipeline differs from that run only in reading the request from stdin and in a portable base64 invocation.
To reproduce, start the cluster as the README describes, build and sign a transaction with one of the testnet's genesis UTxO keys, and run the commands from the new subsection.
Checklist
.changes/