Skip to content

Commit 1395f40

Browse files
author
Aleksandr Penskoi
committed
Update README.md (pabConfig)
1 parent 778cf9a commit 1395f40

File tree

2 files changed

+9
-22
lines changed

2 files changed

+9
-22
lines changed

README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -86,24 +86,24 @@ BotPlutusInterface> :m Prelude
8686
...
8787
Prelude> :l BotPlutusInterface.Config
8888
...
89-
Prelude BotPlutusInterface.Config> putStrLn docPABConfig
89+
Prelude BotPlutusInterface.Config> putStrLn docPABConfig
9090
Top-level configuration file fields:
9191
cliLocation: `local` or destination text
9292
calling the cli through ssh when set to destination (default:
9393
local)
9494
chainIndexUrl: url text
9595
(default: "http://localhost:9083")
96-
networkId: `mainnet` or 32-bit unsigned integral number
96+
networkId: case insensitive `mainnet` atom or 32-bit unsigned integral number
9797
(default: 42)
98-
slotConfig: SlotConfig configuration
99-
(see default in example)
10098
scriptFileDir: path text
10199
Directory name of the script and data files (default:
102100
"./result-scripts")
103101
signingKeyFileDir: path text
104102
Directory name of the signing key files (default: "./signing-keys")
105103
txFileDir: path text
106104
Directory name of the transaction files (default: "./txs")
105+
metadataDir: path text
106+
Directory name of metadata files (default: "/metadata")
107107
protocolParamsFile: filepath text
108108
Protocol params file location relative to the cardano-cli working
109109
directory (needed for the cli) in JSON format. (default:
@@ -115,30 +115,17 @@ Top-level configuration file fields:
115115
(default: info)
116116
ownPubKeyHash: PubKeyHash text
117117
(default: "")
118-
ownStakePubKeyHash: `nothing` or StakePubKeyHash text
118+
ownStakePubKeyHash: case insensitive `nothing` atom or StakePubKeyHash text
119119
(default: nothing)
120120
tipPollingInterval: non-negative integral number
121121
(default: 10000000)
122-
forceBudget: `nothing` or ExecutionUnits configuration
123-
Forced budget for scripts, as optional (CPU Steps, Memory Units)
124-
(default: nothing)
125122
port: port non-negative integral number
126123
(default: 9080)
127124
enableTxEndpoint: `true` or `false`
128125
(default: false)
129-
130-
ExecutionUnits configuration
131-
steps: REQUIRED non-negative integral number
132-
This corresponds roughly to the time to execute a script.
133-
memory: REQUIRED non-negative integral number
134-
This corresponds roughly to the peak memory used during script
135-
execution.
136-
137-
SlotConfig configuration
138-
length: REQUIRED integral number
139-
Length (number of milliseconds) of one slot
140-
zeroTime: REQUIRED integral number
141-
Beginning of slot 0 (in milliseconds)
126+
collectStats: `true` or `false`
127+
Save some stats during contract run (only transactions execution
128+
budgets supported atm) (default: false)
142129
```
143130

144131
To run the fake PAB, you need to prepare a few more things:

src/BotPlutusInterface/Config.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ pabConfigSpec = sectionsSpec "PABConfig" $ do
179179
"Directory name of the transaction files"
180180

181181
pcMetadataDir <-
182-
sectionWithDefault (pcMetadataDir def) "metadataDir" "Directory name of metadata files"
182+
sectionWithDefault' (pcMetadataDir def) "metadataDir" pathSpec "Directory name of metadata files"
183183

184184
pcProtocolParamsFile <-
185185
sectionWithDefault'

0 commit comments

Comments
 (0)