Merge pull request #99 from blinklabs-io/fix/readme-and-pre-conway

fix: update README and preprod and preview network configs

Author: wolf31o2

README.md

@@ -117,14 +117,18 @@ storage and IPC (interprocess communication) so they live beyond the lifetime
 of the container. To mount local host paths instead of using Docker's built in
 volumes, use the local path on the left side of a `-v` argument.
 
-An example of a more advanced configuration for mainnet:
+An example of a more advanced configuration, running a block producer for
+mainnet:
 
 ```bash
 docker run --detach \
   --name cardano-node \
   --restart unless-stopped \
-  -e CARDANO_CONFIG=/opt/cardano/config/mainnet/p2p-config.json \
-  -e CARDANO_TOPOLOGY=/opt/cardano/config/mainnet/p2p-topology.json \
+  -e CARDANO_BLOCK_PRODUCER=true \
+  -e CARDANO_SHELLEY_KES_KEY=/opt/cardano/config/keys/kes.skey \
+  -e CARDANO_SHELLEY_OPERATIONAL_CERTIFICATE=/opt/cardano/config/keys/node.cert \
+  -e CARDANO_SHELLEY_VRF_KEY=/opt/cardano/config/keys/vrf.skey \
+  -v /src/cardano/node-keys:/opt/cardano/config/keys \
   -v /srv/cardano/node-db:/opt/cardano/data \
   -v /srv/cardano/node-ipc:/opt/cardano/ipc \
   -p 3001:3001 \
@@ -134,14 +138,14 @@ docker run --detach \
 
 The above uses Docker's built in supervisor to restart a container which fails
 for any reason. This will also cause the container to automatically restart
-after a host reboot, so long as Docker is configured to start on boot. The
-current default configuration for mainnet does not enable P2P, so we override
-the configuration with the shipped `p2p-config.json` and its accompanying
-`p2p-topology.json` to enable it. Our node's persistent data and client
-communication socket are mapped to `/src/cardano/node-db` and
-`/src/cardano/node-ipc` on the host, respectively. This allows for running
-applications directly on the host which may need access to these. Last, we add
-mapping the host's port 12798 to the container 12798, which is the port for
+after a host reboot, so long as Docker is configured to start on boot. We
+set variables to configure a block producer and pass the paths to the 3 keys
+we need. Our node's persistent data and client communication socket are mapped
+to `/src/cardano/node-db` and `/src/cardano/node-ipc` on the host,
+respectively. This allows for running applications directly on the host which
+may need access to these. We also map `/src/cardano/node-keys` on the host to
+a path within the container to support running as a block producer. Last, we
+add mapping the host's port 12798 to the container 12798, which is the port for
 exposing the node's metrics in Prometheus format, for monitoring.
 
 This mode of operation allows configuring multiple facets of the node using

config/preprod/config.json

@@ -1,12 +1,10 @@
 {
   "AlonzoGenesisFile": "alonzo-genesis.json",
   "AlonzoGenesisHash": "7e94a15f55d1e82d10f09203fa1d40f8eede58fd8066542cf6566008068ed874",
-  "ApplicationName": "cardano-sl",
-  "ApplicationVersion": 0,
   "ByronGenesisFile": "byron-genesis.json",
   "ByronGenesisHash": "d4b8de7a11d929a323373cbab6c1a9bdc931beffff11db111cf9d57356ee1937",
   "ConwayGenesisFile": "conway-genesis.json",
-  "ConwayGenesisHash": "f28f1c1280ea0d32f8cd3143e268650d6c1a8e221522ce4a7d20d62fc09783e1",
+  "ConwayGenesisHash": "89dd23dc6a020afa0c7521fe52fe14e38d494129933a3604154a3acfa4ac16e4",
   "EnableP2P": true,
   "LastKnownBlockVersion-Alt": 0,
   "LastKnownBlockVersion-Major": 2,
@@ -36,13 +34,14 @@
   "TraceDiffusionInitialization": true,
   "TraceErrorPolicy": true,
   "TraceForge": true,
-  "TraceHandshake": false,
+  "TraceHandshake": true,
   "TraceInboundGovernor": true,
   "TraceIpSubscription": true,
   "TraceLedgerPeers": true,
   "TraceLocalChainSyncProtocol": false,
+  "TraceLocalConnectionManager": true,
   "TraceLocalErrorPolicy": true,
-  "TraceLocalHandshake": false,
+  "TraceLocalHandshake": true,
   "TraceLocalRootPeers": true,
   "TraceLocalTxSubmissionProtocol": false,
   "TraceLocalTxSubmissionServer": false,

config/preview/config.json

@@ -1,15 +1,13 @@
 {
   "AlonzoGenesisFile": "alonzo-genesis.json",
   "AlonzoGenesisHash": "7e94a15f55d1e82d10f09203fa1d40f8eede58fd8066542cf6566008068ed874",
-  "ApplicationName": "cardano-sl",
-  "ApplicationVersion": 0,
   "ByronGenesisFile": "byron-genesis.json",
   "ByronGenesisHash": "83de1d7302569ad56cf9139a41e2e11346d4cb4a31c00142557b6ab3fa550761",
   "ConwayGenesisFile": "conway-genesis.json",
-  "ConwayGenesisHash": "f28f1c1280ea0d32f8cd3143e268650d6c1a8e221522ce4a7d20d62fc09783e1",
+  "ConwayGenesisHash": "89dd23dc6a020afa0c7521fe52fe14e38d494129933a3604154a3acfa4ac16e4",
   "EnableP2P": true,
-  "ExperimentalHardForksEnabled": true,
-  "ExperimentalProtocolsEnabled": true,
+  "ExperimentalHardForksEnabled": false,
+  "ExperimentalProtocolsEnabled": false,
   "LastKnownBlockVersion-Alt": 0,
   "LastKnownBlockVersion-Major": 3,
   "LastKnownBlockVersion-Minor": 1,
@@ -42,13 +40,14 @@
   "TraceDiffusionInitialization": true,
   "TraceErrorPolicy": true,
   "TraceForge": true,
-  "TraceHandshake": false,
+  "TraceHandshake": true,
   "TraceInboundGovernor": true,
   "TraceIpSubscription": true,
   "TraceLedgerPeers": true,
   "TraceLocalChainSyncProtocol": false,
+  "TraceLocalConnectionManager": true,
   "TraceLocalErrorPolicy": true,
-  "TraceLocalHandshake": false,
+  "TraceLocalHandshake": true,
   "TraceLocalRootPeers": true,
   "TraceLocalTxSubmissionProtocol": false,
   "TraceLocalTxSubmissionServer": false,