fix: update governance API paths and enhance proposal details handling

Andre-Diamond · Andre-Diamond · commit dc6b6c43b7a1 · 2026-03-02T10:58:49.000+02:00
- Modified API path checks in governanceActiveProposals to remove leading slashes for consistency.
- Enhanced error handling for metadata retrieval, returning structured error responses.
- Improved proposal status resolution logic to handle additional details from the provider.
- Refactored proposal details fetching to ensure accurate data retrieval and status determination.
diff --git a/src/__tests__/governance.test.ts b/src/__tests__/governance.test.ts
@@ -0,0 +1,37 @@
+import { describe, expect, it } from "@jest/globals";
+import { getProposalStatus } from "../lib/governance";
+import type { ProposalDetails } from "../types/governance";
+
+describe("getProposalStatus", () => {
+  const baseProposal: ProposalDetails = {
+    id: "proposal",
+    tx_hash: "tx-hash",
+    cert_index: 0,
+    governance_type: "info_action",
+    deposit: "0",
+    return_address: "addr_test1...",
+    expiration: null,
+    governance_description: { tag: "off_chain" },
+    ratified_epoch: null,
+    enacted_epoch: null,
+    dropped_epoch: null,
+    expired_epoch: null,
+  };
+
+  it("returns active when all terminal epochs are null", () => {
+    expect(getProposalStatus({ ...baseProposal, id: "proposal-1" })).toBe("active");
+  });
+
+  it("returns active when terminal epoch fields are undefined", () => {
+    expect(
+      getProposalStatus({
+        ...baseProposal,
+        id: "proposal-2",
+        ratified_epoch: undefined as unknown as number | null,
+        enacted_epoch: undefined as unknown as number | null,
+        dropped_epoch: undefined as unknown as number | null,
+        expired_epoch: undefined as unknown as number | null,
+      } as unknown as ProposalDetails),
+    ).toBe("active");
+  });
+});
diff --git a/src/__tests__/governanceActiveProposals.test.ts b/src/__tests__/governanceActiveProposals.test.ts
@@ -147,7 +147,7 @@ describe("governanceActiveProposals API", () => {
 
   it("returns only active proposals and tolerates metadata 404", async () => {
     providerGetMock.mockImplementation(async (path: string) => {
-      if (path.startsWith("/governance/proposals?")) {
+      if (path.startsWith("governance/proposals?")) {
         return [
           {
             tx_hash: "tx-active",
@@ -169,10 +169,37 @@ describe("governanceActiveProposals API", () => {
           },
         ];
       }
-      if (path === "/governance/proposals/tx-active/0/metadata") {
-        const error = new Error("404") as Error & { status?: number };
-        error.status = 404;
-        throw error;
+      if (path === "governance/proposals/tx-active/0") {
+        return {
+          ratified_epoch: null,
+          enacted_epoch: null,
+          dropped_epoch: null,
+          expired_epoch: null,
+          expiration: 999,
+          deposit: "1000000",
+          return_address: "addr_test1...",
+        };
+      }
+      if (path === "governance/proposals/tx-ratified/1") {
+        return {
+          ratified_epoch: 530,
+          enacted_epoch: null,
+          dropped_epoch: null,
+          expired_epoch: null,
+          expiration: 999,
+          deposit: "1000000",
+          return_address: "addr_test1...",
+        };
+      }
+      if (path === "governance/proposals/tx-active/0/metadata") {
+        throw JSON.stringify({
+          data: {
+            error: "Not Found",
+            message: "The requested component has not been found.",
+            status_code: 404,
+          },
+          status: 404,
+        });
       }
       return null;
     });
diff --git a/src/lib/governance.ts b/src/lib/governance.ts
@@ -5,10 +5,10 @@ export type BallotChoice = "Yes" | "No" | "Abstain";
 
 export function getProposalStatus(details?: ProposalDetails | null): ProposalStatus | null {
   if (!details) return null;
-  if (details.enacted_epoch !== null) return "enacted";
-  if (details.dropped_epoch !== null) return "dropped";
-  if (details.expired_epoch !== null) return "expired";
-  if (details.ratified_epoch !== null) return "ratified";
+  if (details.enacted_epoch != null) return "enacted";
+  if (details.dropped_epoch != null) return "dropped";
+  if (details.expired_epoch != null) return "expired";
+  if (details.ratified_epoch != null) return "ratified";
   return "active";
 }
 
diff --git a/src/pages/api/v1/governanceActiveProposals.ts b/src/pages/api/v1/governanceActiveProposals.ts
@@ -19,7 +19,28 @@ type BlockfrostProposalListItem = {
   ratified_epoch: number | null;
 };
 
+type BlockfrostProposalDetailsItem = {
+  proposed_epoch?: number | null;
+  activation_epoch?: number | null;
+  expiration?: number | null;
+  deposit?: string | null;
+  return_address?: string | null;
+  parameters?: unknown;
+  ratified_epoch?: number | null;
+  enacted_epoch?: number | null;
+  dropped_epoch?: number | null;
+  expired_epoch?: number | null;
+};
+
 const getErrorStatus = (error: unknown): number | undefined => {
+  if (typeof error === "string") {
+    try {
+      const parsed = JSON.parse(error) as unknown;
+      return getErrorStatus(parsed);
+    } catch {
+      return undefined;
+    }
+  }
   if (
     error &&
     typeof error === "object" &&
@@ -120,52 +141,71 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
   try {
     const provider = getProvider(Number(network));
     const list = (await provider.get(
-      `/governance/proposals?count=${count}&page=${page}&order=${order}`,
+      `governance/proposals?count=${count}&page=${page}&order=${order}`,
     )) as BlockfrostProposalListItem[];
 
-    const active = Array.isArray(list)
-      ? list.filter((item) => {
-          const status = getProposalStatus({
-            id: "",
-            tx_hash: item.tx_hash,
-            cert_index: Number(item.cert_index),
-            governance_type: item.governance_type,
-            deposit: "",
-            return_address: "",
-            governance_description: { tag: "" },
-            ratified_epoch: item.ratified_epoch,
-            enacted_epoch: item.enacted_epoch,
-            dropped_epoch: item.dropped_epoch,
-            expired_epoch: item.expired_epoch,
-            expiration: null,
-          });
-          return status === "active";
-        })
-      : [];
+    const statusResolved = await Promise.all(
+      (Array.isArray(list) ? list : []).map(async (item) => {
+        const txHash = item.tx_hash;
+        const certIndex = Number(item.cert_index);
+        let detailsForStatus: BlockfrostProposalDetailsItem | null = null;
+
+        try {
+          detailsForStatus = (await provider.get(
+            `governance/proposals/${txHash}/${certIndex}`,
+          )) as BlockfrostProposalDetailsItem;
+        } catch (error) {
+          const status = getErrorStatus(error);
+          if (status && status !== 404) throw error;
+        }
+
+        const status = getProposalStatus({
+          id: "",
+          tx_hash: txHash,
+          cert_index: certIndex,
+          governance_type: item.governance_type,
+          deposit:
+            typeof detailsForStatus?.deposit === "string"
+              ? detailsForStatus.deposit
+              : "",
+          return_address:
+            typeof detailsForStatus?.return_address === "string"
+              ? detailsForStatus.return_address
+              : "",
+          governance_description: { tag: "" },
+          ratified_epoch:
+            detailsForStatus?.ratified_epoch ?? item.ratified_epoch ?? null,
+          enacted_epoch:
+            detailsForStatus?.enacted_epoch ?? item.enacted_epoch ?? null,
+          dropped_epoch:
+            detailsForStatus?.dropped_epoch ?? item.dropped_epoch ?? null,
+          expired_epoch:
+            detailsForStatus?.expired_epoch ?? item.expired_epoch ?? null,
+          expiration:
+            typeof detailsForStatus?.expiration === "number"
+              ? detailsForStatus.expiration
+              : null,
+        });
+
+        return { item, detailsForStatus, status };
+      }),
+    );
+
+    const active = statusResolved.filter((entry) => entry.status === "active");
 
     const proposals = await Promise.all(
-      active.map(async (item) => {
+      active.map(async ({ item, detailsForStatus }) => {
         const txHash = item.tx_hash;
         const certIndex = Number(item.cert_index);
         let metadata: any = null;
-        let details: any = null;
 
         try {
-          metadata = await provider.get(`/governance/proposals/${txHash}/${certIndex}/metadata`);
+          metadata = await provider.get(`governance/proposals/${txHash}/${certIndex}/metadata`);
         } catch (error) {
           const status = getErrorStatus(error);
           if (status !== 404) throw error;
         }
 
-        if (includeDetails) {
-          try {
-            details = await provider.get(`/governance/proposals/${txHash}/${certIndex}`);
-          } catch (error) {
-            const status = getErrorStatus(error);
-            if (status && status !== 404) throw error;
-          }
-        }
-
         const body = metadata?.json_metadata?.body ?? {};
         const authors = Array.isArray(metadata?.json_metadata?.authors)
           ? metadata.json_metadata.authors
@@ -187,16 +227,30 @@ export default async function handler(req: NextApiRequest, res: NextApiResponse)
           details: includeDetails
             ? {
                 proposedEpoch:
-                  typeof details?.proposed_epoch === "number" ? details.proposed_epoch : null,
+                  typeof detailsForStatus?.proposed_epoch === "number"
+                    ? detailsForStatus.proposed_epoch
+                    : null,
                 activationEpoch:
-                  typeof details?.activation_epoch === "number" ? details.activation_epoch : null,
-                expiration: typeof details?.expiration === "number" ? details.expiration : null,
-                deposit: typeof details?.deposit === "string" ? details.deposit : null,
+                  typeof detailsForStatus?.activation_epoch === "number"
+                    ? detailsForStatus.activation_epoch
+                    : null,
+                expiration:
+                  typeof detailsForStatus?.expiration === "number"
+                    ? detailsForStatus.expiration
+                    : null,
+                deposit:
+                  typeof detailsForStatus?.deposit === "string"
+                    ? detailsForStatus.deposit
+                    : null,
                 returnAddress:
-                  typeof details?.return_address === "string" ? details.return_address : null,
+                  typeof detailsForStatus?.return_address === "string"
+                    ? detailsForStatus.return_address
+                    : null,
                 parameters:
-                  details && typeof details === "object" && "parameters" in details
-                    ? details.parameters ?? null
+                  detailsForStatus &&
+                  typeof detailsForStatus === "object" &&
+                  "parameters" in detailsForStatus
+                    ? detailsForStatus.parameters ?? null
                     : null,
               }
             : undefined,
