Merge pull request #1196 from input-output-hk/ensemble/stateless-observation-hydra-node

Stateless observation hydra node

Author: v0d1ch

CHANGELOG.md

@@ -8,7 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 As a minor extension, we also keep a semantic version for the `UNRELEASED`
 changes.
 
-## [0.15.0] - UNRELEASEd
+
+## [0.15.0] - UNRELEASED
+
+- Hydra Direct Chain layer does not maintain state and does not make any logic
+  decisions. This is now completely responsibility of the HydraLogic layer.
+  Posting transactions from this layer is now free of any knowledge of L1 keys.
+  [1196](https://github.com/input-output-hk/hydra/pull/1196)
 
 - **BREAKING** Internal changes to `hydra-cardano-api`:
   - Renamed `HasMultiAsset` type class to `IsMaryEraOnwards`. Use
@@ -18,6 +24,7 @@ changes.
   - Renamed `HasInlineDatums` type class to `IsBabbageEraOnwards`. Use
     `babbageEraOnwards` to produce witnesses for features from babbage onwards.
 
+
 ## [0.14.0] - 2023-12-04
 
 - **BREAKING** Multiple changes to the Hydra Head protocol on-chain:

hydra-cardano-api/src/Hydra/Cardano/Api/Hash.hs

@@ -9,6 +9,8 @@ import Cardano.Ledger.Shelley.Scripts qualified as Ledger
 import Data.ByteString qualified as BS
 import PlutusLedgerApi.V2 qualified as Plutus
 
+-- * Type conversions
+
 -- | Convert a cardano-api 'Hash' into a plutus 'PubKeyHash'
 toPlutusKeyHash :: Hash PaymentKey -> Plutus.PubKeyHash
 toPlutusKeyHash (PaymentKeyHash vkh) =

hydra-cardano-api/src/Hydra/Cardano/Api/PolicyId.hs

@@ -1,8 +1,38 @@
+{-# OPTIONS_GHC -Wno-orphans #-}
+
 module Hydra.Cardano.Api.PolicyId where
 
 import Hydra.Cardano.Api.Prelude
 
+import Cardano.Ledger.Alonzo.TxInfo qualified as Ledger
 import Cardano.Ledger.Hashes qualified as Ledger
+import Cardano.Ledger.Mary.Value qualified as Ledger
+import Hydra.Cardano.Api.ScriptHash ()
+import PlutusLedgerApi.V2 (CurrencySymbol, fromBuiltin, unCurrencySymbol)
+
+-- * Orphans
+
+instance Arbitrary PolicyId where
+  arbitrary = PolicyId <$> arbitrary
+
+-- * Type conversions
 
 toLedgerScriptHash :: PolicyId -> Ledger.ScriptHash StandardCrypto
 toLedgerScriptHash (PolicyId scriptHash) = toShelleyScriptHash scriptHash
+
+-- | Convert Cardano api 'PolicyId' to Cardano ledger `PolicyID`.
+toLedgerPolicyID :: PolicyId -> Ledger.PolicyID StandardCrypto
+toLedgerPolicyID (PolicyId sh) = Ledger.PolicyID (toShelleyScriptHash sh)
+
+-- | Convert Cardano api 'PolicyId' to Plutus `CurrencySymbol`.
+toPlutusCurrencySymbol :: PolicyId -> CurrencySymbol
+toPlutusCurrencySymbol = Ledger.transPolicyID . toLedgerPolicyID
+
+-- | Convert a plutus 'CurrencySymbol' into a cardano-api 'PolicyId'.
+fromPlutusCurrencySymbol :: MonadFail m => CurrencySymbol -> m PolicyId
+fromPlutusCurrencySymbol cs =
+  case deserialiseFromRawBytes AsPolicyId bytes of
+    Left err -> fail (show err)
+    Right pid -> pure pid
+ where
+  bytes = fromBuiltin $ unCurrencySymbol cs

hydra-cardano-api/src/Hydra/Cardano/Api/ScriptHash.hs

@@ -1,8 +1,13 @@
+{-# OPTIONS_GHC -Wno-orphans #-}
+
 module Hydra.Cardano.Api.ScriptHash where
 
 import Hydra.Cardano.Api.Prelude
 
 import Cardano.Ledger.Credential qualified as Ledger
+import Hydra.Cardano.Api.PlutusScript ()
+
+-- * Extras
 
 -- | Extract the payment part of an address, as a script hash.
 getPaymentScriptHash :: AddressInEra era -> Maybe ScriptHash
@@ -16,3 +21,10 @@ getPaymentScriptHash = \case
 hashScriptInAnyLang :: ScriptInAnyLang -> ScriptHash
 hashScriptInAnyLang (ScriptInAnyLang _ script) =
   hashScript script
+
+-- * Orphans
+
+instance Arbitrary ScriptHash where
+  arbitrary = do
+    plutusScript <- arbitrary
+    pure $ hashScript (PlutusScript PlutusScriptV2 plutusScript)

hydra-cardano-api/src/Hydra/Cardano/Api/TxBody.hs

@@ -2,19 +2,17 @@ module Hydra.Cardano.Api.TxBody where
 
 import Hydra.Cardano.Api.Prelude
 
-import Hydra.Cardano.Api.PlutusScript (fromLedgerScript)
-import Hydra.Cardano.Api.PolicyId (toLedgerScriptHash)
-import Hydra.Cardano.Api.ScriptData (FromScriptData)
-import Hydra.Cardano.Api.TxIn (toLedgerTxIn)
-import Hydra.Cardano.Api.Value (toLedgerPolicyID)
-
 import Cardano.Ledger.Alonzo.Scripts.Data qualified as Ledger
 import Cardano.Ledger.Alonzo.TxWits qualified as Ledger
 import Cardano.Ledger.Babbage.Tx qualified as Ledger
 import Cardano.Ledger.BaseTypes (strictMaybeToMaybe)
 import Cardano.Ledger.Core qualified as Ledger
 import Data.List (find)
 import Data.Map qualified as Map
+import Hydra.Cardano.Api.PlutusScript (fromLedgerScript)
+import Hydra.Cardano.Api.PolicyId (toLedgerPolicyID, toLedgerScriptHash)
+import Hydra.Cardano.Api.ScriptData (FromScriptData)
+import Hydra.Cardano.Api.TxIn (toLedgerTxIn)
 import PlutusLedgerApi.V2 qualified as Plutus
 
 -- | Find and deserialise from 'ScriptData', a redeemer from the transaction

hydra-cardano-api/src/Hydra/Cardano/Api/TxOut.hs

@@ -86,6 +86,7 @@ findTxOutByAddress address tx =
  where
   indexedOutputs = zip [mkTxIn tx ix | ix <- [0 ..]] (txOuts' tx)
 
+-- | Find a single script output in some 'UTxO'
 findTxOutByScript ::
   forall lang.
   IsPlutusScriptLanguage lang =>
@@ -102,6 +103,28 @@ findTxOutByScript utxo script =
        in scriptHash == scriptHash'
     _ ->
       False
+
+-- | Predicate to find or filter 'TxOut' which are governed by some script. This
+-- is better than comparing the full address as it does not require a network
+-- discriminator.
+isScriptTxOut ::
+  forall lang ctx era.
+  IsPlutusScriptLanguage lang =>
+  PlutusScript lang ->
+  TxOut ctx era ->
+  Bool
+isScriptTxOut script txOut =
+  case address of
+    (AddressInEra (ShelleyAddressInEra _) (ShelleyAddress _ (Ledger.ScriptHashObj sh) _)) ->
+      scriptHash == sh
+    _ -> False
+ where
+  scriptHash = toShelleyScriptHash $ hashScript $ PlutusScript version script
+
+  version = plutusScriptVersion @lang
+
+  (TxOut address _ _ _) = txOut
+
 -- * Type Conversions
 
 -- | Convert a cardano-ledger 'TxOut' into a cardano-api 'TxOut'
@@ -122,14 +145,13 @@ fromPlutusTxOut ::
   (IsMaryEraOnwards era, IsAlonzoEraOnwards era, IsBabbageEraOnwards era, IsShelleyBasedEra era) =>
   Network ->
   Plutus.TxOut ->
-  TxOut CtxUTxO era
-fromPlutusTxOut network out =
-  TxOut addressInEra value datum ReferenceScriptNone
+  Maybe (TxOut CtxUTxO era)
+fromPlutusTxOut network out = do
+  value <- TxOutValue maryEraOnwards <$> fromPlutusValue plutusValue
+  pure $ TxOut addressInEra value datum ReferenceScriptNone
  where
   addressInEra = fromPlutusAddress network plutusAddress
 
-  value = TxOutValue maryEraOnwards $ fromPlutusValue plutusValue
-
   datum = case plutusDatum of
     NoOutputDatum -> TxOutDatumNone
     OutputDatumHash (Plutus.DatumHash hashBytes) ->

hydra-cardano-api/src/Hydra/Cardano/Api/UTxO.hs

@@ -2,7 +2,7 @@ module Hydra.Cardano.Api.UTxO where
 
 import Hydra.Cardano.Api.Prelude
 import Hydra.Cardano.Api.TxId (toLedgerTxId)
-import Hydra.Cardano.Api.TxIn (fromLedgerTxIn, toLedgerTxIn)
+import Hydra.Cardano.Api.TxIn (fromLedgerTxIn, toLedgerTxIn, txIns')
 import Hydra.Cardano.Api.TxOut (fromLedgerTxOut, toLedgerTxOut)
 
 import Cardano.Api.UTxO qualified as UTxO
@@ -12,6 +12,7 @@ import Cardano.Ledger.Shelley.UTxO qualified as Ledger
 import Cardano.Ledger.TxIn qualified as Ledger
 import Data.Foldable (toList)
 import Data.Map qualified as Map
+import Data.Maybe (mapMaybe)
 import Data.String (IsString (..))
 import Data.Text qualified as Text
 
@@ -32,6 +33,12 @@ utxoFromTx (Tx body@(ShelleyTxBody _ ledgerBody _ _ _ _) _) =
         ]
    in fromLedgerUTxO $ Ledger.UTxO $ Map.fromList $ zip txIns txOuts
 
+-- | Resolve tx inputs in a given UTxO
+resolveInputsUTxO :: UTxO -> Tx Era -> UTxO
+resolveInputsUTxO utxo tx =
+  UTxO.fromPairs $
+    mapMaybe (\txIn -> (txIn,) <$> UTxO.resolve txIn utxo) (txIns' tx)
+
 -- * Type Conversions
 
 toLedgerUTxO :: UTxO -> Ledger.UTxO LedgerEra

hydra-cardano-api/src/Hydra/Cardano/Api/Value.hs

@@ -10,8 +10,9 @@ import Data.Word (Word64)
 import Hydra.Cardano.Api.CtxUTxO (ToUTxOContext (..))
 import Hydra.Cardano.Api.Hash (unsafeScriptHashFromBytes)
 import Hydra.Cardano.Api.MaryEraOnwards (maryEraOnwards)
+import Hydra.Cardano.Api.PolicyId (fromPlutusCurrencySymbol)
 import PlutusLedgerApi.V1.Value (flattenValue)
-import PlutusLedgerApi.V2 (CurrencySymbol, adaSymbol, adaToken, fromBuiltin, unCurrencySymbol, unTokenName)
+import PlutusLedgerApi.V2 (adaSymbol, adaToken, fromBuiltin, unTokenName)
 import PlutusLedgerApi.V2 qualified as Plutus
 
 -- * Extras
@@ -82,13 +83,16 @@ toLedgerValue =
   toMaryValue
 
 -- | Convert a plutus 'Value' into a cardano-api 'Value'.
-fromPlutusValue :: Plutus.Value -> Value
-fromPlutusValue plutusValue =
-  valueFromList $ map convertAsset $ flattenValue plutusValue
+fromPlutusValue :: Plutus.Value -> Maybe Value
+fromPlutusValue plutusValue = do
+  fmap valueFromList . mapM convertAsset $ flattenValue plutusValue
  where
   convertAsset (cs, tk, i)
-    | cs == adaSymbol && tk == adaToken = (AdaAssetId, Quantity i)
-    | otherwise = (AssetId (fromPlutusCurrencySymbol cs) (toAssetName tk), Quantity i)
+    | cs == adaSymbol && tk == adaToken =
+        pure (AdaAssetId, Quantity i)
+    | otherwise = do
+        pid <- fromPlutusCurrencySymbol cs
+        pure (AssetId pid (toAssetName tk), Quantity i)
 
   toAssetName :: Plutus.TokenName -> AssetName
   toAssetName = AssetName . fromBuiltin . unTokenName
@@ -97,15 +101,3 @@ fromPlutusValue plutusValue =
 toPlutusValue :: Value -> Plutus.Value
 toPlutusValue =
   Ledger.transValue . toLedgerValue
-
--- | Convert Cardano api 'PolicyId' to Plutus `CurrencySymbol`.
-toPlutusCurrencySymbol :: PolicyId -> CurrencySymbol
-toPlutusCurrencySymbol = Ledger.transPolicyID . toLedgerPolicyID
-
--- | Convert a plutus 'CurrencySymbol' into a cardano-api 'PolicyId'.
-fromPlutusCurrencySymbol :: CurrencySymbol -> PolicyId
-fromPlutusCurrencySymbol = PolicyId . unsafeScriptHashFromBytes . fromBuiltin . unCurrencySymbol
-
--- | Convert Cardano api 'PolicyId' to Cardano ledger `PolicyID`.
-toLedgerPolicyID :: PolicyId -> Ledger.PolicyID StandardCrypto
-toLedgerPolicyID (PolicyId sh) = Ledger.PolicyID (toShelleyScriptHash sh)

hydra-chain-observer/hydra-chain-observer.cabal

@@ -1,6 +1,6 @@
 cabal-version: 2.2
 name:          hydra-chain-observer
-version:       0.14.0
+version:       0.15.0
 synopsis:      Hydra Chain Observer
 author:        IOG
 copyright:     2023 IOG

hydra-chain-observer/src/Hydra/ChainObserver.hs

@@ -7,7 +7,6 @@ import Hydra.Prelude
 import Hydra.Cardano.Api (
   Block (..),
   BlockInMode (..),
-  CardanoEra (..),
   CardanoMode,
   ChainPoint,
   ChainSyncClient,
@@ -36,8 +35,7 @@ import Hydra.Chain.Direct.Tx (
   ContestObservation (..),
   FanoutObservation (..),
   HeadObservation (..),
-  RawInitObservation (..),
-  mkHeadId,
+  InitObservation (..),
   observeHeadTx,
  )
 import Hydra.ChainObserver.Options (Options (..), hydraChainObserverOptions)
@@ -169,7 +167,7 @@ observeTx networkId utxo tx =
   let utxo' = adjustUTxO tx utxo
    in case observeHeadTx networkId utxo tx of
         NoHeadTx -> (utxo, Nothing)
-        Init RawInitObservation{headId} -> (utxo', pure $ HeadInitTx{headId = mkHeadId headId})
+        Init InitObservation{headId} -> (utxo', pure $ HeadInitTx{headId})
         Commit CommitObservation{headId} -> (utxo', pure $ HeadCommitTx{headId})
         CollectCom CollectComObservation{headId} -> (utxo', pure $ HeadCollectComTx{headId})
         Close CloseObservation{headId} -> (utxo', pure $ HeadCloseTx{headId})