Using a config file

.github/workflows/integrate.yaml

@@ -3,17 +3,17 @@ on:
     paths:
       - '**.hs'
       - '**.nix'
-      - 'nix/sources.json'
-      - 'mlabs-pab.cabal'
+      - '*.cabal'
+      - '.gitmodules'
     branches:
       - master
       - staging
   pull_request:
     paths:
       - '**.hs'
       - '**.nix'
-      - 'nix/sources.json'
-      - 'mlabs-pab.cabal'
+      - '*.cabal'
+      - '.gitmodules'
 jobs:
   check-formatting:
     runs-on: ubuntu-latest
@@ -50,10 +50,12 @@ jobs:
 
       - run: ~/.local/bin/hlint $(git ls-tree -r HEAD --full-tree --name-only | grep -E '.*\.hs')
         name: Lint
+
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+        submodules: true
       - uses: cachix/install-nix-action@v13
         name: Set up nix and IOHK cache
         with:

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "plutus-config"]
+	path = plutus-config
+	url = [email protected]:mlabs-haskell/plutus-config.git

README.md

@@ -62,49 +62,76 @@ instance HasDefinitions MyContracts where
         MyContract.contract params
 ```
 
-3. Write your main entrypoint for the application, with the preferred configurations
+3. Write your main entrypoint for the application and the configuration
 
 ```haskell
-import BotPlutusInterface.Types (CLILocation (Local), LogLevel (Debug), PABConfig (..))
-import Cardano.Api (NetworkId (Testnet), NetworkMagic (..))
-import Data.Aeson qualified as JSON
-import Data.ByteString.Lazy qualified as LazyByteString
-import Data.Default (def)
-import Servant.Client.Core (BaseUrl (BaseUrl), Scheme (Http))
+import BotPlutusInterface qualified
+import BotPlutusInterface.Config qualified as BotPlutusInterface
+import Prelude
 
 main :: IO ()
 main = do
-  protocolParams <- JSON.decode <$> LazyByteString.readFile "protocol.json"
-  let pabConf =
-        PABConfig
-          { -- Calling the cli locally or through an ssh connection
-            pcCliLocation = Local
-          , pcNetwork = Testnet (NetworkMagic 42)
-          , pcChainIndexUrl = BaseUrl Http "localhost" 9083 ""
-          , pcPort = 9080
-          , pcProtocolParams = protocolParams
-          , pcTipPollingInterval = 10_000_000
-          , -- | Slot configuration of the network, the default value can be used for the mainnet
-            pcSlotConfig = def
-          , pcOwnPubKeyHash = "0f45aaf1b2959db6e5ff94dbb1f823bf257680c3c723ac2d49f97546"
-          , -- Directory name of the script and data files
-            pcScriptFileDir = "./scripts"
-          , -- Directory for the signing key file(s)
-            pcSigningKeyFileDir = "./signing-keys"
-          , -- Directory where the encoded transaction files will be saved
-            pcTxFileDir = "./txs"
-          , -- Dry run mode will build the tx, but skip the submit step
-            pcDryRun = False
-          , pcLogLevel = Debug
-          , -- | Forced budget for scripts, as optional (CPU Steps, Memory Units)
-            pcForceBudget = Nothing
-          , -- Protocol params file location relative to the cardano-cli working directory (needed for the cli)
-          , pcProtocolParamsFile = "./protocol.json"
-          , pcEnableTxEndpoint = True
-          }
+  pabConf <-
+    either error id
+      <$> BotPlutusInterface.loadPABConfig "config/pabConfig.value"
   BotPlutusInterface.runPAB @MyContracts pabConf
 ```
 
+Configuration format (example: <examples/plutus-game/config/pabConfig.value>): 
+
+``` console
+Top-level configuration file fields:
+    cliLocation: `local` or destination text
+        calling the cli through ssh when set to destination (default:
+        local)
+    chainIndexUrl: url text
+         (default: "http://localhost:9083")
+    networkId: `mainnet` or 32-bit unsigned integral number
+         (default: 42)
+    slotConfig: SlotConfig configuration
+         (see default in example)
+    scriptFileDir: path text
+        Directory name of the script and data files (default:
+        "./result-scripts")
+    signingKeyFileDir: path text
+        Directory name of the signing key files (default: "./signing-keys")
+    txFileDir: path text
+        Directory name of the transaction files (default: "./txs")
+    protocolParamsFile: filepath text
+        Protocol params file location relative to the cardano-cli working
+        directory (needed for the cli) in JSON format.  (default:
+        "./protocol.json")
+    dryRun: `true` or `false`
+        Dry run mode will build the tx, but skip the submit step (default:
+        true)
+    logLevel: `error` or `warn` or `notice` or `info` or `debug`
+         (default: info)
+    ownPubKeyHash: PubKeyHash text
+         (default: "")
+    tipPollingInterval: non-negative integral number
+         (default: 10000000)
+    forceBudget: `nothing` or ExecutionUnits configuration
+        Forced budget for scripts, as optional (CPU Steps, Memory Units)
+        (default: nothing)
+    port: port non-negative integral number
+         (default: 9080)
+    enableTxEndpoint: `true` or `false`
+         (default: false)
+
+ExecutionUnits configuration
+    steps: REQUIRED non-negative integral number
+        This corresponds roughly to the time to execute a script.
+    memory: REQUIRED non-negative integral number
+        This corresponds roughly to the peak memory used during script
+        execution.
+
+SlotConfig configuration
+    length: REQUIRED integral number
+        Length (number of milliseconds) of one slot
+    zeroTime: REQUIRED integral number
+        Beginning of slot 0 (in milliseconds)
+```
+
 To run the fake PAB, you need to prepare a few more things:
 
 4. Save the protocol params file to the root folder of your project using the cardano-cli
@@ -128,6 +155,7 @@ The fake PAB consists of the following modules:
 
 - **BotPlutusInterface** main entry point
 - **BotPlutusInterface.Server** Servant server, handling http endpoint calls and websockets
+- **BotPlutusInterface.Config** load/save PAB configuration file
 - **BotPlutusInterface.Contract** handling contract effects by creating the necessary files and calling cardano-cli commands (a few effects are mocked)
 - **BotPlutusInterface.Balance** doing some preparations so the cli can process the rest (non-ada asset balancing, addig tx inputs, adding minimum lovelaces, add signatories)
 - **BotPlutusInterface.CardanoCLI** wrappers for cardano-cli commands

bot-plutus-interface.cabal

@@ -25,9 +25,9 @@ source-repository head
 common common-lang
   ghc-options:
     -Wall -Wcompat -Wincomplete-record-updates
-    -Wincomplete-uni-patterns -Wredundant-constraints -Werror
-    -fobject-code -fno-ignore-interface-pragmas
-    -fno-omit-interface-pragmas -fplugin=RecordDotPreprocessor
+    -Wincomplete-uni-patterns -Wredundant-constraints -fobject-code
+    -Werror -fno-ignore-interface-pragmas -fno-omit-interface-pragmas
+    -fplugin=RecordDotPreprocessor
 
   build-depends:
     , base                     ^>=4.14
@@ -76,22 +76,26 @@ library
   import:          common-lang
   exposed-modules:
     BotPlutusInterface
+    BotPlutusInterface.Balance
     BotPlutusInterface.CardanoCLI
     BotPlutusInterface.ChainIndex
+    BotPlutusInterface.Config
     BotPlutusInterface.Contract
     BotPlutusInterface.Effects
     BotPlutusInterface.Files
-    BotPlutusInterface.Balance
+    BotPlutusInterface.Server
     BotPlutusInterface.Types
     BotPlutusInterface.UtxoParser
-    BotPlutusInterface.Server
+
   build-depends:
     , aeson                      ^>=1.5.0.0
     , attoparsec                 >=0.13.2.2
     , bytestring                 ^>=0.10.12.0
     , cardano-api
     , cardano-crypto
     , cardano-ledger-alonzo
+    , config-schema
+    , config-value
     , containers
     , data-default
     , data-default-class
@@ -109,6 +113,7 @@ library
     , playground-common
     , plutus-chain-index
     , plutus-chain-index-core
+    , plutus-config
     , plutus-contract
     , plutus-core
     , plutus-ledger
@@ -117,17 +122,21 @@ library
     , plutus-pab
     , plutus-tx
     , plutus-tx-plugin
+    , pretty
     , process
     , QuickCheck
+    , regex-compat
     , row-types
     , serialise
     , servant
     , servant-client
+    , servant-client-core
     , servant-server
     , servant-websockets
     , split
     , stm
     , text                       ^>=1.2.4.0
+    , tostring
     , transformers
     , transformers-either
     , unordered-containers
@@ -144,10 +153,11 @@ test-suite bot-plutus-interface-test
   main-is:        Spec.hs
   ghc-options:    -fplugin-opt PlutusTx.Plugin:defer-errors
   other-modules:
-    Spec.BotPlutusInterface.Contract
     Spec.BotPlutusInterface.Balance
-    Spec.BotPlutusInterface.UtxoParser
+    Spec.BotPlutusInterface.Config
+    Spec.BotPlutusInterface.Contract
     Spec.BotPlutusInterface.Server
+    Spec.BotPlutusInterface.UtxoParser
     Spec.MockContract
 
   build-depends:
@@ -159,6 +169,8 @@ test-suite bot-plutus-interface-test
     , bytestring                 ^>=0.10.12.0
     , cardano-api
     , cardano-crypto-class
+    , config-schema
+    , config-value
     , containers
     , data-default
     , data-default-class
@@ -176,6 +188,7 @@ test-suite bot-plutus-interface-test
     , playground-common
     , plutus-chain-index
     , plutus-chain-index-core
+    , plutus-config
     , plutus-contract
     , plutus-core
     , plutus-ledger
@@ -197,8 +210,8 @@ test-suite bot-plutus-interface-test
     , tasty-quickcheck
     , temporary
     , text                       ^>=1.2.4.0
-    , uuid
     , utf8-string
+    , uuid
     , warp
 
   hs-source-dirs: test

cabal.project

@@ -1,6 +1,7 @@
-index-state: 2022-01-22T00:00:00Z
+index-state: 2022-03-10T00:00:00Z
 
-packages: ./.
+packages: ./bot-plutus-interface.cabal
+          ./plutus-config/plutus-config.cabal
           ./examples/plutus-game/plutus-game.cabal
           ./examples/plutus-transfer/plutus-transfer.cabal
           ./examples/plutus-nft/plutus-nft.cabal

examples/plutus-game/app/Main.hs

@@ -3,30 +3,22 @@
 module Main (main) where
 
 import BotPlutusInterface qualified
+import BotPlutusInterface.Config qualified as BotPlutusInterface
 import BotPlutusInterface.Types (
-  CLILocation (Local),
   HasDefinitions (..),
-  LogLevel (Debug),
-  PABConfig (..),
   SomeBuiltin (..),
   endpointsToSchemas,
  )
-import Cardano.Api (NetworkId (Testnet), NetworkMagic (..))
 import Cardano.PlutusExample.Game (
   GameSchema,
   GuessParams,
   LockParams,
   guess,
   lock,
  )
-import Data.Aeson qualified as JSON
 import Data.Aeson.TH (defaultOptions, deriveJSON)
-import Data.ByteString.Lazy qualified as LazyByteString
-import Data.Default (def)
-import Data.Maybe (fromMaybe)
 import Playground.Types (FunctionSchema)
 import Schema (FormSchema)
-import Servant.Client.Core (BaseUrl (BaseUrl), Scheme (Http))
 import Prelude
 
 instance HasDefinitions GameContracts where
@@ -48,26 +40,7 @@ $(deriveJSON defaultOptions ''GameContracts)
 
 main :: IO ()
 main = do
-  protocolParams <-
-    fromMaybe (error "protocol.json file not found") . JSON.decode
-      <$> LazyByteString.readFile "protocol.json"
-  let pabConf =
-        PABConfig
-          { pcCliLocation = Local
-          , pcNetwork = Testnet (NetworkMagic 1097911063)
-          , pcChainIndexUrl = BaseUrl Http "localhost" 9083 ""
-          , pcPort = 9080
-          , pcProtocolParams = protocolParams
-          , pcTipPollingInterval = 10_000_000
-          , pcSlotConfig = def
-          , pcOwnPubKeyHash = "0f45aaf1b2959db6e5ff94dbb1f823bf257680c3c723ac2d49f97546"
-          , pcScriptFileDir = "./scripts"
-          , pcSigningKeyFileDir = "./signing-keys"
-          , pcTxFileDir = "./txs"
-          , pcDryRun = True
-          , pcLogLevel = Debug
-          , pcProtocolParamsFile = "./protocol.json"
-          , pcForceBudget = Just (1000, 1000)
-          , pcEnableTxEndpoint = True
-          }
+  pabConf <-
+    either error id
+      <$> BotPlutusInterface.loadPABConfig "config/pabConfig.value"
   BotPlutusInterface.runPAB @GameContracts pabConf

examples/plutus-game/config/pabConfig.value

@@ -0,0 +1,26 @@
+-- Calling the cli locally or through an ssh connection
+cliLocation:   local
+chainIndexUrl: "http://localhost:9083"
+networkId:     1097911063
+-- Slot configuration of the network, the default value can be used for the mainnet
+slotConfig:
+  length:   1000
+  zeroTime: 1596059091000
+-- Directory name of the script and data files
+scriptFileDir:      "./scripts"
+-- Directory for the signing key file(s)
+signingKeyFileDir:  "./signing-keys"
+-- Directory where the encoded transaction files will be saved
+txFileDir:          "./txs"
+-- Protocol params file location relative to the cardano-cli working directory (needed for the cli)
+protocolParamsFile: "./config/protocol.json"
+-- Dry run mode will build the tx, but skip the submit step
+dryRun:             true
+logLevel:           debug
+ownPubKeyHash:      "0f45aaf1b2959db6e5ff94dbb1f823bf257680c3c723ac2d49f97546"
+tipPollingInterval: 10000000
+forceBudget:
+  steps:            1000
+  memory:           1000
+port:               9080
+enableTxEndpoint:   true