Merge pull request #459 from IntersectMBO/develop

test: #188, #364, #365, #377, #432, #442, #446 #459

CHANGELOG.md

@@ -9,23 +9,27 @@ As a minor extension, we also keep a semantic version for the `UNRELEASED`
 changes.
 
 ## [Unreleased]
+- Add generate jsonld function [Issue 451](https://github.com/IntersectMBO/govtool/issues/451)
 - Create GA review subbmision page [Issue 362](https://github.com/IntersectMBO/govtool/issues/362)
 - Create GA creation form [Issue 360](https://github.com/IntersectMBO/govtool/issues/360)
 - Create TextArea [Issue 110](https://github.com/IntersectMBO/govtool/issues/110)
+- Choose GA type - GA Submiter [Issue 358](https://github.com/IntersectMBO/govtool/issues/358)
+
+- Add on-chain inputs validation [Issue 377](https://github.com/IntersectMBO/govtool/issues/377)
+
+### Added
+
+- Added `isRegisteredAsSoleVoter` and `wasRegisteredAsSoleVoter` fields to the drep/info response [Issue 212](https://github.com/IntersectMBO/govtool/issues/212)
 - Abandoning registration as DRep [Issue 151](https://github.com/IntersectMBO/govtool/issues/151)
 - Abandoning GA creation [Issue 359](https://github.com/IntersectMBO/govtool/issues/359)
-- Choose GA type - GA Submiter [Issue 358](https://github.com/IntersectMBO/govtool/issues/358)
-- Change step 3 components [Issue 152](https://github.com/intersectMBO/govtool/issues/152)
-- Add possibility to vote on behalf of myself - Sole Voter [Issue 119](https://github.com/IntersectMBO/govtool/issues/119)
 - Create DRep registration page about roles [Issue 205](https://github.com/IntersectMBO/govtool/issues/205)
 - Create Checkbox component. Improve Field and ControlledField [Issue 177](https://github.com/IntersectMBO/govtool/pull/177)
 - Vitest unit tests added for utils functions [Issue 81](https://github.com/IntersectMBO/govtool/issues/81)
 - i18next library added to FE [Issue 80](https://github.com/IntersectMBO/govtool/issues/80)
-
-### Added
-- Added `isRegisteredAsSoleVoter` and `wasRegisteredAsSoleVoter` fields to the drep/info response [Issue 212](https://github.com/IntersectMBO/govtool/issues/212)
+- Add possibility to vote on behalf of myself - Sole Voter [Issue 119](https://github.com/IntersectMBO/govtool/issues/119)
 
 ### Fixed
+
 - Fix drep type detection when changing metadata [Issue 333](https://github.com/IntersectMBO/govtool/issues/333)
 - Fix make button disble when wallet tries connect [Issue 265](https://github.com/IntersectMBO/govtool/issues/265)
 - Fix drep voting power calculation [Issue 231](https://github.com/IntersectMBO/govtool/issues/231)
@@ -40,6 +44,7 @@ changes.
 - Fixed CSP settings to allow error reports with Sentry [Issue 291](https://github.com/IntersectMBO/govtool/issues/291).
 
 ### Changed
+- `drep/list` now return also `status` and `type` fields. Also it now returns the retired dreps, and you can search for given drep by name using optional query parameter. If the drep name is passed exactly, then you can even find a drep that's sole voter. [Issue 446](https://github.com/IntersectMBO/govtool/issues/446)
 - `drep/list` and `drep/info` endpoints now return additional data such as metadata url and hash, and voting power [Issue 223](https://github.com/IntersectMBO/govtool/issues/223)
 - `drep/info` now does not return sole voters (dreps without metadata) [Issue 317](https://github.com/IntersectMBO/govtool/issues/317)
 - `isRegistered` and `wasRegistered` fields in the drep/info endpoint changed to `isRegisteredAsDRep` and `wasRegisteredAsDRep` respectively [Issue 212](https://github.com/IntersectMBO/govtool/issues/212)
@@ -57,6 +62,7 @@ changes.
 - Added a grafana panel to track all the deploys on the target machines [Issue 361](https://github.com/IntersectMBO/govtool/issues/361).
 
 ### Removed
+
 -
 
 ## [sancho-v1.0.0](https://github.com/IntersectMBO/govtool/releases/tag/sancho-v1.0.0) 2023-12-17

govtool/backend/default.nix

@@ -1,7 +1,4 @@
-# TODO: Remove the sources file and use the nixpkgs version provided from the
-# flakes lock file instead when the flakes feature is present and enabled in the
-# root of the project.
-{ pkgs ? (import ./sources.nix).pkgs }:
+{ pkgs ? import <nixpkgs> {} }:
 let
   # This is the version of the Haskell compiler we reccommend using.
   ghcPackages = pkgs.haskell.packages.ghc927;

govtool/backend/shell.nix

@@ -0,0 +1,16 @@
+{ pkgs ? import <nixpkgs> {} }:
+let
+  project = import ./default.nix { inherit pkgs; };
+in
+project.overrideAttrs (attrs: {
+  buildInputs = attrs.buildInputs ++ (with pkgs; [
+    awscli
+    docker
+    git
+    gnumake
+  ]);
+
+  shellHook = ''
+    ln -s ${project}/libexec/yarn-nix-example/node_modules node_modules
+  '';
+})

govtool/backend/sql/list-dreps.sql

@@ -5,29 +5,64 @@ WITH DRepDistr AS (
   FROM drep_distr
   JOIN drep_hash
   on drep_hash.id = drep_distr.hash_id
+), DRepActivity AS (
+  select
+    drep_activity as drep_activity,
+    epoch_no as epoch_no
+  from epoch_param
+  where epoch_no is not null
+  order by epoch_no desc
+  limit 1
 )
 
 SELECT
    encode(dh.raw, 'hex'),
+   dh.view,
    va.url,
    encode(va.data_hash, 'hex'),
    dr_deposit.deposit,
-   DRepDistr.amount
+   DRepDistr.amount,
+   (DRepActivity.epoch_no - Max(coalesce(block.epoch_no,block_first_register.epoch_no))) <= DRepActivity.drep_activity as active,
+   second_to_newest_drep_registration.voting_anchor_id is not null as has_voting_anchor
 FROM drep_hash dh
 JOIN (
   SELECT dr.id, dr.drep_hash_id, dr.deposit,
-         ROW_NUMBER() OVER(PARTITION BY dr.drep_hash_id ORDER BY dr.id DESC) AS rn
+         ROW_NUMBER() OVER(PARTITION BY dr.drep_hash_id ORDER BY dr.tx_id DESC) AS rn
   FROM drep_registration dr
-  where dr.deposit > 0
+  where dr.deposit is not null
 ) as dr_deposit
 on dr_deposit.drep_hash_id = dh.id and dr_deposit.rn = 1
 LEFT JOIN (
   SELECT dr.id, dr.drep_hash_id, dr.voting_anchor_id,
-         ROW_NUMBER() OVER(PARTITION BY dr.drep_hash_id ORDER BY dr.id DESC) AS rn
+         ROW_NUMBER() OVER(PARTITION BY dr.drep_hash_id ORDER BY dr.tx_id DESC) AS rn
   FROM drep_registration dr
 ) as dr_voting_anchor
 on dr_voting_anchor.drep_hash_id = dh.id and dr_voting_anchor.rn = 1
+LEFT JOIN (
+  SELECT dr.id, dr.drep_hash_id, dr.voting_anchor_id,
+         ROW_NUMBER() OVER(PARTITION BY dr.drep_hash_id ORDER BY dr.tx_id DESC) AS rn
+  FROM drep_registration dr
+) as second_to_newest_drep_registration
+on second_to_newest_drep_registration.drep_hash_id = dh.id and second_to_newest_drep_registration.rn = 2
 LEFT JOIN DRepDistr
 on DRepDistr.hash_id = dh.id and DRepDistr.rn = 1
-JOIN voting_anchor va ON va.id = dr_voting_anchor.voting_anchor_id
+LEFT JOIN voting_anchor va ON va.id = dr_voting_anchor.voting_anchor_id
+CROSS JOIN DRepActivity
+LEFT JOIN voting_procedure as voting_procedure
+on voting_procedure.drep_voter = dh.id
+LEFT JOIN tx as tx
+on tx.id = voting_procedure.tx_id
+LEFT JOIN block as block
+on block.id = tx.block_id
+JOIN (
+  SELECT dr.tx_id, dr.drep_hash_id,
+         ROW_NUMBER() OVER(PARTITION BY dr.drep_hash_id ORDER BY dr.tx_id ASC) AS rn
+  FROM drep_registration dr
+) as dr_first_register
+on dr_first_register.drep_hash_id = dh.id and dr_first_register.rn = 1
+JOIN tx as tx_first_register
+on tx_first_register.id = dr_first_register.tx_id
+JOIN block as block_first_register
+ON block_first_register.id = tx_first_register.block_id
 
+GROUP BY dh.raw, second_to_newest_drep_registration.voting_anchor_id, dh.view, va.url, va.data_hash, dr_deposit.deposit, DRepDistr.amount, DRepActivity.epoch_no, DRepActivity.drep_activity

govtool/backend/src/VVA/API.hs

@@ -35,7 +35,7 @@ import VVA.Network as Network
 import Numeric.Natural (Natural)
 
 type VVAApi =
-         "drep" :> "list" :> Get '[JSON] [DRep]
+         "drep" :> "list" :> QueryParam "drepView" Text :> Get '[JSON] [DRep]
     :<|> "drep" :> "get-voting-power" :> Capture "drepId" HexText :> Get '[JSON] Integer
     :<|> "drep" :> "getVotes" :> Capture "drepId" HexText :> QueryParams "type" GovernanceActionType :> QueryParam "sort" GovernanceActionSortMode :> Get '[JSON] [VoteResponse]
     :<|> "drep" :> "info" :> Capture "drepId" HexText :> Get '[JSON] DRepInfoResponse
@@ -68,11 +68,40 @@ server = drepList
     :<|> throw500
     :<|> getNetworkMetrics
 
-drepList :: App m => m [DRep]
-drepList = do
+
+mapDRepType :: Types.DRepType -> DRepType
+mapDRepType Types.DRep = NormalDRep
+mapDRepType Types.SoleVoter = SoleVoter
+
+mapDRepStatus :: Types.DRepStatus -> DRepStatus
+mapDRepStatus Types.Retired = Retired
+mapDRepStatus Types.Active = Active
+mapDRepStatus Types.Inactive = Inactive
+
+drepRegistrationToDrep :: Types.DRepRegistration -> DRep
+drepRegistrationToDrep Types.DRepRegistration {..} =
+  DRep
+    { dRepDrepId = DRepHash dRepRegistrationDRepHash,
+      dRepView = dRepRegistrationView,
+      dRepUrl = dRepRegistrationUrl,
+      dRepMetadataHash = dRepRegistrationDataHash,
+      dRepDeposit = dRepRegistrationDeposit,
+      dRepVotingPower = dRepRegistrationVotingPower,
+      dRepStatus = mapDRepStatus dRepRegistrationStatus,
+      dRepType = mapDRepType dRepRegistrationType
+    }
+
+drepList :: App m => Maybe Text -> m [DRep]
+drepList mDRepView = do
   CacheEnv {dRepListCache} <- asks vvaCache
-  map (\(Types.DRepRegistration drep_hash url data_hash deposit votingPower) -> DRep (DRepHash drep_hash) url data_hash deposit votingPower)
-    <$> cacheRequest dRepListCache () DRep.listDReps
+  dreps <- cacheRequest dRepListCache () DRep.listDReps
+  let filtered = flip filter dreps $ \Types.DRepRegistration {..} ->
+        case (dRepRegistrationType, mDRepView) of
+          (Types.SoleVoter, Just x) -> x == dRepRegistrationView
+          (Types.DRep, Just x) -> isInfixOf x dRepRegistrationView
+          (Types.DRep, Nothing) -> True
+          _ -> False
+  return $ map drepRegistrationToDrep filtered
 
 getVotingPower :: App m => HexText -> m Integer
 getVotingPower (unHexText -> dRepId) = do

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

@@ -511,14 +511,66 @@ instance ToSchema DRepHash where
           ?~ toJSON exampleDrepHash
 
 
+data DRepStatus = Retired | Active | Inactive
+  deriving (Generic, Show)
 
+-- ToJSON instance for DRepStatus
+instance ToJSON DRepStatus where
+  toJSON Retired = "Retired"
+  toJSON Active = "Active"
+  toJSON Inactive = "Inactive"
+
+-- FromJSON instance for DRepStatus
+instance FromJSON DRepStatus where
+  parseJSON = withText "DRepStatus" $ \case
+    "Retired" -> pure Retired
+    "Active" -> pure Active
+    "Inactive" -> pure Inactive
+    _ -> fail "Invalid DRepStatus"
+
+-- ToSchema instance for DRepStatus
+instance ToSchema DRepStatus where
+    declareNamedSchema _ = pure $ NamedSchema (Just "DRepStatus") $ mempty
+        & type_ ?~ OpenApiString
+        & description ?~ "DRep Status"
+        & enum_ ?~ map toJSON [Retired, Active, Inactive]
+
+
+
+data DRepType = NormalDRep | SoleVoter
+
+instance Show DRepType where
+  show NormalDRep = "DRep"
+  show SoleVoter = "SoleVoter"
+
+-- ToJSON instance for DRepType
+instance ToJSON DRepType where
+  toJSON NormalDRep = "DRep"
+  toJSON SoleVoter = "SoleVoter"
+
+-- FromJSON instance for DRepType
+instance FromJSON DRepType where
+  parseJSON = withText "DRepType" $ \case
+    "DRep" -> pure NormalDRep
+    "SoleVoter" -> pure SoleVoter
+    _ -> fail "Invalid DRepType"
+
+-- ToSchema instance for DRepType
+instance ToSchema DRepType where
+    declareNamedSchema _ = pure $ NamedSchema (Just "DRepType") $ mempty
+        & type_ ?~ OpenApiString
+        & description ?~ "DRep Type"
+        & enum_ ?~ map toJSON [NormalDRep, SoleVoter]
 
 data DRep = DRep
   { dRepDrepId :: DRepHash
+  , dRepView :: Text
   , dRepUrl :: Maybe Text
   , dRepMetadataHash :: Maybe Text
   , dRepDeposit :: Integer
   , dRepVotingPower :: Maybe Integer
+  , dRepStatus :: DRepStatus
+  , dRepType :: DRepType
   } deriving (Generic, Show)
 
 
@@ -527,17 +579,30 @@ deriveJSON (jsonOptions "dRep") ''DRep
 exampleDrep :: Text
 exampleDrep =
    "{\"drepId\": \"d3a62ffe9c214e1a6a9809f7ab2a104c117f85e1f171f8f839d94be5\","
+ <> "\"view\": \"drep1l8uyy66sm8u82h82gc8hkcy2xu24dl8ffsh58aa0v7d37yp48u8\","
  <> "\"url\": \"https://proposal.metadata.xyz\","
  <> "\"metadataHash\": \"9af10e89979e51b8cdc827c963124a1ef4920d1253eef34a1d5cfe76438e3f11\","
  <> "\"deposit\": 0,"
- <> "\"votingPower\": 0}"
+ <> "\"votingPower\": 0,"
+ <> "\"status\": \"Active\","
+  <> "\"type\": \"DRep\"}"
 
+-- ToSchema instance for DRep
 instance ToSchema DRep where
-    declareNamedSchema _ = pure $ NamedSchema (Just "DRep") $ mempty
-        & type_ ?~ OpenApiObject
-        & description ?~ "DRep"
-        & example
-          ?~ toJSON exampleDrep
+    declareNamedSchema proxy = do
+      NamedSchema name_ schema_ <-
+        genericDeclareNamedSchema
+        ( fromAesonOptions $ jsonOptions "dRep" )
+        proxy
+      return $
+        NamedSchema name_ $
+          schema_
+            & description ?~ "DRep"
+            & example
+              ?~ toJSON exampleDrep
+
+
+
 
 data GetNetworkMetricsResponse = GetNetworkMetricsResponse
   { getNetworkMetricsResponseCurrentTime :: UTCTime

govtool/backend/src/VVA/DRep.hs

@@ -31,6 +31,8 @@ import VVA.Types
   , Proposal(..)
   , Vote(..)
   , DRepInfo(..)
+  , DRepType(..)
+  , DRepStatus(..)
   )
 
 
@@ -60,7 +62,17 @@ listDReps ::
   m [DRepRegistration]
 listDReps = withPool $ \conn -> do
   results <- liftIO $ SQL.query_ conn listDRepsSql
-  return [DRepRegistration drepHash url dataHash (floor @Scientific deposit) votingPower | (drepHash, url, dataHash, deposit, votingPower) <- results]
+  return
+    [ DRepRegistration drepHash drepView url dataHash (floor @Scientific deposit) votingPower status drepType
+    | (drepHash, drepView, url, dataHash, deposit, votingPower, isActive, wasDRep) <- results
+    , let status = case (isActive, deposit) of
+                      (_, d)        | d < 0 -> Retired
+                      (isActive, d) | d >= 0 && isActive -> Active
+                                    | d >= 0 && not isActive -> Inactive
+    , let drepType | url == Nothing && wasDRep = DRep
+                   | url == Nothing && not wasDRep = SoleVoter
+                   | url /= Nothing = DRep
+    ]
 
 getVotesSql :: SQL.Query
 getVotesSql = sqlFrom $(embedFile "sql/get-votes.sql")

govtool/backend/src/VVA/Types.hs

@@ -69,12 +69,24 @@ data DRepInfo = DRepInfo
   , dRepInfoVotingPower :: Maybe Integer
   }
 
+data DRepStatus
+  = Retired
+  | Active
+  | Inactive
+
+data DRepType
+  = DRep
+  | SoleVoter
+
 data DRepRegistration = DRepRegistration
- { dRepRegistrationDrepHash :: Text
+ { dRepRegistrationDRepHash :: Text
+ , dRepRegistrationView :: Text
  , dRepRegistrationUrl :: Maybe Text
  , dRepRegistrationDataHash :: Maybe Text
  , dRepRegistrationDeposit :: Integer
  , dRepRegistrationVotingPower :: Maybe Integer
+ , dRepRegistrationStatus :: DRepStatus
+ , dRepRegistrationType :: DRepType
  }
 
 data Proposal = Proposal

govtool/frontend/default.nix

@@ -1,17 +1,10 @@
-# This file has been generated by node2nix 1.11.1. Do not edit!
-
-{pkgs ? import <nixpkgs> {
-    inherit system;
-  }, system ? builtins.currentSystem, nodejs ? pkgs."nodejs_18"}:
-
+{ pkgs ? import <nixpkgs> {} }:
 let
-  nodeEnv = import ./node-env.nix {
-    inherit (pkgs) stdenv lib python2 runCommand writeTextFile writeShellScript;
-    inherit pkgs nodejs;
-    libtool = if pkgs.stdenv.isDarwin then pkgs.darwin.cctools else null;
+  project = pkgs.mkYarnPackage {
+    name = "govtool-frontend";
+    src = ./.;
+    packageJSON = ./package.json;
+    yarnLock = ./yarn.lock;
   };
 in
-import ./node-packages.nix {
-  inherit (pkgs) fetchurl nix-gitignore stdenv lib fetchgit;
-  inherit nodeEnv;
-}
+project