Add gRPC to cardano-node

Author: Jimbo4350

.github/workflows/haskell.yml

@@ -38,7 +38,7 @@ jobs:
         # If you edit these versions, make sure the version in the lonely macos-latest job below is updated accordingly
         # TODO add 9.8 again to the versions list when GHC-9.8 gets released with stm > 2.5.2,
         # see https://github.com/haskell/stm/issues/76
-        ghc: ["9.6", "9.12"]
+        ghc: ["9.6", "9.10"]
         cabal: ["3.12"]
         sys:
           - { os: windows-latest, shell: 'C:/msys64/usr/bin/bash.exe -e {0}' }
@@ -97,6 +97,18 @@ jobs:
       with:
         use-sodium-vrf: true # default is true
 
+    - name: "[Linux] Install grpc dependencies"
+      if: runner.os == 'Linux'
+      run: sudo apt install libsnappy-dev protobuf-compiler
+
+    - 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
+
+    - name: "[macOS] Install grpc dependencies"
+      if: runner.os == 'macOS'
+      run: brew install snappy protobuf
+
     - uses: actions/checkout@v4
 
     - name: Cabal update
@@ -230,9 +242,9 @@ jobs:
     # and will silently fail if msys2 is not in path. See the "Run tests" step.
     #
     # - name: Setup tmate session
-    #  if: ${{ failure() }}
-    #  uses: mxschmitt/action-tmate@v3
-    #  with:
+    #   if: ${{ failure() }}
+    #   uses: mxschmitt/action-tmate@v3
+    #   with:
     #     limit-access-to-actor: true
 
   build-complete:

bench/tx-generator/src/Cardano/TxGenerator/Setup/Plutus.hs

@@ -36,6 +36,7 @@ import qualified PlutusTx.AssocMap as AssocMap (empty)
 import           Cardano.TxGenerator.ProtocolParameters (ProtocolParameters(..))
 import           Cardano.TxGenerator.Types (TxGenError (..), TxGenPlutusResolvedTo (..))
 import           Control.Exception (SomeException (..), try, displayException)
+import           RIO (runRIO)
 import           System.FilePath ((<.>), (</>))
 #ifdef WITH_LIBRARY
 import           Cardano.Benchmarking.PlutusScripts (findPlutusScript)

bench/tx-generator/tx-generator.cabal

@@ -140,6 +140,7 @@ library
                       , network
                       , network-mux
                       , optparse-applicative-fork
+                      , rio
                       , ouroboros-consensus >= 0.6
                       , ouroboros-consensus-cardano >= 0.5
                       , ouroboros-consensus-diffusion >= 0.7.0

cabal.project

@@ -61,6 +61,13 @@ package plutus-scripts-bench
 allow-newer:
   , katip:Win32
 
+
+if impl (ghc >= 9.10)
+  allow-newer:
+    -- TODO: remove - this is for protolens
+    , *:base
+    , *:ghc-prim
+
 if impl (ghc >= 9.12)
   allow-newer:
     -- https://github.com/kapralVV/Unique/issues/11
@@ -72,3 +79,22 @@ if impl (ghc >= 9.12)
 -- IMPORTANT
 -- Do NOT add more source-repository-package stanzas here unless they are strictly
 -- temporary! Please read the section in CONTRIBUTING about updating dependencies.
+
+
+source-repository-package
+    type: git
+    location: https://github.com/intersectmbo/cardano-api
+    -- mgalazyn/feature/add-utxorpc-protocol-parameters-query
+    tag: 87b2afaaa037b78d1bed92257413fa9fdf2f156c
+    --sha256: sha256-VZv++ErHQZoG/OokIoQKGfqpKAcdm7dXPD8BzXKAkxU=
+    subdir: cardano-api
+            cardano-api-gen
+            cardano-rpc
+
+source-repository-package
+    type: git
+    location: https://github.com/intersectmbo/cardano-cli
+    -- mgalazyn/chore/remove-upstreamed-instances
+    tag: 386b22edd41820584857537203ca39caca61d158
+    --sha256: sha256-wsP5leh9EIgmG0wVLuaPizHFylvS8LGt7D2erLZbs5s=
+    subdir: cardano-cli

cardano-node/cardano-node.cabal

@@ -158,6 +158,7 @@ library
                       , cardano-prelude
                       , cardano-protocol-tpraos >= 1.4
                       , cardano-slotting >= 0.2
+                      , cardano-rpc ^>= 10.0
                       , cborg ^>= 0.2.4
                       , containers
                       , contra-tracer
@@ -220,6 +221,7 @@ library
                       , typed-protocols:{typed-protocols, stateful} >= 1.0
                       , yaml
 
+
 executable cardano-node
   import:               project-config
   hs-source-dirs:       app
@@ -255,6 +257,7 @@ test-suite cardano-node-test
                       , cardano-crypto-class
                       , cardano-crypto-wrapper
                       , cardano-api
+                      , cardano-rpc
                       , cardano-protocol-tpraos
                       , cardano-node
                       , cardano-slotting

cardano-node/src/Cardano/Node/Configuration/POM.hs

@@ -10,6 +10,8 @@
 
 {-# OPTIONS_GHC -Wno-noncanonical-monoid-instances #-}
 
+{- HLINT ignore "Functor law" -}
+
 module Cardano.Node.Configuration.POM
   ( NodeConfiguration (..)
   , ResponderCoreAffinityPolicy (..)
@@ -34,6 +36,8 @@ import           Cardano.Node.Configuration.Socket (SocketConfig (..))
 import           Cardano.Node.Handlers.Shutdown
 import           Cardano.Node.Protocol.Types (Protocol (..))
 import           Cardano.Node.Types
+import           Cardano.Rpc.Server.Config (PartialRpcConfig, RpcConfig, RpcConfigF (..),
+                   makeRpcConfig)
 import           Cardano.Tracing.Config
 import           Cardano.Tracing.OrphanInstances.Network ()
 import           Ouroboros.Consensus.Ledger.SupportsMempool
@@ -174,6 +178,9 @@ data NodeConfiguration
        , ncGenesisConfig :: GenesisConfig
 
        , ncResponderCoreAffinityPolicy :: ResponderCoreAffinityPolicy
+
+         -- gRPC
+       , ncRpcConfig :: RpcConfig
        } deriving (Eq, Show)
 
 -- | We expose the `Ouroboros.Network.Mux.ForkPolicy` as a `NodeConfiguration` field.
@@ -255,6 +262,7 @@ data PartialNodeConfiguration
        , pncSyncTargetOfKnownBigLedgerPeers       :: !(Last Int)
        , pncSyncTargetOfEstablishedBigLedgerPeers :: !(Last Int)
        , pncSyncTargetOfActiveBigLedgerPeers      :: !(Last Int)
+
          -- Minimum number of active big ledger peers we must be connected to
          -- in Genesis mode
        , pncMinBigLedgerPeersForTrustedState :: !(Last NumberOfBigLedgerPeers)
@@ -269,6 +277,9 @@ data PartialNodeConfiguration
        , pncGenesisConfigFlags :: !(Last GenesisConfigFlags)
 
        , pncResponderCoreAffinityPolicy :: !(Last ResponderCoreAffinityPolicy)
+
+         -- gRPC
+       , pncRpcConfig :: !PartialRpcConfig
        } deriving (Eq, Generic, Show)
 
 instance AdjustFilePaths PartialNodeConfiguration where
@@ -381,6 +392,12 @@ instance FromJSON PartialNodeConfiguration where
         <$> v .:? "ResponderCoreAffinityPolicy"
         <*> v .:? "ForkPolicy" -- deprecated
 
+      pncRpcConfig <-
+        RpcConfig
+          <$> (Last <$> v .:? "EnableRpc")
+          <*> (Last <$> v .:? "RpcSocketPath")
+          <*> pure mempty
+
       pure PartialNodeConfiguration {
              pncProtocolConfig
            , pncSocketConfig = Last . Just $ SocketConfig mempty mempty mempty pncSocketPath
@@ -425,6 +442,7 @@ instance FromJSON PartialNodeConfiguration where
            , pncPeerSharing
            , pncGenesisConfigFlags
            , pncResponderCoreAffinityPolicy
+           , pncRpcConfig
            }
     where
       parseMempoolCapacityBytesOverride v = parseNoOverride <|> parseOverride
@@ -687,6 +705,7 @@ defaultPartialNodeConfiguration =
     , pncGenesisConfigFlags = Last (Just defaultGenesisConfigFlags)
       -- https://ouroboros-consensus.cardano.intersectmbo.org/haddocks/ouroboros-consensus-diffusion/Ouroboros-Consensus-Node-Genesis.html#v:defaultGenesisConfigFlags
     , pncResponderCoreAffinityPolicy = Last $ Just NoResponderCoreAffinity
+    , pncRpcConfig = mempty
     }
 
 lastOption :: Parser a -> Parser (Last a)
@@ -827,6 +846,9 @@ makeNodeConfiguration pnc = do
   experimentalProtocols <-
     lastToEither "Missing ExperimentalProtocolsEnabled" $
       pncExperimentalProtocolsEnabled pnc
+
+  ncRpcConfig <- makeRpcConfig $ (pncRpcConfig pnc){nodeSocketPath=ncSocketPath socketConfig}
+
   return $ NodeConfiguration
              { ncConfigFile = configFile
              , ncTopologyFile = topologyFile
@@ -872,6 +894,7 @@ makeNodeConfiguration pnc = do
              , ncConsensusMode
              , ncGenesisConfig
              , ncResponderCoreAffinityPolicy
+             , ncRpcConfig
              }
 
 ncProtocol :: NodeConfiguration -> Protocol

cardano-node/src/Cardano/Node/Parsers.hs

@@ -15,27 +15,26 @@ module Cardano.Node.Parsers
 
 import           Cardano.Logging.Types
 import qualified Cardano.Logging.Types as Net
-import           Cardano.Node.Configuration.NodeAddress (
-                   NodeHostIPv4Address (NodeHostIPv4Address), File (..),
+import           Cardano.Node.Configuration.NodeAddress (File (..),
+                   NodeHostIPv4Address (NodeHostIPv4Address),
                    NodeHostIPv6Address (NodeHostIPv6Address), PortNumber, SocketPath)
 import           Cardano.Node.Configuration.POM (PartialNodeConfiguration (..), lastOption)
 import           Cardano.Node.Configuration.Socket
 import           Cardano.Node.Handlers.Shutdown
 import           Cardano.Node.Types
 import           Cardano.Prelude (ConvertText (..))
+import           Cardano.Rpc.Server.Config (PartialRpcConfig, RpcConfigF (..))
 import           Ouroboros.Consensus.Ledger.SupportsMempool
 import           Ouroboros.Consensus.Node
 
-import           Data.Foldable
 import           Data.Char (isDigit)
+import           Data.Foldable
 import           Data.Maybe (fromMaybe)
 import           Data.Monoid (Last (..))
 import           Data.Text (Text)
 import qualified Data.Text as Text
 import           Data.Word (Word16, Word32)
 import           Options.Applicative hiding (str, switch)
--- Don't use switch.  It will not allow to set an option in a configuration
--- file.  See `parseStartAsNonProducingNode` and `parseValidateDB`.
 import qualified Options.Applicative as Opt
 import qualified Options.Applicative.Help as OptI
 import           System.Posix.Types (Fd (..))
@@ -56,7 +55,7 @@ nodeRunParser = do
   topFp <- lastOption parseTopologyFile
   dbFp <- lastOption parseNodeDatabasePaths
   validate <- lastOption parseValidateDB
-  socketFp <- lastOption $ parseSocketPath "Path to a cardano-node socket"
+  socketFp <- lastOption $ parseSocketPath "socket-path" "Path to a cardano-node socket"
   traceForwardSocket <- lastOption parseTracerSocketMode
   nodeConfigFp <- lastOption parseConfigFile
 
@@ -83,6 +82,9 @@ nodeRunParser = do
   -- Hidden options (to be removed eventually)
   maybeMempoolCapacityOverride <- lastOption parseMempoolCapacityOverride
 
+  -- gRPC
+  pncRpcConfig <- parseRpcConfig
+
   pure $ PartialNodeConfiguration
            { pncSocketConfig =
                Last . Just $ SocketConfig
@@ -140,12 +142,15 @@ nodeRunParser = do
            , pncPeerSharing = mempty
            , pncGenesisConfigFlags = mempty
            , pncResponderCoreAffinityPolicy = mempty
+           , pncRpcConfig
            }
 
-parseSocketPath :: Text -> Parser SocketPath
-parseSocketPath helpMessage =
+parseSocketPath :: Text -- ^ option name
+                -> Text -- ^ help text
+                -> Parser SocketPath
+parseSocketPath optionName helpMessage =
   fmap File $ strOption $ mconcat
-    [ long "socket-path"
+    [ long (toS optionName)
     , help (toS helpMessage)
     , completer (bashCompleter "file")
     , metavar "FILEPATH"
@@ -419,6 +424,23 @@ parseStartAsNonProducingNode =
         ]
     ]
 
+parseRpcConfig :: Parser PartialRpcConfig
+parseRpcConfig = do
+  isEnabled <- lastOption parseRpcToggle
+  socketPath <- lastOption parseRpcSocketPath
+  pure $ RpcConfig isEnabled socketPath mempty
+  where
+    parseRpcToggle :: Parser Bool
+    parseRpcToggle =
+      Opt.switch (
+           long "grpc-enable"
+        <> help "[EXPERIMENTAL] Enable node gRPC endpoint."
+      )
+    parseRpcSocketPath :: Parser SocketPath
+    parseRpcSocketPath =
+      parseSocketPath
+        "gprc-socket-path"
+        "[EXPERIMENTAL] gRPC socket path. Defaults to rpc.sock in the same directory as node socket."
 
 -- | Produce just the brief help header for a given CLI option parser,
 --   without the options.