Complete minimal example, Multiple minor fixes

Author: errfrom

Makefile

@@ -1,8 +1,9 @@
-.PHONY: build, format, repl, docs, build-example, run-example
+.PHONY: build, format, repl, docs, build-example, run-example, docker-cleanup
 
 ps-sources := $(shell fd --no-ignore-parent -epurs)
 nix-sources := $(shell fd --no-ignore-parent -enix --exclude='spago*')
 purs-args := "--stash --censor-lib --censor-codes=ImplicitImport,ImplicitQualifiedImport,ImplicitQualifiedImportReExport,UserDefinedWarning"
+example-docker := example/minimal/docker/cluster/docker-compose.yaml
 
 system := $(shell uname -s)
 ifeq (${system},Linux)
@@ -36,5 +37,9 @@ build-example:
 	cd example/minimal && \
 		spago build --purs-args ${purs-args}
 
-run-example:
-	docker compose -f example/minimal/docker/cluster/docker-compose.yaml up --build --no-attach cardano-node
+run-example: docker-cleanup
+	docker compose -f ${example-docker} up --build --no-attach cardano-node
+
+docker-cleanup:
+	docker compose -f ${example-docker} rm --force --stop
+	docker volume rm -f cluster_hydra-persist-a cluster_hydra-persist-b

example/minimal/app/Main.purs

@@ -5,18 +5,23 @@ module HydraSdk.Example.Minimal.Main
 import Prelude
 
 import Cardano.AsCbor (encodeCbor)
+import Cardano.Types (Language(PlutusV2), Transaction)
 import Contract.CborBytes (cborBytesToHex)
 import Contract.Log (logError', logInfo', logTrace', logWarn')
-import Contract.Monad (ContractEnv, stopContractEnv)
+import Contract.Monad (Contract, ContractEnv, stopContractEnv)
+import Contract.ProtocolParameters (getProtocolParameters)
 import Contract.Transaction (submit)
 import Control.Monad.Error.Class (throwError)
 import Control.Monad.Reader (ask)
+import Ctl.Internal.Transaction (setScriptDataHash)
 import Data.Argonaut (stringifyWithIndent)
+import Data.Array (length) as Array
 import Data.Codec.Argonaut (encode) as CA
 import Data.Either (Either(Left, Right))
 import Data.Log.Level (LogLevel(Info, Error))
-import Data.Map (empty, fromFoldable) as Map
+import Data.Map (empty, filterKeys, fromFoldable) as Map
 import Data.Maybe (Maybe(Just, Nothing))
+import Data.Newtype (unwrap)
 import Data.Posix.Signal (Signal(SIGINT, SIGTERM))
 import Data.Traversable (traverse_)
 import Data.UInt (fromInt) as UInt
@@ -34,12 +39,14 @@ import HydraSdk.Example.Minimal.App
   , appLogger
   , initApp
   , readHeadStatus
+  , readUtxoSnapshot
   , runAppEff
   , runContractInApp
   )
 import HydraSdk.Example.Minimal.App (setHeadStatus, setUtxoSnapshot) as App
 import HydraSdk.Example.Minimal.Config (configFromArgv)
-import HydraSdk.Lib (log')
+import HydraSdk.Example.Minimal.Contract.L2 (placeArbitraryDatumL2)
+import HydraSdk.Lib (log', reSignTransaction, setAuxDataHash)
 import HydraSdk.NodeApi
   ( HydraNodeApiWebSocket
   , HydraTxRetryStrategy(RetryTxWithParams, DontRetryTx)
@@ -53,8 +60,19 @@ import HydraSdk.Types
       , HeadStatus_Initializing
       , HeadStatus_Open
       , HeadStatus_Closed
+      , HeadStatus_FanoutPossible
+      , HeadStatus_Final
+      )
+  , HydraNodeApi_InMessage
+      ( Greetings
+      , HeadIsInitializing
+      , HeadIsOpen
+      , SnapshotConfirmed
+      , HeadIsClosed
+      , HeadIsContested
+      , ReadyToFanout
+      , HeadIsFinalized
       )
-  , HydraNodeApi_InMessage(Greetings, HeadIsInitializing, HeadIsOpen)
   , HydraSnapshot(HydraSnapshot)
   , hydraSnapshotCodec
   , mkSimpleCommitRequest
@@ -161,7 +179,7 @@ messageHandler ws =
               throwError $ error $ "Commit request failed with error: "
                 <> show httpErr
             Right { cborHex: commitTx } -> do
-              txHash <- runContractInApp $ submit commitTx
+              txHash <- runContractInApp $ submit =<< fixCommitTx commitTx
               logInfo' $ "Submitted Commit transaction: " <> cborBytesToHex
                 (encodeCbor txHash)
         HeadIsOpen { headId, utxo } -> do
@@ -171,8 +189,52 @@ messageHandler ws =
             { snapshotNumber: zero
             , utxo
             }
+          tx <- runContractInApp $ placeArbitraryDatumL2 $ toUtxoMap utxo
+          liftEffect $ ws.submitTxL2 tx
+        SnapshotConfirmed { snapshot } -> do
+          setUtxoSnapshot snapshot
+          { config: { hydraNodeStartupParams: { peers } } } <- ask
+          when ((unwrap snapshot).snapshotNumber > Array.length peers) do
+            logInfo' "All Head participants must have advanced the L2 state. Closing Head..."
+            liftEffect ws.closeHead
+        HeadIsClosed { snapshotNumber } -> do
+          -- TODO: set head status implicitly
+          setHeadStatus HeadStatus_Closed
+          contestClosureIfNeeded ws snapshotNumber
+        HeadIsContested { snapshotNumber } ->
+          contestClosureIfNeeded ws snapshotNumber
+        ReadyToFanout _ -> do
+          setHeadStatus HeadStatus_FanoutPossible
+          liftEffect ws.fanout
+        HeadIsFinalized _ -> do
+          setHeadStatus HeadStatus_Final
+          -- TODO: output fanout tx hash
+          throwError $ error "SUCCESS: Head finalized, Funds transfered to L1 - Exiting..."
         _ -> pure unit
 
+fixCommitTx :: Transaction -> Contract Transaction
+fixCommitTx = reSignTransaction <=< fixScriptIntegrityHash <<< setAuxDataHash
+  where
+  fixScriptIntegrityHash :: Transaction -> Contract Transaction
+  fixScriptIntegrityHash tx = do
+    pparams <- unwrap <$> getProtocolParameters
+    let
+      costModels = Map.filterKeys (eq PlutusV2) pparams.costModels
+      ws = unwrap (unwrap tx).witnessSet
+    liftEffect $ setScriptDataHash costModels ws.redeemers ws.plutusData tx
+
+contestClosureIfNeeded :: HydraNodeApiWebSocket AppM -> Int -> AppM Unit
+contestClosureIfNeeded ws closeSnapshot = do
+  HydraSnapshot { snapshotNumber: localSnapshot } <- readUtxoSnapshot
+  when (closeSnapshot < localSnapshot) do
+    logInfo' $
+      "Detected attempt to close the Head with older snapshot. Close snapshot: "
+        <> show closeSnapshot
+        <> ", local snapshot: "
+        <> show localSnapshot
+        <> ". Contesting Head closure..."
+    liftEffect ws.challengeSnapshot
+
 setHeadStatus :: HydraHeadStatus -> AppM Unit
 setHeadStatus status = do
   App.setHeadStatus status

example/minimal/docker/cluster/config-a.json

@@ -13,7 +13,7 @@
     "nodeSocket": "node-ipc/node.socket",
     "pparams": "protocol-parameters.json",
     "hydraScriptsTxHash": "03f8deb122fbbd98af8eb58ef56feda37728ec957d39586b78198a0cf624412a",
-    "contestPeriodSec": 60,
+    "contestPeriodSec": 120,
     "peers": [
       {
         "hydraNodeAddress": "delegate-node-b:7002",
@@ -24,5 +24,6 @@
   },
   "blockfrostApiKey": null,
   "logLevel": "trace",
+  "ctlLogLevel": "warn",
   "commitOutRef": null
 }

example/minimal/docker/cluster/config-b.json

@@ -13,7 +13,7 @@
     "nodeSocket": "node-ipc/node.socket",
     "pparams": "protocol-parameters.json",
     "hydraScriptsTxHash": "03f8deb122fbbd98af8eb58ef56feda37728ec957d39586b78198a0cf624412a",
-    "contestPeriodSec": 60,
+    "contestPeriodSec": 120,
     "peers": [
       {
         "hydraNodeAddress": "delegate-node-a:7000",
@@ -23,6 +23,7 @@
     ]
   },
   "blockfrostApiKey": null,
-  "logLevel": "trace",
+  "logLevel": "info",
+  "ctlLogLevel": "warn",
   "commitOutRef": null
 }

example/minimal/docker/cluster/docker-compose.yaml

@@ -19,47 +19,47 @@ services:
 
   delegate-node-a:
     build:
-      context: "../.."
-      dockerfile: "docker/node/Dockerfile"
+      context: "../../../.."
+      dockerfile: "example/minimal/docker/node/Dockerfile"
     depends_on:
       cardano-node:
         condition: service_healthy
     command: "config.json"
     volumes:
       - type: "bind"
         source: "./config-a.json"
-        target: "/app/config.json"
+        target: "/app/example/minimal/config.json"
       - type: "bind"
         source: "keys"
-        target: "/app/keys"
+        target: "/app/example/minimal/keys"
       - type: "volume"
         source: "node-ipc"
-        target: "/app/node-ipc"
+        target: "/app/example/minimal/node-ipc"
       - type: "volume"
         source: "hydra-persist-a"
-        target: "/app/hydra-persist"
+        target: "/app/example/minimal/hydra-persist"
 
   delegate-node-b:
     build:
-      context: "../.."
-      dockerfile: "docker/node/Dockerfile"
+      context: "../../../.."
+      dockerfile: "example/minimal/docker/node/Dockerfile"
     depends_on:
       cardano-node:
         condition: service_healthy
     command: "config.json"
     volumes:
       - type: "bind"
         source: "./config-b.json"
-        target: "/app/config.json"
+        target: "/app/example/minimal/config.json"
       - type: "bind"
         source: "keys"
-        target: "/app/keys"
+        target: "/app/example/minimal/keys"
       - type: "volume"
         source: "node-ipc"
-        target: "/app/node-ipc"
+        target: "/app/example/minimal/node-ipc"
       - type: "volume"
         source: "hydra-persist-b"
-        target: "/app/hydra-persist"
+        target: "/app/example/minimal/hydra-persist"
 
 volumes:
   hydra-persist-a:

example/minimal/docker/node/Dockerfile

@@ -3,17 +3,22 @@
 FROM node:18
 WORKDIR /app
 
-COPY package.json package-lock.json .
+COPY src src
+COPY spago.dhall spago.dhall
+
+WORKDIR example/minimal
+
+COPY example/minimal/package.json example/minimal/package-lock.json .
 RUN npm clean-install --production=false --loglevel=verbose
 RUN npm install purescript@0.15.8
 RUN npm install spago@0.21.0
 
-COPY packages.dhall spago.dhall .
+COPY example/minimal/packages.dhall example/minimal/spago.dhall .
 RUN npx --no-install spago install
 
-COPY src src
-COPY app app
-COPY protocol-parameters.json .
+COPY example/minimal/src src
+COPY example/minimal/app app
+COPY example/minimal/protocol-parameters.json .
 RUN npx --no-install spago build
 
 RUN curl -LO https://github.com/input-output-hk/hydra/releases/download/0.19.0/hydra-x86_64-linux-0.19.0.zip

example/minimal/packages.dhall

@@ -3,7 +3,8 @@ let upstream =
         sha256:3e9fbc9ba03e9a1fcfd895f65e2d50ee2f5e86c4cd273f3d5c841b655a0e1bda
 
 let additions =
-      { aeson =
+      { hydra-sdk = ../../spago.dhall as Location
+      , aeson =
         { dependencies =
           [ "aff"
           , "argonaut"
@@ -601,59 +602,6 @@ let additions =
         , repo = "https://github.com/passy/purescript-errors.git"
         , version = "670485beb1e026f77d52ca58ce10c145d96c11ba"
         }
-      , hydra-sdk =
-        { dependencies =
-          [ "aff"
-          , "affjax"
-          , "argonaut"
-          , "arrays"
-          , "avar"
-          , "bifunctors"
-          , "bytearrays"
-          , "cardano-transaction-lib"
-          , "cardano-types"
-          , "codec-argonaut"
-          , "control"
-          , "datetime"
-          , "effect"
-          , "either"
-          , "errors"
-          , "exceptions"
-          , "foldable-traversable"
-          , "foreign-object"
-          , "formatters"
-          , "http-methods"
-          , "integers"
-          , "js-bigints"
-          , "js-date"
-          , "maybe"
-          , "monad-logger"
-          , "newtype"
-          , "node-buffer"
-          , "node-child-process"
-          , "node-path"
-          , "node-streams"
-          , "optparse"
-          , "ordered-collections"
-          , "parsing"
-          , "partial"
-          , "plutus-types"
-          , "prelude"
-          , "profunctor"
-          , "quickcheck"
-          , "safely"
-          , "strings"
-          , "tailrec"
-          , "transformers"
-          , "tuples"
-          , "uint"
-          , "uri"
-          , "uuid"
-          , "variant"
-          ]
-        , repo = "https://github.com/mlabs-haskell/purescript-hydra-sdk"
-        , version = "fde44498050dda20af5541ce7b9d6970be541a86"
-        }
       }
 
-in  (upstream // additions)
+in (upstream // additions)

example/minimal/spago.dhall

@@ -22,6 +22,7 @@
   , "posix-types"
   , "prelude"
   , "profunctor-lenses"
+  , "quickcheck"
   , "refs"
   , "transformers"
   , "tuples"

example/minimal/src/App.purs

@@ -5,6 +5,7 @@ module HydraSdk.Example.Minimal.App
   , appLogger
   , initApp
   , readHeadStatus
+  , readUtxoSnapshot
   , runApp
   , runAppEff
   , runContractInApp
@@ -14,7 +15,7 @@ module HydraSdk.Example.Minimal.App
 
 import Prelude
 
-import Cardano.Types (TransactionInput, TransactionOutput, UtxoMap)
+import Cardano.Types (TransactionInput, TransactionOutput)
 import Contract.Config
   ( ContractParams
   , PrivatePaymentKeySource(PrivatePaymentKeyFile)
@@ -37,7 +38,6 @@ import Control.Monad.Reader (ReaderT, ask, asks, runReaderT)
 import Ctl.Internal.ServerConfig (blockfrostPublicSanchonetServerConfig)
 import Data.Log.Formatter.Pretty (prettyFormatter)
 import Data.Log.Message (Message)
-import Data.Map (empty) as Map
 import Data.Maybe (Maybe(Just, Nothing), maybe)
 import Data.Tuple (Tuple(Tuple))
 import Effect (Effect)
@@ -100,6 +100,9 @@ readHeadStatus = (liftAff <<< AVar.read) =<< asks _.headStatus
 setHeadStatus :: HydraHeadStatus -> AppM Unit
 setHeadStatus status = (void <<< AVar.modify (const (pure status))) =<< asks _.headStatus
 
+readUtxoSnapshot :: AppM HydraSnapshot
+readUtxoSnapshot = (liftAff <<< AVar.read) =<< asks _.utxoSnapshot
+
 setUtxoSnapshot :: HydraSnapshot -> AppM Unit
 setUtxoSnapshot snapshot =
   (void <<< AVar.modify (const (pure snapshot)))
@@ -154,7 +157,7 @@ initApp config@{ hydraNodeStartupParams: { network, cardanoSigningKey }, commitO
   contractParams backendParams =
     { backendParams
     , networkId: networkToNetworkId network
-    , logLevel: config.logLevel
+    , logLevel: config.ctlLogLevel
     , walletSpec: Just $ UseKeys (PrivatePaymentKeyFile cardanoSigningKey) Nothing Nothing
     , customLogger: Nothing
     , suppressLogs: false