Merge pull request #11 from cardanoapi/feat/block-details-api

mesudip · web-flow · commit 404be01518e3 · 2025-04-17T11:55:28.000+05:45
Feat/block details api
diff --git a/src/controllers/blockchain.ts b/src/controllers/blockchain.ts
@@ -1,6 +1,6 @@
 import { Request, Response, Router } from 'express'
 import { handlerWrapper } from '../errors/AppError'
-import { fetchCommitteeGovState, fetchEpochDuration, fetchEpochParams } from '../repository/blockchain'
+import { fetchBlockInfo, fetchCommitteeGovState, fetchEpochDuration, fetchEpochParams } from '../repository/blockchain'
 
 const router = Router()
 
@@ -16,13 +16,22 @@ const getEpochParams = async (req: Request, res: Response): Promise<any> => {
     return res.status(200).json(result)
 }
 
-const getCommitteeGovState = async(req:Request, res:Response):Promise<any> => {
+const getCommitteeGovState = async (req: Request, res: Response): Promise<any> => {
     const result = await fetchCommitteeGovState()
     return res.status(200).json(result)
 }
 
+const getBlockInfo = async (req: Request, res: Response): Promise<any> => {
+    const blockNo = !isNaN(parseInt(req.query.block_no as string)) ? parseInt(req.query.block_no as string) : undefined
+    const limit = !isNaN(parseInt(req.query.limit as string)) ? parseInt(req.query.limit as string) : undefined
+    const result = await fetchBlockInfo(limit, blockNo)
+    if (!result) return res.status(404).json(null)
+    return res.status(200).json(result)
+}
+
 router.get('/epoch', handlerWrapper(getEpochDuration))
 router.get('/epoch/params', handlerWrapper(getEpochParams))
 router.get('/gov-state/committee', handlerWrapper(getCommitteeGovState))
+router.get('/block', handlerWrapper(getBlockInfo))
 
 export default router
diff --git a/src/controllers/proposal.ts b/src/controllers/proposal.ts
@@ -2,7 +2,7 @@ import { Request, Response, Router } from 'express'
 import { handlerWrapper } from '../errors/AppError'
 import { fetchProposalById, fetchProposalVoteCount, fetchProposalVotes, fetchProposals } from '../repository/proposal'
 import { formatProposal, validateHash, validateVoter } from '../helpers/validator'
-import { ProposalTypes, SortTypes } from '../types/proposal'
+import { GovActionStateTypes, ProposalTypes, SortTypes } from '../types/proposal'
 
 const router = Router()
 
@@ -13,10 +13,11 @@ const getProposals = async (req: Request, res: Response) => {
         ? Array.isArray(req.query.type)
             ? (req.query.type as ProposalTypes[])
             : typeof req.query.type === 'string'
-                ? req.query.type.split(',').map((type) => type as ProposalTypes)
-                : undefined
+            ? req.query.type.split(',').map((type) => type as ProposalTypes)
+            : undefined
         : undefined
     const sort = req.query.sort ? (req.query.sort as SortTypes) : undefined
+    const state = req.query.state ? (req.query.state as GovActionStateTypes) : undefined
     const includeVoteCount = 'true' == (req.query.vote_count as string)
     let proposal = req.query.proposal as string
 
@@ -26,7 +27,7 @@ const getProposals = async (req: Request, res: Response) => {
         }
         proposal = proposal.includes('#') ? proposal.split('#')[0] : proposal
     }
-    const { items, totalCount } = await fetchProposals(page, size, proposal, type, sort, includeVoteCount)
+    const { items, totalCount } = await fetchProposals(page, size, proposal, type, sort, state, includeVoteCount)
     return res.status(200).json({ totalCount: totalCount, page, size, items })
 }
 
@@ -60,6 +61,7 @@ const getProposalById = async (req: Request, res: Response) => {
         return res.status(400).json({ message: 'Provide valid govAction Id (hash#index) or bech32' })
     }
     const proposalDetails = await fetchProposalById(proposal.id, proposal.ix, includeVoteCount)
+    if (!proposalDetails) return res.status(404).json(proposalDetails)
     return res.status(200).json(proposalDetails)
 }
 
diff --git a/src/repository/blockchain.ts b/src/repository/blockchain.ts
@@ -103,3 +103,34 @@ export async function fetchCommitteeGovState() {
 
     return convertKeysToCamelCase(rawResult)
 }
+
+export async function fetchBlockInfo(limit?: number, blockNo?: number) {
+    let result: any
+    if (blockNo) result = await prisma.$queryRaw`select * from block b where b.block_no=${blockNo}`
+    else
+        result =
+            await prisma.$queryRaw`select * from block b where b.block_no is not null order by b.block_no desc limit ${
+                limit || 5
+            } `
+
+    const parseResult = (result: any) => {
+        return {
+            blockNo: Number(result.block_no),
+            hash: result.hash.toString('hex'),
+            epochNo: result.epoch_no,
+            slotNo: result.slot_no.toString(),
+            epochSlotNo: result.epoch_slot_no,
+            size: result.size,
+            time: result.time,
+            txCount: Number(result.tx_count),
+            verificationKey: result.vrf_key,
+        }
+    }
+
+    if (result.length == 0) return null
+    if (result.length == 1) return parseResult(result[0])
+    else
+        return result.map((res: any) => {
+            return parseResult(res)
+        })
+}
diff --git a/src/repository/drep.ts b/src/repository/drep.ts
@@ -363,22 +363,25 @@ export const fetchDrepVoteDetails = async (dRepId: string, isScript?: boolean) =
             voteTxHash,
             govActionType
         FROM TimeOrderedDrepVoteDetails
-        ORDER BY govActionId, voteTxHash DESC 
+        ORDER BY govActionId, time DESC 
+    ),
+    OrderedVoteDetails AS (
+        SELECT * from GroupedVoteDetails ORDER BY time DESC
     )
     SELECT json_agg(
                     json_build_object(
-                            'govActionId', GroupedVoteDetails.govActionId,
-                            'title', GroupedVoteDetails.title,
-                            'voteType', GroupedVoteDetails.voteType,
-                            'voteAnchorUrl', GroupedVoteDetails.voteAnchorUrl,
-                            'voteAnchorHash', GroupedVoteDetails.voteAnchorHash,
-                            'epochNo', GroupedVoteDetails.epochNo,
-                            'time', GroupedVoteDetails.time,
-                            'voteTxHash', GroupedVoteDetails.voteTxHash,
-                            'govActionType', GroupedVoteDetails.govActionType
+                            'govActionId', OrderedVoteDetails.govActionId,
+                            'title', OrderedVoteDetails.title,
+                            'voteType', OrderedVoteDetails.voteType,
+                            'voteAnchorUrl', OrderedVoteDetails.voteAnchorUrl,
+                            'voteAnchorHash', OrderedVoteDetails.voteAnchorHash,
+                            'epochNo', OrderedVoteDetails.epochNo,
+                            'time', OrderedVoteDetails.time,
+                            'voteTxHash', OrderedVoteDetails.voteTxHash,
+                            'govActionType', OrderedVoteDetails.govActionType
                     )
             ) AS votes
-    from GroupedVoteDetails
+    from OrderedVoteDetails
     `) as Record<any, any>[]
     return result[0].votes
 }
diff --git a/src/repository/proposal.ts b/src/repository/proposal.ts
@@ -1,13 +1,17 @@
 import { Prisma } from '@prisma/client'
 import { prisma } from '../config/db'
+import { formatResult } from '../helpers/formatter'
+import { GovActionStateTypes, ProposalTypes, SortTypes } from '../types/proposal'
 import { ProposalTypes, SortTypes } from '../types/proposal'
 
+
 export const fetchProposals = async (
     page: number,
     size: number,
     proposal?: string,
     proposalType?: ProposalTypes[],
     sort?: SortTypes,
+    state?: GovActionStateTypes,
     includeVoteCount?: boolean
 ) => {
     const result = (await prisma.$queryRaw`
@@ -180,12 +184,28 @@ SELECT
                         ELSE
                             null
                     END,
-    'status', CASE 
-                    when gov_action_proposal.enacted_epoch is not NULL then json_build_object('enactedEpoch', gov_action_proposal.enacted_epoch)
-                    when gov_action_proposal.ratified_epoch is not NULL then json_build_object('ratifiedEpoch', gov_action_proposal.ratified_epoch)
-                    when gov_action_proposal.expired_epoch is not NULL then json_build_object('expiredEpoch', gov_action_proposal.expired_epoch)
-                    else NULL
-                END,
+    'status', json_build_object(
+        'ratified', 
+            json_build_object(
+            'epoch', gov_action_proposal.ratified_epoch, 
+            'time', (SELECT end_time FROM epoch WHERE epoch.no = gov_action_proposal.ratified_epoch)
+            ),
+        'enacted', 
+            json_build_object(
+            'epoch', gov_action_proposal.enacted_epoch, 
+            'time', (SELECT end_time FROM epoch WHERE epoch.no = gov_action_proposal.enacted_epoch)
+            ),
+        'dropped', 
+            json_build_object(
+            'epoch', gov_action_proposal.dropped_epoch, 
+            'time', (SELECT end_time FROM epoch WHERE epoch.no = gov_action_proposal.dropped_epoch)
+            ),
+        'expired', 
+            json_build_object(
+            'epoch', gov_action_proposal.expired_epoch, 
+            'time', (SELECT end_time FROM epoch WHERE epoch.no = gov_action_proposal.expired_epoch)
+            )
+        ),
     'expiryDate', epoch_utils.last_epoch_end_time + epoch_utils.epoch_duration * (gov_action_proposal.expiration - epoch_utils.last_epoch_no),
     'expiryEpochNon', gov_action_proposal.expiration,
     'createdDate', creator_block.time,
@@ -243,6 +263,10 @@ FROM
         CROSS JOIN always_abstain_voting_power
         JOIN tx AS creator_tx ON creator_tx.id = gov_action_proposal.tx_id
         JOIN block AS creator_block ON creator_block.id = creator_tx.block_id
+        LEFT JOIN epoch AS ratified_epoch ON ratified_epoch.no = gov_action_proposal.ratified_epoch
+        LEFT JOIN epoch AS enacted_epoch ON enacted_epoch.no = gov_action_proposal.enacted_epoch
+        LEFT JOIN epoch AS dropped_epoch ON dropped_epoch.no = gov_action_proposal.dropped_epoch
+        LEFT JOIN epoch AS expired_epoch ON expired_epoch.no = gov_action_proposal.expired_epoch
         LEFT JOIN voting_anchor ON voting_anchor.id = gov_action_proposal.voting_anchor_id
         LEFT JOIN param_proposal as proposal_params ON gov_action_proposal.param_proposal = proposal_params.id
         LEFT JOIN cost_model AS cost_model ON proposal_params.cost_model_id = cost_model.id
@@ -290,14 +314,33 @@ FROM
   AND gov_action_proposal.enacted_epoch IS NULL
   AND gov_action_proposal.expired_epoch IS NULL
   AND gov_action_proposal.dropped_epoch IS NULL 
-${
-    proposalType
-        ? Prisma.sql`WHERE gov_action_proposal.type = ANY(${Prisma.raw(
-              `ARRAY[${proposalType.map((type) => `'${type}'`).join(', ')}]::govactiontype[]`
-          )})`
-        : Prisma.sql``
-}
-
+    ${
+        state === 'Live'
+            ? Prisma.sql`WHERE gov_action_proposal.ratified_epoch is NULL 
+                AND gov_action_proposal.enacted_epoch is NULL 
+                AND gov_action_proposal.dropped_epoch is NULL 
+                AND gov_action_proposal.expired_epoch is NULL`
+            : state === 'Expired'
+            ? Prisma.sql`WHERE gov_action_proposal.expired_epoch is not NULL`
+            : state === 'Enacted'
+            ? Prisma.sql`WHERE gov_action_proposal.enacted_epoch is not NULL`
+            : state === 'Ratified'
+            ? Prisma.sql`WHERE gov_action_proposal.ratified_epoch is not NULL`
+            : state === 'Dropped'
+            ? Prisma.sql`WHERE gov_action_proposal.dropped_epoch is not NULL`
+            : Prisma.sql``
+    }
+    ${
+        proposalType
+            ? state
+                ? Prisma.sql`AND gov_action_proposal.type = ANY(${Prisma.raw(
+                      `ARRAY[${proposalType.map((type) => `'${type}'`).join(', ')}]::govactiontype[]`
+                  )})`
+                : Prisma.sql`WHERE gov_action_proposal.type = ANY(${Prisma.raw(
+                      `ARRAY[${proposalType.map((type) => `'${type}'`).join(', ')}]::govactiontype[]`
+                  )})`
+            : Prisma.sql``
+    }
   GROUP BY
     (gov_action_proposal.id,
      stake_address.view,
@@ -329,11 +372,23 @@ ${
      always_no_confidence_voting_power.amount,
      always_abstain_voting_power.amount,
      prev_gov_action.index,
-     prev_gov_action_tx.hash) 
+     prev_gov_action_tx.hash,
+     ratified_epoch.no,
+     ratified_epoch.end_time,
+     enacted_epoch.no,
+     enacted_epoch.end_time,
+     dropped_epoch.no,
+     dropped_epoch.end_time,
+     expired_epoch.no,
+     expired_epoch.end_time
+     ) 
   ${proposal ? Prisma.sql`HAVING creator_tx.hash = decode(${proposal},'hex')` : Prisma.sql``}
   ${
-      sort === 'ExpiryDate'
-          ? Prisma.sql`ORDER BY epoch_utils.last_epoch_end_time + epoch_utils.epoch_duration * (gov_action_proposal.expiration - epoch_utils.last_epoch_no) DESC`
+      sort === 'Soon to Expire'
+          ? proposal
+              ? Prisma.sql``
+              : Prisma.sql`HAVING epoch_utils.last_epoch_end_time + epoch_utils.epoch_duration * (gov_action_proposal.expiration - epoch_utils.last_epoch_no) >= CURRENT_DATE
+                        ORDER BY epoch_utils.last_epoch_end_time + epoch_utils.epoch_duration * (gov_action_proposal.expiration - epoch_utils.last_epoch_no) ASC`
           : Prisma.sql`ORDER BY creator_block.time DESC`
   }
   OFFSET ${(page ? page - 1 : 0) * (size ? size : 10)}
@@ -380,6 +435,17 @@ ${
         parsedResults.push(parsedResult)
     }
 
+    if (includeVoteCount && sort == 'Highest Yes Count') {
+        parsedResults.sort((a, b) => {
+            const aDrepYes = a.vote.drep.yes.count ?? 0
+            const aSpoYes = a.vote.spo.yes.count ?? 0
+            const bDrepYes = b.vote.drep.yes.count ?? 0
+            const bSpoYes = b.vote.spo.yes.count ?? 0
+            const aCCYes = a.vote.cc.yes
+            const bCCYes = b.vote.cc.yes
+            return bDrepYes + bSpoYes + bCCYes - (aDrepYes + aSpoYes + aCCYes)
+        })
+    }
     return { items: parsedResults, totalCount }
 }
 
@@ -1181,12 +1247,28 @@ export const fetchProposalById = async (proposalId: string, proposaIndex: number
                         ELSE
                             null
                     END,
-        'status', CASE 
-                    when gov_action_proposal.enacted_epoch is not NULL then json_build_object('enactedEpoch', gov_action_proposal.enacted_epoch)
-                    when gov_action_proposal.ratified_epoch is not NULL then json_build_object('ratifiedEpoch', gov_action_proposal.ratified_epoch)
-                    when gov_action_proposal.expired_epoch is not NULL then json_build_object('expiredEpoch', gov_action_proposal.expired_epoch)
-                    else NULL
-                 END,
+        'status', json_build_object(
+                    'ratified', 
+                        json_build_object(
+                        'epoch', gov_action_proposal.ratified_epoch, 
+                        'time', (SELECT end_time FROM epoch WHERE epoch.no = gov_action_proposal.ratified_epoch)
+                        ),
+                    'enacted', 
+                        json_build_object(
+                        'epoch', gov_action_proposal.enacted_epoch, 
+                        'time', (SELECT end_time FROM epoch WHERE epoch.no = gov_action_proposal.enacted_epoch)
+                        ),
+                    'dropped', 
+                        json_build_object(
+                        'epoch', gov_action_proposal.dropped_epoch, 
+                        'time', (SELECT end_time FROM epoch WHERE epoch.no = gov_action_proposal.dropped_epoch)
+                        ),
+                    'expired', 
+                        json_build_object(
+                        'epoch', gov_action_proposal.expired_epoch, 
+                        'time', (SELECT end_time FROM epoch WHERE epoch.no = gov_action_proposal.expired_epoch)
+                        )
+                    ),
         'expiryDate', epoch_utils.last_epoch_end_time + epoch_utils.epoch_duration * (gov_action_proposal.expiration - epoch_utils.last_epoch_no),
         'expiryEpochNon', gov_action_proposal.expiration,
         'createdDate', creator_block.time,
@@ -1331,6 +1413,9 @@ export const fetchProposalById = async (proposalId: string, proposaIndex: number
     const proposalVoteCount = includeVoteCount
         ? { vote: await fetchProposalVoteCount(proposalId, proposaIndex) }
         : undefined
+    if (result.length == 0) {
+        return null
+    }
     const resultData = result[0].result
     const parsedResult = {
         proposal: {
diff --git a/src/types/proposal.ts b/src/types/proposal.ts
@@ -1,2 +1,10 @@
-export type ProposalTypes = 'ParameterChange'| 'HardForkInitiation'| 'TreasuryWithdrawals'| 'NoConfidence'| 'NewCommittee'| 'NewConstitution'| 'InfoAction'
-export type SortTypes = 'CreatedDate'|'ExpiryDate'
+export type ProposalTypes =
+    | 'ParameterChange'
+    | 'HardForkInitiation'
+    | 'TreasuryWithdrawals'
+    | 'NoConfidence'
+    | 'NewCommittee'
+    | 'NewConstitution'
+    | 'InfoAction'
+export type SortTypes = 'Newly Created' | 'Soon to Expire' | 'Highest Yes Count'
+export type GovActionStateTypes = 'Live' | 'Expired' | 'Ratified' | 'Enacted' | 'Dropped'
diff --git a/swagger.yaml b/swagger.yaml
