PLT-8097 create marconi-cardano-chain-index (#273)

Author: brendanrbrown

.github/workflows/haddock.yml

@@ -25,15 +25,21 @@ jobs:
           nix develop --command bash -c '
               cabal update
               cabal haddock marconi-core
-              cabal haddock marconi-chain-index:lib:marconi-chain-index
+              cabal haddock marconi-cardano-core:lib:marconi-cardano-core
+              cabal haddock marconi-cardano-indexers:lib:marconi-cardano-indexers
+              cabal haddock marconi-cardano-chain-index:lib:marconi-cardano-chain-index
               cabal haddock marconi-core-json-rpc
             '
           mkdir dist
           mkdir dist/marconi-core
-          mkdir dist/marconi-chain-index
+          mkdir dist/marconi-cardano-core
+          mkdir dist/marconi-cardano-indexers
+          mkdir dist/marconi-cardano-chain-index
           mkdir dist/marconi-core-json-rpc
           cp -RL ./dist-newstyle/build/x86_64-linux/ghc-9.2.8/marconi-core-1.2.0.0/doc/html/marconi-core/* ./dist/marconi-core
-          cp -RL ./dist-newstyle/build/x86_64-linux/ghc-9.2.8/marconi-chain-index-1.2.0.0/doc/html/marconi-chain-index/* ./dist/marconi-chain-index
+          cp -RL ./dist-newstyle/build/x86_64-linux/ghc-9.2.8/marconi-cardano-core-1.2.0.0/doc/html/marconi-cardano-core/* ./dist/marconi-cardano-core
+          cp -RL ./dist-newstyle/build/x86_64-linux/ghc-9.2.8/marconi-cardano-indexers-1.2.0.0/doc/html/marconi-cardano-indexers/* ./dist/marconi-cardano-indexers
+          cp -RL ./dist-newstyle/build/x86_64-linux/ghc-9.2.8/marconi-cardano-chain-index-1.2.0.0/doc/html/marconi-cardano-chain-index/* ./dist/marconi-cardano-chain-index
           cp -RL ./dist-newstyle/build/x86_64-linux/ghc-9.2.8/marconi-core-json-rpc-1.2.0.0/doc/html/marconi-core-json-rpc/* ./dist/marconi-core-json-rpc
       - uses: JamesIves/github-pages-deploy-action@v4
         with:

README.adoc

@@ -31,15 +31,15 @@ The more in-depth user documentation is available in our http://example.com/TODO
 The Haskell API documentation (Haddock) for the Marconi libraries is hosted here:
 
 * https://input-output-hk.github.io/marconi/main/marconi-core[marconi-core]
-* https://input-output-hk.github.io/marconi/main/marconi-chain-index[marconi-chain-index]
+* https://input-output-hk.github.io/marconi/main/marconi-cardano-chain-index[marconi-cardano-chain-index]
 * https://input-output-hk.github.io/marconi/main/marconi-core-json-rpc[marconi-core-json-rpc]
 
 You may generate them directly with `Cabal` for each component:
 
 ```
 cabal haddock marconi-core
 cabal haddock marconi-core-json-rpc
-cabal haddock marconi-chain-index
+cabal haddock marconi-cardano-chain-index
 ```
 
 [[Architecture]]

benchmark/README.md

@@ -5,7 +5,7 @@ Steps on running `prometheus` and `grafana` locally:
 * Change the `enable` of `start-benchmark-machine` in `shell.nix` to `true`
 * Open a Nix shell with `nix develop`
 * Run `cardano-node`
-* Run `marconi-sidechain` (or `marconi-chain-index`) on port 8090
+* Run `marconi-sidechain` (or `marconi-cardano-chain-index`) on port 8090
 * Run `start-benchmark-machine local` (available in the Nix shell)
 * Go to `http://localhost:8080` on your web browser.
 * Log in with `admin` as username and password.

cabal.project

@@ -17,7 +17,7 @@ index-state:
   , cardano-haskell-packages 2023-12-06T19:40:56Z
 packages: legacy/marconi-core-legacy
           legacy/marconi-chain-index-legacy
-          marconi-chain-index
+          marconi-cardano-chain-index
           marconi-core
           marconi-cardano-core
           marconi-cardano-indexers

doc/read-the-docs-site/adr/0003-observability.rst

@@ -19,7 +19,7 @@ Context
 -------
 
 Whenever we add new features in Marconi, we inevitably end up in a state where we introduce a significant regression in sync time, CPU/RAM/Disk usage and query performance.
-Currently, developers who are adding new features will typically test those features by running ``marconi-chain-index`` or ``marconi-sidechain``, and manually visualize the CPU/RAM usage by running ``htop`` (or similar), checking syncing speed by reading the logs, and manually run queries after syncing is done.
+Currently, developers who are adding new features will typically test those features by running ``marconi-cardano-chain-index`` or ``marconi-sidechain``, and manually visualize the CPU/RAM usage by running ``htop`` (or similar), checking syncing speed by reading the logs, and manually run queries after syncing is done.
 However, that approach does not give accurate information for detecting regressions, because we only look at the logs at specific points in time and we might miss peaks in memory usage for example.
 Moreover, this testing approach does not scale for delivering on time the different features.
 

doc/read-the-docs-site/adr/0004-marconi-sidechain-testing-strategy.rst

@@ -19,7 +19,7 @@ Context
 -------
 
 A general approach to functional testing Marconi-Sidechains covering all test levels.
-The scope of this document is `marconi-sidechain`, not other Marconi applications such as `marconi-chain-index`.
+The scope of this document is `marconi-sidechain`, not other Marconi applications such as `marconi-cardano-chain-index`.
 
 Decision
 --------
@@ -43,7 +43,7 @@ Decision
 UNIT TESTING:
 
 * We will test indexers and filters with as many positive and negative combinations as possible using data-driven and property tests.
-  However, it is not currently possible to test all parts in this way, such as the chain sync client, so we will lean more on the `cardano-node-emulator` to generate valid transactions for thorough testing in this area at the integration test level. 
+  However, it is not currently possible to test all parts in this way, such as the chain sync client, so we will lean more on the `cardano-node-emulator` to generate valid transactions for thorough testing in this area at the integration test level.
   .  To support this, we will produce a generator to act like a "mockchain" to generate a variety of: blocks, transations and roll forward/backward events.
 
 * We will only test functions and modules at lower layers to the CLI or RPC and not aim to cover these interfaces because we will get greater coverage of those with the integration tests.
@@ -72,7 +72,7 @@ END-TO-END TESTING:
 * We will sometimes perform exploratory testing on major features, such as new RPC methods or cli options.
   This can provide faster feedback in lieu of automation testing being produced.
   Should not be carried out by the engineer who implemented the feature (due to assumption bias).
-    
+
 * We will produce tests for each of the RPC API methods to stress the filters.
   These tests will assert against known correct response content.
   These tests will ideally be run on mainnet because there is more interesting transaction data there and so are more likely to catch an edge-case.
@@ -107,7 +107,7 @@ Argument
 
 Alternative solutions
 ---------------------
-When testing marconi-chain-index we can take a similar approach but must also:
+When testing marconi-cardano-chain-index we can take a similar approach but must also:
   - test starting the application with the CLI's disable flags:
     - end-to-end test to check absence of db file being created after run
     - property test to randomise combinations

doc/read-the-docs-site/doc/marconi-as-a-library/tutorials/BasicApp.hs

@@ -40,6 +40,7 @@ import Cardano.Api qualified as C
 import Cardano.BM.Setup qualified as Trace
 import Cardano.BM.Tracing qualified as Trace
 import Data.Void (Void)
+import Marconi.Cardano.ChainIndex.Utils qualified as Utils
 import Marconi.Cardano.Core.Logger (mkMarconiTrace)
 import Marconi.Cardano.Core.Node.Client.Retry qualified as Core
 import Marconi.Cardano.Core.Orphans ()
@@ -51,7 +52,6 @@ import Marconi.Cardano.Core.Types (
   SecurityParam,
  )
 import Marconi.Cardano.Indexers.SyncHelper qualified as Core
-import Marconi.ChainIndex.Utils qualified as Utils
 import Marconi.Core qualified as Core
 import Marconi.Core.JsonRpc qualified as Core
 import Network.JsonRpc.Types (JsonRpc, RawJsonRpc)

doc/read-the-docs-site/doc/marconi-cardano-chain-index/index.rst

@@ -0,0 +1,9 @@
+Running `marconi-cardano-chain-index`
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+
+   overview
+   quickstart
+   openapi-spec