Fix and update ledger-state benchmark instructions

Author: neilmayhew

libs/ledger-state/README.md

@@ -9,64 +9,97 @@ the memory overhead.
 In order to be able to use the tool we need to get ahold of current ledger
 state. For this we need to start a cardano node and wait for it to sync.
 
-```haskell
-$ export CARDANO_DATA="${HOME}/iohk/chain/mainnet"
-$ mkdir -p "${CARDANO_DATA}"/db
+```shell
+$ export CARDANO_DATA=${HOME}/iohk/chain/mainnet
+$ mkdir -p "${CARDANO_DATA}/db"
 $ cd "${CARDANO_DATA}"
 ```
 
-Download all the [mainnet related config files](https://developers.cardano.org/docs/get-started/running-cardano/#mainnet--production):
+Download all the [mainnet related config files](https://developers.cardano.org/docs/get-started/cardano-node/running-cardano/#configuration-files):
+
+```shell
+curl -O -J https://book.play.dev.cardano.org/environments/mainnet/config.json
+curl -O -J https://book.play.dev.cardano.org/environments/mainnet/db-sync-config.json
+curl -O -J https://book.play.dev.cardano.org/environments/mainnet/submit-api-config.json
+curl -O -J https://book.play.dev.cardano.org/environments/mainnet/topology.json
+curl -O -J https://book.play.dev.cardano.org/environments/mainnet/byron-genesis.json
+curl -O -J https://book.play.dev.cardano.org/environments/mainnet/shelley-genesis.json
+curl -O -J https://book.play.dev.cardano.org/environments/mainnet/alonzo-genesis.json
+curl -O -J https://book.play.dev.cardano.org/environments/mainnet/conway-genesis.json
 ```
-curl -O -J https://hydra.iohk.io/build/7370192/download/1/mainnet-config.json
-curl -O -J https://hydra.iohk.io/build/7370192/download/1/mainnet-byron-genesis.json
-curl -O -J https://hydra.iohk.io/build/7370192/download/1/mainnet-shelley-genesis.json
-curl -O -J https://hydra.iohk.io/build/7370192/download/1/mainnet-alonzo-genesis.json
-curl -O -J https://hydra.iohk.io/build/7370192/download/1/mainnet-topology.json
+
+Download or build copies of `cardano-node` and `cardano-cli`. A convenient way of doing this is to download the assets from one of the `cardano-node` [releases](https://github.com/IntersectMBO/cardano-node/releases) on GitHub. The Linux executables are statically linked, so will run on any system.
+
 ```
 
 Start the node and wait for it to fully sync
 
-```
+```shell
 $ export CARDANO_NODE_SOCKET_PATH="${CARDANO_DATA}/db/node.socket"
-$ cardano-node run
-  --topology "${CARDANO_DATA}/mainnet-topology.json" \
-  --database-path "${CARDANO_DATA}/db" \
-  --socket-path "${CARDANO_NODE_SOCKET_PATH}" \
-  --host-addr 127.0.0.1 \
-  --port 3001 \
-  --config "${CARDANO_DATA}/mainnet-config.json" &
+$ cardano-node run \
+    --topology "${CARDANO_DATA}/topology.json" \
+    --config "${CARDANO_DATA}/config.json" \
+    --database-path "${CARDANO_DATA}/db" \
+    --socket-path "${CARDANO_NODE_SOCKET_PATH}" \
+    --host-addr 0.0.0.0 \
+    --port 3001 &
 ```
 
-Dump the ledger state and focus back onto the node:
+Dump the ledger state:
+
+```shell
+$ cardano-cli query ledger-state --mainnet \
+    --socket-path "${CARDANO_NODE_SOCKET_PATH}" \
+    --out-file "${CARDANO_DATA}/new-epoch-state.bin"
+```
+
+Bring the node back into the foreground and use Ctrl-C to stop it:
 
 ```shell
-$ cardano-cli query ledger-state --mainnet --out-file "${CARDANO_DATA}/ledger-state.bin"
 $ fg
+$ ^C
 ```
-Hit Ctr-C to stop the node
 
-## Populate sqlite db
+## Populate sqlite db from `NewEpochState` file
 
 ```shell
-$ cabal run -- ledger-state:ledger-state --new-epoch-state-cbor="${CARDANO_DATA}/ledger-state.bin" --sqlite-db="${CARDANO_DATA}/ledger-state.sqlite"
+$ cabal run -- ledger-state:ledger-state \
+    --new-epoch-state-cbor="${CARDANO_DATA}/new-epoch-state.bin" \
+    --sqlite-db="${CARDANO_DATA}/epoch-state.sqlite"
 ```
 
-## Create NewEpochState from sqlite db
+## Create `EpochState` file from sqlite db
 
 ```shell
-$ cabal run -- ledger-state:ledger-state --epoch-state-cbor="${CARDANO_DATA}/ledger-state.bin" --sqlite-db="${CARDANO_DATA}/ledger-state.sqlite"
+$ cabal run -- ledger-state:ledger-state \
+    --epoch-state-cbor="${CARDANO_DATA}/epoch-state.bin" \
+    --sqlite-db="${CARDANO_DATA}/epoch-state.sqlite"
 ```
 
 ## Running benchmarks
 
 ### Memory
 
 ```shell
-$ cabal bench ledger-state:memory --benchmark-options="--new-epoch-state-cbor=\"${CARDANO_DATA}/ledger-state.bin\" --new-epoch-state-sqlite=\"${CARDANO_DATA}/ledger-state.sqlite\""
+$ cabal build ledger-state:memory
+$ cabal bench ledger-state:memory -v0 \
+    --benchmark-option="--new-epoch-state-cbor=${CARDANO_DATA}/new-epoch-state.bin" \
+    --benchmark-option="--epoch-state-cbor=${CARDANO_DATA}/epoch-state.bin" \
+    --benchmark-option="--sqlite-db=${CARDANO_DATA}/epoch-state.sqlite" |
+  tee ledger-state:memory.txt
 ```
 ### Performance
 
 Performance benchmarks need an actual mainnet ledger state and genesis config
 file to run properly. It is not possible to add extra arguments to criterion cli
 menu, therefore paths to those files must be supplied as environment variables.
 
+```shell
+$ export BENCH_GENESIS_PATH=${CARDANO_DATA}/shelley-genesis.json
+$ export BENCH_LEDGER_STATE_PATH=${CARDANO_DATA}/new-epoch-state.bin
+$ cabal bench ledger-state:performance --benchmark-option=--csv=ledger-state:performance.csv
+```
+
+The csv file will be saved in the `libs/ledger-state` directory.
+
+Since the `performance` benchmark uses only `new-epoch-state.bin` you don't need to run the `sqlite.db` steps above if you want to run only the `performance` benchmark.

libs/ledger-state/app/Main.hs

@@ -14,7 +14,7 @@ import System.IO
 -- | Insight into options:
 --
 -- * `optsNewEpochStateBinaryFile` is for reading a previously serialized
--- * `NewEpochState` produced by cadano-cli` and is used to populate sqlite
+-- * `NewEpochState` produced by cardano-cli` and is used to populate sqlite
 -- * database
 --
 -- * `optsEpochStateBinaryFile` is used for grabbing data from sqlite,
@@ -26,7 +26,7 @@ data Opts = Opts
   -- load into sqlite database
   , optsEpochStateBinaryFile :: Maybe FilePath
   -- ^ Path to the CBOR encoded EpochState data type, which will have data
-  -- from sqlite database written into.
+  -- from sqlite database written into it.
   , optsSqliteDbFile :: Maybe FilePath
   -- ^ Path to Sqlite database file.
   }
@@ -62,7 +62,7 @@ optsParser =
           <> value Nothing
           <> help
             ( "Path to Sqlite database file. When supplied then new-epoch-state "
-                <> "will be loaded into the databse. Requires --new-epoch-state-cbor"
+                <> "will be loaded into the database. Requires --new-epoch-state-cbor"
             )
       )
 
@@ -92,7 +92,7 @@ main = do
       epochState <- loadEpochState dbFp
       putStrLn "Loaded EpochState from the database"
       writeEpochState binFp epochState
-      putStrLn $ "Written EpochState into: " ++ dbFpStr
+      putStrLn $ "Written EpochState into: " ++ binFp
 
 -- forM_ (optsSqliteDbFile opts) $ \dbFpStr -> do
 --   let dbFp = T.pack dbFpStr