Skip to content

cardano-rpc | Use buf for code generation instead of cabal/protoc integration #963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

cardano-rpc | Use buf for code generation instead of cabal/protoc integration #963

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
355706d
Use buf for haskell code generation from protobuf files
carbolymer Nov 4, 2025
ef18cb9
Add code generated using buf
carbolymer Nov 4, 2025
c49c087
Update README.md with code generation instructions
carbolymer Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update README.md with code generation instructions
  • Loading branch information
@carbolymer
carbolymer committed Nov 6, 2025
commit c49c08747fe9860d2f485e7339553ba8e1e56e1d
24 changes: 22 additions & 2 deletions cardano-rpc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## What's this

The `cardano-rpc` package provides client and server haskell modules for gRPC interface of `cardano-node`.
The `cardano-rpc` package provides client and server haskell modules for gRPC interface of `cardano-node`.
It implements [UTxO RPC](https://utxorpc.org/introduction) protobuf communication protocol specification.

## Building
Expand All @@ -14,7 +14,27 @@ You need the following dependencies installed on your system:
- [`snappy`](https://github.com/google/snappy) development files (`libsnappy-dev` in Ubuntu)
- [`protobuf`](https://developers.google.com/protocol-buffers/) compiler (`protobuf-compiler` in Ubuntu)

Then do:
### Generating the Haskell code from proto definitions

You need to install `buf` and `proto-lens-protoc`.
1. Follow the `buf` installation guide at: https://buf.build/docs/cli/installation/
1. To install Haskell protobuf code compiler:
```bash
cabal install proto-lens-protoc
```

Then you can generate Haskell code using:
```bash
( cd cardano-rpc/ ; buf generate proto )
```


This will output the Haskell code into `cardano-rpc/

### Building the haskell code

To build the package use the following command:

```bash
cabal build cardano-rpc
```
Expand Down
Loading