@sentio/sdk 1.18.1 → 1.19.0

package/src/core/meter.ts

@@ -1,7 +1,7 @@
-import { MetricDescriptor, RecordMetaData } from '../gen/processor/protos/processor'
-import { AptosContext, BaseContext, Context, SolanaContext, SuiContext } from './context'
+import { MetricDescriptor } from '../gen/processor/protos/processor'
+import { BaseContext } from './context'
 import { toMetricValue, Numberish } from './numberish'
-import { APTOS_TESTNET_ID, SOL_MAINMET_ID, SUI_DEVNET_ID } from '../utils/chain'
+import { GetRecordMetaData, Labels } from './metadata'
 
 export function normalizeName(name: string): string {
   const regex = new RegExp('![_.a-zA-Z0-9]')
@@ -27,91 +27,6 @@ export function normalizeLabels(labels: Labels): Labels {
   return normLabels
 }
 
-function GetRecordMetaData(ctx: BaseContext, metric: Metric, labels: Labels): RecordMetaData {
-  let descriptor = metric.descriptor
-  if (metric.usage > 0) {
-    // Other setting don't need to be write multiple times
-    descriptor = MetricDescriptor.fromPartial({ name: descriptor.name })
-  }
-
-  descriptor.name = normalizeName(descriptor.name)
-
-  if (ctx instanceof Context) {
-    if (ctx.log) {
-      return {
-        contractAddress: ctx.contract.rawContract.address,
-        blockNumber: ctx.blockNumber,
-        transactionIndex: ctx.log.transactionIndex,
-        transactionHash: ctx.transactionHash || '',
-        logIndex: ctx.log.logIndex,
-        chainId: ctx.chainId.toString(),
-        descriptor: descriptor,
-        labels: normalizeLabels(labels),
-      }
-    }
-    if (ctx.block) {
-      return {
-        contractAddress: ctx.contract.rawContract.address,
-        blockNumber: ctx.blockNumber,
-        transactionIndex: -1,
-        transactionHash: '',
-        logIndex: -1,
-        chainId: ctx.chainId.toString(),
-        descriptor: descriptor,
-        labels: normalizeLabels(labels),
-      }
-    }
-    if (ctx.trace) {
-      return {
-        contractAddress: ctx.contract.rawContract.address,
-        blockNumber: ctx.blockNumber,
-        transactionIndex: ctx.trace.transactionPosition,
-        transactionHash: ctx.transactionHash || '',
-        logIndex: -1,
-        chainId: ctx.chainId.toString(),
-        descriptor: descriptor,
-        labels: normalizeLabels(labels),
-      }
-    }
-  } else if (ctx instanceof SolanaContext) {
-    return {
-      contractAddress: ctx.address,
-      blockNumber: ctx.blockNumber,
-      transactionIndex: 0,
-      transactionHash: '', // TODO add
-      logIndex: 0,
-      chainId: SOL_MAINMET_ID, // TODO set in context
-      descriptor: descriptor,
-      labels: normalizeLabels(labels),
-    }
-  } else if (ctx instanceof SuiContext) {
-    return {
-      contractAddress: ctx.address,
-      blockNumber: ctx.blockNumber,
-      transactionIndex: 0,
-      transactionHash: '', // TODO
-      logIndex: 0,
-      chainId: SUI_DEVNET_ID, // TODO set in context
-      descriptor: descriptor,
-      labels: normalizeLabels(labels),
-    }
-  } else if (ctx instanceof AptosContext) {
-    return {
-      contractAddress: ctx.address,
-      blockNumber: ctx.blockNumber,
-      transactionIndex: 0,
-      transactionHash: '', // TODO
-      logIndex: 0,
-      chainId: APTOS_TESTNET_ID, // TODO set in context
-      descriptor: descriptor,
-      labels: normalizeLabels(labels),
-    }
-  }
-  throw new Error("This can't happen")
-}
-
-export type Labels = { [key: string]: string }
-
 export class MetricDescriptorOption {
   unit?: string
   description?: string

package/src/core/solana-processor.ts

@@ -80,7 +80,7 @@ export class SolanaBaseProcessor {
     return {
       gauges: ctx.gauges,
       counters: ctx.counters,
-      logs: [],
+      logs: ctx.logs,
     }
   }
 

package/src/core/sui-processor.ts

@@ -49,7 +49,7 @@ export class SuiBaseProcessor {
     return {
       gauges: ctx.gauges,
       counters: ctx.counters,
-      logs: [],
+      logs: ctx.logs,
     }
   }
 

package/src/service.ts

@@ -269,12 +269,6 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
       throw new ServerError(Status.UNAVAILABLE, 'Service Not started.')
     }
 
-    const resp: ProcessResult = {
-      gauges: [],
-      counters: [],
-      logs: [],
-    }
-
     const promises: Promise<ProcessResult>[] = []
     for (const l of request.logBindings) {
       if (!l.log) {
@@ -297,11 +291,7 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
       }
     }
 
-    const results = await Promise.all(promises)
-    for (const res of results) {
-      resp.counters = resp.counters.concat(res.counters)
-      resp.gauges = resp.gauges.concat(res.gauges)
-    }
+    const result = mergeProcessResults(await Promise.all(promises))
 
     let updated = false
     if (
@@ -312,9 +302,9 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
       updated = true
     }
 
-    recordRuntimeInfo(resp, HandlerType.LOG)
+    recordRuntimeInfo(result, HandlerType.LOG)
     return {
-      result: resp,
+      result,
       configUpdated: updated,
     }
   }
@@ -346,6 +336,7 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
               if (res) {
                 res.gauges.forEach((g) => result.gauges.push(g))
                 res.counters.forEach((c) => result.counters.push(c))
+                res.logs.forEach((l) => result.logs.push(l))
               }
             }
             resolve()
@@ -369,6 +360,7 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
                 if (res) {
                   res.gauges.forEach((g) => result.gauges.push(g))
                   res.counters.forEach((c) => result.counters.push(c))
+                  res.logs.forEach((l) => result.logs.push(l))
                 }
               }
             }
@@ -425,6 +417,7 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
                 if (res) {
                   res.gauges.forEach((g) => result.gauges.push(g))
                   res.counters.forEach((c) => result.counters.push(c))
+                  res.logs.forEach((l) => result.logs.push(l))
                 } else {
                   console.warn(
                     `Failed to decode the instruction: ${instruction.instructionData} with slot: ${instruction.slot}`
@@ -452,18 +445,11 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
     }
 
     const promises = request.blockBindings.map((binding) => this.processBlock(binding))
-    const results = await Promise.all(promises)
-
-    const res = ProcessResult.fromPartial({})
+    const result = mergeProcessResults(await Promise.all(promises))
 
-    for (const r of results) {
-      res.counters = res.counters.concat(r.counters)
-      res.gauges = res.gauges.concat(r.gauges)
-    }
-
-    recordRuntimeInfo(res, HandlerType.BLOCK)
+    recordRuntimeInfo(result, HandlerType.BLOCK)
     return {
-      result: res,
+      result,
     }
   }
 
@@ -475,12 +461,6 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
 
     const block: Block = JSON.parse(jsonString)
 
-    const resp: ProcessResult = {
-      gauges: [],
-      counters: [],
-      logs: [],
-    }
-
     const promises: Promise<ProcessResult>[] = []
     for (const handlerId of binding.handlerIds) {
       const promise = this.blockHandlers[handlerId](block).catch((e) => {
@@ -488,12 +468,7 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
       })
       promises.push(promise)
     }
-    const allRes = await Promise.all(promises)
-    for (const res of allRes) {
-      resp.counters = resp.counters.concat(res.counters)
-      resp.gauges = resp.gauges.concat(res.gauges)
-    }
-    return resp
+    return mergeProcessResults(await Promise.all(promises))
   }
 
   async processTraces(request: ProcessTracesRequest, context: CallContext): Promise<ProcessTracesResponse> {
@@ -502,18 +477,11 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
     }
 
     const promises = request.traceBindings.map((binding) => this.processTrace(binding))
-    const results = await Promise.all(promises)
-
-    const res = ProcessResult.fromPartial({})
-
-    for (const r of results) {
-      res.counters = res.counters.concat(r.counters)
-      res.gauges = res.gauges.concat(r.gauges)
-    }
+    const result = mergeProcessResults(await Promise.all(promises))
 
-    recordRuntimeInfo(res, HandlerType.TRACE)
+    recordRuntimeInfo(result, HandlerType.TRACE)
     return {
-      result: res,
+      result,
     }
   }
 
@@ -571,6 +539,17 @@ function Utf8ArrayToStr(array: Uint8Array) {
   return out
 }
 
+function mergeProcessResults(results: ProcessResult[]): ProcessResult {
+  const res = ProcessResult.fromPartial({})
+
+  for (const r of results) {
+    res.counters = res.counters.concat(r.counters)
+    res.gauges = res.gauges.concat(r.gauges)
+    res.logs = res.logs.concat(r.logs)
+  }
+  return res
+}
+
 function recordRuntimeInfo(results: ProcessResult, handlerType: HandlerType) {
   results.gauges.forEach((e) => {
     e.runtimeInfo = {
@@ -583,6 +562,12 @@ function recordRuntimeInfo(results: ProcessResult, handlerType: HandlerType) {
       from: handlerType,
     }
   })
+
+  results.logs.forEach((e) => {
+    e.runtimeInfo = {
+      from: handlerType,
+    }
+  })
 }
 
 function errorString(e: Error): string {

package/src/tests/logger.test.ts

@@ -0,0 +1,46 @@
+import { assert, expect } from 'chai'
+
+import { TestProcessorServer } from '../testing'
+import { BigNumber } from 'ethers'
+import { mockApprovalLog, mockTransferLog } from '../builtin/erc20/test-utils'
+import { ERC20Processor } from '../builtin/internal/erc20_processor'
+
+describe('Test Error Capture', () => {
+  const service = new TestProcessorServer(() => {
+    ERC20Processor.bind({ address: '0x80009ff8154bd5653c6dda2fa5f5053e5a5c1a91' })
+      .onEventApproval((evt, ctx) => {
+        ctx.logger.info(`approve ${evt.args}`)
+      })
+      .onEventTransfer((evt, ctx) => {
+        ctx.logger.warn('transferred ' + evt.args.value, { from: evt.args.from })
+      })
+  })
+
+  beforeAll(async () => {
+    await service.start()
+  })
+
+  test('Check approve', async () => {
+    const res = await service.testLog(
+      mockApprovalLog('0x80009ff8154bd5653c6dda2fa5f5053e5a5c1a91', {
+        owner: '0x80009ff8154bd5653c6dda2fa5f5053e5a5c1a91',
+        spender: '0x0000000000000000000000000000000000000000',
+        value: BigNumber.from(0),
+      })
+    )
+    assert(res.result?.logs?.[0].message.includes('approve '))
+  })
+
+  test('Check transfer', async () => {
+    const res = await service.testLog(
+      mockTransferLog('0x80009ff8154bd5653c6dda2fa5f5053e5a5c1a91', {
+        from: '0x80009ff8154bd5653c6dda2fa5f5053e5a5c1a91',
+        to: '0x0000000000000000000000000000000000000000',
+        value: BigNumber.from(0),
+      })
+    )
+    const log = res.result?.logs?.[0]
+    expect(log?.message).eq('transferred 0')
+    expect(log?.metadata?.labels['from'].toLowerCase()).eq('0x80009ff8154bd5653c6dda2fa5f5053e5a5c1a91')
+  })
+})