Refactor: rename module structure accordingly to ADR-009 #840

carbolymer · 2025-05-14T11:37:06Z

Changelog

- description: |
    Breaking refactor: change module structure according to [ADR-009](https://github.com/input-output-hk/cardano-node-wiki/wiki/ADR-009-cardano-api-exports-convention)

    Add new exported modules:

      - Cardano.Api.Certificate
      - Cardano.Api.Era
      - Cardano.Api.Experimental.Plutus
      - Cardano.Api.Genesis
      - Cardano.Api.Governance
      - Cardano.Api.Key
      - Cardano.Api.IPC
      - Cardano.Api.Plutus
      - Cardano.Api.Query
      - Cardano.Api.Serialise.DeserialiseAnyOf
      - Cardano.Api.Serialise.TextEnvelope
      - Cardano.Api.Serialise.Tx
      - Cardano.Api.Value

    Rename modules:

      - Cardano.Api.Byron.Internal.Key -> Cardano.Api.Internal.Keys.Byron
      - Cardano.Api.Byron.Internal.Proposal -> Cardano.Api.Internal.SpecialByron
      - Cardano.Api.Certificate.Internal -> Cardano.Api.Internal.Certificate
      - Cardano.Api.Certificate.Internal.OperationalCertificate -> Cardano.Api.Internal.OperationalCertificate
      - Cardano.Api.Certificate.Internal.StakePoolMetadata -> Cardano.Api.Internal.StakePoolMetadata
      - Cardano.Api.Certificate.Internal.DRepMetadata -> Cardano.Api.Internal.DRepMetadata
      - Cardano.Api.Compatible.Tx -> Cardano.Api.Internal.Compatible.Tx
      - Cardano.Api.ProtocolParameters -> Cardano.Api.Internal.ProtocolParameters
      - Cardano.Api.Consensus.Internal.Reexport -> Cardano.Api.Internal.ReexposeConsensus
      - Cardano.Api.Consensus.Internal.Mode -> Cardano.Api.Internal.Modes
      - Cardano.Api.Consensus.Internal.InMode -> Cardano.Api.Internal.InMode
      - Cardano.Api.Consensus.Internal.Protocol -> Cardano.Api.Internal.Protocol
      - Cardano.Api.Era.Internal.Case -> Cardano.Api.Internal.Eras.Case
      - Cardano.Api.Era.Internal.Core -> Cardano.Api.Internal.Eras.Core
      - Cardano.Api.Era.Internal.Feature -> Cardano.Api.Internal.Feature
      - Cardano.Api.Era.Internal.Eon.AllegraEraOnwards -> Cardano.Api.Internal.Eon.AllegraEraOnwards
      - Cardano.Api.Era.Internal.Eon.AlonzoEraOnwards -> Cardano.Api.Internal.Eon.AlonzoEraOnwards
      - Cardano.Api.Era.Internal.Eon.BabbageEraOnwards -> Cardano.Api.Internal.Eon.BabbageEraOnwards
      - Cardano.Api.Era.Internal.Eon.ByronToAlonzoEra -> Cardano.Api.Internal.Eon.ByronToAlonzoEra
      - Cardano.Api.Era.Internal.Eon.Convert -> Cardano.Api.Internal.Eon.Convert
      - Cardano.Api.Era.Internal.Eon.ConwayEraOnwards -> Cardano.Api.Internal.Eon.ConwayEraOnwards
      - Cardano.Api.Era.Internal.Eon.MaryEraOnwards -> Cardano.Api.Internal.Eon.MaryEraOnwards
      - Cardano.Api.Era.Internal.Eon.ShelleyBasedEra -> Cardano.Api.Internal.Eon.ShelleyBasedEra
      - Cardano.Api.Era.Internal.Eon.ShelleyEraOnly -> Cardano.Api.Internal.Eon.ShelleyEraOnly
      - Cardano.Api.Era.Internal.Eon.ShelleyToAllegraEra -> Cardano.Api.Internal.Eon.ShelleyToAllegraEra
      - Cardano.Api.Era.Internal.Eon.ShelleyToAlonzoEra -> Cardano.Api.Internal.Eon.ShelleyToAlonzoEra
      - Cardano.Api.Era.Internal.Eon.ShelleyToBabbageEra -> Cardano.Api.Internal.Eon.ShelleyToBabbageEra
      - Cardano.Api.Era.Internal.Eon.ShelleyToMaryEra -> Cardano.Api.Internal.Eon.ShelleyToMaryEra
      - Cardano.Api.Era -> Cardano.Api.Internal.Eras
      - Cardano.Api.Experimental.Era -> Cardano.Api.Internal.Experimental.Eras
      - Cardano.Api.Experimental.Plutus.Internal.IndexedPlutusScriptWitness -> Cardano.Api.Internal.Experimental.Plutus.IndexedPlutusScriptWitness
      - Cardano.Api.Experimental.Plutus.Internal.ScriptWitness -> Cardano.Api.Internal.Experimental.Plutus.ScriptWitness
      - Cardano.Api.Experimental.Plutus.Internal.Script -> Cardano.Api.Internal.Experimental.Plutus.Script
      - Cardano.Api.Experimental.Plutus.Internal.Shim.LegacyScripts -> Cardano.Api.Internal.Experimental.Plutus.Shim.LegacyScripts
      - Cardano.Api.Experimental.Simple.Script -> Cardano.Api.Internal.Experimental.Simple.Script
      - Cardano.Api.Experimental.Tx -> Cardano.Api.Internal.Experimental.Tx
      - Cardano.Api.Experimental.Tx.Internal.AnyWitness -> Cardano.Api.Internal.Experimental.Witness.AnyWitness
      - Cardano.Api.Experimental.Tx.Internal.TxScriptWitnessRequirements -> Cardano.Api.Internal.Experimental.Witness.TxScriptWitnessRequirements
      - Cardano.Api.Genesis.Internal.Parameters -> Cardano.Api.Internal.GenesisParameters
      - Cardano.Api.Genesis.Internal -> Cardano.Api.Internal.Genesis
      - Cardano.Api.Governance.Internal.Action.ProposalProcedure -> Cardano.Api.Internal.Governance.Actions.ProposalProcedure
      - Cardano.Api.Governance.Internal.Action.VotingProcedure -> Cardano.Api.Internal.Governance.Actions.VotingProcedure
      - Cardano.Api.Governance.Internal.Metadata.Anchor -> Cardano.Api.Internal.Anchor
      - Cardano.Api.Governance.Internal.Metadata.DrepRegistration -> Cardano.Api.Internal.Governance.Metadata.DrepRegistration
      - Cardano.Api.Governance.Internal.Metadata.GovAction -> Cardano.Api.Internal.Governance.Metadata.GovAction
      - Cardano.Api.Governance.Internal.Metadata.Validation -> Cardano.Api.Internal.Governance.Metadata.Validation
      - Cardano.Api.Governance.Internal.Poll -> Cardano.Api.Internal.Governance.Poll
      - Cardano.Api.IO.Internal.Compat.Posix -> Cardano.Api.Internal.IO.Compat.Posix
      - Cardano.Api.IO.Internal.Compat.Win32 -> Cardano.Api.Internal.IO.Compat.Win32
      - Cardano.Api.IO.Internal.Compat -> Cardano.Api.Internal.IO.Compat
      - Cardano.Api.IO.Internal.Base -> Cardano.Api.Internal.IO.Base
      - Cardano.Api.IO -> Cardano.Api.Internal.IO
      - Cardano.Api.Key.Internal -> Cardano.Api.Internal.Keys.Shelley
      - Cardano.Api.Key.Internal.Class -> Cardano.Api.Internal.Keys.Class
      - Cardano.Api.Key.Internal.Mnemonic -> Cardano.Api.Internal.Keys.Mnemonics
      - Cardano.Api.Key.Internal.Praos -> Cardano.Api.Internal.Keys.Praos
      - Cardano.Api.Key.Internal.SomeAddressVerificationKey -> Cardano.Api.Internal.Keys.SomeAddressVerificationKey
      - Cardano.Api.Ledger.Internal.Reexport -> Cardano.Api.Internal.ReexposeLedger
      - Cardano.Api.LedgerState -> Cardano.Api.Internal.LedgerState
      - Cardano.Api.LedgerState.Internal.ConvertLedgerEvent -> Cardano.Api.Internal.LedgerEvents.ConvertLedgerEvent
      - Cardano.Api.LedgerState.Internal.LedgerEvent -> Cardano.Api.Internal.LedgerEvents.LedgerEvent
      - Cardano.Api.LedgerState.Internal.Rule.BBODY.DELEGS -> Cardano.Api.Internal.LedgerEvents.Rule.BBODY.DELEGS
      - Cardano.Api.LedgerState.Internal.Rule.BBODY.LEDGER -> Cardano.Api.Internal.LedgerEvents.Rule.BBODY.LEDGER
      - Cardano.Api.LedgerState.Internal.Rule.BBODY.UTXOW -> Cardano.Api.Internal.LedgerEvents.Rule.BBODY.UTXOW
      - Cardano.Api.LedgerState.Internal.Rule.TICK.RUPD -> Cardano.Api.Internal.LedgerEvents.Rule.TICK.RUPD
      - Cardano.Api.LedgerState.Internal.Rule.TICK.NEWEPOCH -> Cardano.Api.Internal.LedgerEvents.Rule.TICK.NEWEPOCH
      - Cardano.Api.Network.Internal.Reexport -> Cardano.Api.Internal.ReexposeNetwork
      - Cardano.Api.Network.Internal.NetworkId -> Cardano.Api.Internal.NetworkId
      - Cardano.Api.Network.IPC.Internal.ChainSync.ClientPipelined -> Cardano.Api.ChainSync.ClientPipelined
      - Cardano.Api.Network.IPC.Internal.ChainSync.Client -> Cardano.Api.ChainSync.Client
      - Cardano.Api.Network.IPC.Internal.Monad -> Cardano.Api.Internal.IPC.Monad
      - Cardano.Api.Network.IPC.Internal.Version -> Cardano.Api.Internal.IPC.Version
      - Cardano.Api.Network.IPC.Internal -> Cardano.Api.Internal.IPC
      - Cardano.Api.Plutus.Internal -> Cardano.Api.Internal.Plutus
      - Cardano.Api.Plutus.Internal.ScriptData -> Cardano.Api.Internal.ScriptData
      - Cardano.Api.Plutus.Internal.Script -> Cardano.Api.Internal.Script
      - Cardano.Api.Serialise.Bech32 -> Cardano.Api.Internal.SerialiseBech32
      - Cardano.Api.Serialise.Cip129 -> Cardano.Api.Internal.CIP.Cip129
      - Cardano.Api.Serialise.Cbor.Canonical -> Cardano.Api.Internal.Serialise.Cbor.Canonical
      - Cardano.Api.Serialise.Cbor -> Cardano.Api.Internal.Serialise.Cbor
      - Cardano.Api.Serialise.DeserialiseAnyOf -> Cardano.Api.Internal.DeserialiseAnyOf
      - Cardano.Api.Serialise.Json -> Cardano.Api.Internal.SerialiseJSON
      - Cardano.Api.Serialise.Raw -> Cardano.Api.Internal.SerialiseRaw
      - Cardano.Api.Serialise.SerialiseUsing -> Cardano.Api.Internal.SerialiseUsing
      - Cardano.Api.Serialise.TextEnvelope.Internal -> Cardano.Api.Internal.SerialiseTextEnvelope
      - Cardano.Api.Serialise.TextEnvelope.Internal.Cddl -> Cardano.Api.Internal.SerialiseLedgerCddl
      - Cardano.Api.Query.Internal.Convenience -> Cardano.Api.Internal.Convenience.Query
      - Cardano.Api.Query.Internal.Expr -> Cardano.Api.Internal.Query.Expr
      - Cardano.Api.Query.Internal.Type.DebugLedgerState -> Cardano.Api.Internal.Query.Types
      - Cardano.Api.Query.Internal.Type.DelegationsAndRewards -> Cardano.Api.Internal.Rewards
      - Cardano.Api.Query.Internal.Type.QueryInMode -> Cardano.Api.Internal.Query
      - Cardano.Api.Tx.Internal.Body -> Cardano.Api.Internal.Tx.Body
      - Cardano.Api.Tx.Internal.Body.Lens -> Cardano.Api.Ledger.Lens
      - Cardano.Api.Tx.Internal.Convenience -> Cardano.Api.Internal.Convenience.Construction
      - Cardano.Api.Tx.Internal.Fee -> Cardano.Api.Internal.Fees
      - Cardano.Api.Tx.Internal.Sign -> Cardano.Api.Internal.Tx.Sign
      - Cardano.Api.Tx.Internal.BuildTxWith -> Cardano.Api.Internal.Tx.BuildTxWith
      - Cardano.Api.Tx.Internal.Output -> Cardano.Api.Internal.Tx.Output
      - Cardano.Api.Tx.Internal.TxIn -> Cardano.Api.Internal.TxIn
      - Cardano.Api.Tx.Internal.TxMetadata -> Cardano.Api.Internal.TxMetadata
      - Cardano.Api.Address -> Cardano.Api.Internal.Address
      - Cardano.Api.Block -> Cardano.Api.Internal.Block
      - Cardano.Api.Error -> Cardano.Api.Internal.Error
      - Cardano.Api.HasTypeProxy -> Cardano.Api.Internal.HasTypeProxy
      - Cardano.Api.Hash -> Cardano.Api.Internal.Hash
      - Cardano.Api.Monad.Error -> Cardano.Api.Internal.Monad.Error
      - Cardano.Api.Pretty -> Cardano.Api.Internal.Pretty
      - Cardano.Api.Pretty.Internal.ShowOf -> Cardano.Api.Internal.Via.ShowOf
      - Cardano.Api.UTxO -> Cardano.Api.Internal.Tx.UTxO
      - Cardano.Api.Value.Internal.Parser -> Cardano.Api.Internal.ValueParser
      - Cardano.Api.Value.Internal -> Cardano.Api.Internal.Value


# 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
   - refactoring    # QoL changes
  # - 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

This PR implements ADR 009 cardano api exports convention.

Related discussion about ADR-009:

ADR 9: cardano-api modules exports convention input-output-hk/cardano-node-wiki#63

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

refactor.hs

cardano-api/src/Cardano/Api/Internal/Utils.hs

Jimbo4350

LGTM 👍 . Can you include the list of renames in the description? This will make it easier to include the renames in the next node release.

This reverts commit d380768.

…n for changes from ADR-009

carbolymer self-assigned this May 14, 2025

github-advanced-security bot found potential problems May 14, 2025

View reviewed changes

refactor.hs Fixed Show fixed Hide fixed

carbolymer force-pushed the mgalazyn/refactor/rename-modules branch 3 times, most recently from 290fd3d to 6bef0e2 Compare May 14, 2025 13:08

carbolymer force-pushed the mgalazyn/refactor/rename-modules branch 2 times, most recently from f025e72 to 652fa8f Compare May 21, 2025 14:53

github-advanced-security bot found potential problems May 21, 2025

View reviewed changes

refactor.hs Fixed Show fixed Hide fixed

carbolymer force-pushed the mgalazyn/refactor/rename-modules branch 10 times, most recently from 5273cee to 229d88a Compare June 5, 2025 18:05

github-advanced-security bot found potential problems Jun 5, 2025

View reviewed changes

carbolymer force-pushed the mgalazyn/refactor/rename-modules branch 11 times, most recently from 5048144 to 053dd35 Compare June 6, 2025 17:17

carbolymer requested review from CarlosLopezDeLara, disassembler, kevinhammond, newhoggy and palas as code owners June 6, 2025 17:26

Jimbo4350 approved these changes Jun 9, 2025

View reviewed changes

carbolymer force-pushed the mgalazyn/refactor/rename-modules branch 2 times, most recently from cf41fd3 to 6564139 Compare June 9, 2025 13:27

REMOVEME: Add module rename script

d380768

carbolymer force-pushed the mgalazyn/refactor/rename-modules branch 7 times, most recently from 0cc8bc6 to c3bb509 Compare June 9, 2025 17:55

carbolymer added 2 commits June 10, 2025 07:25

Revert "REMOVEME: Add module rename script"

c01cf14

This reverts commit d380768.

Remove Cardano.Api.Shelley. Add new aggregating modules in preparatio…

2e35406

…n for changes from ADR-009

carbolymer force-pushed the mgalazyn/refactor/rename-modules branch from c3bb509 to 7801a45 Compare June 10, 2025 05:34

carbolymer enabled auto-merge June 10, 2025 05:35

carbolymer added 2 commits June 10, 2025 07:41

Rename modules according to ADR-009

334163a

Add refactoring commits to .git-blame-ignore-revs

daeff22

carbolymer force-pushed the mgalazyn/refactor/rename-modules branch from 7801a45 to daeff22 Compare June 10, 2025 05:41

carbolymer added this pull request to the merge queue Jun 10, 2025

Merged via the queue into master with commit 95b9805 Jun 10, 2025
27 checks passed

carbolymer deleted the mgalazyn/refactor/rename-modules branch June 10, 2025 06:29

carbolymer linked an issue Jun 10, 2025 that may be closed by this pull request

Reorganise modules according to ADR-009 #810

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refactor: rename module structure accordingly to ADR-009 #840

Refactor: rename module structure accordingly to ADR-009 #840

Uh oh!

carbolymer commented May 14, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Jimbo4350 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Refactor: rename module structure accordingly to ADR-009 #840

Refactor: rename module structure accordingly to ADR-009 #840

Uh oh!

Conversation

carbolymer commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Context

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Jimbo4350 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

carbolymer commented May 14, 2025 •

edited

Loading