Merge pull request #1305 from IntersectMBO/mgalazyn/fix/rpc-initial-funds-extraconfig

cardano-rpc: fix ReadGenesis initial funds and stop retaining the genesis in memory

Author: carbolymer

.changes/20260820_cardano_api_ledgerstate_resolve_initial_funds.yml

@@ -0,0 +1,9 @@
+project: cardano-api
+
+pr: 1305
+
+kind:
+  - compatible
+
+description: |
+  Export resolveShelleyInitialFunds from Cardano.Api.LedgerState. It takes a ShelleyGenesis and resolves its initial funds against its sgExtraConfig the way ledger's own genesis state construction does, including streaming InjectionFromFile sources with content-hash verification.

.changes/20260820_cardano_rpc_genesis_initial_funds_extraconfig.yml

@@ -0,0 +1,10 @@
+project: cardano-rpc
+
+pr: 1305
+
+kind:
+  - bugfix
+  - breaking
+
+description: |
+  Fixed the UTxO RPC `ReadGenesis` response reporting no initial funds for networks created with `cardano-cli create-testnet-data`, and stopped the node retaining the parsed genesis in memory for its whole lifetime. The Shelley genesis is now read from disk when `ReadGenesis` is served, verified against the genesis hash computed at node startup, and kept for five minutes after the last request; a genesis file that changed since startup fails the request with `FAILED_PRECONDITION`. Breaking change: `mkNodeKernelAccess` no longer takes `ProtocolInfoArgs` and takes the Shelley genesis file path instead.

cardano-api/cardano-api.cabal

@@ -167,6 +167,7 @@ library
     filepath,
     formatting,
     fs-api ^>=0.4,
+    io-classes,
     iproute,
     memory,
     mempack,

cardano-api/src/Cardano/Api/Consensus.hs

@@ -53,6 +53,7 @@ module Cardano.Api.Consensus
     -- * Reexports from @ouroboros-consensus@
   , BlockComponent (..)
   , ByronBlock
+  , ByronPartialLedgerConfig (..)
   , CardanoBlock
   , ChainDB.ChainDB
   , ChainDB.ChainType (..)
@@ -66,23 +67,28 @@ module Cardano.Api.Consensus
   , ChainDepState
   , GenTx (..)
   , EraMismatch (..)
+  , HardForkLedgerConfig (..)
   , HasHardForkHistory (..)
   , HasHeader
   , Header
   , HeaderHash
   , NodeKernel (..)
   , OneEraHash (..)
   , PastHorizonException
+  , PerEraLedgerConfig (..)
   , PraosProtocolSupportsNode
   , PraosProtocolSupportsNodeCrypto
   , RealPoint (..)
   , ResourceRegistry
   , SecurityParam (..)
   , ShelleyGenesisStaking (..)
+  , ShelleyPartialLedgerConfig (..)
   , StandardCrypto
   , TopLevelConfig
+  , WrapPartialLedgerConfig (..)
   , ledgerState
   , shelleyLedgerGenesis
+  , shelleyLedgerTranslationContext
   , blockHash
   , blockNo
   , blockSlot

cardano-api/src/Cardano/Api/Consensus/Internal/Reexport.hs

@@ -1,6 +1,7 @@
 module Cardano.Api.Consensus.Internal.Reexport
   ( BlockComponent (..)
   , ByronBlock
+  , ByronPartialLedgerConfig (..)
   , CardanoBlock
   , ChainUpdate (..)
   , ConfigSupportsNode
@@ -12,18 +13,23 @@ module Cardano.Api.Consensus.Internal.Reexport
   , EraMismatch (..)
   , NodeKernel (..)
   , OneEraHash (..)
+  , HardForkLedgerConfig (..)
   , HasHardForkHistory (..)
   , PastHorizonException
+  , PerEraLedgerConfig (..)
   , PraosProtocolSupportsNode
   , PraosProtocolSupportsNodeCrypto
   , RealPoint (..)
   , ResourceRegistry
   , SecurityParam (..)
   , ShelleyGenesisStaking (..)
+  , ShelleyPartialLedgerConfig (..)
   , StandardCrypto
   , TopLevelConfig
+  , WrapPartialLedgerConfig (..)
   , ledgerState
   , shelleyLedgerGenesis
+  , shelleyLedgerTranslationContext
   , blockHash
   , blockNo
   , blockSlot
@@ -52,6 +58,7 @@ import Ouroboros.Consensus.Block
   , blockNo
   , blockSlot
   )
+import Ouroboros.Consensus.Byron.ByronHFC (ByronPartialLedgerConfig (..))
 import Ouroboros.Consensus.Byron.Ledger (ByronBlock (byronBlockRaw), GenTx (..), byronIdTx)
 import Ouroboros.Consensus.Cardano.Block (CardanoBlock, EraMismatch (..))
 import Ouroboros.Consensus.Config
@@ -63,7 +70,12 @@ import Ouroboros.Consensus.Config
 import Ouroboros.Consensus.Config.SecurityParam (SecurityParam (..))
 import Ouroboros.Consensus.Config.SupportsNode (ConfigSupportsNode)
 import Ouroboros.Consensus.HardFork.Abstract (HasHardForkHistory (..))
-import Ouroboros.Consensus.HardFork.Combinator.AcrossEras (OneEraHash (..))
+import Ouroboros.Consensus.HardFork.Combinator.AcrossEras
+  ( OneEraHash (..)
+  , PerEraLedgerConfig (..)
+  )
+import Ouroboros.Consensus.HardFork.Combinator.Basics (HardForkLedgerConfig (..))
+import Ouroboros.Consensus.HardFork.Combinator.PartialConfig (WrapPartialLedgerConfig (..))
 import Ouroboros.Consensus.HardFork.History.EpochInfo (interpreterToEpochInfo)
 import Ouroboros.Consensus.HardFork.History.Qry
   ( PastHorizonException
@@ -79,7 +91,11 @@ import Ouroboros.Consensus.Protocol.Praos.Common
   , PraosProtocolSupportsNodeCrypto
   , getOpCertCounters
   )
-import Ouroboros.Consensus.Shelley.Ledger.Ledger (shelleyLedgerGenesis)
+import Ouroboros.Consensus.Shelley.Ledger.Ledger
+  ( ShelleyPartialLedgerConfig (..)
+  , shelleyLedgerGenesis
+  , shelleyLedgerTranslationContext
+  )
 import Ouroboros.Consensus.Shelley.Node (ShelleyGenesisStaking (..))
 import Ouroboros.Consensus.Storage.Common (BlockComponent (..))
 import Ouroboros.Consensus.Util.Condense (condense)

cardano-api/src/Cardano/Api/LedgerState.hs

@@ -77,6 +77,7 @@ module Cardano.Api.LedgerState
   , GenesisConfig (..)
   , readCardanoGenesisConfig
   , mkProtocolInfoCardano
+  , resolveShelleyInitialFunds
 
     -- *** Byron Genesis Config
   , readByronGenesisConfig
@@ -174,6 +175,7 @@ import Cardano.Ledger.Keys qualified as SL
 import Cardano.Ledger.Shelley.API qualified as ShelleyAPI
 import Cardano.Ledger.Shelley.Core qualified as Core
 import Cardano.Ledger.Shelley.Genesis qualified as Ledger
+import Cardano.Ledger.Shelley.Transition qualified as Ledger
 import Cardano.Ledger.Slot qualified as Ledger
 import Cardano.Ledger.State qualified as SL
 import Cardano.Protocol.Crypto qualified as Crypto
@@ -221,8 +223,10 @@ import Ouroboros.Network.Protocol.ChainSync.PipelineDecision
 import Control.Concurrent
 import Control.DeepSeq
 import Control.Error.Util (note)
-import Control.Exception.Safe
+import Control.Exception.Safe hiding (MonadThrow)
 import Control.Monad
+import Control.Monad.Class.MonadST (MonadST)
+import Control.Monad.Class.MonadThrow (MonadThrow)
 import Control.Monad.State.Strict
 import Control.Tracer qualified as Tracer
 import Data.Aeson as Aeson
@@ -272,7 +276,7 @@ import GHC.Stack (HasCallStack)
 import Lens.Micro
 import Network.Mux qualified as Mux
 import Network.TypedProtocol.Core (Nat (..))
-import System.FS.API (SomeHasFS)
+import System.FS.API (SomeHasFS (..))
 import System.FilePath
 
 data InitialLedgerStateError
@@ -1521,6 +1525,53 @@ readCardanoGenesisConfig enc = do
   let transCfg = Ledger.mkLatestTransitionConfig shelleyGenesis alonzoGenesis conwayGenesis dijkstraGenesis
   pure $ GenesisCardano enc byronGenesis shelleyGenesisHash transCfg
 
+-- | Resolve a Shelley genesis' 'Ledger.sgInitialFunds' against its
+-- 'Ledger.sgExtraConfig', mirroring the resolution ledger's own
+-- @registerInitialFunds@ performs when building the initial ledger state
+-- from genesis.
+--
+-- A 'Ledger.ShelleyGenesis' carries two sources of initial funds: the legacy
+-- 'Ledger.sgInitialFunds' field, and 'Ledger.sgExtraConfig', which is where
+-- @cardano-cli create-testnet-data@ puts the funded addresses, embedded or in
+-- an external hash-verified file. The ledger reconciles the two only while
+-- building the initial ledger state and never writes the result back into the
+-- 'Ledger.ShelleyGenesis' value, so a parsed genesis read outside that path
+-- must repeat the resolution. Once the ledger drops the legacy field, the
+-- two-source reconciliation here can go, but turning 'Ledger.secInitialFunds'
+-- into actual funds (including reading and hash-checking an injection file)
+-- is still needed.
+--
+-- Throws 'Ledger.InjectionConflictingSources' if the genesis specifies initial
+-- funds through both the legacy field and the extra config, and
+-- 'Ledger.InjectionHashMismatch' if an 'Ledger.InjectionFromFile' source does
+-- not hash to the value the genesis declares for it.
+resolveShelleyInitialFunds
+  :: (MonadST m, MonadThrow m)
+  => SomeHasFS m
+  -- ^ Filesystem capability used to stream an 'Ledger.InjectionFromFile'
+  -- source, mounted at the Shelley genesis file's directory.
+  -> Ledger.ShelleyGenesis
+  -- ^ The Shelley genesis whose initial funds to resolve.
+  -> m Ledger.ShelleyGenesis
+resolveShelleyInitialFunds (SomeHasFS hasFS) genesis = do
+  initialFundsSource <-
+    Ledger.resolveInjectionSource
+      "initialFunds"
+      (Ledger.sgExtraConfig genesis)
+      Ledger.secInitialFunds
+      (Ledger.sgInitialFunds genesis)
+  resolvedInitialFunds <-
+    fromList <$> Ledger.foldInjectionData hasFS initialFundsSource (flip (:)) []
+  pure $
+    genesis
+      & Ledger.sgInitialFundsL .~ resolvedInitialFunds
+      -- The source has now been folded into 'sgInitialFunds'; null it out
+      -- so that re-resolving this (already-resolved) genesis later does
+      -- not trip 'Ledger.InjectionConflictingSources'.
+      & Ledger.sgExtraConfigL .~ (clearInitialFundsSource <$> Ledger.sgExtraConfig genesis)
+ where
+  clearInitialFundsSource extraConfig = extraConfig{Ledger.secInitialFunds = Ledger.NoInjection}
+
 exampleDijkstraGenesis :: Ledger.DijkstraGenesis
 exampleDijkstraGenesis =
   Ledger.DijkstraGenesis

cardano-rpc/cardano-rpc.cabal

@@ -58,6 +58,7 @@ library
     Cardano.Rpc.Server.Internal.Error
     Cardano.Rpc.Server.Internal.Monad
     Cardano.Rpc.Server.Internal.Node
+    Cardano.Rpc.Server.Internal.TimedCache
     Cardano.Rpc.Server.Internal.Tracing
     Cardano.Rpc.Server.Internal.UtxoRpc.Eval
     Cardano.Rpc.Server.Internal.UtxoRpc.Predicate
@@ -115,6 +116,7 @@ library
     errors,
     filepath,
     formatting,
+    fs-api ^>=0.4,
     generic-data,
     grapesy,
     grpc-spec,
@@ -125,6 +127,7 @@ library
     proto-lens-protobuf-types,
     random,
     rio,
+    strict-sop-core,
     text,
     time,