Add cardano-rpc package #885

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

Jump to bottom

Merged

carbolymer merged 4 commits into master from mgalazyn/feature/add-cardano-rpc

Jul 8, 2025

Contributor

carbolymer commented Jul 2, 2025 •

edited

Loading

Changelog

- description: |
    cardano-rpc: Add cardano-rpc package with a dummy gRPC service
# uncomment types applicable to the change:
  type:
   - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - refactoring    # QoL changes
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

This PR adds new cardano-rpc cabal module.

It is not buildable with GHC 9.12 yet, so in GHA GHC 9.10 is used instead.

Tested in: IntersectMBO/cardano-node#6205

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

carbolymer force-pushed the mgalazyn/feature/add-cardano-rpc branch 2 times, most recently from 825e7a0 to 6c7069d Compare

July 2, 2025 15:53

carbolymer marked this pull request as ready for review

July 2, 2025 16:10

carbolymer requested review from a team, CarlosLopezDeLara, Jimbo4350, dcoutts, disassembler, erikd, kevinhammond, newhoggy and palas as code owners

July 2, 2025 16:10

carbolymer force-pushed the mgalazyn/feature/add-cardano-rpc branch from 6c7069d to 0d02419 Compare

July 2, 2025 16:10

carbolymer commented

View reviewed changes

fourmolu.yaml

    
              unicode: never

              respectful: false

              fixities: []

              fixities:

Contributor Author

carbolymer Jul 2, 2025

I think missing fixity information was causing weird formatting issues with lenses in your PRs, @palas . I think this should help.

Contributor

palas Jul 4, 2025

Ah, nice!

carbolymer force-pushed the mgalazyn/feature/add-cardano-rpc branch from 0d02419 to 44c2834 Compare

July 2, 2025 16:46

carbolymer self-assigned this

carbolymer force-pushed the mgalazyn/feature/add-cardano-rpc branch 7 times, most recently from 5ddf6a4 to f5e18c6 Compare

July 3, 2025 08:29

carbolymer commented

View reviewed changes

flake.nix Outdated Show resolved Hide resolved

carbolymer commented

View reviewed changes

.github/workflows/haskell.yml Outdated

Comment on lines 177 to 184

    
                  - name: Setup tmate session

                    if: ${{ failure() }}

                    uses: mxschmitt/action-tmate@v3

                    with:

                       limit-access-to-actor: true

Contributor Author

carbolymer Jul 3, 2025

Suggested change

      
                - name: Setup tmate session
          
                  if: ${{ failure() }}
          
                  uses: mxschmitt/action-tmate@v3
          
                  with:
          
                     limit-access-to-actor: true
          
                # - name: Setup tmate session
          
                #   if: ${{ failure() }}
          
                #   uses: mxschmitt/action-tmate@v3
          
                #   with:
          
                #      limit-access-to-actor: true

Contributor

Jimbo4350 Jul 3, 2025

Interesting, how were you using this?

Contributor Author

carbolymer Jul 4, 2025 •

edited

Loading

You uncomment this, and then the CI action waits infinitely printing a ssh command, which allows you to interactively log in and troubleshoot on the GHA runner.

https://github.com/IntersectMBO/cardano-api/actions/runs/16048917967/job/45286704820#step:18:48

carbolymer force-pushed the mgalazyn/feature/add-cardano-rpc branch 4 times, most recently from 388ba81 to 9a2fb9c Compare

July 3, 2025 11:14

Jimbo4350 requested changes

View reviewed changes

Contributor

Jimbo4350 left a comment •

edited

Loading

This PR needs to be broken up into smaller pieces. I suggest:

Open a PR with the dummy example.
Open a PR per mini-protocol along with their protobuf files.

.github/workflows/haskell.yml

    
                  strategy:

                    fail-fast: false

                    matrix:

                      ghc: ["9.6", "9.12"]

Contributor

Jimbo4350 Jul 3, 2025

You weren't able to get it to build with 9.12?

Contributor Author

carbolymer Jul 4, 2025 •

edited

Loading

No, unfortunately no. I suspect the situation will improve once there will be stackage snapshot with 9.12, which means more of haskell packages will work with 9.12. Do we need 9.12 at this moment?

Contributor

Jimbo4350 Jul 4, 2025 •

edited

Loading

Nop we don't.

Contributor Author

carbolymer Jul 8, 2025

.github/workflows/haskell.yml

    
                  - name: "[Windows] Install grpc dependencies"

                    if: runner.os == 'Windows'

                    run: /usr/bin/pacman --noconfirm -S mingw-w64-x86_64-snappy mingw-w64-x86_64-protobuf

Contributor

Jimbo4350 Jul 3, 2025

👍

.github/workflows/haskell.yml Outdated

Comment on lines 177 to 184

    
                  - name: Setup tmate session

                    if: ${{ failure() }}

                    uses: mxschmitt/action-tmate@v3

                    with:

                       limit-access-to-actor: true

Contributor

Jimbo4350 Jul 3, 2025

Interesting, how were you using this?

cardano-rpc/CHANGELOG.md Outdated Show resolved Hide resolved

cardano-rpc/NOTICE Outdated Show resolved Hide resolved

cardano-rpc/proto/utxorpc/v1alpha/cardano/cardano.proto Outdated

    
              // Represents a set of witnesses that validate a transaction

              message WitnessSet {

                repeated VKeyWitness vkeywitness = 1; // List of VKey witnesses.

                repeated Script script = 2; // List of scripts.

Contributor

Jimbo4350 Jul 3, 2025

Redeemers and bootstrap witnesses should also be here.

cardano-rpc/proto/utxorpc/v1alpha/cardano/cardano.proto Outdated

    
              // Represents a transaction in the Cardano blockchain.

              message Tx {

                repeated TxInput inputs = 1; // List of transaction inputs

Contributor

Jimbo4350 Jul 3, 2025

Can you add a comment with the currently outstanding fields?

Contributor Author

carbolymer Jul 4, 2025 •

edited

Loading

I wouldn't want to do that. I can mark them in haskell code, but I would like to keep the proto files identical to source files in UTxO RPC spec.

cardano-rpc/proto/utxorpc/v1alpha/cardano/cardano.proto Outdated

    
                  NewConstitutionAction new_constitution_action = 6; // Replace the Constitution

                  // TODO: revisit if there's a better way to handle this option because it doesn't actually need a value but proto syntax needs to require it

                  uint32 info_action = 7; // Info action should just be the integer number 6

Contributor

Jimbo4350 Jul 3, 2025

Why not:

diff --git a/cardano-rpc/proto/utxorpc/v1alpha/cardano/cardano.proto b/cardano-rpc/proto/utxorpc/v1alpha/cardano/cardano.proto
index e15f60eff..c96103366 100644
--- a/cardano-rpc/proto/utxorpc/v1alpha/cardano/cardano.proto
+++ b/cardano-rpc/proto/utxorpc/v1alpha/cardano/cardano.proto
@@ -129,7 +129,7 @@ message GovernanceAction {
     NewConstitutionAction new_constitution_action = 6; // Replace the Constitution
 
     // TODO: revisit if there's a better way to handle this option because it doesn't actually need a value but proto syntax needs to require it
-    uint32 info_action = 7; // Info action should just be the integer number 6
+    InfoAction info_action = 7; // Info action should just be the integer number 6
   }
 }
 
@@ -163,6 +163,8 @@ message NoConfidenceAction {
   GovernanceActionId gov_action_id = 1;
 }
 
+message InfoAction {}
+
 message UpdateCommitteeAction {
   GovernanceActionId gov_action_id = 1;
   repeated StakeCredential remove_committee_credentials = 2; // Committee members to remove (if any)

cardano-rpc/proto/utxorpc/v1alpha/cardano/cardano.proto Outdated

    
              }

              message TreasuryWithdrawalsAction {

                repeated WithdrawalAmount withdrawals = 1; // A map of the withdrawals to make

Contributor

Jimbo4350 Jul 3, 2025

This would make a list

cardano-rpc/proto/utxorpc/v1alpha/cardano/cardano.proto Outdated

    
              // Represents a native script in Cardano.

              message NativeScript {

                oneof native_script {

                  bytes script_pubkey = 1; // Script based on an address key hash.

Contributor

Jimbo4350 Jul 3, 2025

script_pubkey_hash?

carbolymer force-pushed the mgalazyn/feature/add-cardano-rpc branch 5 times, most recently from d1c9c89 to 99bd26b Compare

July 8, 2025 11:47

Jimbo4350 reviewed

View reviewed changes

cabal.project Outdated Show resolved Hide resolved

carbolymer force-pushed the mgalazyn/feature/add-cardano-rpc branch from 4b5d1b8 to 9ad6d49 Compare

July 8, 2025 12:21

Jimbo4350 approved these changes

View reviewed changes

Contributor

Jimbo4350 left a comment

LGTM 👍

cardano-rpc/cardano-rpc.cabal Outdated Show resolved Hide resolved

cardano-rpc/src/Cardano/Rpc/Server/Config.hs

    
                  } = do

                  let isEnabled = fromMaybe False mIsEnabled

                      -- default to a some non-existing path. Does not matter if the gRPC endpoint is disabled

                      nodeSocketPath = fromMaybe "./node.socket" mNodeSocketPath

Contributor

Jimbo4350 Jul 8, 2025

Abstracting this as a separate value (as we do for the node configuration) would be clearer IMO.

carbolymer force-pushed the mgalazyn/feature/add-cardano-rpc branch 4 times, most recently from 37851af to e77348c Compare

July 8, 2025 14:29


          Upstream Error instances from cardano-cli. Add lens fixities in fourm…

7ea9f5e

…olu config.

carbolymer force-pushed the mgalazyn/feature/add-cardano-rpc branch from e77348c to e5a011d Compare

July 8, 2025 14:33

carbolymer added 3 commits

July 8, 2025 17:15


          Add cardano-rpc package with dummy service

dec79f8


          Update haskell.nix

0ed5628


          HLS GHA: Add workaround for cabal custom-setup

30b9187

carbolymer force-pushed the mgalazyn/feature/add-cardano-rpc branch from e5a011d to 30b9187 Compare

July 8, 2025 15:15

carbolymer enabled auto-merge

July 8, 2025 15:18

carbolymer added this pull request to the merge queue

Merged via the queue into master with commit 1638513

27 of 29 checks passed

carbolymer deleted the mgalazyn/feature/add-cardano-rpc branch

July 8, 2025 16:15

carbolymer mentioned this pull request

gRPC: Address UTxO RPC proto files remarks from #885 #898

Open

1 task

This was referenced Nov 13, 2025

gRPC: Make optional fields optional in proto definition #1012

Open

gRPC: Remove redeemers from multiasset in proto definition #1018

Open

This was referenced Nov 24, 2025

gRPC: Move governance info action to a separate type in proto #1035

Open

gRPC: Rename NativeScript.script_pubkey to script_pubkey_hash in proto definition #1036

Open

gRPC: Add redeemers and bootstrap witnesses to WitnessSet in proto file #1037

Open

gRPC: Simplify Asset definition in proto file #1041

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Jimbo4350 Jimbo4350 approved these changes

newhoggy Awaiting requested review from newhoggy newhoggy is a code owner

palas Awaiting requested review from palas palas is a code owner

disassembler Awaiting requested review from disassembler disassembler is a code owner

CarlosLopezDeLara Awaiting requested review from CarlosLopezDeLara CarlosLopezDeLara is a code owner

dcoutts Awaiting requested review from dcoutts dcoutts is a code owner

erikd Awaiting requested review from erikd erikd is a code owner

kevinhammond Awaiting requested review from kevinhammond kevinhammond is a code owner

Labels

None yet