Separate Alonzo genesis file #2743

newhoggy · 2021-05-25T05:21:11Z

No description provided.

cardano-api/src/Cardano/Api/LedgerState.hs

newhoggy · 2021-05-25T06:57:48Z

configuration/chairman/byron-shelley/configuration.yaml

@@ -8,6 +8,7 @@

 ByronGenesisFile: byron/genesis.json
 ShelleyGenesisFile: shelley/genesis.json
+AlonzoGenesisFile: alonzo/genesis.json


New entry in the configuration.yaml

If we include a new genesis file shouldn't we also include a hash in that file?

You can but it's not mandatory.

scripts/byron-to-alonzo/mkfiles.sh

Jimbo4350

Looking good! We need to incorporate the Alonzo genesis hash check similarly to:
https://github.com/input-output-hk/cardano-node/blob/ad76ebe63e138f5bdaa91117f7583b145b687b85/cardano-node/src/Cardano/Node/Protocol/Shelley.hs#L107

And then update the mainnet configuration files in the node.

cardano-node/src/Cardano/Node/Configuration/POM.hs

scripts/byron-to-alonzo/mkfiles.sh

Jimbo4350 · 2021-05-25T09:44:36Z

scripts/byron-to-alonzo/mkfiles.sh

@@ -560,10 +590,6 @@ if [ "$1" = "alonzo" ]; then
  sed -i ${ROOT}/configuration.yaml \
      -e 's/LastKnownBlockVersion-Major: 1/LastKnownBlockVersion-Major: 5/'

-  # Update shelley genesis with required Alonzo fields.
-  alonzogenesisparams='.+ {adaPerUTxOWord: 0, executionPrices: {prMem: 1, prSteps: 1}, maxTxExUnits: {exUnitsMem: 1, exUnitsSteps: 1}, maxBlockExUnits: {exUnitsMem: 1, exUnitsSteps: 1}, maxValueSize: 1000, collateralPercentage: 100, maxCollateralInputs: 1}'


newhoggy · 2021-05-26T00:44:33Z

cardano-cli/src/Cardano/CLI/Shelley/Run/Genesis.hs

+    , "maxValueSize" .= Aeson.toJSON @Int 1000
+    , "collateralPercentage" .= Aeson.toJSON @Int 100
+    , "maxCollateralInputs" .= Aeson.toJSON @Int 1
+    ]


cardano-cli genesis create now creates <rootdir>/genesis.alonzo.json.

should create-staked also do that?

cardano-api/src/Cardano/Api/LedgerState.hs

dcoutts

All the comments below are now outdated as I've resolved them all.

dcoutts · 2021-05-26T10:34:45Z

cardano-api/src/Cardano/Api/LedgerState.hs

+data AlonzoGenesisError
+     = AlonzoGenesisReadError !FilePath !Text
+     | AlonzoGenesisHashMismatch !GenesisHashAlonzo !GenesisHashAlonzo -- actual, expected
+     | AlonzoGenesisDecodeError !FilePath !Text
+     deriving Show


Do we need a new type and all this duplication? Can't we just change the existing ShelleyGenesisError to be just GenesisError and cover both eras? Even the error messages are essentially the same.

dcoutts · 2021-05-26T10:36:58Z

cardano-node/src/Cardano/Node/Configuration/POM.hs

+        primary   <- v .:? "AlonzoGenesisFile"
+        npcAlonzoGenesisFile <- case primary of
+            Just g -> return g
+            Nothing -> fail $ "Missing required field: AlonzoGenesisFile"


Can't this be simplified to just this?

npcAlonzoGenesisFile <- v .: "AlonzoGenesisFile"

dcoutts · 2021-05-26T10:37:32Z

cardano-node/src/Cardano/Node/Protocol/Cardano.hs

    -- We choose to include the Alonzo relevant fields in the Shelley genesis
    -- and therefore avoid creating a separate Alonzo genesis file


This comment has to be updated.

dcoutts · 2021-05-26T10:48:51Z

cardano-node/src/Cardano/Node/Protocol/Cardano.hs

    alonzoGenesis <- firstExceptT CardanoProtocolInstantiationErrorAlonzo
-                   $ readAlonzoGenesis shelleyGenFile
+                   $ readAlonzoGenesis alonzoGenFile


This will need to be changed to be more like Shelley.readGenesis and take the optional hash, and check it.

We should either:

essentially copy and paste Shelley.readGenesis over the existing readAlonzoGenesis but with the necessary adaptations for the Alonzo-specific errors; or

generalising the type of Shelley.readGenesis so that instead of using ShelleyGenesis StandardShelley it uses genesis for any FromJSON genesis =>. The errors would need to be separated. Specifically the first three constructors from ShelleyProtocolInstantiationError would need to be moved into a separate ReadGenesisError type. Then we would delete readAlonzoGenesis and use the Shelley.readGenesis in both places but at different types.

2 is preferable of course.

dcoutts · 2021-05-26T10:51:09Z

cardano-cli/src/Cardano/CLI/Shelley/Run/Genesis.hs

@@ -366,6 +366,26 @@ runGenesisCreate (GenesisDir rootdir)
                       (Lovelace 10) (Lovelace 1, Lovelace 1) (1,1) (1,1) 1 1 1

  writeShelleyGenesis (rootdir </> "genesis.json") finalGenesis
+
+  liftIO $ LBS.writeFile (rootdir </> "genesis.alonzo.json") $ Aeson.encode $


At minimum we should leave a TODO here to make the naming scheme sane, so it's symmetric between the eras.

dcoutts · 2021-05-26T10:52:32Z

cardano-api/src/Cardano/Api/LedgerState.hs

@@ -759,22 +762,21 @@ renderShelleyGenesisError sge =
          ]
  where
    renderHash :: GenesisHashShelley -> Text
-    renderHash (GenesisHashShelley h) = Text.decodeUtf8 $ Base16.encode (Cardano.Crypto.Hash.Class.hashToBytes h)
+    renderHash (GenesisHashShelley h) = Text.decodeUtf8 (Cardano.Crypto.Hash.Class.hashToBytesAsHex h)


There's already a version that returns it as text. We should use that.

Split out the reusable phases of the genesis handling so they can be reused more easily in the Cardano mode, and so they can also be partially reused for Alonzo genesis file loading.

This means we benefit from the hash checking and error types.

Only in the node itself, CLI and scripts still need updating. Co-authored-by: John Ky <john.ky@iohk.io>

CLI that generates genesis files and scripts. Co-authored-by: John Ky <john.ky@iohk.io>

* removes unused selfnode environments

disassembler · 2021-05-26T20:21:36Z

bors r+

iohk-bors · 2021-05-26T20:32:50Z

Build succeeded:

newhoggy requested review from DavidEichmann, dcoutts, erikd and Jimbo4350 as code owners May 25, 2021 05:21

newhoggy force-pushed the newhoggy/separate-alonzo-genesis-file branch 2 times, most recently from 75875d2 to 3d1c320 Compare May 25, 2021 05:23

erikd reviewed May 25, 2021

View reviewed changes

cardano-api/src/Cardano/Api/LedgerState.hs Outdated Show resolved Hide resolved

newhoggy force-pushed the newhoggy/separate-alonzo-genesis-file branch from 3d1c320 to 6efb28c Compare May 25, 2021 06:35

newhoggy commented May 25, 2021

View reviewed changes

scripts/byron-to-alonzo/mkfiles.sh Outdated Show resolved Hide resolved

newhoggy requested a review from erikd May 25, 2021 06:58

Jimbo4350 reviewed May 25, 2021

View reviewed changes

newhoggy force-pushed the newhoggy/separate-alonzo-genesis-file branch 2 times, most recently from c988b80 to e61ca38 Compare May 26, 2021 00:30

newhoggy commented May 26, 2021

View reviewed changes

Jimbo4350 self-requested a review May 26, 2021 07:15

Jimbo4350 reviewed May 26, 2021

View reviewed changes

cardano-api/src/Cardano/Api/LedgerState.hs Outdated Show resolved Hide resolved

newhoggy force-pushed the newhoggy/separate-alonzo-genesis-file branch from e2b2bd1 to 67d1278 Compare May 26, 2021 09:08

disassembler force-pushed the newhoggy/separate-alonzo-genesis-file branch from 86cd1d3 to 2d26267 Compare May 26, 2021 16:06

dcoutts force-pushed the newhoggy/separate-alonzo-genesis-file branch from 2ac4fea to 3656f58 Compare May 26, 2021 16:48

nfrisby mentioned this pull request May 26, 2021

Bring back db-analyzer after Alonzo integration in consensus. IntersectMBO/ouroboros-network#3179

Closed

dcoutts force-pushed the newhoggy/separate-alonzo-genesis-file branch from 3656f58 to 1fcd036 Compare May 26, 2021 19:09

dcoutts approved these changes May 26, 2021

View reviewed changes

dcoutts and others added 5 commits May 26, 2021 20:24

Refactor node's Shelley genesis file error handling

877489f

Split out the reusable phases of the genesis handling so they can be reused more easily in the Cardano mode, and so they can also be partially reused for Alonzo genesis file loading.

Refactor to move the protocol error types to the Error class

6defc6b

Redo readAlonzoGenesis using the general readGenesisAny

dbd5e13

This means we benefit from the hash checking and error types.

Separate the Alonzo genesis file from the Shelley genesis, node parts

684d0e5

Only in the node itself, CLI and scripts still need updating. Co-authored-by: John Ky <john.ky@iohk.io>

Separate the Alonzo genesis file from the Shelley genesis, CLI parts

527bae4

CLI that generates genesis files and scripts. Co-authored-by: John Ky <john.ky@iohk.io>

dcoutts force-pushed the newhoggy/separate-alonzo-genesis-file branch from 1fcd036 to a9583e5 Compare May 26, 2021 19:25

iohk-nix: bump configs for all environments to support alonzo

f69e248

* removes unused selfnode environments

disassembler force-pushed the newhoggy/separate-alonzo-genesis-file branch from a9583e5 to f69e248 Compare May 26, 2021 20:21

iohk-bors bot merged commit 62d2675 into master May 26, 2021

iohk-bors bot deleted the newhoggy/separate-alonzo-genesis-file branch May 26, 2021 20:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Separate Alonzo genesis file #2743

Separate Alonzo genesis file #2743

newhoggy commented May 25, 2021

newhoggy May 25, 2021

disassembler May 25, 2021

Jimbo4350 May 26, 2021

Jimbo4350 left a comment •

edited

Loading

Jimbo4350 May 25, 2021

newhoggy May 26, 2021

jbgi May 26, 2021

dcoutts left a comment

dcoutts May 26, 2021

dcoutts May 26, 2021

dcoutts May 26, 2021

dcoutts May 26, 2021

dcoutts May 26, 2021

dcoutts May 26, 2021

disassembler commented May 26, 2021

iohk-bors bot commented May 26, 2021

		-- We choose to include the Alonzo relevant fields in the Shelley genesis
		-- and therefore avoid creating a separate Alonzo genesis file

Separate Alonzo genesis file #2743

Separate Alonzo genesis file #2743

Conversation

newhoggy commented May 25, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jimbo4350 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcoutts left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

disassembler commented May 26, 2021

iohk-bors bot commented May 26, 2021

Jimbo4350 left a comment •

edited

Loading