Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: disable voting tally #996

Merged
merged 3 commits into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Improvements

- [#996](https://github.com/alleslabs/celatone-frontend/pull/996) Allow disable voting period tally config
- [#960](https://github.com/alleslabs/celatone-frontend/pull/960) Adjust UI in contract and account detail page
- [#983](https://github.com/alleslabs/celatone-frontend/pull/983) Add fallback for collection names that are empty string
- [#982](https://github.com/alleslabs/celatone-frontend/pull/982) Support Icns in account osmosis lite version
Expand Down
1 change: 1 addition & 0 deletions src/config/chain/initia.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ export const INITIA_CHAIN_CONFIGS: ChainConfigs = {
enabled: true,
version: "v1",
hideOpenProposal: true,
disableVotingPeriodTally: true,
},
nft: {
enabled: true,
Expand Down
1 change: 1 addition & 0 deletions src/config/chain/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ type GovConfig =
hideOpenProposal?: boolean;
disableWhitelistProposal?: boolean;
disableStoreCodeProposal?: boolean;
disableVotingPeriodTally?: boolean;
}
| {
enabled: false;
Expand Down
26 changes: 26 additions & 0 deletions src/lib/pages/proposal-details/components/NoVotingPeriodTally.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { Alert, AlertDescription } from "@chakra-ui/react";

import { useCurrentChain } from "lib/app-provider";
import { CustomIcon } from "lib/components/icon";

export const NoVotingPeriodTallyExplanation = () => {
const {
chain: { chain_id: chainId },
} = useCurrentChain();
return (
<>
The proposal tally information during voting period is unavailable in{" "}
<span style={{ fontWeight: 700 }}>{chainId}</span>. It will be available
after voting period ends.
</>
);
};

export const NoVotingPeriodTallyAlert = () => (
<Alert variant="warning" gap={3}>
<CustomIcon name="alert-circle-solid" boxSize={4} color="warning.main" />
<AlertDescription>
<NoVotingPeriodTallyExplanation />
</AlertDescription>
</Alert>
);
15 changes: 15 additions & 0 deletions src/lib/pages/proposal-details/components/ResultExplanation.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import { SkeletonText, Text } from "@chakra-ui/react";
import { isNull } from "lodash";

import { useGovConfig } from "lib/app-provider";
import {
extractParams,
mapDeposit,
Expand All @@ -20,6 +21,7 @@ import { ProposalStatus } from "lib/types";
import { formatPrettyPercent, formatTokenWithValueList } from "lib/utils";

import { ErrorFetchingProposalInfos } from "./ErrorFetchingProposalInfos";
import { NoVotingPeriodTallyExplanation } from "./NoVotingPeriodTally";
import { ViewFailedReason } from "./ViewFailedReason";

const Passed = () => (
Expand Down Expand Up @@ -66,12 +68,25 @@ export interface ResultExplanationProps {
isLoading: boolean;
}

// eslint-disable-next-line complexity
export const ResultExplanation = ({
proposalData,
params,
votesInfo,
isLoading,
}: ResultExplanationProps) => {
const gov = useGovConfig({ shouldRedirect: false });
if (
gov.enabled &&
gov.disableVotingPeriodTally &&
proposalData.status === ProposalStatus.VOTING_PERIOD
)
return (
<Text variant="body2">
<NoVotingPeriodTallyExplanation />
</Text>
);

if (proposalData.status === ProposalStatus.DEPOSIT_FAILED)
return (
<Text variant="body2">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ import { Button, Flex, Text } from "@chakra-ui/react";

import type { ProposalOverviewProps } from "..";
import { ErrorFetchingProposalInfos } from "../../ErrorFetchingProposalInfos";
import { useInternalNavigate } from "lib/app-provider";
import { NoVotingPeriodTallyAlert } from "../../NoVotingPeriodTally";
import { useGovConfig, useInternalNavigate } from "lib/app-provider";
import { CustomIcon } from "lib/components/icon";
import { Loading } from "lib/components/Loading";
import { TabIndex } from "lib/pages/proposal-details/types";
Expand All @@ -20,6 +21,15 @@ const VotingOverviewBody = ({
}: ProposalOverviewProps) => {
const navigate = useInternalNavigate();

const gov = useGovConfig({ shouldRedirect: false });
const disableVotingPeriodTally = gov.enabled && gov.disableVotingPeriodTally;

if (
proposalData.status === ProposalStatus.VOTING_PERIOD &&
disableVotingPeriodTally
)
return <NoVotingPeriodTallyAlert />;

if (proposalData.status === ProposalStatus.DEPOSIT_PERIOD)
return (
<Text variant="body2" color="text.dark">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import type { CSSProperties } from "react";
import type { ProposalOverviewProps } from "..";
import { ActiveDot } from "../../ActiveDot";
import { ResultExplanation } from "../../ResultExplanation";
import { useGovConfig } from "lib/app-provider";
import { StatusChip } from "lib/components/table";
import { ProposalStatus } from "lib/types";

import { SummaryStatusChip } from "./SummaryStatusChip";
Expand Down Expand Up @@ -34,6 +36,8 @@ export const StatusSummary = ({
proposalData,
...props
}: ProposalOverviewProps) => {
const gov = useGovConfig({ shouldRedirect: false });
const disableVotingPeriodTally = gov.enabled && gov.disableVotingPeriodTally;
const isDepositOrVoting =
proposalData.status === ProposalStatus.DEPOSIT_PERIOD ||
proposalData.status === ProposalStatus.VOTING_PERIOD;
Expand All @@ -55,10 +59,22 @@ export const StatusSummary = ({
>
<Flex align="center" gap={2} whiteSpace="nowrap">
{isDepositOrVoting && <ActiveDot />}
<Text variant="body1" textColor="text.main" fontWeight={700}>
{isDepositOrVoting ? "Current" : "Final"} proposal result:
</Text>
<SummaryStatusChip proposalData={proposalData} {...props} />
{disableVotingPeriodTally &&
proposalData.status === ProposalStatus.VOTING_PERIOD ? (
<>
<Text variant="body1" textColor="text.main" fontWeight={700}>
Current proposal status:
</Text>
<StatusChip status={ProposalStatus.VOTING_PERIOD} />
</>
) : (
<>
<Text variant="body1" textColor="text.main" fontWeight={700}>
{isDepositOrVoting ? "Current" : "Final"} proposal result:
</Text>
<SummaryStatusChip proposalData={proposalData} {...props} />
</>
)}
</Flex>
<SummaryStatusTime proposalData={proposalData} />
</Flex>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ import { isNull } from "lodash";
import type { ReactNode } from "react";

import type { VoteDetailsProps } from "..";
import { NoVotingPeriodTallyAlert } from "../../NoVotingPeriodTally";
import { AmpEvent, track } from "lib/amplitude";
import { useMobile, useTierConfig } from "lib/app-provider";
import { useGovConfig, useMobile, useTierConfig } from "lib/app-provider";
import { CustomIcon } from "lib/components/icon";
import { TableTitle } from "lib/components/table";
import { useProposalAnswerCounts } from "lib/services/proposal";
import { ProposalStatus } from "lib/types";
import { scrollToComponent, scrollYPosition } from "lib/utils";

import { ProposalVotesPanel } from "./ProposalVotesPanel";
Expand Down Expand Up @@ -50,9 +52,11 @@ const ContentContainer = ({
const scrollComponentId = "voting-period";

export const VotingPeriod = ({ proposalData, ...props }: VoteDetailsProps) => {
const isMobile = useMobile();
const isFullTier = useTierConfig() === "full";
const gov = useGovConfig({ shouldRedirect: false });
const disableVotingPeriodTally = gov.enabled && gov.disableVotingPeriodTally;

const isMobile = useMobile();
const validatorVoteDisclosure = useDisclosure();
const allVoteDisclosure = useDisclosure();

Expand Down Expand Up @@ -111,14 +115,21 @@ export const VotingPeriod = ({ proposalData, ...props }: VoteDetailsProps) => {
transition="all 0.25s ease-in-out"
gap={4}
>
{/* Voting Participations */}
<ContentContainer transparent={isMobile}>
<VotingQuorum proposalData={proposalData} {...props} />
</ContentContainer>
{/* Voting Results */}
<ContentContainer transparent={isMobile}>
<VotingThreshold proposalData={proposalData} {...props} />
</ContentContainer>
{proposalData.status === ProposalStatus.VOTING_PERIOD &&
disableVotingPeriodTally ? (
<NoVotingPeriodTallyAlert />
) : (
<>
{/* Voting Participations */}
<ContentContainer transparent={isMobile}>
<VotingQuorum proposalData={proposalData} {...props} />
</ContentContainer>
{/* Voting Results */}
<ContentContainer transparent={isMobile}>
<VotingThreshold proposalData={proposalData} {...props} />
</ContentContainer>
</>
)}
{isFullTier && (
<Grid gridTemplateColumns={isMobile ? "1fr " : "1fr 1fr"} gridGap={4}>
{/* Validator Votes */}
Expand Down
12 changes: 9 additions & 3 deletions src/lib/pages/proposal-details/data.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { useTierConfig } from "lib/app-provider";
import { useGovConfig, useTierConfig } from "lib/app-provider";
import { useAssetInfos } from "lib/services/assetService";
import { useMovePoolInfos } from "lib/services/move/poolService";
import {
Expand Down Expand Up @@ -124,10 +124,16 @@ export const useDerivedProposalVotesInfo = (
proposalData: DerivedProposalDataResponse["data"],
isProposalDataLoading: boolean
): DerivedProposalVotesInfoResponse => {
const gov = useGovConfig({ shouldRedirect: false });
const disableVotingPeriodTally = gov.enabled && gov.disableVotingPeriodTally;

const isVotingPeriod =
proposalData?.info?.status === ProposalStatus.VOTING_PERIOD;

const { data, isLoading } = useProposalVotesInfo(id, isVotingPeriod);
const { data, isFetching } = useProposalVotesInfo(
id,
isVotingPeriod && !disableVotingPeriodTally
);

if (!isVotingPeriod) {
return {
Expand All @@ -138,6 +144,6 @@ export const useDerivedProposalVotesInfo = (

return {
data,
isLoading,
isLoading: isFetching,
};
};
Loading