Address reviews

- Merge cabal.project files remove hie.yaml and update base constraint
- Import `project-config` and fix compilation errors and format
- Fix for CI errors
- Fix type synonym
- Split `Cardano.Wasm.JavaScirpt.Bridge` in two and remove obsolete
functions
- Add `HasCallStack` to `addSimpleTxOutImpl`
- Evaluate exceptions eagerly in IO
- Reorganise modules

Rename build-complete so that it is not required and disable schedule

Rename CI action for consistency

Co-authored-by: Mateusz Galazyn <[email protected]>

Add clarifying comment about disabled cache and generalise authors

Move internal modules to `Internal` package

Simplify folder creation in README.md

Co-authored-by: Mateusz Galazyn <[email protected]>

Rename `APIInfo` to `ApiInfo`

Use `MonadThrow` in partial functions

Author: palas

.github/bin/check-git-dependencies

@@ -23,7 +23,7 @@ commits () {
   done
 }
 
-grep '\(^source-repository-package\|^ *location:\|^ *tag:\)' cabal.project | sed 's|^source-repository-package|-|g' | \
+cat cabal.project | sed '/-- WASM compilation specific/q' | grep '\(^source-repository-package\|^ *location:\|^ *tag:\)' - | sed 's|^source-repository-package|-|g' | \
   yq eval -P -j \
   > tmp/repositories.json
 

.github/workflows/haskell-wasm.yml

@@ -1,4 +1,4 @@
-name: Compile to WASM
+name: Haskell CI (WASM)
 
 on:
   merge_group:
@@ -10,8 +10,8 @@ on:
       - master
   # GH caches are removed when not accessed within 7 days - this schedule runs the job every 6 days making
   # sure that we always have some caches on master
-  schedule:
-    - cron: '0 0 */6 * *'
+#  schedule:
+#    - cron: '0 0 */6 * *'
 
 jobs:
   build:
@@ -68,32 +68,35 @@ jobs:
 
     - name: Cabal update
       run: |
-        cd cardano-wasm
         wasm32-wasi-cabal update
 
     # 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: |
-        cd cardano-wasm
-        wasm32-wasi-cabal build all --dry-run
+        wasm32-wasi-cabal build cardano-wasm --dry-run
 
     # From the install plan we generate a dependency list.
     - name: Record dependencies
       id: record-deps
       run: |
-        cd cardano-wasm
         cat dist-newstyle/cache/plan.json | jq -r '."install-plan"[] | select(.style != "local") | .id' | sort | uniq > dependencies.txt
 
     - name: Store month number as environment variable used in cache version
       run: |
-        cd cardano-wasm
         cat <<EOF >> $GITHUB_ENV
         MONTHNUM=$(date -u '+%m')
         GHC=$(ghc --numeric-version)
         STORE=$(wasm32-wasi-cabal path --store | tail -n 1)
         EOF
 
+# Cache is disabled because GHA default builders are not able to build all dependencies
+# because they lack RAM, so having the cache expire would break the CI check.
+# For this reason, we are providing a build of the dependencies instead in
+# the "Restore cached deps" step, and we make the check not required.
+# When we are able to make this CI check self-sufficient, we should reenable the
+# caching and remove the manual restoring of cached deps.
+
     # 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.
@@ -103,15 +106,14 @@ jobs:
 #      with:
 #        path: |
 #          ${{ env.STORE }}
-#          cardano-wasm/dist-newstyle
+#          dist-newstyle
 #        key:
 #          wasm-cache-${{ env.CABAL_CACHE_VERSION }}-${{ runner.os }}-${{ env.GHC }}-${{ hashFiles('cardano-wasm/dependencies.txt') }}
 #        restore-keys: |
 #          wasm-cache-${{ env.CABAL_CACHE_VERSION }}-${{ runner.os }}-${{ env.GHC }}-
 
     - name: Restore cached deps
       run: |
-        cd cardano-wasm
         wget "https://agrius.feralhosting.com/palas/wasm-cache/4c200033737be4736cd2a363d64c49a385937d5ea57d8e52773f65d08bbd1342.tar.bz2"
         tar -jxf 4c200033737be4736cd2a363d64c49a385937d5ea57d8e52773f65d08bbd1342.tar.bz2
         rm -fr ~/.ghc-wasm/.cabal/store/
@@ -122,8 +124,7 @@ jobs:
     # cache it for the next step.
     - name: Install dependencies
       run: |
-        cd cardano-wasm
-        wasm32-wasi-cabal build all --only-dependencies --no-semaphore -j1 --ghc-options="-j1"
+        wasm32-wasi-cabal build cardano-wasm --only-dependencies --no-semaphore -j1 --ghc-options="-j1"
 
     # Always store the cabal cache.
 #    - name: Cache Cabal store
@@ -132,15 +133,14 @@ jobs:
 #      with:
 #        path: |
 #          ${{ env.STORE }}
-#          cardano-wasm/dist-newstyle
+#          dist-newstyle
 #        key:
 #          ${{ steps.cache.outputs.cache-primary-key }}
 
     # Now we build.
     - name: Build all
       run: |
-        cd cardano-wasm
-        wasm32-wasi-cabal build all --no-semaphore -j1 --ghc-options="-j1"
+        wasm32-wasi-cabal build cardano-wasm --no-semaphore -j1 --ghc-options="-j1"
 
     # - name: Run tests
     #   env:
@@ -166,7 +166,7 @@ jobs:
     #  with:
     #     limit-access-to-actor: true
 
-  build-complete:
+  wasm-builds-complete:
     needs: [build]
     if: ${{ always() }}
     runs-on: ubuntu-latest

cabal.project

@@ -19,6 +19,7 @@ index-state:
 packages:
     cardano-api
     cardano-api-gen
+    cardano-wasm
 
 extra-packages: Cabal, process
 
@@ -59,3 +60,94 @@ if impl (ghc >= 9.12)
     -- https://github.com/kapralVV/Unique/issues/11
     , Unique:hashable
 
+-- WASM compilation specific
+
+if arch(wasm32)
+  source-repository-package
+    type: git
+    location: https://github.com/amesgen/plutus.git
+    tag: dc1edea4458d6fb794b245a26c730620265645f3
+    subdir:
+      plutus-core
+      plutus-ledger-api
+      plutus-tx
+    --sha256: sha256-QBtLmoS54b5QMAKIDOJIM6lmRC+1leBpuGKaFc7QQos=
+
+  package plutus-core
+    flags: +do-not-build-plutus-exec
+
+  source-repository-package
+    type: git
+    location: https://github.com/haskell-wasm/hs-memory.git
+    tag: a198a76c584dc2cfdcde6b431968de92a5fed65e
+    --sha256: sha256-LRC3L+J921+/moZS7F17vCfM/4usYy/eMR+w/mXsjeA=
+
+  source-repository-package
+    type: git
+    location: https://github.com/palas/ouroboros-network.git
+    tag: ef3e30603e4e45dac336a085114ee22b7aa8c9ed
+    subdir:
+      ouroboros-network
+      ouroboros-network-framework
+    --sha256: sha256-+IdAmWJqzRy+erKONywtk+5YLrm63q942nZavoEA4E4=
+
+  source-repository-package
+    type: git
+    location: https://github.com/palas/criterion.git
+    tag: dd160d2b5f051e918e72fe1957d77905682b8d6c
+    subdir:
+      criterion-measurement
+    --sha256: sha256-wzEwOUTeFL0C3QnS25/3X1ue2tUuedrLqtT0h1JZW6c=
+
+  source-repository-package
+    type: git
+    location: https://github.com/palas/haskell-lmdb-mock.git
+    tag: c8d61e6eee03ee271e7768c0576110da885aec48
+    --sha256: sha256-+gB1MmM6qRApz1p7tFsdvKoAWDrYB4a+bJ9Djm6ieYI=
+
+  source-repository-package
+    type: git
+    location: https://github.com/palas/double-conversion.git
+    tag: b2030245727ee56de76507fe305e3741f6ce3260
+    --sha256: sha256-kzwHHQzHPfPnIDtnSDAom7YGSzWjr0113x0zsfI/Tb0=
+
+  source-repository-package
+    type: git
+    location: https://github.com/amesgen/cborg
+    tag: 2dff24d241d9940c5a7f5e817fcf4c1aa4a8d4bf
+    subdir: cborg
+    --sha256: sha256-yuz1apKQ0EB9LtJkc/I1EEtB4oZnURMvCckvdFbT6qM=
+
+  source-repository-package
+    type: git
+    location: https://github.com/Jimbo4350/foundation.git
+    tag: b3cb78484fe6f6ce1dfcef59e72ceccc530e86ac
+    subdir:
+      basement
+      foundation
+    --sha256: sha256-QKKHl/XocxGD7bwAoGe7VaIg9o8x4dA20j3sJOgiTBw=
+
+  source-repository-package
+    type: git
+    location: https://github.com/palas/mempack.git
+    tag: 0211addbbbf51011e5348d3696566eb12ccbef07
+    --sha256: sha256-iLc+foF2AM3vG6deuZ51+faI6buMkubMP75md51hMe8=
+
+  source-repository-package
+    type: git
+    location: https://github.com/haskell-wasm/network
+    tag: ab92e48e9fdf3abe214f85fdbe5301c1280e14e9
+    --sha256: sha256-U+ln/gbXoQZpNjZHydNa0FG/9GdJFgL1+T3+7KTzDWo=
+
+  package cardano-crypto-praos
+    flags: -external-libsodium-vrf
+
+  package atomic-counter
+    flags: +no-cmm
+
+  constraints: time installed
+  allow-newer: time
+
+  package crypton
+    ghc-options: -optc-DARGON2_NO_THREADS
+

cardano-api/cardano-api.cabal

@@ -38,7 +38,7 @@ common project-config
     -Wunused-packages
 
 common maybe-unix
-  if !os(windows)
+  if !(os(windows)|| arch(wasm32))
     build-depends: unix
 
 common maybe-Win32
@@ -236,6 +236,7 @@ library
     Cardano.Api.IO.Internal.Base
     Cardano.Api.IO.Internal.Compat
     Cardano.Api.IO.Internal.Compat.Posix
+    Cardano.Api.IO.Internal.Compat.Wasm
     Cardano.Api.IO.Internal.Compat.Win32
     Cardano.Api.Internal.Orphans
     Cardano.Api.Internal.Orphans.Misc

cardano-api/src/Cardano/Api/IO/Internal/Compat.hs

@@ -11,6 +11,7 @@ where
 import Cardano.Api.Error
 import Cardano.Api.IO.Internal.Base
 import Cardano.Api.IO.Internal.Compat.Posix
+import Cardano.Api.IO.Internal.Compat.Wasm
 import Cardano.Api.IO.Internal.Compat.Win32
 
 import Control.Monad.Except (ExceptT)

cardano-api/src/Cardano/Api/IO/Internal/Compat/Posix.hs

@@ -1,7 +1,7 @@
 {-# LANGUAGE CPP #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 
-#if !defined(mingw32_HOST_OS)
+#if !defined(mingw32_HOST_OS) && !defined(wasm32_HOST_ARCH)
 #define UNIX
 #endif
 

cardano-api/src/Cardano/Api/IO/Internal/Compat/Wasm.hs

@@ -0,0 +1,40 @@
+{-# LANGUAGE CPP #-}
+
+#if defined(wasm32_HOST_ARCH)
+#define WASM
+#endif
+
+module Cardano.Api.IO.Internal.Compat.Wasm
+  (
+#ifdef WASM
+    checkVrfFilePermissionsImpl
+  , handleFileForWritingWithOwnerPermissionImpl
+  , writeSecretsImpl
+#endif
+  )
+where
+
+#ifdef WASM
+
+import           Cardano.Api.Error (FileError (..))
+import           Cardano.Api.IO.Internal.Base
+import           Control.Monad.Except (ExceptT)
+import           Data.ByteString (ByteString)
+import           System.IO (Handle)
+
+handleFileForWritingWithOwnerPermissionImpl
+  :: FilePath
+  -> (Handle -> IO ())
+  -> IO (Either (FileError e) ())
+handleFileForWritingWithOwnerPermissionImpl _path _f = return $ Right () -- Dummy implementation for WASM
+
+writeSecretsImpl :: FilePath -> [Char] -> [Char] -> (a -> ByteString) -> [a] -> IO ()
+writeSecretsImpl _outDir _prefix _suffix _secretOp _xs = return () -- Dummy implementation for WASM
+
+-- | Make sure the VRF private key file is readable only
+-- by the current process owner the node is running under.
+checkVrfFilePermissionsImpl
+  :: File content direction -> ExceptT VRFPrivateKeyFilePermissionError IO ()
+checkVrfFilePermissionsImpl _vrfPrivKeyFile = return () -- Dummy implementation for WASM
+
+#endif

cardano-wasm/README.md

@@ -1,6 +1,6 @@
 # cardano-wasm
 
-Part of an effort at IOG (@Jimbo4350, @palas, and @amesgen) to build Cardano Haskell libraries to Wasm.
+Part of an effort at IOG to build Cardano Haskell libraries to Wasm.
 
 ## Building the wasm module
 
@@ -45,9 +45,7 @@ Then we need to compile three libraries to WASM: `libblst`, `libsodium`, and `li
 In order to not interfere with the system library installation, we will create a folder to serve as our prefix:
 
 ```console
-mkdir ~/prefix
-mkdir ~/prefix/{lib,include}
-mkdir ~/prefix/lib/pkgconfig
+mkdir -p ~/prefix/{lib/pkgconfig,include}
 ```
 
 #### Installing `libblst`