feat: add transaction type filter to the fasset explorer and include total pagination count in the same (now postgres specific) sql query

Author: kuco23

packages/fasset-indexer-api/src/analytics/explorer.ts

@@ -13,6 +13,9 @@ const VALID_EVENTS = [
   EVENTS.ASSET_MANAGER.RETURN_FROM_CORE_VAULT_REQUESTED
 ]
 
+const ALL_TRANSACTION_TYPES = Object.values(ExplorerType.TransactionType)
+  .filter(v => typeof v === "number")
+
 export class ExplorerAnalytics {
   protected lookup: ContractLookup
   private coreVaultCache = new Map<FAssetType, string>()
@@ -29,15 +32,16 @@ export class ExplorerAnalytics {
     limit: number, offset: number,
     user?: string, agent?: string,
     start?: number, end?: number,
-    asc: boolean = false
+    asc: boolean = false,
+    types: ExplorerType.TransactionType[] = ALL_TRANSACTION_TYPES
   ): Promise<ExplorerType.TransactionsInfo> {
     const em = this.orm.em.fork()
     const isuser = user != null
     const isagent = agent != null
     ;[start, end] = this.standardizeInterval(start, end)
     const window = start != null || end != null
     const transactions = await em.getConnection('read').execute(
-      SQL.EXPLORER_TRANSACTIONS(isuser, isagent, asc, window),
+      SQL.EXPLORER_TRANSACTIONS(isuser, isagent, asc, window, types),
       (isuser || isagent)
         ? (window ? [user ?? agent, start, end, limit, offset] : [user ?? agent, limit, offset])
         : (window ? [start, end, limit, offset] : [limit, offset])
@@ -51,10 +55,7 @@ export class ExplorerAnalytics {
         timestamp, origin: source, hash, value: BigInt(value_uba)
       })
     }
-    const count = (info.length < limit)
-      ? offset + info.length
-      : await this.getExplorerTransactionCount(em, user, agent)
-    return { transactions: info, count }
+    return { transactions: info, count: transactions[0]?.count ?? 0 }
   }
 
   async transactionClassification(
@@ -302,19 +303,6 @@ export class ExplorerAnalytics {
     return resp
   }
 
-  async getExplorerTransactionCount(em: EntityManager, user?: string, agent?: string): Promise<number> {
-    let query = null
-    if (user != null) {
-      query = SQL.EXPLORER_TRANSACTION_USER_COUNT
-    } else if (agent != null) {
-      query = SQL.EXPLORER_TRANSACTION_AGENT_COUNT
-    } else {
-      query = SQL.EXPLORER_TRANSACTION_COUNT
-    }
-    const resp = await em.getConnection('read').execute(query, [user ?? agent])
-    return Number(resp[0]?.cnt)
-  }
-
   protected async getUnderlyingTransaction(
     em: EntityManager, fasset: FAssetType, reference: string, target: string, source?: string
   ): Promise<Entities.UnderlyingVoutReference | null> {

packages/fasset-indexer-api/src/analytics/utils/raw-sql.ts

@@ -1,4 +1,5 @@
 import { FAssetType } from "fasset-indexer-core"
+import { TransactionType } from "../interface"
 
 
 export const COLLATERAL_POOL_PORTFOLIO_SQL = `
@@ -98,18 +99,22 @@ GROUP BY t.fasset
 ORDER BY t.fasset
 `
 
-export const EXPLORER_TRANSACTIONS = (user: boolean, agent: boolean, asc: boolean, window: boolean) => `
-SELECT et.hash, el.name, eb.timestamp, eaa.hex as agent_vault, am.name as agent_name, eau.hex as user, eao.hex as source, t.value_uba FROM (
-  SELECT cr.evm_log_id, cr.agent_vault_address_id, cr.value_uba, cr.minter_id as user_id FROM collateral_reserved cr
-  UNION ALL
-  SELECT rr.evm_log_id, rr.agent_vault_address_id, rr.value_uba, rr.redeemer_id as user_id FROM redemption_requested rr
-  FULL JOIN transfer_to_core_vault_started tc ON rr.fasset = tc.fasset AND rr.request_id = tc.transfer_redemption_request_id
-  WHERE tc.evm_log_id IS NULL
-  UNION ALL
-  SELECT tc.evm_log_id, tc.agent_vault_address_id, tc.value_uba, NULL as user_id FROM transfer_to_core_vault_started tc
-  UNION ALL
-  SELECT rc.evm_log_id, rc.agent_vault_address_id, rc.value_uba, NULL as user_id FROM return_from_core_vault_requested rc
-) t
+const transactions = new Map([
+  [TransactionType.Mint, `SELECT cr.evm_log_id, cr.agent_vault_address_id, cr.value_uba, cr.minter_id as user_id FROM collateral_reserved cr`],
+  [TransactionType.Redeem, `SELECT rr.evm_log_id, rr.agent_vault_address_id, rr.value_uba, rr.redeemer_id as user_id FROM redemption_requested rr
+    FULL JOIN transfer_to_core_vault_started tc ON rr.fasset = tc.fasset AND rr.request_id = tc.transfer_redemption_request_id
+    WHERE tc.evm_log_id IS NULL`],
+  [TransactionType.TransferToCV, `SELECT tc.evm_log_id, tc.agent_vault_address_id, tc.value_uba, NULL as user_id FROM transfer_to_core_vault_started tc`],
+  [TransactionType.ReturnFromCV, `SELECT rc.evm_log_id, rc.agent_vault_address_id, rc.value_uba, NULL as user_id FROM return_from_core_vault_requested rc`]
+])
+
+// psql specific query
+export const EXPLORER_TRANSACTIONS = (user: boolean, agent: boolean, asc: boolean, window: boolean, methods: TransactionType[]) => `
+SELECT
+  et.hash, el.name, eb.timestamp, eaa.hex as agent_vault,
+  am.name as agent_name, eau.hex as user, eao.hex as source,
+  t.value_uba, COUNT(*) OVER() as count
+FROM (${Array.from(transactions.entries()).filter(([k, _]) => methods.includes(k)).map(([_,v]) => v).join(' UNION ALL ')}) t
 FULL JOIN evm_address eau ON eau.id = t.user_id
 JOIN evm_log el ON el.id = t.evm_log_id
 JOIN evm_block eb ON eb.index = el.block_index
@@ -126,41 +131,10 @@ ORDER BY el.block_index ${asc ? 'ASC' : 'DESC'}
 LIMIT ? OFFSET ?
 `
 
-// postgresql-specific query
-export const EXPLORER_TRANSACTION_COUNT = `
-SELECT SUM(reltuples::bigint) AS cnt FROM pg_class
-WHERE relkind = 'r' AND relname IN (
-  'collateral_reserved', 'redemption_requested', 'return_from_core_vault_requested'
-);
-`
-
-export const EXPLORER_TRANSACTION_USER_COUNT = `
-SELECT COUNT(evm_log_id) as cnt FROM (
-  SELECT cr.evm_log_id, cr.minter_id as user_id FROM collateral_reserved cr
-  UNION ALL
-  SELECT rr.evm_log_id, rr.redeemer_id as user_id FROM redemption_requested rr
-  FULL JOIN transfer_to_core_vault_started tc ON rr.fasset = tc.fasset AND rr.request_id = tc.transfer_redemption_request_id
-  WHERE tc.evm_log_id IS NULL
-) t
-JOIN evm_address ea ON t.user_id = ea.id
-WHERE ea.hex = ?
-`
-
-export const EXPLORER_TRANSACTION_AGENT_COUNT = `
-SELECT COUNT(evm_log_id) AS cnt FROM (
-  SELECT cr.evm_log_id, cr.agent_vault_address_id FROM collateral_reserved cr
-  UNION ALL
-  SELECT rr.evm_log_id, rr.agent_vault_address_id FROM redemption_requested rr
-  UNION ALL
-  SELECT rc.evm_log_id, rc.agent_vault_address_id FROM return_from_core_vault_requested rc
-) t
-JOIN evm_address eaa ON eaa.id = t.agent_vault_address_id
-WHERE eaa.hex = ?
-`
-
 export type ExplorerTransactionsOrmResult = {
   name: string, timestamp: number, source: string, user: string,
-  hash: string, agent_vault: string, agent_name: string, value_uba: string
+  hash: string, agent_vault: string, agent_name: string, value_uba: string,
+  count: number
 }
 
 export const EVENT_FROM_UNDERLYING_HASH = `

packages/fasset-indexer-api/src/controllers/explorer.controller.ts

@@ -3,13 +3,14 @@ import { CacheInterceptor } from '@nestjs/cache-manager'
 import { ApiOperation, ApiQuery, ApiTags } from '@nestjs/swagger'
 import { ExplorerService } from '../services/explorer.service'
 import { apiResponse, ApiResponse } from '../shared/api-response'
-import type {
-  MintTransactionDetails,
-  RedeemTransactionDetails,
-  RetrunFromCoreVaultTransactionDetails,
-  TransferToCoreVaultTransactionDetails,
-  TransactionsInfo,
-  GenericTransactionClassification
+import {
+  type MintTransactionDetails,
+  type RedeemTransactionDetails,
+  type RetrunFromCoreVaultTransactionDetails,
+  type TransferToCoreVaultTransactionDetails,
+  type TransactionsInfo,
+  type GenericTransactionClassification,
+  TransactionType
 } from '../analytics/interface'
 
 
@@ -28,16 +29,20 @@ export class ExplorerController {
   @ApiQuery({ name: 'start', type: Number, required: false })
   @ApiQuery({ name: 'end', type: Number, required: false })
   @ApiQuery({ name: 'asc', type: Boolean, required: false })
+  @ApiQuery({ name: 'types', type: String, isArray: true, required: false })
   getTransactions(
     @Query('limit', ParseIntPipe) limit: number,
     @Query('offset', ParseIntPipe) offset: number,
     @Query('user') user?: string,
     @Query('agent') agent?: string,
     @Query('asc') asc?: boolean,
     @Query('start', new ParseIntPipe({ optional: true })) start?: number,
-    @Query('end', new ParseIntPipe({ optional: true })) end?: number
+    @Query('end', new ParseIntPipe({ optional: true })) end?: number,
+    @Query('types') types?: string | string[]
   ): Promise<ApiResponse<TransactionsInfo>> {
-    return apiResponse(this.service.transactions(limit, offset, user, agent, start, end, asc), 200)
+    if (types != null && typeof types == 'string') types = [types]
+    const transactionTypes = types != null ? this.parseTransactionTypes(types as string[]) : null
+    return apiResponse(this.service.transactions(limit, offset, user, agent, start, end, asc, transactionTypes), 200)
   }
 
   @Get('transaction-classification')
@@ -85,4 +90,7 @@ export class ExplorerController {
     return apiResponse(this.service.returnFromCoreVaultTransactionDetails(hash), 200)
   }
 
+  private parseTransactionTypes(types: string[]): TransactionType[] {
+    return types.map(t => TransactionType[t])
+  }
 }