Changelog

All notable changes to this repository will be documented in this file. At at later date we may adopt per-Haskell-package changelogs.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning in the naming of release branches.

[Unreleased]

Added

Add PlutusDebug to TransactionScriptFailure.ValidationFailedV{1|2}: #3135
- Also add a harmless dummy Show instance for PlutusDebug with a constant "PlutusDebug Omitted"
Create a cardano-ledger-binary package that does versioned serialization as a replacement for cardano-binary package: #3063, #3078
Switch to cardano-ledger-binary package throughout the ledger codebase: #3138
Created translateEraThroughCBOR: #3138
Start on the cardano-ledger-api package and implement setMinCoinTxOut+setMinCoinSizedTxOut: #2995
Added getMinCoinTxOut/getMinCoinSizedTxOut to EraTxOut: #3008
Added getMinFeeTx to EraTx
Added datumTxOutF to AlonzoEraTxOut
Added allInputsTxBodyF
Added EraUTxO class with getConsumedValue
Added type synonyms for eras: Shelley, Allegra, Mary, Alonzo, Babbage and Conway.
Added Twiddle class to test alternative serializations: #2994
Added getScriptsNeeded and getScriptsHashesNeeded to EraUTxO class: #3019
Added evaluateTransactionExecutionUnitsWithLogs to Alonzo: #3111
Added mkAlonzoTxAuxData and getAlonzoTxAuxDataScripts that help to recover previous behavior of AlonzoTxAuxData #3165 and #3166
Addition of Memoized type class and helper functions that utilize this new abstraction: mkMemoized, getMemoSafeHash, getMemoRawType, zipMemoRawType, getMemoRawBytes and lensMemoRawType #3165

Changed

Changed FromCBOR instance in Babbage.TxOut to fail pointer address deserialization starting with protocol version 9: #3174
Updated Conway low protocol version to 9 and Babbage high protocol version to 8: #3174
Fixed mismathed parenthesis in the Show instance for Ptr: #3184.
Moved Cardano.Ledger.Shelley.LedgerState(DPState) to Cardano.Ledger(DPState) in Core
- Since the old file was hidden, this will have no noticeable effects.
Split cardano-ledger-shelley-ma into cardano-ledger-allegra and cardano-ledger-mary #3175:
- Moved ShelleyMA.AuxiliaryData -> Allegra.TxAuxData
- Moved ShelleyMA.Timelocks -> Allegra.Scripts
- ShelleyMA.TxBody.MATxBody was split into Allegra.AllegraTxBody and Mary.MaryTxBody. pattern record fields were renamed correspondingly
  - inputs to atbInputs and mtbInputs
  - outputs to atbOutputs and mtbOutputs
  - certs to atbCerts and mtbCerts
  - wdrls to atbWdrls and mtbWdrls
  - txfee to atbTxFee and mtbTxFee
  - vldt to atbValidityInterval and mtbValidityInterval
  - update to atbUpdate and mtbUpdate
  - adHash to atbAuxDataHash and mtbAuxDataHash
  - mint to mtbMint
Changed structure and field names of Cardano.Ledger.Alonzo.Data.AlonzoTxAuxData #3165:
- Renamed AlonzoTxAuxData.txMD to AlonzoTxAuxData.atadMetadata:
- Removed AlonzoTxAuxData.scripts in favor of two new fields atadTimelock and atadPlutus. This was needed due to #3166
Changed major version in ProtVer to use new type Version instead of Natural: #3138
Renamed records fields in Cardano.Ledger to names without _ (underscores) #3126
- Alonzo.TxBody.AlonzoTxBody pattern synonym
  - inputs to atbInputs
  - collateral to atbCollateral
  - outputs to atbOutputs
  - txcerts to atbCerts
  - txwdrls to atbWdrls
  - txfee to atbTxFee
  - txvldt to atbValidityInterval
  - txUpdates to atbUpdate
  - reqSignerHashes to atbReqSignerHashes
  - mint to atbMint
  - scriptIntegrityHash to atbScriptIntegrityHash
  - adHash to atbAuxDataHash
  - txnetworkid to atbTxNetworkId
- Babbage.TxBody.BabbageTxBody pattern synonym
  - inputs to btbInputs
  - collateral to btbCollateral
  - referenceInputs to btbReferenceInputs
  - outputs to btbOutputs
  - collateralReturn to btbCollateralReturn
  - totalCollateral to btbTotalCollateral
  - txcerts to btbCerts
  - txwdrls to btbWdrls
  - txfee to btbTxFee
  - txvldt to btbValidityInterval
  - txUpdates to btbUpdate
  - reqSignerHashes to btbReqSignerHashes
  - mint to btbMint
  - scriptIntegrityHash to btbScriptIntegrityHash
  - adHash to btbAuxDataHash
  - txnetworkid to btbrTxNetworkId
- Shelley.TxBody.TxBodyRaw to Shelley.TxBody.ShelleyTxBodyRaw
  - inputsX to stbrInputs
  - outputsX to stbrOutputs
  - certsX to stbrCerts
  - wdrlsX to stbrWdrls
  - txfeeX to stbrTxFee
  - ttlX to stbrTTL
  - txUpdateX to stbrUpdate
  - mdHashX to stbrMDHash
- Shelley.TxBody.ShelleyTxBody pattern synonym
  - _inputs to stbInputs
  - _outputs to stbOutputs
  - _certs to stbCerts
  - _wdrls to stbWdrls
  - _txfee to stbTxFee
  - _ttl to stbTTL
  - _txUpdate to stbUpdate
  - _mdHash to stbMDHash
Renamed records fields in Cardano.Ledger to names without _ (underscores) #3118
Shelley.LedgerState.Types.AccountState
- _treasury -> asTreasury
- _reserves -> asReserves
PoolParams.PoolParams
- _poolId -> ppId
- _poolVrf -> ppVrf
- _poolPledge -> ppPledge
- _poolCost -> ppCost
- _poolMargin -> ppMargin
- _poolRAcnt -> ppRewardAcnt
- _poolOwners -> ppOwners
- _poolRelays -> ppRelays
- _poolMD -> ppMetadata
PoolParams.PoolMetadata
- _poolMDUrl -> pmUrl
- _poolMDHash -> pmHash
Renamed records fields in Cardano.Ledger to names without _ (underscores) #3120
- Shelley.Delegation.Certificates
  - _delegator to dDelegator
  - _delegatee to dDelegatee
- EpochBoundary.SnapShot
  - _stake to ssStake
  - _delegations to ssDelegations
  - _poolParams to ssPoolParams
- EpochBoundary.SnapShots
  - _pstakeMark to ssStakeMark
  - _pstakeSet to ssStakeSet
  - _pstakeGo to ssStakeGo
  - _feeSS to ssFee
Renamed records fields in Cardano.Ledger.Shelley.LedgerState.DPState to names without _ (underscores) #3116
- DState
  - _unified -> dsUnified
  - _fGenDelegs -> dsFutureGenDelegs
  - _genDelegs -> dsGenDelegs
  - _irwd -> dsIRewards
- PState
  - _pParams -> psStakePoolParams
  - _fPParams -> psFutureStakePoolParams
  - _retiring -> psRetiring
Renamed Cardano.Ledger.Shelley.LedgerState.Types.UTxOState fields to names without _ (underscores) #3108
- _utxo -> utxosUtxo
- _deposited -> utxosDeposited
- _fees -> utxosFees
- _ppups -> utxosPpups
- _stakeDistro -> utxosStakeDistr (notice the lacking o at the end)
Moved Cardano.Ledger.Shelley.Orphans to Cardano.Ledger.Orphans in the core modules
Moved Cardano.Ledger.Shelley.PoolParms to Cardano.Ledger.PoolParams in the core modules
Moved Cardano.Ledger.Shelley.EpochBoundary to Cardano.Ledger.EpochBoundary in the core modules
Added deprecated modules that import the moved ones and export their contents
Moved Data.AbstractSize from cardano-data to byron-spec-ledger #3046
Renamed in Cardano.Ledger.Mary.Value: #3047
- insert to insertMultiAsset
- lookup to lookupMultiAsset
Changed mint field type to MultiAsset (Crypto era) in MATxBody, AlonzoTxBody, BabbageTxBody #2954
All Shelley rules are now available through Cadano.Ledger.Shelley.Rules module: #2996
Renamed the Crypto dependent type in the Era class to EraCrypto #3009
Renamed in Cardano.Ledger.Core #2976:
- EraWitnesses to EraTxWits
- Witnesses to EraTxWits
- mkBasicWitnesses to mkBasicTxWits
- addrWitsL to addrTxWitsL
- bootAddrWitsL to bootAddrTxWitsL
- scriptWitsL to scriptTxWitsL
Renamed in (new) module Cardano.Ledger.Alonzo.TxWits (renamed from Cardano.Ledger.Alonzo.TxWitness) #2976:
- AlonzoEraWitnesses to AlonzoEraTxWits
- TxWitness to AlonzoTxWits
- addrAlonzoWitsL to addrAlonzoTxWitsL
- bootAddrAlonzoWitsL to bootAddrAlonzoTxWitsL
- scriptAlonzoWitsL to scriptAlonzoTxWitsL
- datsWitsL to datsTxWitsL
- datsAlonzoWitsL to datsAlonzoTxWitsL
- rdmrsWitsL to rdmrsTxWitsL
- rdmrsAlonzoWitsL to rdmrsAlonzoTxWitsL
Renamed in (new) module Cardano.Ledger.Shelley.TxWits (extracted from Cardano.Ledger.Shelley.Tx) #2976:
- ShelleyWitnesses to ShelleyTxWits
- addrShelleyWitsL to addrShelleyTxWitsL
- bootAddrShelleyWitsL to bootAddrShelleyTxWitsL
- scriptShelleyWitsL to scriptShelleyTxWitsL
Updated package metadata #3023
Moved TxOut to a separate module in each era #3024
Moved mintedTxBodyF into ShelleyMAEraTxBody class #3019
Moved thet RewardType and Reward types from the Cardano.Ledger.Shelley.Reward module in the cardano-ledger-shelley package into a new module Cardano.Ledger.Reward inside the cardano-ledger-core package. #3059

Removed

Removed unused deserialiseAddrStakeRef function from Address module: #3174
MAClass is gone: #3175
ShelleyMAEra type in favor of AllegraEra and MaryEra: #3175
MATxBody type in favor of AllegraTxBody and MaryTxBody: #3175
Deprecated Cardano.Ledger.Serialization in favor of Cardano.Ledger.Binary from cardano-ledger-binary: #3138
Removed Data.Coders from cardano-data in favor of Cardano.Ledger.Binary.Coders from cardano-ledger-binary: #3138
Removed Data.Sharing from cardano-data in favor of Cardano.Ledger.Binary from cardano-ledger-binary: #3138
Removed boundedRationalFromCBOR/boundedRationalToCBOR as obsolete and invalid: #3138
Removed pattern synonym Cardano.Ledger.ShelleyMA.TxBody.MATxBody.TxBody' with fields #3126
- adHash'
- certs'
- inputs'
- mint'
- outputs'
- txfee'
- update'
- vldt'
- wdrls'
Deprecated the validPlutusdata function: #3006
Deprecated the misspelled HasAlgorithm type alias: #3007
Deprecated CLI.evaluateMinLovelaceOutput in favor of newly added EraTxOut.getMinCoinTxOut/EraTxOut.getMinCoinSizedTxOut #3008
Deprecated minfee and CLI.evaluateMinfee in favor of new EraTx.getMinFeeTx
Deprecated ExtendedUTxO.getTxOutDatum in favor of new AlonzoEraTxOut.datumTxOutF
Removed ExtendedUTxO.allOuts and ExtendedUTxO.allSizedOuts in favor of BabbageEraTxBody.allInputsTxBodyF
Deprecated consumed and evaluateConsumed in favor of new EraUTxO.getConsumedValue
Removed CLI class
Deprecated scriptsNeededFromBody and scriptsNeeded in all eras in favor of new class function EraUTxO.getScriptsNeeded #3019
Remove model test framework #3019
The Cardano.Ledger.Alonzo.Scripts module no longer re-exports the plutus-ledger-api's assertWellFormedCostModelParams. #3065
Removed unused Data.BiMap module from cardano-data #3089
Removed getMultiSigBytes as unused #3138
Removed hashCostModel as unused and invalid #3138
Removed EncodeMint/DecodeMint classes in favor of regular ToCBOR/FromCBOR #3172

Fixed

Fixed typo in makeHashWithExplicitProxys phantom type (indexl to index). #3072
Fixed the incorrect conversion of the validity interval's upper bound in transVITime (fixes #3043). #3200

Release branch 1.1.x

Added

New calculatePoolDistr' function which is similar to calculatePoolDistr but has a new filter argument to only include the stake pool ids (stake pool key hashes) that are needed. #2957
New package cardano-ledger-conway, which defines new era: the ConwayEra
Added coinsPerUTxOByteToCoinsPerUTxOWord helper function for Babbage #2896
Core type classes: EraSegWits, EraTx, EraTxBody, EraTxOut, EraPParams, EraAuxiliaryData, EraTxWits, EraScript
Era specific type classes: ShelleyEraTxBody, ShelleyMAEraTxBody, AlonzoEraTxBody, AlonzoEraTxOut, AlonzoEraTx, BabbageEraTxBody, BabbageEraTxOut
Type class hierarchy:

EraSegWits --> EraTx --> EraTxBody --> EraTxOut --> Era
                     \             `--> EraPParams --> Era
                      `--> EraTxWits --> EraScript --> Era
                       `--> EraAuxiliaryData --> Era

Shelley:

ShelleyEraTxBody --> EraTxBody --> EraTxOut --> Era

ShelleyMA:

ShelleyMAEraTxBody --> ShelleyEraTxBody --> EraTxBody --> EraTxOut --> Era

Alonzo:

AlonzoEraTx --> EraTx --> ...
           `--> AlonzoEraTxBody --> ShelleyMAEraTxBody --> ShelleyEraTxBody --> EraTxBody --> ...
                                `--> AlonzoEraTxOut -> ShelleyEraTxOut --> EraTxOut --> ...

Babbage:

BabbageEraTxBody --> AlonzoEraTxBody --> ....
                `--> BabbageEraTxOut -> AlonzoEraTxOut -->

Changed

Some types have been moved:
- The WitVKey type has been moved into its own module in core.
- The HKD type has been moved to cardano-ledger-core.
- The PoolParams type has been moved into its own module
- The DCert type and related functionality from TxBody to Cardano.Ledger.Shelley.Delegation.Certificates. #2880
The initial funds and staking in the Shelley genesis type (used only for testing) now use ListMap instead of Map. #2871, #2890, #2892, #2895
Renamed SupportsSegWit to EraSegWits
Split ValidateScript into EraScript and EraTx.validateScript
Renamed ValidateAuxiliaryData to EraAuxiliaryData while removing usage of FunDeps.
Renamed in Cardano.Ledger.Shelley:
- Tx to ShelleyTx (kept type synonym with a deprecation message)
- TxOut to ShelleyTxOut (kept type synonym with a deprecation message)
- TxBody to ShelleyTxBody (kept type synonym with a deprecation message)
- PParams to ShelleyPParams (kept type synonym with a deprecation message)
- PParamsUpdate to ShelleyPParamsUpdate (kept type synonym with a deprecation message)
- AuxiliaryData to ShelleyAuxiliaryData (kept type synonym with a deprecation message)
Renamed in Cardano.Ledger.Mary:
- Renamed Value to MaryValue (kept type synonym with a deprecation message)
Renamed in Cardano.Ledger.ShelleyMA:
- TxBody to MATxBody (kept type synonym with a deprecation message)
- AuxiliaryData to ShelleyAuxiliaryData (kept type synonym with a deprecation message)
Renamed in Cardano.Ledger.Alonzo:
- ValidatedTx to AlonzoTx (kept type synonym with a deprecation message)
- TxOut to AlonzoTxOut (kept type synonym with a deprecation message)
- TxBody to AlonzoTxBody (kept type synonym with a deprecation message)
- Script to AlonzoScript (kept type synonym with a deprecation message)
- PParams to AlonzoPParams (kept type synonym with a deprecation message)
- PParamsUpdate to AlonzoPParamsUpdate (kept type synonym with a deprecation message)
- AuxiliaryData to AlonzoAuxiliaryData (kept type synonym with a deprecation message)
Renamed in Cardano.Ledger.Babbage:
- TxOut to BabbageTxOut (kept type synonym with a deprecation message)
- TxBody to BabbageTxBody (kept type synonym with a deprecation message)
- PParams to BabbagePParams (kept type synonym with a deprecation message)
- PParamsUpdate to BabbagePParamsUpdate (kept type synonym with a deprecation message)
Renamed Rules:
- BBODY -> ShelleyBBODY
- DELEG -> ShelleyDELEG
- DELEGS -> ShelleyDELEGS
- DELPL -> ShelleyDELPL
- EPOCH -> ShelleyEPOCH
- LEDGER -> ShelleyLEDGER
- LEDGERS -> ShelleyLEDGERS
- MIR -> ShelleyMIR
- NEWEPOCH -> ShelleyNEWEPOCH
- NEWPP -> ShelleyNEWPP
- POOL -> ShelleyPOOL
- POOLREAP -> ShelleyPOOLREAP
- PPUP -> ShelleyPPUP
- RUPD -> ShelleyRUPD
- SNAP -> ShelleySNAP
- TICK -> ShelleyTICK, ShelleyTICKF
- UPEC -> ShelleyUPEC
- UTXO -> ShelleyUTXO
- UTXOW -> ShelleyUTXOW
Renamed rules environments:
- PPUPEnv -> PpupEnv
Renamed rules events:
- BbodyEvent -> ShelleyBbodyEvent
- DelegEvent -> ShelleyDelegEvent
- DelegsEvent -> ShelleyDelegsEvent
- DelplEvent -> ShelleyDelplEvent
- EpochEvent -> ShelleyEpochEvent
- LedgerEvent -> ShelleyLedgerEvent
- LedgersEvent -> ShelleyLedgersEvent
- MirEvent -> ShelleyMirEvent
- NewEpochEvent -> ShelleyNewEpochEvent
- PoolreapEvent -> ShelleyPoolreapEvent
- TickEvent -> ShelleyTickEvent
- TickfEvent -> ShelleyTickfEvent
- UtxowEvent -> ShelleyUtxowEvent
Renamed predicate failure type names:
- Cardano.Ledger.Shelley.Rules:
  - BbodyPredicateFailure -> ShelleyBbodyPredFailure
  - DelegPredicateFailure -> ShelleyDelegPredFailure
  - DelegsPredicateFailure -> ShelleyDelegsPredFailure
  - DelplPredicateFailure -> ShelleyDelplPredFailure
  - EpochPredicateFailure -> ShelleyEpochPredFailure
  - LedgerPredicateFailure -> ShelleyLedgerPredFailure
  - LedgersPredicateFailure -> ShelleyLedgersPredFailure
  - MirPredicateFailure -> ShelleyMirPredFailure
  - NewEpochPredicateFailure -> ShelleyNewEpochPredFailure
  - NewppPredicateFailure -> ShelleyNewppPredFailure
  - LedgerPredicateFailure -> ShelleyLedgerPredFailure
  - PoolPredicateFailure -> ShelleyPoolPredFailure
  - PoolreapPredicateFailure -> ShelleyPoolreapPredFailure
  - PpupPredicateFailure -> ShelleyPpupPredFailure
  - RupdPredicateFailure -> ShelleyRupdPredFailure
  - SnapPredicateFailure -> ShelleySnapPredFailure
  - TickPredicateFailure -> ShelleyTickPredFailure
  - TickfPredicateFailure -> ShelleyTickfPredFailure
  - UpecPredicateFailure -> ShelleyUpecPredFailure
  - UtxoPredicateFailure -> ShelleyUtxoPredFailure
  - UtxowPredicateFailure -> ShelleyUtxowPredFailure
- Cardano.Ledger.ShelleyMA.Rules:
  - UtxoPredicateFailure -> ShelleyMAUtxoPredFailure
- Cardano.Ledger.Alonzo.Rules:
  - AlonzoBbodyPredFail -> AlonzoBbodyPredFailure and constructor:
    - ShelleyInAlonzoPredFail -> ShelleyInAlonzoBbodyPredFailure
  - UtxoPredicateFailure -> AlonzoUtxoPredFailure
  - UtxosPredicateFailure -> AlonzoUtxosPredFailure
  - UtxowPredicateFail -> AlonzoUtxowPredFailure and constructor:
    - WrappedShelleyEraFailure -> ShelleyInAlonzoUtxowPredFailure
- Cardano.Ledger.Babbage.Rules:
  - BabbageUtxoPred -> BabbageUtxoPredFailure and constructor:
    - FromAlonzoUtxoFail -> AlonzoInBabbageUtxoPredFailure
  - BabbageUtxowPred -> BabbageUtxowPredFailure and constructor:
    - FromAlonzoUtxowFail -> AlonzoInBabbageUtxowPredFailure

Deprecated

The provenance for the reward calculation has been removed. The type signature to the API function getRewardProvenance has not change, it just returns an empty provenance value. The type signature will be changed once the corresponding query has been deprecated in the ouroboros-network repository. #2879
getTxOutAddr txOut in favor of txOut ^. addrTxOutL
getTxOutEitherAddr txOut in favor of txOut ^. addrEitherTxOutL
getTxOutCompactAddr txOut in favor of txOut ^. compactAddrTxOutL
getTxOutBootstrapAddress txOut in favor of txOut ^. bootAddrTxOutF
getAllInputs txBody in favor of txBody ^. allInputsTxBodyF
getCoin txOut in favor of txOut ^. coinTxOutL

Removed

The StakeCreds type was unused and is now removed. #2880
TheOrd instance for MemoBytes was removed. #2881
makeTxOut in favor of mkBasicTxOut
HasField instances for: "inputs", "outputs", "txfee", "auxiliaryData", "minted", "wdrls", "ttl", "update", "certs", "vldt", "mint", "collateral", "reqSignerHashes", "scriptIntegrityHash", "txnetworkid", "sizedOutputs", "referenceInputs", "totalCollateral", "collateralReturn", "sizedCollateralReturn", "body", "wits", "auxData", "size", "isValid", "addrWits", "scriptWits", "bootWits", "txdatahash", "addr", "bootAddr", "script", "dats", "rdmrs"
ValidateScript in favor of EraScript and EraTx
Type class synonyms:
- Trans*
- Uses*: UsesPParams, UsesScript, UsesTxBody, UsesTxOut, UsesAuxiliaryData
- BlockAnn
- ChainData
- AnnotatedData
- SerialisableData
- WellFormed
- ConcreteAlonzo
- ConcreteBabbage
- ...

Fixed

The error message for failed Plutus V2 scripts was being obscured by a bug which has now been fixed. #2888

Release branch 1.0.x

The first release branch in the cardano-ledger repository, namely release/1.0.0, branches from the cardano-ledger commit used for the 1.35.0 release of cardano-node release.

Fixed

Ensure Babbage TxOut decoder can't fail due to malformed Ptr. This bug was manifesting in the cardano-node as: if a node is running in the Babbage era and shuts down, when it comes back up it has to re-sync from genesis. #2897
The Alonzo UTxO rule was previously using the incorrect minfee function (from Shelley). It now uses the Alonze minfee function. #2936

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CHANGELOG.md

CHANGELOG.md

Changelog

[Unreleased]

Added

Changed

Removed

Fixed

Release branch 1.1.x

Added

Changed

Deprecated

Removed

Fixed

Release branch 1.0.x

Fixed

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

Changelog

[Unreleased]

Added

Changed

Removed

Fixed

Release branch 1.1.x

Added

Changed

Deprecated

Removed

Fixed

Release branch 1.0.x

Fixed