Merge pull request #758 from alleslabs/feat/cfe-285-validator-votes

feat: proposal validator votes hook

CHANGELOG.md

@@ -39,6 +39,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Features
 
+- [#758](https://github.com/alleslabs/celatone-frontend/pull/758) api v1 - proposal validator votes
 - [#757](https://github.com/alleslabs/celatone-frontend/pull/757) api v1 - proposal data
 - [#731](https://github.com/alleslabs/celatone-frontend/pull/731) Add proposal detail page structure
 - [#749](https://github.com/alleslabs/celatone-frontend/pull/749) Add multi-type proposals

src/lib/app-provider/env.ts

@@ -52,6 +52,7 @@ export enum CELATONE_QUERY_KEYS {
   FAUCET_INFO = "CELATONE_QUERY_FAUCET_INFO",
   // X/GOV
   PROPOSAL_DATA = "CELATONE_QUERY_PROPOSAL_DATA",
+  PROPOSAL_VALIDATOR_VOTES = "CELATONE_QUERY_PROPOSAL_VALIDATOR_VOTES",
   RELATED_PROPOSALS_BY_CONTRACT_ADDRESS = "CELATONE_QUERY_RELATED_PROPOSALS_BY_CONTRACT_ADDRESS",
   PROPOSALS_BY_MODULE_ID = "CELATONE_QUERY_PROPOSALS_BY_MODULE_ID",
   PROPOSALS_COUNT_BY_MODULE_ID = "CELATONE_QUERY_PROPOSALS_COUNT_BY_MODULE_ID",

src/lib/services/proposal.ts

@@ -8,6 +8,7 @@ import {
   zProposalStatus,
   zProposalType,
   zUtcDate,
+  zValidator,
 } from "lib/types";
 import type {
   AccessConfigPermission,
@@ -20,6 +21,7 @@ import type {
   ProposalData,
   ProposalStatus,
   ProposalType,
+  ProposalVote,
 } from "lib/types";
 import { snakeToCamel } from "lib/utils";
 
@@ -199,3 +201,33 @@ export const getProposalData = async (
   axios
     .get(`${endpoint}/${encodeURIComponent(id)}/info`)
     .then(({ data }) => zProposalDataResponse.parse(data));
+
+const zProposalVotesResponseItem = z
+  .object({
+    proposal_id: z.number().nonnegative(),
+    abstain: z.number().nonnegative(),
+    no: z.number().nonnegative(),
+    no_with_veto: z.number().nonnegative(),
+    yes: z.number().nonnegative(),
+    is_vote_weighted: z.boolean(),
+    validator: zValidator,
+    voter: zBechAddr.nullable(),
+    timestamp: zUtcDate.nullable(),
+    tx_hash: z.string().nullable(),
+  })
+  .transform<ProposalVote>(snakeToCamel);
+
+const zProposalVotesResponse = z.object({
+  items: z.array(zProposalVotesResponseItem),
+  total: z.number().nonnegative(),
+});
+
+export type ProposalVotesResponse = z.infer<typeof zProposalVotesResponse>;
+
+export const getProposalValidatorVotes = async (
+  endpoint: string,
+  id: number
+): Promise<ProposalVotesResponse> =>
+  axios
+    .get(`${endpoint}/${encodeURIComponent(id)}/validator-votes`)
+    .then(({ data }) => zProposalVotesResponse.parse(data));

src/lib/services/proposalService.ts

@@ -39,6 +39,7 @@ import { useMovePoolInfos } from "./move";
 import type {
   DepositParamsInternal,
   ProposalDataResponse,
+  ProposalVotesResponse,
   ProposalsResponse,
   RelatedProposalsResponse,
   UploadAccess,
@@ -53,6 +54,7 @@ import {
   getProposals,
   getProposalTypes,
   getProposalData,
+  getProposalValidatorVotes,
 } from "./proposal";
 
 export const useProposals = (
@@ -323,3 +325,15 @@ export const useUploadAccessParams = (): UseQueryResult<UploadAccess> => {
     { keepPreviousData: true, refetchOnWindowFocus: false }
   );
 };
+
+export const useProposalValidatorVotes = (
+  id: number
+): UseQueryResult<ProposalVotesResponse> => {
+  const endpoint = useBaseApiRoute("proposals");
+
+  return useQuery(
+    [CELATONE_QUERY_KEYS.PROPOSAL_VALIDATOR_VOTES, endpoint, id],
+    async () => getProposalValidatorVotes(endpoint, id),
+    { retry: 1, refetchOnWindowFocus: false }
+  );
+};

src/lib/types/proposal.ts

@@ -1,7 +1,7 @@
 import type { Coin } from "@cosmjs/amino";
 import { z } from "zod";
 
-import type { BechAddr, Nullable, Option } from "lib/types";
+import type { BechAddr, Nullable, Option, Validator } from "lib/types";
 
 export enum ProposalStatus {
   DEPOSIT_PERIOD = "DepositPeriod",
@@ -90,3 +90,16 @@ export interface ProposalData extends Proposal {
   version: string;
   votingTime: Nullable<Date>;
 }
+
+export interface ProposalVote {
+  proposalId: number;
+  abstain: number;
+  no: number;
+  noWithVeto: number;
+  yes: number;
+  isVoteWeighted: boolean;
+  validator: Validator;
+  voter: Nullable<BechAddr>;
+  timestamp: Nullable<Date>;
+  txHash: Nullable<string>;
+}