split status functions

aragon · Jul 24, 2023 · c011b9b · c011b9b
1 parent 5c3d30f
commit c011b9b
Show file tree

Hide file tree

Showing 9 changed files with 177 additions and 76 deletions.
diff --git a/modules/client/src/addresslistVoting/internal/client/methods.ts b/modules/client/src/addresslistVoting/internal/client/methods.ts
@@ -20,7 +20,6 @@ import { isAddress } from "@ethersproject/address";
 import { IAddresslistVotingClientMethods } from "../interfaces";
 import {
   CanVoteParams,
-  computeProposalStatusFilter,
   CreateMajorityVotingProposalParams,
   ExecuteProposalStep,
   ExecuteProposalStepValue,
@@ -45,6 +44,7 @@ import {
 import {
   toAddresslistVotingProposal,
   toAddresslistVotingProposalListItem,
+  computeProposalStatusFilter
 } from "../utils";
 import { AddresslistVoting__factory } from "@aragon/osx-ethers";
 import { toUtf8Bytes } from "@ethersproject/strings";

diff --git a/modules/client/src/addresslistVoting/internal/utils.ts b/modules/client/src/addresslistVoting/internal/utils.ts
@@ -2,9 +2,9 @@ import {
   decodeRatio,
   getCompactProposalId,
   hexToBytes,
+  InvalidProposalStatusError,
 } from "@aragon/sdk-common";
 import {
-  computeProposalStatus,
   SubgraphAction,
   SubgraphVoteValuesMap,
   VoteValues,
@@ -21,7 +21,11 @@ import {
   SubgraphAddresslistVotingProposalListItem,
   SubgraphAddresslistVotingVoterListItem,
 } from "./types";
-import { DaoAction, ProposalMetadata } from "@aragon/sdk-client-common";
+import {
+  DaoAction,
+  ProposalMetadata,
+  ProposalStatus,
+} from "@aragon/sdk-client-common";
 
 export function toAddresslistVotingProposal(
   proposal: SubgraphAddresslistVotingProposal,
@@ -144,3 +148,57 @@ export function addresslistVotingInitParamsToContract(
     params.addresses,
   ];
 }
+
+export function computeProposalStatus(
+  proposal:
+    | SubgraphAddresslistVotingProposal
+    | SubgraphAddresslistVotingProposalListItem,
+): ProposalStatus {
+  const now = new Date();
+  const startDate = new Date(
+    parseInt(proposal.startDate) * 1000,
+  );
+  const endDate = new Date(parseInt(proposal.endDate) * 1000);
+  if (proposal.executed) {
+    return ProposalStatus.EXECUTED;
+  }
+  if (startDate >= now) {
+    return ProposalStatus.PENDING;
+  }
+  if (proposal.potentiallyExecutable || proposal.earlyExecutable) {
+    return ProposalStatus.SUCCEEDED;
+  }
+  if (endDate >= now) {
+    return ProposalStatus.ACTIVE;
+  }
+  return ProposalStatus.DEFEATED;
+}
+
+export function computeProposalStatusFilter(status: ProposalStatus) {
+  let where = {};
+  const now = Math.round(new Date().getTime() / 1000).toString();
+  switch (status) {
+    case ProposalStatus.PENDING:
+      where = { startDate_gte: now };
+      break;
+    case ProposalStatus.ACTIVE:
+      where = { startDate_lt: now, endDate_gte: now, executed: false };
+      break;
+    case ProposalStatus.EXECUTED:
+      where = { executed: true };
+      break;
+    case ProposalStatus.SUCCEEDED:
+      where = { potentiallyExecutable: true, endDate_lt: now };
+      break;
+    case ProposalStatus.DEFEATED:
+      where = {
+        potentiallyExecutable: false,
+        endDate_lt: now,
+        executed: false,
+      };
+      break;
+    default:
+      throw new InvalidProposalStatusError();
+  }
+  return where;
+}
diff --git a/modules/client/src/client-common/types/plugin.ts b/modules/client/src/client-common/types/plugin.ts
@@ -130,14 +130,6 @@ export type SubgraphProposalBase = {
   potentiallyExecutable: boolean;
 };
 
-export interface IComputeStatusProposal {
-  startDate: string;
-  endDate: string;
-  executed: boolean;
-  earlyExecutable?: boolean;
-  potentiallyExecutable: boolean;
-}
-
 export type ProposalQueryParams = Pagination & {
   sortBy?: ProposalSortBy;
   status?: ProposalStatus;

diff --git a/modules/client/src/client-common/utils.ts b/modules/client/src/client-common/utils.ts
@@ -2,19 +2,16 @@ import { IDAO } from "@aragon/osx-ethers";
 import { VoteValues, VotingMode } from "./types/plugin";
 import {
   CreateMajorityVotingProposalParams,
-  IComputeStatusProposal,
 } from "./types/plugin";
 
 import {
-  InvalidProposalStatusError,
   InvalidVotingModeError,
 } from "@aragon/sdk-common";
 import { FAILING_PROPOSAL_AVAILABLE_FUNCTION_SIGNATURES } from "./internal";
 import {
   DaoAction,
   DecodedApplyInstallationParams,
   getFunctionFragment,
-  ProposalStatus,
 } from "@aragon/sdk-client-common";
 
 import { Result } from "@ethersproject/abi";
@@ -34,60 +31,6 @@ export function unwrapProposalParams(
   ];
 }
 
-export function computeProposalStatus(
-  proposal: IComputeStatusProposal,
-): ProposalStatus {
-  const now = new Date();
-  const startDate = new Date(
-    parseInt(proposal.startDate) * 1000,
-  );
-  const endDate = new Date(parseInt(proposal.endDate) * 1000);
-  if (proposal.executed) {
-    return ProposalStatus.EXECUTED;
-  }
-  if (startDate >= now) {
-    return ProposalStatus.PENDING;
-  }
-  if (proposal.potentiallyExecutable || proposal.earlyExecutable) {
-    return ProposalStatus.SUCCEEDED;
-  }
-  if (endDate >= now) {
-    return ProposalStatus.ACTIVE;
-  }
-  return ProposalStatus.DEFEATED;
-}
-
-export function computeProposalStatusFilter(
-  status: ProposalStatus,
-): Object {
-  let where = {};
-  const now = Math.round(new Date().getTime() / 1000).toString();
-  switch (status) {
-    case ProposalStatus.PENDING:
-      where = { startDate_gte: now };
-      break;
-    case ProposalStatus.ACTIVE:
-      where = { startDate_lt: now, endDate_gte: now, executed: false };
-      break;
-    case ProposalStatus.EXECUTED:
-      where = { executed: true };
-      break;
-    case ProposalStatus.SUCCEEDED:
-      where = { potentiallyExecutable: true, endDate_lt: now };
-      break;
-    case ProposalStatus.DEFEATED:
-      where = {
-        potentiallyExecutable: false,
-        endDate_lt: now,
-        executed: false,
-      };
-      break;
-    default:
-      throw new InvalidProposalStatusError();
-  }
-  return where;
-}
-
 export function votingModeToContracts(votingMode: VotingMode): number {
   switch (votingMode) {
     case VotingMode.STANDARD:

diff --git a/modules/client/src/multisig/internal/client/methods.ts b/modules/client/src/multisig/internal/client/methods.ts
@@ -33,7 +33,6 @@ import {
   SubgraphMultisigVotingSettings,
 } from "../types";
 import {
-  computeProposalStatusFilter,
   ExecuteProposalStep,
   ExecuteProposalStepValue,
   ProposalCreationSteps,
@@ -49,7 +48,7 @@ import {
   QueryMultisigProposals,
   QueryMultisigVotingSettings,
 } from "../graphql-queries";
-import { toMultisigProposal, toMultisigProposalListItem } from "../utils";
+import { computeProposalStatusFilter, toMultisigProposal, toMultisigProposalListItem } from "../utils";
 import { toUtf8Bytes } from "@ethersproject/strings";
 import { IMultisigClientMethods } from "../interfaces";
 import {

diff --git a/modules/client/src/multisig/internal/utils.ts b/modules/client/src/multisig/internal/utils.ts
@@ -1,11 +1,15 @@
-import { getCompactProposalId, hexToBytes } from "@aragon/sdk-common";
-import { computeProposalStatus, SubgraphAction } from "../../client-common";
+import { InvalidProposalStatusError, getCompactProposalId, hexToBytes } from "@aragon/sdk-common";
+import { SubgraphAction } from "../../client-common";
 import { MultisigProposal, MultisigProposalListItem } from "../types";
 import {
   SubgraphMultisigProposal,
   SubgraphMultisigProposalListItem,
 } from "./types";
-import { DaoAction, ProposalMetadata } from "@aragon/sdk-client-common";
+import {
+  DaoAction,
+  ProposalMetadata,
+  ProposalStatus,
+} from "@aragon/sdk-client-common";
 
 export function toMultisigProposal(
   proposal: SubgraphMultisigProposal,
@@ -98,3 +102,54 @@ export function toMultisigProposalListItem(
     status: computeProposalStatus(proposal),
   };
 }
+
+export function computeProposalStatus(
+  proposal: SubgraphMultisigProposal | SubgraphMultisigProposalListItem,
+): ProposalStatus {
+  const now = new Date();
+  const startDate = new Date(
+    parseInt(proposal.startDate) * 1000,
+  );
+  const endDate = new Date(parseInt(proposal.endDate) * 1000);
+  if (proposal.executed) {
+    return ProposalStatus.EXECUTED;
+  }
+  if (now < startDate) {
+    return ProposalStatus.PENDING;
+  }
+  if (proposal.potentiallyExecutable && now < endDate) {
+    return ProposalStatus.SUCCEEDED;
+  }
+  if (now < endDate) {
+    return ProposalStatus.ACTIVE;
+  }
+  return ProposalStatus.DEFEATED;
+}
+
+export function computeProposalStatusFilter(status: ProposalStatus) {
+  let where = {};
+  const now = Math.round(new Date().getTime() / 1000).toString();
+  switch (status) {
+    case ProposalStatus.PENDING:
+      where = { startDate_gte: now };
+      break;
+    case ProposalStatus.ACTIVE:
+      where = { startDate_lt: now, endDate_gte: now, executed: false };
+      break;
+    case ProposalStatus.EXECUTED:
+      where = { executed: true };
+      break;
+    case ProposalStatus.SUCCEEDED:
+      where = { potentiallyExecutable: true, endDate_gte: now };
+      break;
+    case ProposalStatus.DEFEATED:
+      where = {
+        endDate_lt: now,
+        executed: false,
+      };
+      break;
+    default:
+      throw new InvalidProposalStatusError();
+  }
+  return where;
+}
diff --git a/modules/client/src/tokenVoting/internal/client/methods.ts b/modules/client/src/tokenVoting/internal/client/methods.ts
@@ -20,7 +20,6 @@ import {
 } from "@aragon/sdk-common";
 import {
   CanVoteParams,
-  computeProposalStatusFilter,
   CreateMajorityVotingProposalParams,
   ExecuteProposalStep,
   ExecuteProposalStepValue,
@@ -70,6 +69,7 @@ import {
   QueryTokenVotingSettings,
 } from "../graphql-queries";
 import {
+  computeProposalStatusFilter,
   tokenVotingInitParamsToContract,
   toTokenVotingMember,
   toTokenVotingProposal,

diff --git a/modules/client/src/tokenVoting/internal/utils.ts b/modules/client/src/tokenVoting/internal/utils.ts
@@ -1,5 +1,4 @@
 import {
-  computeProposalStatus,
   SubgraphAction,
   SubgraphVoteValuesMap,
   VoteValues,
@@ -34,10 +33,12 @@ import {
   decodeRatio,
   getCompactProposalId,
   hexToBytes,
+  InvalidProposalStatusError,
 } from "@aragon/sdk-common";
 import {
   DaoAction,
   ProposalMetadata,
+  ProposalStatus,
   TokenType,
 } from "@aragon/sdk-client-common";
 
@@ -276,3 +277,57 @@ export function toTokenVotingMember(
     }),
   };
 }
+
+
+
+export function computeProposalStatus(
+  proposal: SubgraphTokenVotingProposal | SubgraphTokenVotingProposalListItem,
+): ProposalStatus {
+  const now = new Date();
+  const startDate = new Date(
+    parseInt(proposal.startDate) * 1000,
+  );
+  const endDate = new Date(parseInt(proposal.endDate) * 1000);
+  if (proposal.executed) {
+    return ProposalStatus.EXECUTED;
+  }
+  if (startDate >= now) {
+    return ProposalStatus.PENDING;
+  }
+  if (proposal.potentiallyExecutable || proposal.earlyExecutable) {
+    return ProposalStatus.SUCCEEDED;
+  }
+  if (endDate >= now) {
+    return ProposalStatus.ACTIVE;
+  }
+  return ProposalStatus.DEFEATED;
+}
+
+export function computeProposalStatusFilter(status: ProposalStatus) {
+  let where = {};
+  const now = Math.round(new Date().getTime() / 1000).toString();
+  switch (status) {
+    case ProposalStatus.PENDING:
+      where = { startDate_gte: now };
+      break;
+    case ProposalStatus.ACTIVE:
+      where = { startDate_lt: now, endDate_gte: now, executed: false };
+      break;
+    case ProposalStatus.EXECUTED:
+      where = { executed: true };
+      break;
+    case ProposalStatus.SUCCEEDED:
+      where = { potentiallyExecutable: true, endDate_lt: now };
+      break;
+    case ProposalStatus.DEFEATED:
+      where = {
+        potentiallyExecutable: false,
+        endDate_lt: now,
+        executed: false,
+      };
+      break;
+    default:
+      throw new InvalidProposalStatusError();
+  }
+  return where;
+}
diff --git a/modules/client/test/integration/multisig-client/methods.test.ts b/modules/client/test/integration/multisig-client/methods.test.ts
@@ -606,7 +606,6 @@ describe("Client Multisig", () => {
         QueryMultisigProposals,
         {
           where: {
-            potentiallyExecutable: false,
             endDate_lt: nowFilter,
             executed: false,
           },