Bump CHaP to latest ledger, consensus, network in preparation for cardano-node 8.8 #407

Jimbo4350 · 2023-12-18T13:18:47Z

Changelog

- description: |
    Bump CHaP for cardano node 8.8 release
    Parameterize `TransactionValidityError` and `TxBodyErrorAutoBalance` on era 
    Data constructor `TransactionValidityTranslationError` is now parameterized on `ContextError (ShelleyLedgerEra era)`
    `cppPoolRetireMaxEpoch`, `protocolParamPoolRetireMaxEpoch`,  `icCommitteeTermLength` and `protocolUpdatePoolRetireMaxEpoch` records are updated to `Ledger.EpochInterval`
    Records `cppMaxBlockBodySize`, `cppMaxTxSize`, `protocolUpdateMaxBlockBodySize`, `protocolUpdateMaxTxSize` have been updated to `StrictMaybe Word32`
    Records`cppMaxBlockHeaderSize`, `protocolUpdateMaxBlockHeaderSize` has been updated to `StrictMaybe Word16`
    Inhabitants `SuccessfulPlutusScript` and `FailedPlutusScript` of `LedgerEvent` are now parameterized on `NonEmpty PlutusWithContext`
    `queryNodeLocalState` are now `executeLocalStateQueryExpr` parameterized on `Target ChainPoint`
    `ResolvablePointers` data constructor has been updated with associated data types `PlutusPurpose AsIndex (ShelleyLedgerEra era)` and `PlutusPurpose AsItem (ShelleyLedgerEra era)`
    Replace `PrevGovActionId` with `GovPurposeId`
    Implement `TxProposalProcedures` and `TxVotingProcedures` which enables Plutus script witnessing of proposals and votes.
    Remove support for intermediate tx body format.
# uncomment types applicable to the change:
  type:
  - feature        # introduces a new feature
  - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  # - test           # fixes/modifies tests
  # - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

Additional context for the PR goes here. If the PR fixes a particular issue please provide a link to the issue.

How to trust this PR

Highlight important bits of the PR that will make the review faster. If there are commands the reviewer can run to observe the new behavior, describe them.

Checklist

Commit sequence broadly makes sense and commits have useful messages
New tests are added if needed and existing tests are updated. See Running tests for more details
Self-reviewed the diff

cardano-api/internal/Cardano/Api/Fees.hs

cardano-api/internal/Cardano/Api/Eon/ShelleyBasedEra.hs

cardano-api/internal/Cardano/Api/Orphans.hs

Propagate cardano-ledger's TransactionScriptFailure changes

Implement PlutusScriptBinary pattern

gov action lifetime from EpochNo to EpochInterval

cardano-api/internal/Cardano/Api/Fees.hs

cardano-api/internal/Cardano/Api/ProtocolParameters.hs

carbolymer · 2024-02-02T11:24:38Z

cardano-api/internal/Cardano/Api/Query.hs

@@ -599,7 +600,10 @@ toConsensusQueryShelleyBased sbe = \case
    Some (consensusQueryInEraInMode era Consensus.GetEpochNo)

  QueryConstitution ->
-    Some (consensusQueryInEraInMode era Consensus.GetConstitution)
+    caseShelleyToBabbageOrConwayEraOnwards
+    (const $ error "toConsensusQueryShelleyBased: QueryConstitution is only available in the Conway era")


Why? This check feels redundant because it duplicates what's already here: https://github.com/IntersectMBO/cardano-api/blob/main/cardano-api/internal/Cardano/Api/Query/Expr.hs#L213

So we now have to provide this constraint because in ouroboros-consensus:

-- | Not supported in eras before Conway GetConstitution :: CG.ConwayEraGov era => BlockQuery (ShelleyBlock proto era) (Maybe (LC.Constitution era))

But era :: CardanoEra era, so this caseShelleyToBabbageOrConwayEraOnwards is not required and just consensusQueryInEraInMode era should work as well.

Push a branch that compiles with the above ^

cardano-api/internal/Cardano/Api/Tx/Sign.hs

carbolymer · 2024-02-02T11:42:58Z

cardano-api/internal/Cardano/Api/Tx/Sign.hs

+                                  && txscriptsA      == txscriptsB
+                                  && redeemersA      == redeemersB
+                                  && txmetadataA     == txmetadataB
+                                  && scriptValidityA == scriptValidityB


Why scriptValidity and redeemers equality does not make sense for previous eras?

These were introduced in Alonzo. You can't construct those in pre-Alonzo eras. This conversation here is another example of why we need to nuke the pre-mainnet eras where transaction construction is concerned. We shouldn't be thinking about this.

You can't construct those in pre-Alonzo eras.

Do you mean that in such case both fields will be equal to []? If that's true, there shouldn't be anything wrong with still comparing them for earlier eras.

ledger in preparation for cardano-node 8.8

Add required constraints

'ResolvablePointers' GADT Replace 'RdmrPtr' with 'ScriptWitnessIndex' in 'ScriptErrorMissingScript'

- CommitteeTermLength: EpochNo -> EpochInterval - MaxBlockBodySize: Natural -> Word32 - MaxTxSize: Natural -> Word32 - MaxBlockHeaderSize: Natural -> Word16

…eId' Add Governance policy script hash to 'TreasuryWithdrawal' and 'UpdatePParams'

- Cardano.Api.Tx -> Cardano.Api.Tx.Sign - Cardano.Api.TxBody -> Cardano.Api.Tx.Body

ppEMaxl is now an EpochInterval

These encapsulate the possibility of having plutus script witnesses for votes and proposals Update collectTxBodyScriptWitnesses to collect script witneses for votes and proposals

cardano-cli intermediate format and fully rely on ledger CBOR serialization instances. See SerialiseAsCBOR (TxBody era) instance.

…ne-datums-in-babbage #406 Enable use of inline datums in Babbage era transactions

Jimbo4350 changed the title ~~WIP~~ WIP:WIP: Bump CHaP to latest ledger, consensus, network Dec 18, 2023

Jimbo4350 mentioned this pull request Dec 18, 2023

WIP: Bump CHaP to latest ledger and consensus #401

Closed

3 tasks

Jimbo4350 changed the title ~~WIP:WIP: Bump CHaP to latest ledger, consensus, network~~ WIP: Bump CHaP to latest ledger, consensus, network Dec 18, 2023

Jimbo4350 force-pushed the jordan/20231218-ledger-consensus-network-bump branch from 361b1aa to 7f246bb Compare December 18, 2023 13:47

github-advanced-security bot found potential problems Dec 18, 2023

View reviewed changes

cardano-api/internal/Cardano/Api/Fees.hs Fixed Show fixed Hide fixed

cardano-api/internal/Cardano/Api/Eon/ShelleyBasedEra.hs Fixed Show fixed Hide fixed

Jimbo4350 force-pushed the jordan/20231218-ledger-consensus-network-bump branch 2 times, most recently from a2ebff4 to 4fc8aae Compare December 19, 2023 16:38

github-advanced-security bot found potential problems Dec 19, 2023

View reviewed changes

cardano-api/internal/Cardano/Api/Orphans.hs Fixed Show fixed Hide fixed

Jimbo4350 force-pushed the jordan/20231218-ledger-consensus-network-bump branch 7 times, most recently from 89248cf to eaad676 Compare December 20, 2023 15:26

Jimbo4350 mentioned this pull request Dec 20, 2023

Bump CHaP in preparation for cardano-node 8.8 IntersectMBO/cardano-cli#529

Merged

3 tasks

Jimbo4350 force-pushed the jordan/20231218-ledger-consensus-network-bump branch 4 times, most recently from 3320fdd to ea0835d Compare January 19, 2024 20:58

Jimbo4350 force-pushed the jordan/20231218-ledger-consensus-network-bump branch 3 times, most recently from b923148 to 7b4dabb Compare January 30, 2024 00:00

Jimbo4350 added 4 commits January 31, 2024 09:55

Replace deserialiseAddr with decodeAddr

bf0c2ef

Parameterize TransactionValidityError on era and convert to GADT

9d3ecd0

Propagate cardano-ledger's TransactionScriptFailure changes

Remove patterns AlonzoPlutusScript and AlonzoTimelockScript

ff3f622

Implement PlutusScriptBinary pattern

Update protocol parameter types pool max retire epoch, drep activity and

8b6dcaa

gov action lifetime from EpochNo to EpochInterval

Jimbo4350 force-pushed the jordan/20231218-ledger-consensus-network-bump branch 2 times, most recently from 3e8372f to 215e587 Compare January 31, 2024 16:04

Jimbo4350 changed the title ~~WIP: Bump CHaP to latest ledger, consensus, network~~ Bump CHaP to latest ledger, consensus, network in preparation for cardano-node 8.8 Jan 31, 2024

carbolymer reviewed Feb 2, 2024

View reviewed changes

cardano-api/internal/Cardano/Api/Fees.hs Outdated Show resolved Hide resolved

carbolymer reviewed Feb 2, 2024

View reviewed changes

cardano-api/internal/Cardano/Api/ProtocolParameters.hs Outdated Show resolved Hide resolved

carbolymer reviewed Feb 2, 2024

View reviewed changes

cardano-api/internal/Cardano/Api/Tx/Sign.hs Outdated Show resolved Hide resolved

carbolymer reviewed Feb 2, 2024

View reviewed changes

carbolymer approved these changes Feb 2, 2024

View reviewed changes

Jimbo4350 added 17 commits February 5, 2024 09:03

Remove ExtendedUTxO and EraPlutusContext type classes

757cd89

Update cardano-api.cabal file with latest releases from consensus and

cd786ca

ledger in preparation for cardano-node 8.8

Update arguments for textToUrl and textToDns

edc018d

Replace 'Maybe ChainPoint' with 'Target ChainPoint' from consensus

50c0762

Remove redundant constraints

1f7b7d9

Add required constraints

Replace 'RdmrPtr' with associated data type 'PlutusPurpose' in

9bd9c49

'ResolvablePointers' GADT Replace 'RdmrPtr' with 'ScriptWitnessIndex' in 'ScriptErrorMissingScript'

Satisfy required ledger constraints in Conway related queries

c55b15e

Update the following protocol parameters:

3122765

- CommitteeTermLength: EpochNo -> EpochInterval - MaxBlockBodySize: Natural -> Word32 - MaxTxSize: Natural -> Word32 - MaxBlockHeaderSize: Natural -> Word16

Replace 'PrevGovActionId' usage in 'GovernanceAction' with 'GovPurpos…

a42f536

…eId' Add Governance policy script hash to 'TreasuryWithdrawal' and 'UpdatePParams'

Delete Cardano.Api.TxBody and Cardano.Api.Tx

1c57e9a

Propagate renames:

d6f3994

- Cardano.Api.Tx -> Cardano.Api.Tx.Sign - Cardano.Api.TxBody -> Cardano.Api.Tx.Body

Update golden files

eb3422b

Update cardano-api gen's generators

2809c42

Update piplineSize of chain sync client from Word32 -> Word16

2dd0b0a

ppEMaxl is now an EpochInterval

Implement TxProposalProcedures and TxVotingProcedures

0d8efae

These encapsulate the possibility of having plutus script witnesses for votes and proposals Update collectTxBodyScriptWitnesses to collect script witneses for votes and proposals

Move TxBody to Cardano.Api.Sign.Tx in order to remove the old

e739675

cardano-cli intermediate format and fully rely on ledger CBOR serialization instances. See SerialiseAsCBOR (TxBody era) instance.

Address review comments

9aae71c

Jimbo4350 force-pushed the jordan/20231218-ledger-consensus-network-bump branch from 80cab27 to 9aae71c Compare February 5, 2024 15:46

Jimbo4350 enabled auto-merge February 5, 2024 15:48

Jimbo4350 added this pull request to the merge queue Feb 5, 2024

Merged via the queue into main with commit 9143a17 Feb 5, 2024
19 of 25 checks passed

Jimbo4350 deleted the jordan/20231218-ledger-consensus-network-bump branch February 5, 2024 18:56

newhoggy pushed a commit that referenced this pull request Mar 11, 2024

Merge pull request #407 from input-output-hk/mgalazyn/fix/enable-inli…

e86aa60

…ne-datums-in-babbage #406 Enable use of inline datums in Babbage era transactions

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump CHaP to latest ledger, consensus, network in preparation for cardano-node 8.8 #407

Bump CHaP to latest ledger, consensus, network in preparation for cardano-node 8.8 #407

Jimbo4350 commented Dec 18, 2023 •

edited

carbolymer Feb 2, 2024 •

edited

Jimbo4350 Feb 2, 2024 •

edited

carbolymer Feb 5, 2024 •

edited

Jimbo4350 Feb 5, 2024

carbolymer Feb 2, 2024

Jimbo4350 Feb 2, 2024 •

edited

carbolymer Feb 5, 2024 •

edited

Bump CHaP to latest ledger, consensus, network in preparation for cardano-node 8.8 #407

Bump CHaP to latest ledger, consensus, network in preparation for cardano-node 8.8 #407

Conversation

Jimbo4350 commented Dec 18, 2023 • edited

Changelog

Context

How to trust this PR

Checklist

carbolymer Feb 2, 2024 • edited

Choose a reason for hiding this comment

Jimbo4350 Feb 2, 2024 • edited

Choose a reason for hiding this comment

carbolymer Feb 5, 2024 • edited

Choose a reason for hiding this comment

Jimbo4350 Feb 5, 2024

Choose a reason for hiding this comment

carbolymer Feb 2, 2024

Choose a reason for hiding this comment

Jimbo4350 Feb 2, 2024 • edited

Choose a reason for hiding this comment

carbolymer Feb 5, 2024 • edited

Choose a reason for hiding this comment

Jimbo4350 commented Dec 18, 2023 •

edited

carbolymer Feb 2, 2024 •

edited

Jimbo4350 Feb 2, 2024 •

edited

carbolymer Feb 5, 2024 •

edited

Jimbo4350 Feb 2, 2024 •

edited

carbolymer Feb 5, 2024 •

edited