tui displays node peers from environment (#2087)

ffakenz · web-flow · commit 4d7f5f0a6b4d · 2025-07-03T03:21:16.000+02:00
Closes #2044 By including the Environment of the running hydra-node in the Greetings message, clients can now use this information to display the expected peers the node should be connected with. ---  * [x] CHANGELOG updated or not needed * [x] Documentation updated or not needed * [x] Haddocks updated or not needed * [x] No new TODOs introduced or explained herafter
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,8 @@ changes.
 
 - Hydra API server responds with the correct `Content-Type` header `application-json`.
 
+- Add `Environment` to `Greetings` message, enabling clients to access runtime settings.
+
 ## [0.22.2] - 2025.06.30
 
 * Fix wrong hydra-script-tx-ids in networks.json
diff --git a/hydra-node/golden/Greetings/Greetings.json b/hydra-node/golden/Greetings/Greetings.json
@@ -0,0 +1,27 @@
+{
+    "samples": [
+        {
+            "env": {
+                "configuredPeers": "",
+                "contestationPeriod": 43200,
+                "depositPeriod": 61129,
+                "otherParties": [],
+                "participants": [
+                    "01000000000001000101000101010101000101000001000000010100"
+                ],
+                "party": {
+                    "vkey": "35719d612496ce0f320cd39e4693a2997194cec954ec602064f67a5c81150136"
+                },
+                "signingKey": "c659b97ce8782bc64476a5e82a14cbd38d0413cb15b18fa87d281b44272fa476"
+            },
+            "headStatus": "Closed",
+            "hydraHeadId": "01000001000001000000000001000101",
+            "hydraNodeVersion": "",
+            "me": {
+                "vkey": "3d8fb298d77d2fda814e9530b5539758751d27ad1c234080e04ec2e15dea1490"
+            },
+            "tag": "Greetings"
+        }
+    ],
+    "seed": -307089451
+}
diff --git a/hydra-node/golden/ServerOutput/Greetings.json b/hydra-node/golden/ServerOutput/Greetings.json
diff --git a/hydra-node/golden/SigningKey HydraKey.json b/hydra-node/golden/SigningKey HydraKey.json
@@ -0,0 +1,10 @@
+{
+    "samples": [
+        "3eadfbc424301d997974d754f31cab05549b401f23888912e5ef263010cd83ff",
+        "fcec437392209b6cb455d1a498d4b637d1fd7813f39ad774e6080fbd603628fb",
+        "2f6e6edcd13b4e697a13b1285ccc04e8b3768c9f251168333e3262fff21b4e87",
+        "1e26d64fa949a34916a24673aa0a00bd8d98594ac122a14196ecd99965a32672",
+        "fad6a4694d7ce44c9cae9ea0002d858e2a3eb12252161dff03580d6c5bfe7acf"
+    ],
+    "seed": 504743142
+}
diff --git a/hydra-node/json-schemas/api.yaml b/hydra-node/json-schemas/api.yaml
@@ -809,6 +809,7 @@ components:
         - me
         - headStatus
         - hydraNodeVersion
+        - env
       properties:
         tag:
           type: string
@@ -825,6 +826,8 @@ components:
           $ref: "api.yaml#/components/schemas/UTCTime"
         hydraNodeVersion:
           $ref: "api.yaml#/components/schemas/HydraNodeVersion"
+        env:
+          $ref: "api.yaml#/components/schemas/Environment"
 
     # Client inputs
 
@@ -2788,6 +2791,45 @@ components:
       description: |
         Current hydra-node version.
 
+    DepositPeriod:
+      type: number
+      description: |
+        A length of time, measured in whole seconds, to be used in deposit validity.
+      example: 60
+
+    Environment:
+      type: object
+      description: |
+        Running context derived from hydra-node run options.
+      required:
+      - party
+      - signingKey
+      - otherParties
+      - participants
+      - contestationPeriod
+      - depositPeriod
+      - configuredPeers
+      additionalProperties: false
+      properties:
+        party:
+          $ref: "api.yaml#/components/schemas/Party"
+        signingKey:
+          $ref: "api.yaml#/components/schemas/Signature"
+        otherParties:
+          type: array
+          items:
+            $ref: "api.yaml#/components/schemas/Party"
+        participants:
+          type: array
+          items:
+            $ref: "api.yaml#/components/schemas/OnChainId"
+        contestationPeriod:
+          $ref: "api.yaml#/components/schemas/ContestationPeriod"
+        depositPeriod:
+          $ref: "api.yaml#/components/schemas/DepositPeriod"
+        configuredPeers:
+          type: string
+
     SequenceNumber:
       type: integer
       minimum: 0
diff --git a/hydra-node/src/Hydra/API/Server.hs b/hydra-node/src/Hydra/API/Server.hs
@@ -125,7 +125,7 @@ withAPIServer config env party eventSource tracer chain pparams serverOutputFilt
             . simpleCors
             $ websocketsOr
               defaultConnectionOptions
-              (wsApp party tracer historyTimedOutputs callback headStateP headIdP responseChannel serverOutputFilter)
+              (wsApp env party tracer historyTimedOutputs callback headStateP headIdP responseChannel serverOutputFilter)
               ( httpApp
                   tracer
                   chain
diff --git a/hydra-node/src/Hydra/API/ServerOutput.hs b/hydra-node/src/Hydra/API/ServerOutput.hs
@@ -16,6 +16,7 @@ import Hydra.HeadLogic.State (ClosedState (..), HeadState (..), InitialState (..
 import Hydra.HeadLogic.State qualified as HeadState
 import Hydra.Ledger (ValidationError)
 import Hydra.Network (Host, ProtocolVersion)
+import Hydra.Node.Environment (Environment (..))
 import Hydra.Prelude hiding (seq)
 import Hydra.Tx (HeadId, Party, Snapshot, SnapshotNumber, getSnapshot)
 import Hydra.Tx qualified as Tx
@@ -101,6 +102,7 @@ data Greetings tx = Greetings
   , hydraHeadId :: Maybe HeadId
   , snapshotUtxo :: Maybe (UTxOType tx)
   , hydraNodeVersion :: String
+  , env :: Environment
   }
   deriving (Generic)
 
@@ -126,6 +128,8 @@ instance IsChainState tx => FromJSON (Greetings tx) where
 instance ArbitraryIsTx tx => Arbitrary (Greetings tx) where
   arbitrary = genericArbitrary
 
+instance (ArbitraryIsTx tx, IsChainState tx) => ToADTArbitrary (Greetings tx)
+
 data InvalidInput = InvalidInput
   { reason :: String
   , input :: Text
diff --git a/hydra-node/src/Hydra/API/WSServer.hs b/hydra-node/src/Hydra/API/WSServer.hs
@@ -44,6 +44,7 @@ import Hydra.HeadLogic (ClosedState (ClosedState, readyToFanoutSent), HeadState,
 import Hydra.HeadLogic.State qualified as HeadState
 import Hydra.Logging (Tracer, traceWith)
 import Hydra.NetworkVersions qualified as NetworkVersions
+import Hydra.Node.Environment (Environment (..))
 import Hydra.Tx (Party)
 import Hydra.Tx.HeadId (HeadId (..))
 import Network.WebSockets (
@@ -60,6 +61,7 @@ import Text.URI.QQ (queryKey, queryValue)
 wsApp ::
   forall tx.
   IsChainState tx =>
+  Environment ->
   Party ->
   Tracer IO APIServerLog ->
   ConduitT () (TimedServerOutput tx) (ResourceT IO) () ->
@@ -72,7 +74,7 @@ wsApp ::
   ServerOutputFilter tx ->
   PendingConnection ->
   IO ()
-wsApp party tracer history callback headStateP headIdP responseChannel ServerOutputFilter{txContainsAddr} pending = do
+wsApp env party tracer history callback headStateP headIdP responseChannel ServerOutputFilter{txContainsAddr} pending = do
   traceWith tracer NewAPIConnection
   let path = requestPath $ pendingRequest pending
   queryParams <- uriQuery <$> mkURIBs path
@@ -105,6 +107,7 @@ wsApp party tracer history callback headStateP headIdP responseChannel ServerOut
             , hydraHeadId
             , snapshotUtxo = getSnapshotUtxo headState
             , hydraNodeVersion = showVersion NetworkVersions.hydraNodeVersion
+            , env
             }
 
   Projection{getLatest} = headStateP
diff --git a/hydra-node/src/Hydra/Node/Environment.hs b/hydra-node/src/Hydra/Node/Environment.hs
@@ -24,6 +24,7 @@ data Environment = Environment
   -- ^ Configured peers for the network layer, used for comparison on etcd errors.
   }
   deriving stock (Generic, Show, Eq)
+  deriving anyclass (ToJSON, FromJSON)
 
 instance Arbitrary Environment where
   arbitrary = genericArbitrary
diff --git a/hydra-node/test/Hydra/API/ServerOutputSpec.hs b/hydra-node/test/Hydra/API/ServerOutputSpec.hs
@@ -20,6 +20,7 @@ import Test.QuickCheck (conjoin, withMaxSuccess)
 spec :: Spec
 spec = parallel $ do
   roundtripAndGoldenADTSpecsWithSettings defaultSettings{sampleSize = 1} $ Proxy @(MinimumSized (ServerOutput Tx))
+  roundtripAndGoldenADTSpecsWithSettings defaultSettings{sampleSize = 1} $ Proxy @(MinimumSized (Greetings Tx))
 
   -- NOTE: Kupo and maybe other downstream projects use this file as a test vector.
   it "golden SnapshotConfirmed is good" $ do
diff --git a/hydra-node/test/Hydra/CryptoSpec.hs b/hydra-node/test/Hydra/CryptoSpec.hs
@@ -49,6 +49,7 @@ specSigningKey =
       (seedA /= seedB) ==>
         (generateSigningKey seedA =/= generateSigningKey seedB)
     propCollisionResistant "arbitrary @(SigningKey HydraKey)" (arbitrary @(SigningKey HydraKey))
+    roundtripAndGoldenSpecs (Proxy @(SigningKey HydraKey))
 
 specVerificationKey :: Spec
 specVerificationKey =
diff --git a/hydra-tui/src/Hydra/TUI/Drawing.hs b/hydra-tui/src/Hydra/TUI/Drawing.hs
@@ -286,15 +286,24 @@ drawNetworkState s =
             Just NetworkDisconnected -> withAttr negative $ txt "Disconnected"
     ]
 
-drawPeers :: ConnectedState -> [Host] -> Widget n
+drawPeers :: ConnectedState -> [(Host, PeerStatus)] -> Widget n
 drawPeers s peers = vBox $ str "Alive peers:" : rest
  where
   -- Note: We only show the list of alive peers if the network is connected;
   -- otherwise, it is not reliable.
   rest = case s of
-    Connected{connection = Connection{networkState = Just NetworkConnected}} -> map drawShow peers
+    Connected{connection = Connection{networkState = Just NetworkConnected}} ->
+      map drawPeer peers
     _ -> [txt "Unknown"]
 
+  drawPeer (host, status) =
+    withAttr (statusAttr status) (drawShow host)
+
+  statusAttr = \case
+    PeerIsConnected -> positive
+    PeerIsDisconnected -> negative
+    PeerIsUnknown -> neutral
+
 drawHeadId :: HeadId -> Widget n
 drawHeadId x = txt $ "Head id: " <> serialiseToRawBytesHexText x
 
diff --git a/hydra-tui/src/Hydra/TUI/Handlers.hs b/hydra-tui/src/Hydra/TUI/Handlers.hs
@@ -8,13 +8,11 @@ module Hydra.TUI.Handlers where
 import Hydra.Prelude hiding (Down)
 
 import Brick
-import Hydra.Cardano.Api hiding (Active)
-import Hydra.Chain (PostTxError (InternalWalletError, NotEnoughFuel), reason)
-
 import Brick.Forms (Form (formState), editField, editShowableFieldWithValidate, handleFormEvent, newForm)
 import Cardano.Api.UTxO qualified as UTxO
 import Data.List (nub, (\\))
 import Data.Map qualified as Map
+import Data.Text qualified as T
 import Graphics.Vty (
   Event (EvKey),
   Key (..),
@@ -24,11 +22,15 @@ import Graphics.Vty qualified as Vty
 import Hydra.API.ClientInput (ClientInput (..))
 import Hydra.API.ServerOutput (TimedServerOutput (..))
 import Hydra.API.ServerOutput qualified as API
+import Hydra.Cardano.Api hiding (Active)
 import Hydra.Cardano.Api.Prelude ()
+import Hydra.Chain (PostTxError (InternalWalletError, NotEnoughFuel), reason)
 import Hydra.Chain.CardanoClient (CardanoClient (..))
 import Hydra.Chain.Direct.State ()
 import Hydra.Client (AllPossibleAPIMessages (..), Client (..), HydraEvent (..))
 import Hydra.Ledger.Cardano (mkSimpleTx)
+import Hydra.Network (readHost)
+import Hydra.Node.Environment (Environment (..))
 import Hydra.TUI.Forms
 import Hydra.TUI.Logging.Handlers (info, report, warn)
 import Hydra.TUI.Logging.Types (LogMessage, LogState, LogVerbosity (..), Severity (..), logMessagesL, logVerbosityL)
@@ -83,16 +85,37 @@ handleHydraEventsConnectedState = \case
 
 handleHydraEventsConnection :: HydraEvent Tx -> EventM Name Connection ()
 handleHydraEventsConnection = \case
-  Update (ApiGreetings API.Greetings{me}) -> meL .= Identified me
-  Update (ApiTimedServerOutput TimedServerOutput{output = API.PeerConnected p}) -> peersL %= \cp -> nub $ cp <> [p]
-  Update (ApiTimedServerOutput TimedServerOutput{output = API.PeerDisconnected p}) -> peersL %= \cp -> cp \\ [p]
+  Update (ApiGreetings API.Greetings{me, env = Environment{configuredPeers}}) -> do
+    meL .= Identified me
+    let peerStrs = map T.unpack (T.splitOn "," configuredPeers)
+    let peerAddrs = map (takeWhile (/= '=')) peerStrs
+    case traverse readHost peerAddrs of
+      Left err -> do
+        liftIO $ putStrLn $ "Failed to parse configured peers: " <> err
+        peersL .= mempty
+      Right parsedPeers -> do
+        existing <- use peersL
+        let existingMap = Map.fromList existing
+            updatedMap =
+              Map.fromList $
+                [ (p, Map.findWithDefault PeerIsUnknown p existingMap)
+                | p <- parsedPeers
+                ]
+        peersL .= Map.toList updatedMap
+  Update (ApiTimedServerOutput TimedServerOutput{output = API.PeerConnected p}) ->
+    peersL %= updatePeerStatus p PeerIsConnected
+  Update (ApiTimedServerOutput TimedServerOutput{output = API.PeerDisconnected p}) ->
+    peersL %= updatePeerStatus p PeerIsDisconnected
   Update (ApiTimedServerOutput TimedServerOutput{output = API.NetworkConnected}) -> do
     networkStateL .= Just NetworkConnected
-    peersL .= []
+    peersL %= map (\(h, _) -> (h, PeerIsUnknown))
   Update (ApiTimedServerOutput TimedServerOutput{output = API.NetworkDisconnected}) -> do
     networkStateL .= Just NetworkDisconnected
-    peersL .= []
+    peersL %= map (\(h, _) -> (h, PeerIsUnknown))
   e -> zoom headStateL $ handleHydraEventsHeadState e
+ where
+  updatePeerStatus host status peers =
+    (host, status) : filter ((/= host) . fst) peers
 
 handleHydraEventsHeadState :: HydraEvent Tx -> EventM Name HeadState ()
 handleHydraEventsHeadState e = do
diff --git a/hydra-tui/src/Hydra/TUI/Model.hs b/hydra-tui/src/Hydra/TUI/Model.hs
@@ -36,9 +36,11 @@ data IdentifiedState
 -- | Connectivity of the hydra node to the hydra network.
 data NetworkState = NetworkConnected | NetworkDisconnected
 
+data PeerStatus = PeerIsConnected | PeerIsDisconnected | PeerIsUnknown
+
 data Connection = Connection
   { me :: IdentifiedState
-  , peers :: [Host]
+  , peers :: [(Host, PeerStatus)]
   , networkState :: Maybe NetworkState
   , headState :: HeadState
   }
diff --git a/hydra-tui/src/Hydra/TUI/Style.hs b/hydra-tui/src/Hydra/TUI/Style.hs
@@ -9,6 +9,7 @@ import Brick (
  )
 import Brick.Forms (focusedFormInputAttr, invalidFormInputAttr)
 import Graphics.Vty (
+  brightBlack,
   brightBlue,
   defAttr,
   green,
@@ -32,6 +33,9 @@ positive = attrName "positive"
 negative :: AttrName
 negative = attrName "negative"
 
+neutral :: AttrName
+neutral = attrName "neutral"
+
 own :: AttrName
 own = attrName "own"
 
@@ -42,6 +46,7 @@ style _ =
     [ (infoA, fg brightBlue)
     , (negative, fg red)
     , (positive, fg green)
+    , (neutral, fg brightBlack)
     , (own, fg yellow)
     , -- Brick forms
       (focusedFormInputAttr, fg brightBlue)
diff --git a/hydra-tx/src/Hydra/Tx/Crypto.hs b/hydra-tx/src/Hydra/Tx/Crypto.hs
@@ -187,6 +187,18 @@ instance HasTextEnvelope (VerificationKey HydraKey) where
     "HydraVerificationKey_"
       <> fromString (algorithmNameDSIGN (Proxy :: Proxy Ed25519DSIGN))
 
+instance ToJSON (SigningKey HydraKey) where
+  toJSON = toJSON . serialiseToRawBytesHexText
+
+instance FromJSON (SigningKey HydraKey) where
+  parseJSON = Aeson.withText "SigningKey" $ decodeBase16 >=> deserialiseKey
+   where
+    deserialiseKey =
+      maybe
+        (fail "unable to deserialize SigningKey, wrong length")
+        (pure . HydraSigningKey)
+        . rawDeserialiseSignKeyDSIGN
+
 -- | Create a new 'SigningKey' from a 'ByteString' seed. The created keys are
 -- not random and insecure, so don't use this in production code!
 generateSigningKey :: ByteString -> SigningKey HydraKey

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ data Environment = Environment`
`24`	`24`	`-- ^ Configured peers for the network layer, used for comparison on etcd errors.`
`25`	`25`	`}`
`26`	`26`	`deriving stock (Generic, Show, Eq)`
	`27`	`+ deriving anyclass (ToJSON, FromJSON)`
`27`	`28`
`28`	`29`	`instance Arbitrary Environment where`
`29`	`30`	`arbitrary = genericArbitrary`