Skip to content

cardano-rpc: Add quickstart documentation and examples - #1337

Draft
carbolymer wants to merge 1 commit into
masterfrom
mgalazyn/cardano-rpc-quickstart
Draft

cardano-rpc: Add quickstart documentation and examples#1337
carbolymer wants to merge 1 commit into
masterfrom
mgalazyn/cardano-rpc-quickstart

Conversation

@carbolymer

@carbolymer carbolymer commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Context

Adds a Quickstart section to cardano-rpc/README.md and per-language example clients under cardano-rpc/quickstart/.
The goal is to make cardano-rpc approachable for external developers, so someone new to the project can get from a fresh checkout to a working call in a few commands, without first reading the proto files or the Haskell server code.

The quickstart covers:

  • Prerequisites (Nix with flakes, a checkout of this repository for the vendored proto files).
  • Starting a local single-node cluster with cardano-testnet --enable-grpc.
  • Bridging the cluster's Unix-socket gRPC endpoint to TCP with socat, for tools that expect TCP.
  • Making first calls with buf and grpcurl.
  • Cleaning up the cluster afterwards.
  • A configuration reference for the three transport modes (Unix socket, HTTP/2 cleartext, HTTP/2 with TLS).

Two language examples are included:

  • Rust, using the utxorpc-spec crate's v1beta bindings.
  • TypeScript, with a hand-rolled v1beta MeshJS provider. The published JS u5c SDKs are still pinned to v1alpha (tracked upstream in chore: initialize v1 version utxorpc/spec#209), so @meshsdk/provider's off-the-shelf U5CProvider does not work against cardano-rpc yet.

How to trust this PR

All commands and examples in this PR were run against a live local cluster started the same way the Quickstart describes.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • New tests are added if needed and existing tests are updated. See Running tests for more details
  • Self-reviewed the diff
  • Changelog fragment added in .changes/

🤖 Generated with Claude Code

@carbolymer carbolymer self-assigned this Sep 10, 2026
@carbolymer carbolymer changed the title cardano-rpc: Add quickstart cardano-rpc: Add quickstart documentation and examples Sep 10, 2026
@carbolymer
carbolymer force-pushed the mgalazyn/cardano-rpc-quickstart branch from b4fc88f to 48ed6fb Compare September 10, 2026 18:09
@carbolymer
carbolymer force-pushed the mgalazyn/cardano-rpc-quickstart branch from 48ed6fb to 28bf138 Compare September 10, 2026 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant