@sentio/sdk 1.19.4 → 1.19.6

package/src/core/base-processor-template.ts

@@ -4,7 +4,7 @@ import { BaseContract, EventFilter } from 'ethers'
 import { Event } from '@ethersproject/contracts'
 import { BaseProcessor } from './base-processor'
 import { BindOptions, getOptionsSignature } from './bind-options'
-import { TemplateInstance } from '../gen/processor/protos/processor'
+import { TemplateInstance } from '../gen'
 import Long from 'long'
 import { getNetwork } from '@ethersproject/providers'
 import { PromiseOrVoid } from '../promise-or-void'

package/src/core/base-processor.ts

@@ -5,7 +5,7 @@ import { BaseContract, EventFilter } from '@ethersproject/contracts'
 import Long from 'long'
 
 import { BoundContractView, Context, ContractView } from './context'
-import { ProcessResult } from '../gen/processor/protos/processor'
+import { ProcessResult } from '../gen'
 import { BindInternalOptions, BindOptions } from './bind-options'
 import { PromiseOrVoid } from '../promise-or-void'
 import { Trace } from './trace'

package/src/core/bind-options.ts

@@ -41,4 +41,3 @@ export class SolanaBindOptions extends BindOptions {
 }
 
 export class SuiBindOptions extends BindOptions {}
-export class AptosBindOptions extends BindOptions {}

package/src/core/context.ts

@@ -1,25 +1,29 @@
-import { CounterResult, GaugeResult, LogResult } from '../gen/processor/protos/processor'
+import { CounterResult, GaugeResult, LogResult, MetricDescriptor, RecordMetaData } from '../gen'
 import { BaseContract, EventFilter } from 'ethers'
 import { Block, Log } from '@ethersproject/abstract-provider'
-import { Meter } from './meter'
+import { Meter, normalizeLabels } from './meter'
 import Long from 'long'
 import { Trace } from './trace'
 import { Logger } from './logger'
+import { Labels } from './metadata'
+import { SOL_MAINMET_ID, SUI_DEVNET_ID } from '../utils/chain'
 
-export class BaseContext {
+export abstract class BaseContext {
   gauges: GaugeResult[] = []
   counters: CounterResult[] = []
   logs: LogResult[] = []
   meter: Meter
   logger: Logger
 
-  constructor() {
+  protected constructor() {
     this.meter = new Meter(this)
     this.logger = new Logger(this)
   }
+
+  abstract getMetaData(descriptor: MetricDescriptor | undefined, labels: Labels): RecordMetaData
 }
 
-export class EthContext extends BaseContext {
+export abstract class EthContext extends BaseContext {
   chainId: number
   log?: Log
   block?: Block
@@ -27,7 +31,7 @@ export class EthContext extends BaseContext {
   blockNumber: Long
   transactionHash?: string
 
-  constructor(chainId: number, block?: Block, log?: Log, trace?: Trace) {
+  protected constructor(chainId: number, block?: Block, log?: Log, trace?: Trace) {
     super()
     this.chainId = chainId
     this.log = log
@@ -58,6 +62,46 @@ export class Context<
     this.contract = view
     this.address = view.rawContract.address
   }
+
+  getMetaData(descriptor: MetricDescriptor | undefined, labels: Labels): RecordMetaData {
+    if (this.log) {
+      return {
+        contractAddress: this.contract.rawContract.address,
+        blockNumber: this.blockNumber,
+        transactionIndex: this.log.transactionIndex,
+        transactionHash: this.transactionHash || '',
+        logIndex: this.log.logIndex,
+        chainId: this.chainId.toString(),
+        descriptor: descriptor,
+        labels: normalizeLabels(labels),
+      }
+    }
+    if (this.block) {
+      return {
+        contractAddress: this.contract.rawContract.address,
+        blockNumber: this.blockNumber,
+        transactionIndex: -1,
+        transactionHash: '',
+        logIndex: -1,
+        chainId: this.chainId.toString(),
+        descriptor: descriptor,
+        labels: normalizeLabels(labels),
+      }
+    }
+    if (this.trace) {
+      return {
+        contractAddress: this.contract.rawContract.address,
+        blockNumber: this.blockNumber,
+        transactionIndex: this.trace.transactionPosition,
+        transactionHash: this.transactionHash || '',
+        logIndex: -1,
+        chainId: this.chainId.toString(),
+        descriptor: descriptor,
+        labels: normalizeLabels(labels),
+      }
+    }
+    throw new Error("Invaid ctx argument can't happen")
+  }
 }
 
 export class ContractView<TContract extends BaseContract> {
@@ -109,6 +153,19 @@ export class SolanaContext extends BaseContext {
     this.address = address
     this.blockNumber = slot
   }
+
+  getMetaData(descriptor: MetricDescriptor | undefined, labels: Labels): RecordMetaData {
+    return {
+      contractAddress: this.address,
+      blockNumber: this.blockNumber,
+      transactionIndex: 0,
+      transactionHash: '', // TODO add
+      logIndex: 0,
+      chainId: SOL_MAINMET_ID, // TODO set in context
+      descriptor: descriptor,
+      labels: normalizeLabels(labels),
+    }
+  }
 }
 
 export class SuiContext extends BaseContext {
@@ -120,15 +177,17 @@ export class SuiContext extends BaseContext {
     this.address = address
     this.blockNumber = slot
   }
-}
 
-export class AptosContext extends BaseContext {
-  address: string
-  blockNumber: Long
-
-  constructor(address: string, slot: Long) {
-    super()
-    this.address = address
-    this.blockNumber = slot
+  getMetaData(descriptor: MetricDescriptor | undefined, labels: Labels): RecordMetaData {
+    return {
+      contractAddress: this.address,
+      blockNumber: this.blockNumber,
+      transactionIndex: 0,
+      transactionHash: '', // TODO
+      logIndex: 0,
+      chainId: SUI_DEVNET_ID, // TODO set in context
+      descriptor: descriptor,
+      labels: normalizeLabels(labels),
+    }
   }
 }

package/src/core/index.ts

@@ -3,13 +3,13 @@ export { Context, ContractView, BoundContractView, SolanaContext } from './conte
 export { CounterBinding, Meter, GaugeBinding, Counter, Gauge, MetricDescriptorOption } from './meter'
 export { type Numberish, toBigInteger, toMetricValue } from './numberish'
 
-export { BindOptions, SolanaBindOptions, SuiBindOptions, AptosBindOptions } from './bind-options'
+export { BindOptions, SolanaBindOptions, SuiBindOptions } from './bind-options'
 
 export { BaseProcessor } from './base-processor'
 export { GenericProcessor } from './generic-processor'
 export { BaseProcessorTemplate } from './base-processor-template'
 export { SolanaBaseProcessor } from './solana-processor'
 export { SuiBaseProcessor } from './sui-processor'
-export { AptosBaseProcessor } from './aptos-processor'
+// export * from '../aptos'
 
 export type { TypedCallTrace, Trace } from './trace'

package/src/core/logger.ts

@@ -1,6 +1,6 @@
 import { BaseContext } from './context'
 import { Labels, GetRecordMetaData } from './metadata'
-import { LogLevel } from '@sentio/sdk'
+import { LogLevel } from '../gen'
 
 export type Attributes = Record<string, any>
 

package/src/core/metadata.ts

@@ -1,7 +1,6 @@
-import { AptosContext, BaseContext, Context, SolanaContext, SuiContext } from './context'
-import { MetricDescriptor, RecordMetaData } from '@sentio/sdk'
-import { APTOS_TESTNET_ID, SOL_MAINMET_ID, SUI_DEVNET_ID } from '../utils/chain'
-import { Metric, normalizeLabels, normalizeName } from './meter'
+import { BaseContext } from './context'
+import { MetricDescriptor, RecordMetaData } from '../gen'
+import { Metric, normalizeName } from './meter'
 
 export type Labels = { [key: string]: string }
 
@@ -17,76 +16,5 @@ export function GetRecordMetaData(ctx: BaseContext, metric: Metric | undefined,
     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")
+  return ctx.getMetaData(descriptor, labels)
 }

package/src/core/meter.ts

@@ -1,4 +1,4 @@
-import { MetricDescriptor } from '../gen/processor/protos/processor'
+import { MetricDescriptor } from '../gen'
 import { BaseContext } from './context'
 import { toMetricValue, Numberish } from './numberish'
 import { GetRecordMetaData, Labels } from './metadata'

package/src/core/numberish.test.ts

@@ -3,7 +3,7 @@ import { toBigInteger, toMetricValue } from './numberish'
 import { webcrypto } from 'crypto'
 import { BigNumber } from 'ethers'
 import { performance } from 'perf_hooks'
-import { BigInteger } from '../gen/processor/protos/processor'
+import { BigInteger } from '../gen'
 import { BigDecimal } from '.'
 
 // TODO add test for type conversion

package/src/core/numberish.ts

@@ -1,5 +1,5 @@
 import { BigNumber } from 'ethers'
-import { BigInteger, MetricValue } from '../gen/processor/protos/processor'
+import { BigInteger, MetricValue } from '../gen'
 import { BigDecimal } from '.'
 import { BN } from '@project-serum/anchor'
 

package/src/core/solana-processor.ts

@@ -1,4 +1,4 @@
-import { ProcessResult } from '../gen/processor/protos/processor'
+import { ProcessResult } from '../gen'
 import { SolanaContext } from './context'
 import Long from 'long'
 import { Instruction } from '@project-serum/anchor'

package/src/core/sui-processor.ts

@@ -1,6 +1,6 @@
 import { SuiBindOptions } from './bind-options'
 import { SuiContext } from './context'
-import { ProcessResult } from '..'
+import { ProcessResult } from '../gen'
 import Long from 'long'
 
 type IndexConfigure = {

package/src/gen/index.ts

@@ -0,0 +1 @@
+export * from '../gen/processor/protos/processor'

package/src/index.ts

@@ -7,5 +7,8 @@ export { EthersError } from './error'
 
 export { getProcessor, addProcessor, getContractByABI, addContractByABI, getContractName } from './binds'
 
-export * from './gen/processor/protos/processor'
+export * from './gen'
+
 export * from './core'
+
+export * as aptos from './aptos'

package/src/processor-runner.ts

@@ -2,7 +2,7 @@
 
 import commandLineArgs from 'command-line-args'
 import { createServer } from 'nice-grpc'
-import { ProcessorDefinition } from './gen/processor/protos/processor'
+import { ProcessorDefinition } from './gen'
 import { ProcessorServiceImpl } from './service'
 import { setProvider } from './provider'
 

package/src/processor-state.ts

@@ -5,8 +5,10 @@ import {
   BaseProcessorTemplate,
   SolanaBaseProcessor,
   SuiBaseProcessor,
-  AptosBaseProcessor,
 } from './core'
+
+import { AptosBaseProcessor } from './aptos'
+
 import { BaseContract } from 'ethers'
 import { TemplateInstance } from './gen/processor/protos/processor'
 import { Provider } from '@ethersproject/providers'

package/src/service.ts

@@ -22,7 +22,7 @@ import {
   ProcessTransactionsRequest,
   StartRequest,
   TemplateInstance,
-} from './gen/processor/protos/processor'
+} from './gen'
 
 import { Empty } from './gen/google/protobuf/empty'
 import Long from 'long'
@@ -213,13 +213,13 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
         contract: {
           name: aptosProcessor.name,
           chainId: APTOS_TESTNET_ID,
-          address: aptosProcessor.address,
+          address: aptosProcessor.config.address,
           abi: '',
         },
         blockConfigs: [],
         logConfigs: [],
         traceConfigs: [],
-        startBlock: aptosProcessor.config.startSeqNumber,
+        startBlock: aptosProcessor.config.startVersion,
         endBlock: DEFAULT_MAX_BLOCK,
         instructionConfig: undefined,
         aptosEventConfigs: [],
@@ -324,7 +324,7 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
   async processBinding(request: DataBinding, options?: CallContext): Promise<ProcessResult> {
     switch (request.handlerType) {
       case HandlerType.APT_CALL:
-        return this.processAptosCall(request)
+        return this.processAptosFunctionCall(request)
       case HandlerType.APT_EVENT:
         return this.processAptosEvent(request)
       default:
@@ -410,30 +410,30 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
       await Promise.all(processorPromises)
     }
 
-    if (request.chainId.toLowerCase().startsWith('apt') && global.PROCESSOR_STATE.aptosProcessors) {
-      const processorPromises: Promise<void>[] = []
-      for (const txn of request.transactions) {
-        processorPromises.push(
-          new Promise((resolve, _) => {
-            for (const processor of global.PROCESSOR_STATE.aptosProcessors) {
-              if (processor.address === txn.programAccountId!) {
-                const res = processor.handleTransaction(
-                  JSON.parse(new TextDecoder().decode(txn.raw)),
-                  txn.slot ?? Long.fromNumber(0)
-                )
-                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()
-          })
-        )
-      }
-      await Promise.all(processorPromises)
-    }
+    // if (request.chainId.toLowerCase().startsWith('apt') && global.PROCESSOR_STATE.aptosProcessors) {
+    //   const processorPromises: Promise<void>[] = []
+    //   for (const txn of request.transactions) {
+    //     processorPromises.push(
+    //       new Promise((resolve, _) => {
+    //         for (const processor of global.PROCESSOR_STATE.aptosProcessors) {
+    //           if (processor.address === txn.programAccountId!) {
+    //             const res = processor.handleTransaction(
+    //               JSON.parse(new TextDecoder().decode(txn.raw)),
+    //               txn.slot ?? Long.fromNumber(0)
+    //             )
+    //             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()
+    //       })
+    //     )
+    //   }
+    //   await Promise.all(processorPromises)
+    // }
 
     recordRuntimeInfo(result, HandlerType.TRANSACTION)
     return {
@@ -575,7 +575,7 @@ export class ProcessorServiceImpl implements ProcessorServiceImplementation {
     return result
   }
 
-  async processAptosCall(binding: DataBinding): Promise<ProcessResult> {
+  async processAptosFunctionCall(binding: DataBinding): Promise<ProcessResult> {
     if (!binding.data) {
       throw new ServerError(Status.INVALID_ARGUMENT, "Event can't be empty")
     }

package/src/testing/metric-utils.ts

@@ -1,6 +1,6 @@
 import { DeepPartial } from '../gen/builtin'
-import { BigDecimal, MetricValue, ProcessResult } from '@sentio/sdk'
-import { Numberish } from '../core'
+import { MetricValue, ProcessResult } from '../gen'
+import { Numberish, BigDecimal } from '../core'
 import { BigNumber } from 'ethers'
 
 export function MetricValueToNumber(v: DeepPartial<MetricValue> | undefined): Numberish | undefined {

package/src/testing/test-processor-server.ts

@@ -25,7 +25,7 @@ import { Block, Log } from '@ethersproject/abstract-provider'
 import Long from 'long'
 import { getNetwork, Networkish } from '@ethersproject/providers'
 
-const TEST_CONTEXT: CallContext = <CallContext>{}
+export const TEST_CONTEXT: CallContext = <CallContext>{}
 
 function cleanTest() {
   global.PROCESSOR_STATE = new ProcessorState()
@@ -238,7 +238,10 @@ export class TestProcessorServer implements ProcessorServiceImplementation {
     return binding
   }
 
-  processBindings(request: ProcessBindingsRequest, context: CallContext): Promise<ProcessBindingResponse> {
+  processBindings(
+    request: ProcessBindingsRequest,
+    context: CallContext = TEST_CONTEXT
+  ): Promise<ProcessBindingResponse> {
     return this.service.processBindings(request, context)
   }
 }

package/src/testing/test-provider.ts

@@ -1,6 +1,6 @@
 import { ChainConfig } from '../chain-config'
 import { CHAIN_MAP } from '../utils/chain'
-import { setProvider } from '@sentio/sdk'
+import { setProvider } from '../provider'
 
 export function loadTestProvidersFromEnv(requiredChainIds: string[] | string): boolean {
   const dummyConfig: Record<string, ChainConfig> = {}

package/src/tests/aptos.test.ts

@@ -1,8 +1,6 @@
 import { expect } from 'chai'
-import Long from 'long'
 import { TextEncoder } from 'util'
-import { ProcessTransactionsRequest } from '..'
-import { chain } from '../utils'
+import { HandlerType, ProcessBindingsRequest } from '..'
 
 import { TestProcessorServer } from '../testing'
 
@@ -21,20 +19,57 @@ describe('Test Aptos Example', () => {
   })
 
   test('Check souffl3 transaction dispatch', async () => {
-    const request: ProcessTransactionsRequest = {
-      chainId: chain.APTOS_TESTNET_ID,
-      transactions: [
+    const request: ProcessBindingsRequest = {
+      bindings: [
         {
-          raw: new TextEncoder().encode(JSON.stringify(testData)),
-          programAccountId: '4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807',
-          slot: Long.fromNumber(12345),
+          data: {
+            raw: new TextEncoder().encode(JSON.stringify(testData)),
+          },
+          handlerId: 0,
+          handlerType: HandlerType.APT_CALL,
+        },
+      ],
+    }
+    const res = await service.processBindings(request)
+    expect(res.result?.counters).length(1)
+    expect(res.result?.gauges).length(0)
+    expect(res.result?.counters[0].metadata?.blockNumber.toInt()).equal(18483034)
+  })
+
+  test('Check souffl3 function call dispatch', async () => {
+    const request: ProcessBindingsRequest = {
+      bindings: [
+        {
+          data: {
+            raw: new TextEncoder().encode(JSON.stringify(testData)),
+          },
+          handlerId: 1,
+          handlerType: HandlerType.APT_CALL,
+        },
+      ],
+    }
+    const res = await service.processBindings(request)
+    expect(res.result?.counters).length(2)
+    expect(res.result?.gauges).length(0)
+    expect(res.result?.counters[0].metadata?.blockNumber.toInt()).equal(18483034)
+  })
+
+  test('Check souffl3 event dispatch', async () => {
+    const request: ProcessBindingsRequest = {
+      bindings: [
+        {
+          data: {
+            raw: new TextEncoder().encode(JSON.stringify(testData.events[1])),
+          },
+          handlerId: 0,
+          handlerType: HandlerType.APT_EVENT,
         },
       ],
     }
-    const res = await service.processTransactions(request)
+    const res = await service.processBindings(request)
     expect(res.result?.counters).length(1)
     expect(res.result?.gauges).length(0)
-    expect(res.result?.counters[0].metadata?.blockNumber.toInt()).equal(12345)
+    expect(res.result?.counters[0].metadata?.blockNumber.toInt()).equal(18483034)
   })
 })
 
@@ -84,6 +119,7 @@ const testData = {
       },
     },
     {
+      version: '18483034',
       guid: {
         creation_number: '2',
         account_address: '0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807',

package/src/tests/souffl3.ts

@@ -1,23 +1,35 @@
-import { AptosBindOptions, AptosBaseProcessor } from '@sentio/sdk'
+import { aptos } from '@sentio/sdk'
 
-class Souffl3 extends AptosBaseProcessor {
-  static bind(options: AptosBindOptions): Souffl3 {
-    if (options && !options.name) {
-      options.name = 'souffl3'
+aptos.AptosBaseProcessor.bind({
+  name: 'souffl3',
+  startVersion: 6604913,
+  address: '0x4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807',
+})
+  .onTransaction((txn, ctx) => {
+    if (txn.events) {
+      for (const event of txn.events) {
+        if (event && event.type === '0x3::token::DepositEvent') {
+          ctx.meter.Counter('deposit_token_count').add(Number(event.data.amount))
+        }
+      }
     }
-    return new Souffl3(options)
-  }
-}
-
-Souffl3.bind({
-  startBlock: 6604913,
-  address: '4188c8694687e844677c2aa87171019e23d61cac60de5082a278a8aa47e9d807',
-}).onTransaction((txn, ctx) => {
-  if (txn.events) {
-    for (const event of txn.events) {
-      if (event && event.type === '0x3::token::DepositEvent') {
-        ctx.meter.Counter('deposit_token_count').add(Number(event.data.amount))
+  })
+  .onEntryFunctionCall(
+    (call, ctx) => {
+      ctx.meter.Counter('call_num').add(1)
+      if (call.arguments.length > 3 && call.type_arguments.length > 0) {
+        ctx.meter.Counter('arg').add(parseInt(call.arguments[3]), { type: call.type_arguments[0] })
       }
+    },
+    {
+      function: 'SouffleChefCampaign::pull_token_v2',
     }
-  }
-})
+  )
+  .onEvent(
+    (event, ctx) => {
+      ctx.meter.Counter('evt_num').add(1)
+    },
+    {
+      type: '0x1::coin::DepositEvent',
+    }
+  )

package/src/utils/chain.ts

@@ -91,7 +91,9 @@ export const SUI_DEVNET_ID = 'sui_devnet'
 CHAIN_MAP[SUI_DEVNET_ID] = 'sui-dev'
 
 export const APTOS_TESTNET_ID = 'aptos_testnet'
+export const APTOS_MAINNET_ID = 'aptos_mainnet'
 CHAIN_MAP[APTOS_TESTNET_ID] = 'aptos-test'
+CHAIN_MAP[APTOS_MAINNET_ID] = 'aptos-mainnet'
 
 export function getChainName(chainId: string | number): string {
   if (typeof chainId === 'number') {