Draft JSON instances for HeadObservation

Author: ch1bo

hydra-tx/src/Hydra/Tx/Abort.hs

@@ -106,6 +106,11 @@ abortTx committedUTxO scriptRegistry vk (headInput, initialHeadOutput) headToken
 
 newtype AbortObservation = AbortObservation {headId :: HeadId}
   deriving stock (Eq, Show, Generic)
+  deriving anyclass (ToJSON, FromJSON)
+
+instance Arbitrary AbortObservation where
+  arbitrary = genericArbitrary
+  shrink = genericShrink
 
 -- | Identify an abort tx by looking up the input spending the Head output and
 -- decoding its redeemer.

hydra-tx/src/Hydra/Tx/Close.hs

@@ -156,6 +156,11 @@ data CloseObservation = CloseObservation
   , contestationDeadline :: UTCTime
   }
   deriving stock (Show, Eq, Generic)
+  deriving anyclass (ToJSON, FromJSON)
+
+instance Arbitrary CloseObservation where
+  arbitrary = genericArbitrary
+  shrink = genericShrink
 
 -- | Identify a close tx by lookup up the input spending the Head output and
 -- decoding its redeemer.

hydra-tx/src/Hydra/Tx/CollectCom.hs

@@ -1,4 +1,5 @@
 {-# LANGUAGE AllowAmbiguousTypes #-}
+{-# LANGUAGE DerivingVia #-}
 {-# LANGUAGE DuplicateRecordFields #-}
 
 module Hydra.Tx.CollectCom where
@@ -99,6 +100,15 @@ collectComTx networkId scriptRegistry vk headId headParameters (headInput, initi
 
 newtype UTxOHash = UTxOHash ByteString
   deriving stock (Eq, Show, Generic)
+  deriving (ToJSON, FromJSON) via (UsingRawBytesHex UTxOHash)
+
+instance HasTypeProxy UTxOHash where
+  data AsType UTxOHash = AsUTxOHash
+  proxyToAsType _ = AsUTxOHash
+
+instance SerialiseAsRawBytes UTxOHash where
+  serialiseToRawBytes (UTxOHash bytes) = bytes
+  deserialiseFromRawBytes _ = Right . UTxOHash
 
 instance Arbitrary UTxOHash where
   arbitrary = UTxOHash . BS.pack <$> vectorOf 32 arbitrary
@@ -108,6 +118,11 @@ data CollectComObservation = CollectComObservation
   , utxoHash :: UTxOHash
   }
   deriving stock (Show, Eq, Generic)
+  deriving anyclass (ToJSON, FromJSON)
+
+instance Arbitrary CollectComObservation where
+  arbitrary = genericArbitrary
+  shrink = genericShrink
 
 -- | Identify a collectCom tx by lookup up the input spending the Head output
 -- and decoding its redeemer.

hydra-tx/src/Hydra/Tx/Commit.hs

@@ -155,6 +155,11 @@ data CommitObservation = CommitObservation
   , headId :: HeadId
   }
   deriving stock (Eq, Show, Generic)
+  deriving anyclass (ToJSON, FromJSON)
+
+instance Arbitrary CommitObservation where
+  arbitrary = undefined -- TODO: Arbitrary UTxO in hydra-tx
+  shrink = undefined -- TODO: Arbitrary UTxO in hydra-tx
 
 -- | Identify a commit tx by:
 --

hydra-tx/src/Hydra/Tx/Contest.hs

@@ -155,6 +155,16 @@ data ContestObservation = ContestObservation
   }
   deriving stock (Show, Eq, Generic)
 
+instance ToJSON ContestObservation where
+  toJSON = undefined -- TODO: ToJSON PubKeyHash?
+
+instance FromJSON ContestObservation where
+  parseJSON = undefined -- TODO: FromJSON PubKeyHash?
+
+instance Arbitrary ContestObservation where
+  arbitrary = undefined -- TODO: Arbitrary PubKeyHash
+  shrink = undefined -- TODO: Arbitrary PubKeyHash
+
 -- | Identify a close tx by lookup up the input spending the Head output and
 -- decoding its redeemer.
 observeContestTx ::

hydra-tx/src/Hydra/Tx/Decrement.hs

@@ -99,6 +99,11 @@ data DecrementObservation = DecrementObservation
   , distributedUTxO :: UTxO
   }
   deriving stock (Show, Eq, Generic)
+  deriving anyclass (ToJSON, FromJSON)
+
+instance Arbitrary DecrementObservation where
+  arbitrary = undefined -- TODO: Arbitrary UTxO in hydra-tx
+  shrink = undefined -- TODO: Arbitrary UTxO in hydra-tx
 
 observeDecrementTx ::
   UTxO ->

hydra-tx/src/Hydra/Tx/Deposit.hs

@@ -83,6 +83,16 @@ data DepositObservation = DepositObservation
   }
   deriving stock (Show, Eq, Generic)
 
+instance ToJSON DepositObservation where
+  toJSON = undefined -- TODO: ToJSON POSIXTime?
+
+instance FromJSON DepositObservation where
+  parseJSON = undefined -- TODO: FromJSON POSIXTime?
+
+instance Arbitrary DepositObservation where
+  arbitrary = undefined -- TODO: Arbitrary TxId and UTxO
+  shrink = undefined -- TODO: Arbitrary TxId and UTxO
+
 -- | Observe a deposit transaction by decoding the target head id, deposit
 -- deadline and deposited utxo in the datum.
 --

hydra-tx/src/Hydra/Tx/Fanout.hs

@@ -7,10 +7,7 @@ import Cardano.Api.UTxO qualified as UTxO
 import Hydra.Contract.Head qualified as Head
 import Hydra.Contract.HeadState qualified as Head
 import Hydra.Contract.MintAction (MintAction (..))
-import Hydra.Ledger.Cardano.Builder (
-  burnTokens,
-  unsafeBuildTransaction,
- )
+import Hydra.Ledger.Cardano.Builder (burnTokens, unsafeBuildTransaction)
 import Hydra.Tx.HeadId (HeadId)
 import Hydra.Tx.ScriptRegistry (ScriptRegistry (..))
 import Hydra.Tx.Utils (findStateToken, headTokensFromValue, mkHydraHeadV1TxName)
@@ -78,8 +75,16 @@ fanoutTx scriptRegistry utxo utxoToCommit utxoToDecommit (headInput, headOutput)
 
 -- * Observation
 
-data FanoutObservation = FanoutObservation {headId :: HeadId, fanoutUTxO :: UTxO}
+data FanoutObservation = FanoutObservation
+  { headId :: HeadId
+  , fanoutUTxO :: UTxO
+  }
   deriving stock (Eq, Show, Generic)
+  deriving anyclass (ToJSON, FromJSON)
+
+instance Arbitrary FanoutObservation where
+  arbitrary = undefined -- TODO: Arbitrary UTxO in hydra
+  shrink = undefined -- TODO: Arbitrary UTxO in hydra-tx
 
 -- | Identify a fanout tx by lookup up the input spending the Head output and
 -- decoding its redeemer.

hydra-tx/src/Hydra/Tx/Increment.hs

@@ -113,6 +113,11 @@ data IncrementObservation = IncrementObservation
   , depositTxId :: TxId
   }
   deriving stock (Show, Eq, Generic)
+  deriving anyclass (ToJSON, FromJSON)
+
+instance Arbitrary IncrementObservation where
+  arbitrary = undefined -- TODO: Arbitrary TxId
+  shrink = undefined -- TODO: Arbitrary TxId
 
 observeIncrementTx ::
   UTxO ->

hydra-tx/src/Hydra/Tx/Init.hs

@@ -93,6 +93,11 @@ data InitObservation = InitObservation
     participants :: [OnChainId]
   }
   deriving stock (Show, Eq, Generic)
+  deriving anyclass (ToJSON, FromJSON)
+
+instance Arbitrary InitObservation where
+  arbitrary = genericArbitrary
+  shrink = genericShrink
 
 data NotAnInitReason
   = NoHeadOutput