Merge pull request #1447 from Concordium/plt-merge

Merge the PLT feature branch

Author: td202

.github/workflows/build-test.yaml

@@ -21,7 +21,8 @@ name: Check formatting, build and run tests
 
 on:
   push:
-    branches: main
+    branches:
+        - main
     paths:
     - '.github/workflows/build-test.yaml'
     - '**/Cargo.toml'
@@ -35,7 +36,8 @@ on:
     - 'concordium-node/rustfmt.toml'
 
   pull_request:
-    branches: main
+    branches:
+        - main
     types: [opened, synchronize, reopened, ready_for_review]
     paths:
     - '.github/workflows/build-test.yaml'
@@ -51,9 +53,8 @@ on:
   workflow_dispatch: # allow manual trigger
 
 env:
-  dummy: 16                 # change to force cache invalidation
+  dummy: 17                # change to force cache invalidation
   CARGO_TERM_COLOR: always # implicitly adds '--color=always' to all cargo commands
-  TEST_LEVEL: 1            # for stack tests
 
 jobs:
 
@@ -65,9 +66,16 @@ jobs:
     - name: Download fourmolu
       uses: supplypike/setup-bin@v1
       with:
-        uri: 'https://github.com/fourmolu/fourmolu/releases/download/v0.13.1.0/fourmolu-0.13.1.0-linux-x86_64'
+        uri: 'https://github.com/fourmolu/fourmolu/releases/download/v0.18.0.0/fourmolu-0.18.0.0-linux-x86_64'
         name: 'fourmolu'
-        version: '0.13.1.0'
+        version: '0.18.0.0'
+    
+    - name: Download hpack
+      run: |
+        curl -L https://github.com/sol/hpack/releases/download/0.38.1/hpack_linux.gz -o hpack.gz
+        gunzip hpack.gz
+        chmod +x hpack
+        mv hpack /usr/local/bin/
 
     - name: Checkout project
       uses: actions/checkout@v2
@@ -78,7 +86,8 @@ jobs:
     # needed to generate a cabal file from the package.yaml.
     - name: Setup the project
       run: |
-        stack --stack-yaml concordium-consensus/stack.yaml setup
+        cd concordium-consensus
+        hpack package.yaml
 
     - name: Run fourmolu
       run: |
@@ -126,7 +135,7 @@ jobs:
       matrix:
         plan:
         - rust: 1.82
-          ghc: 9.6.6
+          ghc: 9.10.2
 
     steps:
     - name: Remove unnecessary files
@@ -141,13 +150,9 @@ jobs:
     - name: Install system packages and protoc
       run: |
         sudo apt-get update && sudo apt-get -y install liblmdb-dev gcc-mingw-w64-x86-64 binutils-mingw-w64-x86-64
-        wget https://github.com/google/flatbuffers/archive/refs/tags/v22.12.06.zip
-        unzip v22.12.06.zip
-        cd flatbuffers-22.12.06
-        cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release
-        make
-        sudo make install
-        cd ..
+        wget https://github.com/google/flatbuffers/releases/download/v22.12.06/Linux.flatc.binary.g++-10.zip
+        unzip Linux.flatc.binary.g++-10.zip
+        sudo mv ./flatc /usr/bin/flatc
         flatc --version
         wget https://github.com/protocolbuffers/protobuf/releases/download/v3.15.3/protoc-3.15.3-linux-x86_64.zip
         unzip protoc-3.15.3-linux-x86_64.zip
@@ -173,11 +178,13 @@ jobs:
           ~/.cargo/git
           concordium-base/rust-src/target
           concordium-base/lib
-          concordium-consensus/smart-contracts/wasm-chain-integration/target
-          concordium-consensus/smart-contracts/lib
+          concordium-base/smart-contracts/wasm-chain-integration/target
+          concordium-base/smart-contracts/lib
           concordium-node/target
-        key: ${{ runner.os }}-${{ env.dummy }}-rust-deps-${{ matrix.plan.rust }}-${{ hashFiles('**/Cargo.toml', '**/Cargo.lock') }}
+          collector/target
+        key: ${{ runner.os }}-${{ env.dummy }}-rust-deps-${{ matrix.plan.rust }}-${{ hashFiles('**/Cargo.toml', '**/Cargo.lock') }}-${{ hashFiles('concordium-base/rust-src/**/*.rs','concordium-base/smart-contracts/wasm-chain-integration/**/*.rs')}}
         restore-keys: |
+          ${{ runner.os }}-${{ env.dummy }}-rust-deps-${{ matrix.plan.rust }}-${{ hashFiles('**/Cargo.toml', '**/Cargo.lock') }}
           ${{ runner.os }}-${{ env.dummy }}-rust-deps-${{ matrix.plan.rust }}
 
     # HASKELL #
@@ -188,6 +195,12 @@ jobs:
     # The cache entry keys depend on the GHC version and contents of 'package.yaml' and 'stack.yaml'
     # but will fall back to cache entries from different versions if no match is found.
 
+    - name: Compute cache keys
+      id: cache-keys
+      run: |
+        echo "proto_hash=${{ hashFiles('**/*.proto') }}" >> $GITHUB_OUTPUT
+        echo "base_hash=${{ hashFiles('concordium-base/**/*.hs') }}" >> $GITHUB_OUTPUT
+      
     - name: Cache stack global package DB
       id: stack-global
       uses: actions/cache@v4
@@ -196,14 +209,6 @@ jobs:
         key: ${{ runner.os }}-${{ env.dummy }}-stack-global-${{ matrix.plan.ghc }}-${{ hashFiles('**.yaml') }}
         restore-keys: |
           ${{ runner.os }}-${{ env.dummy }}-stack-global-${{ matrix.plan.ghc }}
-    - name: Cache stack-installed programs in '~/.local/bin'
-      id: stack-programs
-      uses: actions/cache@v4
-      with:
-        path: ~/.local/bin
-        key: ${{ runner.os }}-${{ env.dummy }}-stack-programs-${{ matrix.plan.ghc }}-${{ hashFiles('**.yaml') }}
-        restore-keys: |
-          ${{ runner.os }}-${{ env.dummy }}-stack-programs-${{ matrix.plan.ghc }}
     - name: Cache '.stack-work'
       uses: actions/cache@v4
       with:
@@ -213,34 +218,16 @@ jobs:
           concordium-consensus/.stack-work
           concordium-consensus/haskell-lmdb/.stack-work
 
-        key: ${{ runner.os }}-${{ env.dummy }}-stack-work-${{ matrix.plan.ghc }}-${{ hashFiles('**.yaml') }}
+        key: ${{ runner.os }}-${{ env.dummy }}-stack-work-${{ matrix.plan.ghc }}-${{ hashFiles('**.yaml') }}-${{ steps.cache-keys.outputs.proto_hash }}-${{ steps.cache-keys.outputs.base_hash }}
         restore-keys: |
+          ${{ runner.os }}-${{ env.dummy }}-stack-work-${{ matrix.plan.ghc }}-${{ hashFiles('**.yaml') }}-${{ steps.cache-keys.outputs.proto_hash }}-
+          ${{ runner.os }}-${{ env.dummy }}-stack-work-${{ matrix.plan.ghc }}-${{ hashFiles('**.yaml') }}-
           ${{ runner.os }}-${{ env.dummy }}-stack-work-${{ matrix.plan.ghc }}
 
-    - name: Install GHC (unless it was cached)
-      if: steps.stack-programs.outputs.cache-hit != 'true' || steps.stack-global.outputs.cache-hit != 'true'
-      run: |
-        stack setup --install-ghc
-    - name: Build haskell dependencies (unless they were cached)
-      if: steps.stack-programs.outputs.cache-hit != 'true' || steps.stack-global.outputs.cache-hit != 'true'
-      run: |
-        stack build --test --bench --only-dependencies --stack-yaml concordium-consensus/stack.yaml
-
     # Compile Haskell sources. This must be done before running checks or tests on the Rust sources.
-    - name: Build consensus
-      run: |
-        stack build --test --bench --force-dirty --stack-yaml concordium-consensus/stack.yaml --no-run-tests --no-run-benchmarks --ghc-options "-Werror"
-
-    # Test Haskell sources. Could be run in parallel with the steps below.
-    - name: Test consensus
-      run: |
-        stack --stack-yaml concordium-consensus/stack.yaml test concordium-consensus:consensus --bench --no-run-benchmarks --ta --level=${TEST_LEVEL}
-    - name: Test globalstate
-      run: |
-        stack --stack-yaml concordium-consensus/stack.yaml test concordium-consensus:globalstate --bench --no-run-benchmarks --ta --level=${TEST_LEVEL}
-    - name: Test scheduler
+    - name: Build consensus and run tests
       run: |
-        stack --stack-yaml concordium-consensus/stack.yaml test concordium-consensus:scheduler --bench --no-run-benchmarks
+        stack build concordium-consensus --test --bench --force-dirty --no-run-benchmarks --ghc-options "-Werror" --ghc-options -j
 
     # RUST #
 

.github/workflows/release.yaml

@@ -21,11 +21,11 @@ on:
 
 env:
   UBUNTU_VERSION: '24.04'
-  STATIC_LIBRARIES_IMAGE_TAG: 'rust-1.82_ghc-9.6.6-0'
+  STATIC_LIBRARIES_IMAGE_TAG: 'rust-1.82_ghc-9.10.2'
   RUST_VERSION: '1.82'
-  STACK_VERSION: '3.1.1'
+  STACK_VERSION: '3.7.1'
   FLATBUFFERS_VERSION: '23.5.26'
-  GHC_VERSION: '9.6.6'
+  GHC_VERSION: '9.10.2'
   PROTOC_VERSION: '28.3'
   STATIC_NODE_BINARY_IMAGE_NAME: 'static-node-binaries'
   DOCKER_ARTIFACT_NAME: 'image'

.gitignore

@@ -10,6 +10,8 @@ _rust_rocksdb*
 tags
 path
 .vscode
+.idea/
+concordium-node/.idea/
 .so
 .stack-work
 dist

CHANGELOG.md

@@ -2,8 +2,76 @@
 
 ## Unreleased changes
 
+## 9.0.7
+
 - Docker base images upgraded from Ubuntu 20.04 to 24.04
 - Node Docker image is now signed with Sigstore Cosign
+- Add P8 -> P9 update.
+- Update GHC version to 9.10.2 (lts-24.0).
+- Protocol-level tokens:
+  - Change energy charging to occur as early as possible in the token module.
+  - Added `touch` kernel method. The `touch` method initializes the token state
+    of an account by setting its balance to zero. This method only affects
+    accounts that have no existing state for the token.
+  - Additional check in transaction verification asserting that the effective
+    time equals zero of CreatePLT update transactions.
+
+## 9.0.6 (DevNet)
+
+- Protocol-level tokens:
+  - Adjusted energy cost of mint/burn from 100 to 50
+  - PLTs can now only be created with the module reference:
+    5c5c2645db84a7026d78f2501740f60a8ccb8fae5c166dc2428077fd9a699a4a
+  - Support for token pause/unpause operations.
+
+## 9.0.5 (DevNet)
+
+- Protocol-level tokens:
+  - Simplified token transaction handling: Consolidated all token holder and
+    governance operations for a single `TokenUpdateTransaction` type.
+  - Moved authorization from the scheduler to the token module.
+  - Fix a bug in checking authorization for CreatePLT update.
+
+## 9.0.4 (DevNet)
+
+- Protocol-level tokens:
+  - Changes to event representation and serialization.
+
+## 9.0.3 (DevNet)
+
+- Protocol-level tokens:
+  - `GetAccountInfo` reports the token module-defined state as CBOR-encoded, rather than directly
+    exposing the allow/deny list membership at the GRPC level.
+  - `metadata` in token module state (reported in `GetTokenInfo`) can now include the metadata
+    hash as well as the URL.
+  - A new set of authorized level-2 keys for the `CreatePLT` chain update.
+
+## 9.0.2 (DevNet)
+
+- Protocol-level tokens:
+  - Token operations emit events. This includes `CreatePLT`.
+  - Support for energy charging for token module execution.
+
+## 9.0.1 (DevNet)
+
+- Protocol-level tokens:
+  - Support for token governance transactions (mint, burn, modify allow/deny lists).
+  - Enforcement of allow and deny lists in transfer operations.
+  - `GetTokenInfo` returns state from token module.
+  - `GetAccountInfo` reports state of allow/deny lists.
+  - Changes to the caching and storage of account-level token state.
+
+
+## 9.0.0 (DevNet)
+
+- Preliminary support for protocol-level tokens (as part of protocol version 9), including:
+  - Support for `CreatePLT` chain update for creating a new protocol-level token.
+  - Support for transferring protocol-level tokens between accounts with the `TokenHolder`
+    transaction type.
+  - API support:
+    - Add `GetTokenList` query for getting a list of all protocol-level tokens.
+    - Add `GetTokenInfo` query for getting details about a specific protocol-level token.
+    - `GetAccountInfo` query displays balances of protocol-level tokens held by an account.
 
 ## 8.1.0
 

README.md

@@ -78,7 +78,7 @@ dependencies must be pre-build, which is done automatically by the cabal setup
 script.
 
 Code should be formatted using [`fourmolu`](https://github.com/fourmolu/fourmolu)
-version `0.13.1.0` and using the config `fourmolu.yaml` found in the project root.
+version `0.18.0.0` and using the config `fourmolu.yaml` found in the project root.
 The CI is setup to ensure the code follows this style.
 
 To check the formatting locally run the following command from the project root:

collector/src/bin/collector.rs

@@ -13,6 +13,9 @@ extern crate log;
 
 #[allow(clippy::large_enum_variant, clippy::enum_variant_names)]
 mod grpc {
+    mod plt {
+        tonic::include_proto!("concordium.v2.plt");
+    }
     tonic::include_proto!("concordium.v2");
 }
 use grpc::{node_info::node::ConsensusStatus, tokenomics_info::Tokenomics};

concordium-base

@@ -29,7 +29,7 @@ rustup default stable-x86_64-pc-windows-gnu
 ```
 
 ### `user specified .o/.so/.DLL could not be loaded (addDLL: pthread or dependencies not loaded. (Win32 error 5)) whilst trying to load:  (dynamic) pthread`
-Copy `%LOCALAPPDATA%\Programs\stack\x86_64-windows\ghc-9.6.6\mingw\bin\libwinpthread-1.dll` to `%LOCALAPPDATA%\Programs\stack\x86_64-windows\ghc-9.6.6\mingw\bin\pthread.dll`.
+Copy `%LOCALAPPDATA%\Programs\stack\x86_64-windows\ghc-9.10.2\mingw\bin\libwinpthread-1.dll` to `%LOCALAPPDATA%\Programs\stack\x86_64-windows\ghc-9.10.2\mingw\bin\pthread.dll`.
 
 # The library and dependencies
 

concordium-consensus/README.md

@@ -23,7 +23,9 @@ EXPORTS
  stopImportingBlocks
 
  getAccountInfoV2
+ getTokenInfoV2
  getAccountListV2
+ getTokenListV2
  getModuleListV2
  getModuleSourceV2
  getInstanceListV2

concordium-consensus/lib.def

@@ -3,6 +3,7 @@
 {-# LANGUAGE GADTs #-}
 {-# LANGUAGE RankNTypes #-}
 {-# LANGUAGE ScopedTypeVariables #-}
+{-# LANGUAGE TypeAbstractions #-}
 {-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE TypeFamilies #-}
 
@@ -238,7 +239,8 @@ runWithEBlockStateContext mvr (EBlockStateContextV1 vc1 drs) operation = do
         mvr
 
 -- | Handle that identifies a particular dry-run session.
-data DryRunHandle = forall finconf.
+data DryRunHandle
+    = forall finconf.
       DryRunHandle
     { -- | Wrap the multi-version runner from the consensus runner.
       drhMVR :: !(MultiVersionRunner finconf),
@@ -686,7 +688,9 @@ dryRunTransaction dryRunPtr senderPtr energyLimit payloadPtr payloadLen sigPairs
                                 key <- KeyIndex <$> peekByteOff sigPairs (2 * i + 1)
                                 addSigs (i + 1) $!
                                     m
-                                        & at' cred . nonEmpty . at' key
+                                        & at' cred
+                                            . nonEmpty
+                                            . at' key
                                             ?~ Sig.dummySignatureEd25519
                             | otherwise = return m
                     addSigs 0 Map.empty