Query fixes and refactoring

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased changes
 
+- Fix a bug where `GetBakersRewardPeriod` returns incorrect data (#1176).
+- Fix a bug where `GetPoolInfo` returns incorrect data (#1177).
 - Change the severity of logs for failed gRPC API requests to DEBUG level.
 - Add support for new `invoke` calls from smart contracts in protocol version 7:
   - query the contract module reference for a given contract address

concordium-consensus/src-lib/Concordium/External/GRPC2.hs

@@ -548,10 +548,10 @@ getPoolInfoV2 cptr blockType blockHashPtr bakerId outHash outVec copierCbk = do
     Ext.ConsensusRunner mvr <- deRefStablePtr cptr
     let copier = callCopyToVecCallback copierCbk
     bhi <- decodeBlockHashInput blockType blockHashPtr
-    response <- runMVR (Q.getPoolStatus bhi (Just $ fromIntegral bakerId)) mvr
+    response <- runMVR (Q.getPoolStatus bhi (fromIntegral bakerId)) mvr
     copyHashTo outHash response
     case fmap toProto <$> response of
-        Q.BQRBlock _ (Just (Left proto)) -> do
+        Q.BQRBlock _ (Just proto) -> do
             let encoded = Proto.encodeMessage proto
             BS.unsafeUseAsCStringLen encoded (\(ptr, len) -> copier outVec (castPtr ptr) (fromIntegral len))
             return $ queryResultCode QRSuccess
@@ -573,10 +573,10 @@ getPassiveDelegationInfoV2 cptr blockType blockHashPtr outHash outVec copierCbk
     Ext.ConsensusRunner mvr <- deRefStablePtr cptr
     let copier = callCopyToVecCallback copierCbk
     bhi <- decodeBlockHashInput blockType blockHashPtr
-    response <- runMVR (Q.getPoolStatus bhi Nothing) mvr
+    response <- runMVR (Q.getPassiveDelegationStatus bhi) mvr
     copyHashTo outHash response
     case fmap toProto <$> response of
-        Q.BQRBlock _ (Just (Right proto)) -> do
+        Q.BQRBlock _ (Just proto) -> do
             let encoded = Proto.encodeMessage proto
             BS.unsafeUseAsCStringLen encoded (\(ptr, len) -> copier outVec (castPtr ptr) (fromIntegral len))
             return $ queryResultCode QRSuccess

concordium-consensus/src/Concordium/GlobalState/Basic/BlockState/Account.hs

@@ -131,6 +131,7 @@ instance (IsAccountVersion av) => HashableTo (AccountHash av) (Account av) where
         SAccountV0 -> AHIV0 (accountHashInputsV0 acc)
         SAccountV1 -> AHIV1 (accountHashInputsV0 acc)
         SAccountV2 -> AHIV2 (accountHashInputsV2 acc)
+        SAccountV3 -> undefined -- TODO: Implement account version 3
 
 instance forall av. (IsAccountVersion av) => HashableTo Hash.Hash (Account av) where
     getHash = coerce @(AccountHash av) . getHash

concordium-consensus/src/Concordium/GlobalState/Basic/BlockState/AccountReleaseSchedule.hs

@@ -25,6 +25,7 @@ type family AccountReleaseSchedule' (av :: AccountVersion) where
     AccountReleaseSchedule' 'AccountV0 = ARSV0.AccountReleaseSchedule
     AccountReleaseSchedule' 'AccountV1 = ARSV0.AccountReleaseSchedule
     AccountReleaseSchedule' 'AccountV2 = ARSV1.AccountReleaseSchedule
+    AccountReleaseSchedule' 'AccountV3 = ARSV1.AccountReleaseSchedule
 
 -- | Release schedule on an account, parametrized by the account version.
 newtype AccountReleaseSchedule (av :: AccountVersion) = AccountReleaseSchedule
@@ -51,6 +52,7 @@ theAccountReleaseScheduleV1 ::
     ARSV1.AccountReleaseSchedule
 theAccountReleaseScheduleV1 = case accountVersion @av of
     SAccountV2 -> theAccountReleaseSchedule
+    SAccountV3 -> theAccountReleaseSchedule
 
 -- | Converse of 'theAccountReleaseScheduleV0'.
 fromAccountReleaseScheduleV0 ::
@@ -70,25 +72,29 @@ fromAccountReleaseScheduleV1 ::
     AccountReleaseSchedule av
 fromAccountReleaseScheduleV1 = case accountVersion @av of
     SAccountV2 -> AccountReleaseSchedule
+    SAccountV3 -> AccountReleaseSchedule
 
 instance (IsAccountVersion av) => Eq (AccountReleaseSchedule av) where
     (==) = case accountVersion @av of
         SAccountV0 -> (==) `on` theAccountReleaseSchedule
         SAccountV1 -> (==) `on` theAccountReleaseSchedule
         SAccountV2 -> (==) `on` theAccountReleaseSchedule
+        SAccountV3 -> (==) `on` theAccountReleaseSchedule
 
 instance (IsAccountVersion av) => Show (AccountReleaseSchedule av) where
     show = case accountVersion @av of
         SAccountV0 -> show . theAccountReleaseSchedule
         SAccountV1 -> show . theAccountReleaseSchedule
         SAccountV2 -> show . theAccountReleaseSchedule
+        SAccountV3 -> show . theAccountReleaseSchedule
 
 -- | Produce an 'AccountReleaseSummary' from an 'AccountReleaseSchedule'.
 toAccountReleaseSummary :: forall av. (IsAccountVersion av) => AccountReleaseSchedule av -> AccountReleaseSummary
 toAccountReleaseSummary = case accountVersion @av of
     SAccountV0 -> ARSV0.toAccountReleaseSummary . theAccountReleaseSchedule
     SAccountV1 -> ARSV0.toAccountReleaseSummary . theAccountReleaseSchedule
     SAccountV2 -> ARSV1.toAccountReleaseSummary . theAccountReleaseSchedule
+    SAccountV3 -> ARSV1.toAccountReleaseSummary . theAccountReleaseSchedule
 
 instance (IsAccountVersion av, AccountStructureVersionFor av ~ 'AccountStructureV0) => HashableTo ARSV0.AccountReleaseScheduleHashV0 (AccountReleaseSchedule av) where
     getHash = case accountVersion @av of
@@ -99,6 +105,7 @@ instance (IsAccountVersion av, AccountStructureVersionFor av ~ 'AccountStructure
 instance (IsAccountVersion av, AccountStructureVersionFor av ~ 'AccountStructureV1) => HashableTo ARSV1.AccountReleaseScheduleHashV1 (AccountReleaseSchedule av) where
     getHash = case accountVersion @av of
         SAccountV2 -> getHash . theAccountReleaseSchedule
+        SAccountV3 -> getHash . theAccountReleaseSchedule
     {-# INLINE getHash #-}
 
 -- | Create an empty account release schedule
@@ -107,6 +114,7 @@ emptyAccountReleaseSchedule = case accountVersion @av of
     SAccountV0 -> AccountReleaseSchedule ARSV0.emptyAccountReleaseSchedule
     SAccountV1 -> AccountReleaseSchedule ARSV0.emptyAccountReleaseSchedule
     SAccountV2 -> AccountReleaseSchedule ARSV1.emptyAccountReleaseSchedule
+    SAccountV3 -> AccountReleaseSchedule ARSV1.emptyAccountReleaseSchedule
 
 -- | Add a list of amounts to this @AccountReleaseSchedule@.
 --
@@ -121,6 +129,7 @@ addReleases = case accountVersion @av of
     SAccountV0 -> \rels (AccountReleaseSchedule ars) -> AccountReleaseSchedule (ARSV0.addReleases rels ars)
     SAccountV1 -> \rels (AccountReleaseSchedule ars) -> AccountReleaseSchedule (ARSV0.addReleases rels ars)
     SAccountV2 -> \rels (AccountReleaseSchedule ars) -> AccountReleaseSchedule (ARSV1.addReleases rels ars)
+    SAccountV3 -> \rels (AccountReleaseSchedule ars) -> AccountReleaseSchedule (ARSV1.addReleases rels ars)
 
 -- | Remove the amounts up to and including the given timestamp.
 -- It returns the unlocked amount, maybe the next smallest timestamp for this account and the new account release schedule.
@@ -137,20 +146,24 @@ unlockAmountsUntil = case accountVersion @av of
         _3 %~ AccountReleaseSchedule $ ARSV0.unlockAmountsUntil ts ars
     SAccountV2 -> \ts (AccountReleaseSchedule ars) ->
         _3 %~ AccountReleaseSchedule $ ARSV1.unlockAmountsUntil ts ars
+    SAccountV3 -> \ts (AccountReleaseSchedule ars) ->
+        _3 %~ AccountReleaseSchedule $ ARSV1.unlockAmountsUntil ts ars
 
 -- | Get the timestamp at which the next scheduled release will occur (if any).
 nextReleaseTimestamp :: forall av. (IsAccountVersion av) => AccountReleaseSchedule av -> Maybe Timestamp
 nextReleaseTimestamp = case accountVersion @av of
     SAccountV0 -> ARSV0.nextReleaseTimestamp . theAccountReleaseSchedule
     SAccountV1 -> ARSV0.nextReleaseTimestamp . theAccountReleaseSchedule
     SAccountV2 -> ARSV1.nextReleaseTimestamp . theAccountReleaseSchedule
+    SAccountV3 -> ARSV1.nextReleaseTimestamp . theAccountReleaseSchedule
 
 -- | Get the total locked balance.
 totalLockedUpBalance :: forall av. (IsAccountVersion av) => SimpleGetter (AccountReleaseSchedule av) Amount
 totalLockedUpBalance = case accountVersion @av of
     SAccountV0 -> to theAccountReleaseSchedule . ARSV0.totalLockedUpBalance
     SAccountV1 -> to theAccountReleaseSchedule . ARSV0.totalLockedUpBalance
     SAccountV2 -> to (ARSV1.arsTotalLockedAmount . theAccountReleaseSchedule)
+    SAccountV3 -> to (ARSV1.arsTotalLockedAmount . theAccountReleaseSchedule)
 
 -- | Compute the sum of releases in the release schedule.
 --  This should produce the same result as '_totalLockedUpBalance', and is provided for testing
@@ -160,3 +173,4 @@ sumOfReleases = case accountVersion @av of
     SAccountV0 -> ARSV0.sumOfReleases . theAccountReleaseSchedule
     SAccountV1 -> ARSV0.sumOfReleases . theAccountReleaseSchedule
     SAccountV2 -> ARSV1.sumOfReleases . theAccountReleaseSchedule
+    SAccountV3 -> ARSV1.sumOfReleases . theAccountReleaseSchedule

concordium-consensus/src/Concordium/GlobalState/BlockState.hs

@@ -81,7 +81,7 @@ import Concordium.Types.Accounts
 import Concordium.Types.Accounts.Releases
 import Concordium.Types.AnonymityRevokers
 import Concordium.Types.IdentityProviders
-import Concordium.Types.Queries (PoolStatus, RewardStatus')
+import Concordium.Types.Queries (BakerPoolStatus, PassiveDelegationStatus, RewardStatus')
 import Concordium.Types.SeedState (SeedState, SeedStateVersion (..), SeedStateVersionFor)
 import Concordium.Types.Transactions hiding (BareBlockItem (..))
 import qualified Concordium.Types.UpdateQueues as UQ
@@ -646,14 +646,19 @@ class (ContractStateOperations m, AccountOperations m, ModuleQuery m) => BlockSt
     -- | Get the epoch time of the next scheduled payday.
     getPaydayEpoch :: (PVSupportsDelegation (MPV m)) => BlockState m -> m Epoch
 
-    -- | Get a 'PoolStatus' record describing the status of a baker pool (when the 'BakerId' is
-    --  provided) or the passive delegators (when 'Nothing' is provided). The result is 'Nothing'
-    --  if the 'BakerId' is not currently a baker.
+    -- | Get a 'BakerPoolStatus' record describing the status of a baker pool. The result is
+    -- 'Nothing' if the 'BakerId' is not an active or current-epoch baker.
     getPoolStatus ::
         (PVSupportsDelegation (MPV m)) =>
         BlockState m ->
-        Maybe BakerId ->
-        m (Maybe PoolStatus)
+        BakerId ->
+        m (Maybe BakerPoolStatus)
+
+    -- | Get the status of passive delegation.
+    getPassiveDelegationStatus ::
+        (PVSupportsDelegation (MPV m)) =>
+        BlockState m ->
+        m PassiveDelegationStatus
 
 -- | Distribution of newly-minted GTU.
 data MintAmounts = MintAmounts
@@ -1502,6 +1507,7 @@ instance (Monad (t m), MonadTrans t, BlockStateQuery m) => BlockStateQuery (MGST
     getChainParameters = lift . getChainParameters
     getPaydayEpoch = lift . getPaydayEpoch
     getPoolStatus s = lift . getPoolStatus s
+    getPassiveDelegationStatus = lift . getPassiveDelegationStatus
     {-# INLINE getModule #-}
     {-# INLINE getAccount #-}
     {-# INLINE accountExists #-}

concordium-consensus/src/Concordium/GlobalState/Persistent/Account.hs

@@ -59,6 +59,7 @@ instance (IsAccountVersion av, MonadBlobStore m) => BlobStorable m (PersistentAc
         SAccountV0 -> fmap PAV0 <$> load
         SAccountV1 -> fmap PAV1 <$> load
         SAccountV2 -> fmap PAV2 <$> load
+        SAccountV3 -> undefined -- TODO: Implement account version 3
 
 -- | Type of references to persistent accounts.
 type AccountRef (av :: AccountVersion) = HashedCachedRef (AccountCache av) (PersistentAccount av)
@@ -82,6 +83,7 @@ instance (IsAccountVersion av, MonadBlobStore m) => BlobStorable m (PersistentBa
         SAccountV0 -> fmap PBIRV0 <$!> load
         SAccountV1 -> fmap PBIRV1 <$!> load
         SAccountV2 -> fmap PBIRV2 <$!> load
+        SAccountV3 -> undefined -- TODO: Implement account version 3
 
 -- * Account cache
 
@@ -457,6 +459,7 @@ makePersistentAccount tacc = case accountVersion @av of
     SAccountV0 -> PAV0 <$> V0.makePersistentAccount tacc
     SAccountV1 -> PAV1 <$> V0.makePersistentAccount tacc
     SAccountV2 -> PAV2 <$> V1.makePersistentAccount tacc
+    SAccountV3 -> undefined -- TODO: Implement account version 3
 
 -- | Create an empty account with the given public key, address and credential.
 newAccount ::
@@ -470,6 +473,7 @@ newAccount = case accountVersion @av of
     SAccountV0 -> \ctx addr cred -> PAV0 <$> V0.newAccount ctx addr cred
     SAccountV1 -> \ctx addr cred -> PAV1 <$> V0.newAccount ctx addr cred
     SAccountV2 -> \ctx addr cred -> PAV2 <$> V1.newAccount ctx addr cred
+    SAccountV3 -> undefined -- TODO: Implement account version 3
 
 -- | Make a persistent account from a genesis account.
 --  The data is immediately flushed to disc and cached.
@@ -489,6 +493,7 @@ makeFromGenesisAccount spv =
             PAV1 <$> V0.makeFromGenesisAccount spv cryptoParams chainParameters genesisAccount
         SAccountV2 -> \cryptoParams chainParameters genesisAccount ->
             PAV2 <$> V1.makeFromGenesisAccount spv cryptoParams chainParameters genesisAccount
+        SAccountV3 -> undefined -- TODO: Implement account version 3
 
 -- ** 'PersistentBakerInfoRef' creation
 
@@ -502,6 +507,7 @@ makePersistentBakerInfoRef = case accountVersion @av of
     SAccountV0 -> fmap PBIRV0 . V0.makePersistentBakerInfoEx
     SAccountV1 -> fmap PBIRV1 . V0.makePersistentBakerInfoEx
     SAccountV2 -> fmap PBIRV2 . V1.makePersistentBakerInfoEx
+    SAccountV3 -> undefined -- TODO: Implement account version 3
 
 -- * Migration
 
@@ -523,7 +529,7 @@ migratePersistentAccount m@StateMigrationParametersP2P3 (PAV0 acc) = PAV0 <$> V0
 migratePersistentAccount m@StateMigrationParametersP3ToP4{} (PAV0 acc) = PAV1 <$> V0.migratePersistentAccount m acc
 migratePersistentAccount m@StateMigrationParametersP4ToP5{} (PAV1 acc) = PAV2 <$> V1.migratePersistentAccountFromV0 m acc
 migratePersistentAccount m@StateMigrationParametersP5ToP6{} (PAV2 acc) = PAV2 <$> V1.migratePersistentAccount m acc
-migratePersistentAccount m@StateMigrationParametersP6ToP7{} (PAV2 acc) = PAV2 <$> V1.migratePersistentAccount m acc
+migratePersistentAccount StateMigrationParametersP6ToP7{} _ = undefined -- TODO: Implement migration
 
 -- | Migrate a 'PersistentBakerInfoRef' between protocol versions according to a state migration.
 migratePersistentBakerInfoRef ::
@@ -540,7 +546,7 @@ migratePersistentBakerInfoRef m@StateMigrationParametersP2P3 (PBIRV0 bir) = PBIR
 migratePersistentBakerInfoRef m@StateMigrationParametersP3ToP4{} (PBIRV0 bir) = PBIRV1 <$> V0.migratePersistentBakerInfoEx m bir
 migratePersistentBakerInfoRef m@StateMigrationParametersP4ToP5{} (PBIRV1 bir) = PBIRV2 <$> V1.migratePersistentBakerInfoExFromV0 m bir
 migratePersistentBakerInfoRef m@StateMigrationParametersP5ToP6{} (PBIRV2 bir) = PBIRV2 <$> V1.migratePersistentBakerInfoEx m bir
-migratePersistentBakerInfoRef m@StateMigrationParametersP6ToP7{} (PBIRV2 bir) = PBIRV2 <$> V1.migratePersistentBakerInfoEx m bir
+migratePersistentBakerInfoRef StateMigrationParametersP6ToP7{} _ = undefined -- TODO: Implement migration
 
 -- * Conversion