Skip to content

Commit 8d56cce

Browse files
authored
Add some details on the expected file formats (#1662)
This tiny PR documents in a bit more details how the arguments to `db-synthesizer` program look like. In particular, it wasn't obvious what the "bulk credentials" structure was and I got it only after looking at the example. HTH.
2 parents 6002345 + 6ff2c09 commit 8d56cce

File tree

1 file changed

+5
-4
lines changed
  • ouroboros-consensus-cardano/app/DBSynthesizer

1 file changed

+5
-4
lines changed

ouroboros-consensus-cardano/app/DBSynthesizer/Parsers.hs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ parseOperationalCertFilePath =
7171
strOption
7272
( long "shelley-operational-certificate"
7373
<> metavar "FILE"
74-
<> help "Path to the delegation certificate"
74+
<> help "Path to the delegation certificate (in JSON TextEnvelope format)"
7575
<> completer (bashCompleter "file")
7676
)
7777

@@ -80,7 +80,7 @@ parseKesKeyFilePath =
8080
strOption
8181
( long "shelley-kes-key"
8282
<> metavar "FILE"
83-
<> help "Path to the KES signing key"
83+
<> help "Path to the KES signing key (in JSON TextEnvelope format)"
8484
<> completer (bashCompleter "file")
8585
)
8686

@@ -89,7 +89,7 @@ parseVrfKeyFilePath =
8989
strOption
9090
( long "shelley-vrf-key"
9191
<> metavar "FILE"
92-
<> help "Path to the VRF signing key"
92+
<> help "Path to the VRF signing key (in JSON TextEnvelope format)"
9393
<> completer (bashCompleter "file")
9494
)
9595

@@ -98,7 +98,8 @@ parseBulkFilePath =
9898
strOption
9999
( long "bulk-credentials-file"
100100
<> metavar "FILE"
101-
<> help "Path to the bulk credentials file"
101+
<> help
102+
"Path to the bulk credentials file (a JSON file containing an array of arrays containing 3 TextEnvelope objects for the opcert, VRF Signing key, KES signing key)"
102103
<> completer (bashCompleter "file")
103104
)
104105

0 commit comments

Comments
 (0)