feat(#3672): add /account service for the usage of Proposal Discussion Forum pillar

Author: Ciabas

govtool/backend/sql/get-account-info.sql

@@ -0,0 +1,23 @@
+SELECT
+  sa.id,
+  sa.view,
+  CASE
+    WHEN sa.script_hash IS NOT NULL THEN true
+    ELSE false
+  END AS is_script_based,
+  CASE
+    WHEN (
+      SELECT COALESCE(MAX(epoch_no), 0)
+      FROM stake_registration sr
+      WHERE sr.addr_id = sa.id
+    ) > (
+      SELECT COALESCE(MAX(epoch_no), 0)
+      FROM stake_deregistration sd
+      WHERE sd.addr_id = sa.id
+    ) THEN true
+    ELSE false
+  END AS is_registered
+FROM
+  stake_address sa
+WHERE
+  sa.hash_raw = decode(?, 'hex');

govtool/backend/src/VVA/API.hs

@@ -40,6 +40,7 @@ import           VVA.Config
 import qualified VVA.DRep                 as DRep
 import qualified VVA.Epoch                as Epoch
 import           VVA.Network              as Network
+import           VVA.Account              as Account
 import qualified VVA.Proposal             as Proposal
 import qualified VVA.Transaction          as Transaction
 import qualified VVA.Types                as Types
@@ -85,6 +86,7 @@ type VVAApi =
     :<|> "network" :> "metrics" :> Get '[JSON] GetNetworkMetricsResponse
     :<|> "network" :> "info" :> Get '[JSON] GetNetworkInfoResponse
     :<|> "network" :> "total-stake" :> Get '[JSON] GetNetworkTotalStakeResponse
+    :<|> "account" :> Capture "stakeKey" HexText :> Get '[JSON] GetAccountInfoResponse
 
 server :: App m => ServerT VVAApi m
 server = drepList
@@ -103,6 +105,7 @@ server = drepList
     :<|> getNetworkMetrics
     :<|> getNetworkInfo
     :<|> getNetworkTotalStake
+    :<|> getAccountInfo
 
 mapDRepType :: Types.DRepType -> DRepType
 mapDRepType Types.DRep      = NormalDRep
@@ -527,3 +530,14 @@ getNetworkMetrics = do
     , getNetworkMetricsResponseQuorumNumerator = networkMetricsQuorumNumerator
     , getNetworkMetricsResponseQuorumDenominator = networkMetricsQuorumDenominator
     }
+
+getAccountInfo :: App m => HexText -> m GetAccountInfoResponse
+getAccountInfo (unHexText -> stakeKey) = do
+  -- CacheEnv {accountInfoCache} <- asks vvaCache
+  Types.AccountInfo {..} <- Account.accountInfo stakeKey
+  return $ GetAccountInfoResponse
+    { getAccountInfoResponseId = accountInfoId
+    , getAccountInfoResponseView = accountInfoView
+    , getAccountInfoResponseIsRegistered = accountInfoIsRegistered
+    , getAccountInfoResponseIsScriptBased = accountInfoIsScriptBased
+    }

govtool/backend/src/VVA/API/Types.hs

@@ -1032,3 +1032,26 @@ instance ToSchema GetNetworkMetricsResponse where
         & description ?~ "GetNetworkMetricsResponse"
         & example
           ?~ toJSON exampleGetNetworkMetricsResponse
+
+data GetAccountInfoResponse
+  = GetAccountInfoResponse
+      { getAccountInfoResponseId            :: Integer
+      , getAccountInfoResponseView          :: Text
+      , getAccountInfoResponseIsRegistered  :: Bool
+      , getAccountInfoResponseIsScriptBased :: Bool
+      }
+  deriving (Generic, Show)
+deriveJSON (jsonOptions "getAccountInfoResponse") ''GetAccountInfoResponse
+exampleGetAccountInfoResponse :: Text
+exampleGetAccountInfoResponse =
+  "{\"stakeKey\": \"stake1u9\","
+  <> " \"id\": \"1\","
+  <> "\"view\": \"stake_test1uzapf83wydusjln97rqr7fen6vgrz5087yqdxm0akqdqkgstjz8g4\","
+  <> "\"isRegistered\": false,"
+  <> "\"isScriptBased\": false}"
+instance ToSchema GetAccountInfoResponse where
+    declareNamedSchema _ = pure $ NamedSchema (Just "GetAccountInfoResponse") $ mempty
+        & type_ ?~ OpenApiObject
+        & description ?~ "GetAccountInfoResponse"
+        & example
+          ?~ toJSON exampleGetAccountInfoResponse

govtool/backend/src/VVA/Account.hs

@@ -0,0 +1,35 @@
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE TemplateHaskell  #-}
+
+module VVA.Account where
+
+import           Control.Monad.Except       (MonadError, throwError)
+import           Control.Monad.Reader       (MonadIO, MonadReader, liftIO)
+import           Data.ByteString            (ByteString)
+import           Data.FileEmbed             (embedFile)
+import           Data.String                (fromString)
+import qualified Database.PostgreSQL.Simple as SQL
+import           VVA.Types                  (AppError(..), AccountInfo(..))
+import           Data.Text                  (Text, unpack)
+import qualified Data.Text.Encoding         as Text
+import qualified Data.Text.IO               as Text
+import           Data.Has                   (Has)
+import           VVA.Pool                   (ConnectionPool, withPool)
+
+sqlFrom :: ByteString -> SQL.Query
+sqlFrom = fromString . unpack . Text.decodeUtf8
+
+accountInfoSql :: SQL.Query
+accountInfoSql = sqlFrom $(embedFile "sql/get-account-info.sql")
+
+accountInfo ::
+  (Has ConnectionPool r, MonadReader r m, MonadIO m, MonadError AppError m) =>
+  Text ->
+    m AccountInfo
+accountInfo stakeKey = withPool $ \conn -> do
+  result <- liftIO $ SQL.query conn accountInfoSql (SQL.Only stakeKey)
+  case result of
+    [(id, view, is_registered, is_script_based)] ->
+      return $ AccountInfo id view is_registered is_script_based
+    _ -> throwError $ CriticalError "Could not query the account info."

govtool/backend/src/VVA/Types.hs

@@ -302,3 +302,11 @@ data Delegation
       , delegationIsDRepScriptBased :: Bool
       , delegationTxHash            :: Text
       }
+
+data AccountInfo
+  = AccountInfo
+      { accountInfoId            :: Integer
+      , accountInfoView          :: Text
+      , accountInfoIsRegistered  :: Bool
+      , accountInfoIsScriptBased :: Bool
+      }

govtool/backend/vva-be.cabal

@@ -37,6 +37,7 @@ extra-source-files:
   sql/get-dreps-voting-power-list.sql
   sql/get-filtered-dreps-voting-power.sql
   sql/get-previous-enacted-governance-action-proposal-details.sql
+  sql/get-account-info.sql
 executable vva-be
     main-is:          Main.hs
 
@@ -124,4 +125,5 @@ library
                  , VVA.Pool
                  , VVA.Types
                  , VVA.Network
+                 , VVA.Account
   ghc-options: -threaded

govtool/frontend/src/models/api.ts

@@ -261,3 +261,10 @@ type DRepVotingPower = {
 };
 
 export type DRepVotingPowerListResponse = DRepVotingPower[];
+
+export type Account = {
+  id: number,
+  view: string,
+  isRegistered: boolean,
+  isScriptBased: boolean
+}

govtool/frontend/src/pages/ProposalDiscussion.tsx

@@ -12,7 +12,7 @@ import { useValidateMutation } from "@/hooks/mutations";
 import { useScreenDimension } from "@/hooks/useScreenDimension";
 import { Footer, TopNav } from "@/components/organisms";
 import { useGetDRepVotingPowerList, useGetVoterInfo } from "@/hooks";
-import { getAdaHolderVotingPower } from "@/services";
+import { getAdaHolderVotingPower, getAccount } from "@/services";
 
 const ProposalDiscussion = React.lazy(
   () => import("@intersect.mbo/pdf-ui/cjs"),
@@ -81,6 +81,7 @@ export const ProposalDiscussionPillar = () => {
             setUsername={setUsername}
             epochParams={epochParams}
             getAdaHolderVotingPower={getAdaHolderVotingPower}
+            getAccount={getAccount}
             {...snackbarContext}
           />
         </Suspense>

govtool/frontend/src/services/requests/getAccount.ts

@@ -0,0 +1,8 @@
+import { Account } from "@/models";
+import { API } from "../API";
+
+export const getAccount = async ({ stakeKey }: { stakeKey?: string }) => {
+  const response = await API.get<Account>(`/account/${stakeKey || ""}`);
+
+  return response.data;
+};

govtool/frontend/src/services/requests/getAdaHolderVotingPower.ts

@@ -4,8 +4,10 @@ export const getAdaHolderVotingPower = async ({
   stakeKey,
 }: {
   stakeKey?: string;
-}): Promise<number> => {
-  const response = await API.get(`/ada-holder/get-voting-power/${stakeKey}`);
+}) => {
+  const response = await API.get<number>(
+    `/ada-holder/get-voting-power/${stakeKey}`,
+  );
 
   return response.data;
 };