Merge pull request #327 from cardanoapi/fix/drep-decode

mesudip · web-flow · commit 431febff70d2 · 2025-02-03T16:19:45.000+05:45
fix: Update query for drep related endpoints to support scriptDrep
diff --git a/dbsync-api/src/controllers/drep.ts b/dbsync-api/src/controllers/drep.ts
@@ -1,6 +1,6 @@
-import { Request, Response, Router } from 'express'
-import { handlerWrapper } from '../errors/AppError'
-import { convertToHexIfBech32, decodeDrep, isHexValue, validateAddress } from '../helpers/validator'
+import {Request, Response, Router} from 'express'
+import {handlerWrapper} from '../errors/AppError'
+import {convertToHexIfBech32, decodeDrep, isHexValue, validateAddress} from '../helpers/validator'
 import {
     fetchDrepDelegationDetails,
     fetchDrepDetails,
@@ -11,17 +11,13 @@ import {
     fetchDrepActiveDelegators,
     fetchDrepDelegationHistory,
 } from '../repository/drep'
-import { DrepSortType, DrepStatusType } from '../types/drep'
+import {DrepSortType, DrepStatusType} from '../types/drep'
 
 const router = Router()
 
 const getDrepDetails = async (req: Request, res: Response): Promise<any> => {
-    
-    let drep = decodeDrep(req.params.id as string)
-    if (!drep) {
-        return res.status(400).json({ message: 'Provide a valid Drep ID' })
-    }
-    const result = await fetchDrepDetails(drep.credential,drep.isScript)
+    const drep = decodeDrep(req.params.id as string)
+    const result = await fetchDrepDetails(drep.credential, drep.isScript)
     return res.status(200).json(result)
 }
 
@@ -30,53 +26,41 @@ const getDrepList = async (req: Request, res: Response) => {
     const page = req.query.page ? +req.query.page : 1
     const status = req.query.status ? (req.query.status as DrepStatusType) : undefined
     const sort = req.query.sort ? (req.query.sort as DrepSortType) : undefined
-    const search = convertToHexIfBech32(req.query.search as string)
-    const { items, totalCount } = await fetchDrepList(page, size, search, status, sort)
-    return res.status(200).json({ total: totalCount, page, size, items })
+    const searchDrep = req.query.search ? decodeDrep(req.query.search as string) : {credential: '', isScript: undefined}
+    const {
+        items,
+        totalCount
+    } = await fetchDrepList(page, size, searchDrep.credential, searchDrep.isScript, status, sort)
+    return res.status(200).json({total: totalCount, page, size, items})
 }
 
 const getDrepVoteDetails = async (req: Request, res: Response) => {
-    const dRepId = convertToHexIfBech32(req.params.id as string)
-    if (dRepId && !isHexValue(dRepId)) {
-        return res.status(400).json({ message: 'Provide a valid Drep ID' })
-    }
-    const result = await fetchDrepVoteDetails(dRepId)
+    const dRepId = decodeDrep(req.params.id as string)
+    const result = await fetchDrepVoteDetails(dRepId.credential, dRepId.isScript)
     return res.status(200).json(result)
 }
 
 const getDrepDelegationDetails = async (req: Request, res: Response) => {
-    const dRepId = convertToHexIfBech32(req.params.id as string)
-    if (dRepId && !isHexValue(dRepId)) {
-        return res.status(400).json({ message: 'Provide a valid Drep ID' })
-    }
-    const result = await fetchDrepDelegationHistory(dRepId)
+    const dRepId = decodeDrep(req.params.id as string)
+    const result = await fetchDrepDelegationHistory(dRepId.credential, dRepId.isScript)
     return res.status(200).json(result)
 }
 
 const getDrepRegistrationDetails = async (req: Request, res: Response) => {
-    const dRepId = convertToHexIfBech32(req.params.id as string)
-    if (dRepId && !isHexValue(dRepId)) {
-        return res.status(400).json({ message: 'Provide a valid Drep ID' })
-    }
-    const result = await fetchDrepRegistrationDetails(dRepId)
+    const dRepId = decodeDrep(req.params.id as string)
+    const result = await fetchDrepRegistrationDetails(dRepId.credential, dRepId.isScript)
     return res.status(200).json(result)
 }
 
 const getDrepActiveDelegation = async (req: Request, res: Response) => {
-    const dRepId = convertToHexIfBech32(req.params.id as string)
-    if (dRepId && !isHexValue(dRepId)) {
-        return res.status(400).json({ message: 'Provide a valid Drep ID' })
-    }
-    const result = await fetchDrepActiveDelegation(dRepId)
+    const dRepId = decodeDrep(req.params.id as string)
+    const result = await fetchDrepActiveDelegation(dRepId.credential, dRepId.isScript)
     return res.status(200).json(result)
 }
 
 const getDrepActiveDelegators = async (req: Request, res: Response) => {
-    const dRepId = convertToHexIfBech32(req.params.id as string)
-    if (dRepId && !isHexValue(dRepId)) {
-        return res.status(400).json({ message: 'Provide a valid Drep ID' })
-    }
-    const activeDelegators = await fetchDrepActiveDelegators(dRepId)
+    const dRepId = decodeDrep(req.params.id as string)
+    const activeDelegators = await fetchDrepActiveDelegators(dRepId.credential, dRepId.isScript)
     return res.status(200).json(activeDelegators)
 }
 
diff --git a/dbsync-api/src/helpers/formatter.ts b/dbsync-api/src/helpers/formatter.ts
@@ -1,32 +1,37 @@
-export function formatResult(result:Array<Record<string,any>>){
-  return result.map((item)=>item.result)
+import {encodeDrep} from "./validator";
+
+export function formatResult(result: Array<Record<string, any>>) {
+    return result.map((item) => {
+        const {has_script, drepId} = item.result
+        return {...item.result, view: encodeDrep(drepId, has_script)}
+    })
 }
 
 export function combineArraysWithSameObjectKey(array1: any, array2: any) {
-  // Create a map for array2 based on the stake_address
-  const map2 = new Map();
-  array2.forEach((item: any) => {
-    const { stakeAddress, ...rest } = item.json_build_object;
-    map2.set(stakeAddress, rest);  // Use stake_address as the key
-  });
+    // Create a map for array2 based on the stake_address
+    const map2 = new Map();
+    array2.forEach((item: any) => {
+        const {stakeAddress, ...rest} = item.json_build_object;
+        map2.set(stakeAddress, rest);  // Use stake_address as the key
+    });
 
-  // Combine the data from array1 and array2 based on stake_address
-  return array1.map((item1: any) => {
-    const { stakeAddress, ...rest1 } = item1.json_build_object;
-    const matchedData = map2.get(stakeAddress);
+    // Combine the data from array1 and array2 based on stake_address
+    return array1.map((item1: any) => {
+        const {stakeAddress, ...rest1} = item1.json_build_object;
+        const matchedData = map2.get(stakeAddress);
 
-    if (matchedData) {
-      // Combine both objects if match is found
-      return {
-        json_build_object: {
-          ...rest1,
-          ...matchedData,
-          stakeAddress
+        if (matchedData) {
+            // Combine both objects if match is found
+            return {
+                json_build_object: {
+                    ...rest1,
+                    ...matchedData,
+                    stakeAddress
+                }
+            };
+        } else {
+            // Return the original object if no match is found in array2
+            return item1;
         }
-      };
-    } else {
-      // Return the original object if no match is found in array2
-      return item1;
-    }
-  });
+    });
 }
diff --git a/dbsync-api/src/helpers/validator.ts b/dbsync-api/src/helpers/validator.ts
@@ -1,99 +1,114 @@
-import { bech32 } from "bech32";
+import {bech32} from "bech32";
+import AppError from "../errors/AppError";
 
 export function convertToHexIfBech32(address: string): string {
-  if (!address) return ''
-  if (address.startsWith('stake')|| address.startsWith('drep')){
-    const decoded = bech32.decode(address);
-    const data = bech32.fromWords(decoded.words);
-    return Buffer.from(data).toString('hex');
-  }
-  else if (address.length === 58 && (address.startsWith('22') || address.startsWith('23'))){
-    return address.slice(2)
-  }
-  return address
+    if (!address) return ''
+    if (address.startsWith('stake') || address.startsWith('drep')) {
+        const decoded = bech32.decode(address);
+        const data = bech32.fromWords(decoded.words);
+        return Buffer.from(data).toString('hex');
+    } else if (address.length === 58 && (address.startsWith('22') || address.startsWith('23'))) {
+        return address.slice(2)
+    }
+    return address
 }
 
-export function decodeDrep(address:string):{credential:string,isScript?:boolean}{
-  const drep = decodeAddress(address);
-  if(drep.bech32Prefix === 'drep_script'){
-    return {
-      credential: drep.credential.toString('hex'),
-      isScript: true
-    }
-  }else{
-    if(drep.dataHeader.length >1){
-      throw new Error("Drep credential contains invalid header: "+address)
-    }
-    let isScript
-    const header=drep.dataHeader.at(0)
-    if(header == 0x22){
-      isScript = false
-    }else if (header == 0x23){
-      isScript = true
-    }else if ( header){
-      throw new Error("Drep credential contains invalid header 0x"+ header.toString(16)+ ": "+address)
+export function decodeDrep(address: string): { credential: string, isScript?: boolean } {
+    const drep = decodeAddress(address);
+    if (drep.bech32Prefix === 'drep_script') {
+        return {
+            credential: drep.credential.toString('hex'),
+            isScript: true
+        }
+    } else {
+        if (drep.dataHeader.length > 1) {
+            throw new AppError("Drep credential contains invalid header: " + address)
+        }
+        let isScript
+        const header = drep.dataHeader.at(0)
+        if (header == 0x22) {
+            isScript = false
+        } else if (header == 0x23) {
+            isScript = true
+        } else if (header) {
+            throw new AppError("Drep credential contains invalid header 0x" + header.toString(16) + ": " + address)
+        }
+        return {
+            credential: drep.credential.toString('hex'),
+            isScript: isScript
+        }
     }
-    return {
-      credential: drep.credential.toString('hex'),
-      isScript: isScript
-    }
-  }
+}
 
+export function encodeDrep(hexValue: string, isScript: boolean) {
+    try {
+        let drepHexVal = hexValue
+        if (isScript) {
+            drepHexVal = '23' + drepHexVal
+        } else {
+            drepHexVal = '22' + drepHexVal
+        }
+        const drepBufferVal = Buffer.from(drepHexVal,'hex')
+        const bech32Words = bech32.toWords(drepBufferVal)
+        return bech32.encode(isScript ? 'drep_script' : 'drep', bech32Words, 100)
+    } catch (e: any) {
+        throw new AppError(e?.message || 'Error During DrepViewConversion: ', e)
+    }
 }
 
 
 export function decodeAddress(address: string): { bech32Prefix: string, dataHeader: Buffer, credential: Buffer } {
-  if (!address) return { bech32Prefix: "", dataHeader: Buffer.alloc(0), credential: Buffer.alloc(0) }; // Return empty if address is falsy
+    if (!address) return {bech32Prefix: "", dataHeader: Buffer.alloc(0), credential: Buffer.alloc(0)}; // Return empty if address is falsy
 
-  if (isHexValue(address)) {
-    // Handle the case where the address is hex-encoded (you can tweak this based on your needs)
-    const buffer = Buffer.from(address, 'hex');
-    const dataHeader = buffer.subarray(0, buffer.length - 28);
-    const credential = buffer.subarray(buffer.length - 28);
-    return { bech32Prefix: "hex", dataHeader, credential };
-  } else {
-    try {
-      // Decode the Bech32 address
-      const decoded = bech32.decode(address);
-      const data = bech32.fromWords(decoded.words);
-      const buffer = Buffer.from(data);
+    if (isHexValue(address)) {
+        // Handle the case where the address is hex-encoded (you can tweak this based on your needs)
+        const buffer = Buffer.from(address, 'hex');
+        const dataHeader = buffer.subarray(0, buffer.length - 28);
+        const credential = buffer.subarray(buffer.length - 28);
+        return {bech32Prefix: "hex", dataHeader, credential};
+    } else {
+        try {
+            // Decode the Bech32 address
+            const decoded = bech32.decode(address);
+            const data = bech32.fromWords(decoded.words);
+            const buffer = Buffer.from(data);
 
-      // Split the buffer into header and credential (last 28 bytes for credential)
-      const dataHeader = buffer.subarray(0, buffer.length - 28);
-      const credential = buffer.subarray(buffer.length - 28);
+            // Split the buffer into header and credential (last 28 bytes for credential)
+            const dataHeader = buffer.subarray(0, buffer.length - 28);
+            const credential = buffer.subarray(buffer.length - 28);
 
-      return {
-        bech32Prefix: decoded.prefix,  // Extract prefix from the Bech32 decoding result
-        dataHeader,
-        credential
-      };
+            return {
+                bech32Prefix: decoded.prefix,  // Extract prefix from the Bech32 decoding result
+                dataHeader,
+                credential
+            };
 
-    } catch (e: any) {
-      throw new Error("Data is not hex or bech32: " + address);
+        } catch (e: any) {
+            throw new AppError("Data is not hex or bech32: " + address);
+        }
     }
-  }
 }
 
 
-export function isHexValue(value:string):boolean{
-  const hexRegex = /^(?:[0-9a-fA-F]{56}|[0-9a-fA-F]{58})$/;
-  return hexRegex.test(value);
+export function isHexValue(value: string): boolean {
+    const hexRegex = /^(?:[0-9a-fA-F]{56}|[0-9a-fA-F]{58})$/;
+    return hexRegex.test(value);
 }
 
-export function validateHash(value:string) {
-  const regex = /^[a-f0-9A-F]{64}$/
-  if (value.includes('#')){
-    return regex.test(value.slice(0,-2))
-  }else return regex.test(value)
+export function validateHash(value: string) {
+    const regex = /^[a-f0-9A-F]{64}$/
+    if (value.includes('#')) {
+        return regex.test(value.slice(0, -2))
+    } else return regex.test(value)
 }
 
 export function fromHex(prefix: string, hex: string) {
-  return bech32.encode(prefix, bech32.toWords(Buffer.from(hex, "hex")));
+    return bech32.encode(prefix, bech32.toWords(Buffer.from(hex, "hex")));
 }
 
 export function validateAddress(value: string): boolean {
-  if (isHexValue(value)){
-    return value.length === 56 || value.length === 58
-  }
-  return false
+    if (isHexValue(value)) {
+        return value.length === 56 || value.length === 58
+    }
+    return false
 }
diff --git a/dbsync-api/src/index.ts b/dbsync-api/src/index.ts
@@ -62,18 +62,18 @@ app.use('/api/health', healthCheckRoute)
 app.use('/api/gov-action', govActionRoute)
 
 setupSwaggerUi(app)
-const indexFile = path.resolve('.','./index.html')
-// Check if index.html exists
-fs.access(indexFile, fs.constants.F_OK, (err) => {
-  if (!err) {
-    // If index.html exists, define the catch-all handler
-    app.get('*', (req: Request, res: Response) => {
-      res.sendFile(indexFile);
-    });
-  } else {
-    console.error('index.html does not exist.');
-  }
-});
+// const indexFile = path.resolve('.','./index.html')
+// // Check if index.html exists
+// fs.access(indexFile, fs.constants.F_OK, (err) => {
+//   if (!err) {
+//     // If index.html exists, define the catch-all handler
+//     app.get('*', (req: Request, res: Response) => {
+//       res.sendFile(indexFile);
+//     });
+//   } else {
+//     console.error('index.html does not exist.');
+//   }
+// });
 app.use(errorHandler); 
 
 
diff --git a/dbsync-api/src/repository/drep.ts b/dbsync-api/src/repository/drep.ts
