Merge remote-tracking branch 'upstream/master'

Author: NanuIjaz

.github/workflows/github-page.yml

@@ -32,17 +32,17 @@ jobs:
 
     - name: Fetch nix cache and update cabal indices
       run: |
-        nix develop .\#project.x86_64-linux.projectVariants.ghc963.shell --command \
+        nix develop .\#project.x86_64-linux.projectVariants.ghc964.shell --command \
           cabal update
 
     - name: Build whole project
       run: |
-        nix develop .\#project.x86_64-linux.projectVariants.ghc963.shell --command \
+        nix develop .\#project.x86_64-linux.projectVariants.ghc964.shell --command \
           cabal build all
 
     - name: Build documentation
       run: |
-        nix develop .\#project.x86_64-linux.projectVariants.ghc963.shell --command \
+        nix develop .\#project.x86_64-linux.projectVariants.ghc964.shell --command \
           cabal haddock-project --local --output=./haddocks --internal --foreign-libraries
 
     - name: Compress haddocks

.github/workflows/haskell.yml

@@ -38,7 +38,7 @@ jobs:
 
     env:
       # Modify this value to "invalidate" the cabal cache.
-      CABAL_CACHE_VERSION: "2024-03-07"
+      CABAL_CACHE_VERSION: "2024-04-24"
 
     concurrency:
       group: >
@@ -87,67 +87,51 @@ jobs:
         echo "# cabal.project.local"
         cat cabal.project.local
 
+    # A dry run `build all` operation does *NOT* downlaod anything, it just looks at the package
+    # indices to generate an install plan.
     - name: Build dry run
-      run: |
-        cabal build all --dry-run --minimize-conflict-set
+      run: cabal build all --enable-tests --dry-run --minimize-conflict-set
 
-    # For users who fork cardano-node and want to define a writable cache, then can set up their own
-    # S3 bucket then define in their forked repository settings the following secrets:
-    #
-    #   AWS_ACCESS_KEY_ID
-    #   AWS_SECRET_ACCESS_KEY
-    #   BINARY_CACHE_URI
-    #   BINARY_CACHE_REGION
-    - name: Cabal cache over S3
-      uses: action-works/cabal-cache-s3@v1
-      env:
-        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+    # From the install plan we generate a dependency list.
+    - name: Record dependencies
+      id: record-deps
+      run: |
+        # The tests call out to msys2 commands. We generally do not want to mix toolchains, so
+        # we are very deliberate about only adding msys64 to the path where absolutely necessary.
+        ${{ (runner.os == 'Windows' && '$env:PATH=("C:\msys64\mingw64\bin;{0}" -f $env:PATH)') || '' }}
+        cat dist-newstyle/cache/plan.json | jq -r '."install-plan" | select(.style != "local") | .id' | sort | uniq > dependencies.txt
+
+    # From the dependency list we restore the cached dependencies.
+    # We use the hash of `dependencies.txt` as part of the cache key because that will be stable
+    # until the `index-state` values in the `cabal.project` file changes.
+    - name: Restore cached dependencies
+      uses: actions/cache/restore@v4
+      id: cache
       with:
-        region: ${{ vars.BINARY_CACHE_REGION }}
-        dist-dir: dist-newstyle
-        store-path: ${{ steps.setup-haskell.outputs.cabal-store }}
-        threads: ${{ vars.BINARY_CACHE_THREADS }}
-        archive-uri: ${{ vars.BINARY_CACHE_URI }}/${{ env.CABAL_CACHE_VERSION }}/${{ runner.os }}/${{ matrix.cabal }}/${{ matrix.ghc }}
-        skip: "${{ vars.BINARY_CACHE_URI == '' }}"
-
-    # It's important to ensure that people who fork this repository can not only successfully build in
-    # CI by default, but also have meaning cabal store caching.
-    #
-    # Because syncing with S3 requires credentials, we cannot rely on S3 for this. For this reason a
-    # https fallback is used. The https server mirrors the content of the S3 bucket. The https cabal
-    # store archive is read-only for security reasons.
-    #
-    # Users who fork this repository who want to have a writable cabal store archive are encouraged
-    # to set up their own S3 bucket.
-    - name: Cabal cache over HTTPS
-      uses: action-works/cabal-cache-s3@v1
+        path: |
+          ${{ steps.setup-haskell.outputs.cabal-store }}
+          dist-newstyle
+        key: cache-${{ env.CABAL_CACHE_VERSION }}-${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('dependencies.txt') }}
+
+    # Now we install the dependencies. If the cache was found and restored in the previous step,
+    # this should be a no-op, but if the cache key was not found we need to build stuff so we can
+    # cache it for the next step.
+    - name: Install dependencies
+      run: cabal build all --enable-tests --only-dependencies -j --ghc-option=-j4
+
+    # Always store the cabal cache.
+    # This can fail (benign failure) if there is already a hash at that key.
+    - name: Cache Cabal store
+      uses: actions/cache/save@v4
       with:
-        dist-dir: dist-newstyle
-        store-path: ${{ steps.setup-haskell.outputs.cabal-store }}
-        threads: ${{ vars.BINARY_CACHE_THREADS }}
-        archive-uri: https://iohk.cache.haskellworks.io/${{ env.CABAL_CACHE_VERSION }}/${{ runner.os }}/${{ matrix.cabal }}/${{ matrix.ghc }}
-        skip: "${{ vars.BINARY_CACHE_URI != '' }}"
-        enable-save: false
-
-    # The following seems like a duplicate but it is due to a bug in cabal which can sometimes
-    # cause build intermittent build failures on Windows, so we run the build twice.
-    #
-    # https://github.com/haskell/cabal/issues/9587
-    #
-    # TODO Remove the workaround when the cabal bug is fixed.
-    - name: Build core components
-      continue-on-error: true
-      run: |
-        cabal build cardano-node cardano-cli cardano-node-chairman cardano-submit-api -j1
+        path: |
+          ${{ steps.setup-haskell.outputs.cabal-store }}
+          dist-newstyle
+        key: cache-${{ env.CABAL_CACHE_VERSION }}-${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('dependencies.txt') }}
 
-    - name: Build core components
-      run: |
-        cabal build cardano-node cardano-cli cardano-node-chairman cardano-submit-api -j1
-
-    - name: Build remaining components
-      run: |
-        cabal build all
+    # Now we build.
+    - name: Build all
+      run: cabal build all --enable-tests
 
     - name: Run tests
       env:
@@ -168,7 +152,7 @@ jobs:
 
     - name: Upload workspaces on tests failure
       if: ${{ failure() }}
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: failed-test-workspaces-${{ matrix.os }}-ghc${{ matrix.ghc }}-cabal${{ matrix.cabal }}.tgz
         path: ${{ runner.temp }}/workspaces.tgz
@@ -198,7 +182,8 @@ jobs:
           find "${{ runner.temp }}/chairman" -type s -exec rm -f {} \;
         fi
 
-    - uses: actions/upload-artifact@v2
+    - name: Save Artifact
+      uses: actions/upload-artifact@v4
       if: ${{ always() }}
       continue-on-error: true
       with:
@@ -217,9 +202,9 @@ jobs:
     # and will silently fail if msys2 is not in path. See the "Run tests" step.
     #
     # - name: Setup tmate session
-    #   if: ${{ failure() }}
-    #   uses: mxschmitt/action-tmate@v3
-    #   with:
+    #  if: ${{ failure() }}
+    #  uses: mxschmitt/action-tmate@v3
+    #  with:
     #     limit-access-to-actor: true
 
   build-complete:

README.rst

@@ -40,12 +40,12 @@ Network Configuration, Genesis and Topology Files
 
 The latest supported networks can be found at `<https://book.world.dev.cardano.org/environments.html>`_
 
-****
+**************************
 Obtaining ``cardano-node``
-****
+**************************
 
 Building from source
-====
+====================
 
 Documentation for building the node can be found `here <https://docs.cardano.org/getting-started/installing-the-cardano-node>`_.
 
@@ -56,7 +56,7 @@ You can download the hydra binaries of ``cardano-node`` and ``cardano-cli`` from
 
 
 Running the node on Windows
-----
+---------------------------
 
 The download includes cardano-node.exe and a .dll. To run the node with cardano-node run you need to reference a few files and directories as arguments. These can be copied from the cardano-node repo into the executables directory. The command to run the node on mainnet looks like this:
 
@@ -73,12 +73,13 @@ You can pull the docker image with the latest version of cardano-node from `here
 
     docker pull inputoutput/cardano-node
 
-****
+**********************
 Using ``cardano-node``
-****
+**********************
 
 Command line summary: ``cardano-node``
-====
+======================================
+
 This refers to the client that is used for running a node.
 
 The general synopsis is as follows:
@@ -132,7 +133,7 @@ The general synopsis is as follows:
 * ``--validate-db`` - Flag to revalidate all on-disk database files
 
 Configuration
-====
+=============
 
 The ``--config`` flag points to a ``.yaml`` (or a structurally equivalent ``.json``) file that is responsible to configuring the logging & other important settings for the node. E.g. see the Byron mainnet configuration in this
 `configuration.yaml <https://github.com/intersectmbo/cardano-node/blob/master/configuration/defaults/byron-mainnet/configuration.yaml>`_.
@@ -148,9 +149,9 @@ Scripts
 
 Please see ``scripts/README.md`` for information on the various scripts.
 
-****
+*********************
 Using ``cardano-cli``
-****
+*********************
 
 A CLI utility to support a variety of key material operations (genesis, migration, pretty-printing..) for different system generations.
 Usage documentation can be found at ``https://github.com/input-output-hk/cardano-cli/tree/master/cardano-cli/README.md``.
@@ -165,7 +166,7 @@ The general synopsis is as follows:
 before ``cardano-cli``.  We henceforth assume that the necessary environment-specific adjustment has been made, so we only mention ``cardano-cli``.
 
 Command line options: ``cardano-cli``
-====
+=====================================
 
 The subcommands are subdivided in groups, and their full list can be seen in the output of ``cardano-cli --help``.
 
@@ -190,7 +191,7 @@ All subcommands have help available.  For example:
 
 
 Genesis generation
-====
+==================
 
 The Byron genesis generation operations will create a directory that contains:
 
@@ -421,9 +422,9 @@ Note: When developing locally, for any package you are working on, in **cabal.pr
 
 Otherwise GHC might complain about unused packages.
 
-****
+*************
 Native Tokens
-****
+*************
 
 Native tokens is a new feature that enables the transacting of multi-assets on Cardano. Native tokens are now supported on mainnet and users can transact with ada, and an unlimited number of user-defined (custom) tokens natively. Note that users who do not need to create new assets (“token holders”) will be able to send and receive existing multi-asset tokens using a wallet such as Daedalus or Yoroi, and with no requirement to use any CLI commands.
 
@@ -439,33 +440,33 @@ To help you get started, see:
 
 To start, please ensure that you are familiar with setting up and operating the `Cardano node <https://github.com/intersectmbo/cardano-node>`_. Alternatively, see instructions on how to `start your node <https://github.com/input-output-hk/cardano-node-wiki/wiki/2_start_your_nodes>`_ to submit the commands. You will not need to set up and start a full block producing node ('stake pool'), just a much simpler relay node. This node will need to connect to a Cardano network that is capable of processing native tokens (e.g., the native token pre-production environment (PPE), or the Cardano mainnet).
 
-****
+*****************
 API Documentation
-****
+*****************
 
 The API documentation is published `here <https://cardano-node.cardano.intersectmbo.org/>`_.
 
 The documentation is built with each push, but is only published from ``master`` branch.  In order to
 test if the documentation is working, build the documentation locally with ``cabal haddock-project --local --output=./haddocks`` and
 open ``haddocks/index.html`` in the browser.
 
-****
+*******************************************
 Using the ``cardano-node`` Haskell packages
-****
+*******************************************
 
 If you want to use the ``cardano-node`` Haskell packages from another project, you should use `CHaP <https://github.com/input-output-hk/cardano-haskell-packages>`_ to get the packages defined in this repository.
 Please note that you may need to use any ``source-repository-package`` stanzas defined in ``cabal.project``, although we will endeavour to keep these to an absolute minimum.
 
-****
+***********
 Style guide
-****
+***********
 
 The `style guide <https://github.com/input-output-hk/cardano-node-wiki/wiki/Style-guide>`_ for can be found
 on the `cardano-node repository's wiki <https://github.com/input-output-hk/cardano-node-wiki/wiki>`_.
 
-****
+***************************************
 Troubleshooting ``cardano-node`` issues
-****
+***************************************
 
 For some troubleshooting help with building or running ``cardano-node``, the wiki has a
 `troubleshooting page <https://github.com/input-output-hk/cardano-node-wiki/wiki/Troubleshooting>`_

bench/locli/locli.cabal

@@ -101,7 +101,7 @@ library
                       , attoparsec
                       , attoparsec-iso8601
                       , bytestring
-                      , cardano-git-rev
+                      , cardano-git-rev ^>= 0.2.2
                       , cardano-ledger-core
                       , cardano-prelude
                       , cardano-slotting
@@ -121,7 +121,7 @@ library
                       , optparse-generic
                       , ouroboros-consensus
                       -- for Data.SOP.Strict:
-                      , ouroboros-network ^>= 0.12
+                      , ouroboros-network ^>= 0.13
                       , ouroboros-network-api
                       , process
                       , quiet

bench/locli/src/Cardano/Analysis/API/LocliVersion.hs

@@ -1,4 +1,5 @@
 {-# LANGUAGE DeriveAnyClass #-}
+{-# LANGUAGE TemplateHaskell #-}
 module Cardano.Analysis.API.LocliVersion (module Cardano.Analysis.API.LocliVersion) where
 
 import Cardano.Prelude (NFData, mconcat)
@@ -22,7 +23,7 @@ data LocliVersion =
 getLocliVersion :: LocliVersion
 getLocliVersion =
   LocliVersion
-    Cardano.Git.Rev.gitRev
+    $(Cardano.Git.Rev.gitRev)
     (pack (showVersion Paths_locli.version))
 
 renderProgramAndVersion :: LocliVersion -> Text

bench/locli/src/Cardano/Analysis/API/Types.hs

@@ -443,8 +443,8 @@ testSlotStats :: Genesis -> SlotStats a -> SlotCond -> Bool
 testSlotStats g SlotStats{..} = \case
   SlotGEq  s -> slSlot >= s
   SlotLEq  s -> slSlot <= s
-  EpochGEq s -> fromIntegral (unEpochNo slEpoch) >= s
-  EpochLEq s -> fromIntegral (unEpochNo slEpoch) <= s
+  EpochGEq s -> slEpoch >= s
+  EpochLEq s -> slEpoch <= s
   SlotHasLeaders -> slCountLeads > 0
   EpochSafeIntGEq i -> slEpochSafeInt >= i
   EpochSafeIntLEq i -> slEpochSafeInt <= i

bench/locli/src/Cardano/Analysis/MachPerf.hs

@@ -74,7 +74,7 @@ timelineFromLogObjects run@Run{genesis} (f, xs') =
    zeroSlotStats =
      SlotStats
      { slSlot = impliedSlot genesis firstRelevantLogObjectTime
-     , slEpoch = 0
+     , slEpoch = EpochNo 0
      , slEpochSlot = 0
      , slEpochSafeInt = 0
      , slStart = SlotStart firstRelevantLogObjectTime

bench/plutus-scripts-bench/plutus-scripts-bench.cabal

@@ -73,10 +73,10 @@ library
   -- IOG dependencies
   --------------------------
   build-depends:
-    , cardano-api             ^>= 8.39.2.0
+    , cardano-api             ^>= 8.44
     , plutus-ledger-api       >=1.0.0
     , plutus-tx               >=1.0.0
-    , plutus-tx-plugin        ^>=1.21
+    , plutus-tx-plugin        ^>=1.23
 
   ------------------------
   -- Non-IOG dependencies