@sentio/sdk 2.39.7-rc.8 → 2.40.0-rc.1

package/src/eth/builtin/internal/weth9-processor.ts

@@ -20,6 +20,7 @@ import {
   TypedCallTrace,
   EthContext,
   EthFetchConfig,
+  PreprocessResult,
 } from "@sentio/sdk/eth";
 
 import { WETH9__factory } from "./index.js";
@@ -354,7 +355,11 @@ export class WETH9Processor extends BaseProcessor<
   onEventApproval(
     handler: (event: ApprovalEvent, ctx: WETH9Context) => void,
     filter?: ApprovalEventFilter | ApprovalEventFilter[],
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      event: ApprovalEvent,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
     if (!filter) {
       filter = templateContract.filters["Approval(address,address,uint256)"](
@@ -363,13 +368,17 @@ export class WETH9Processor extends BaseProcessor<
         null
       );
     }
-    return super.onEthEvent(handler, filter!, fetchConfig);
+    return super.onEthEvent(handler, filter!, fetchConfig, preprocessHandler);
   }
 
   onEventTransfer(
     handler: (event: TransferEvent, ctx: WETH9Context) => void,
     filter?: TransferEventFilter | TransferEventFilter[],
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      event: TransferEvent,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
     if (!filter) {
       filter = templateContract.filters["Transfer(address,address,uint256)"](
@@ -378,24 +387,32 @@ export class WETH9Processor extends BaseProcessor<
         null
       );
     }
-    return super.onEthEvent(handler, filter!, fetchConfig);
+    return super.onEthEvent(handler, filter!, fetchConfig, preprocessHandler);
   }
 
   onEventDeposit(
     handler: (event: DepositEvent, ctx: WETH9Context) => void,
     filter?: DepositEventFilter | DepositEventFilter[],
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      event: DepositEvent,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
     if (!filter) {
       filter = templateContract.filters["Deposit(address,uint256)"](null, null);
     }
-    return super.onEthEvent(handler, filter!, fetchConfig);
+    return super.onEthEvent(handler, filter!, fetchConfig, preprocessHandler);
   }
 
   onEventWithdrawal(
     handler: (event: WithdrawalEvent, ctx: WETH9Context) => void,
     filter?: WithdrawalEventFilter | WithdrawalEventFilter[],
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      event: WithdrawalEvent,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
     if (!filter) {
       filter = templateContract.filters["Withdrawal(address,uint256)"](
@@ -403,84 +420,183 @@ export class WETH9Processor extends BaseProcessor<
         null
       );
     }
-    return super.onEthEvent(handler, filter!, fetchConfig);
+    return super.onEthEvent(handler, filter!, fetchConfig, preprocessHandler);
   }
 
   onCallName(
     handler: (call: NameCallTrace, ctx: WETH9Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      call: NameCallTrace,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("0x06fdde03", handler as any, fetchConfig);
+    return super.onEthTrace(
+      "0x06fdde03",
+      handler as any,
+      fetchConfig,
+      preprocessHandler
+    );
   }
 
   onCallApprove(
     handler: (call: ApproveCallTrace, ctx: WETH9Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      call: ApproveCallTrace,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("0x095ea7b3", handler as any, fetchConfig);
+    return super.onEthTrace(
+      "0x095ea7b3",
+      handler as any,
+      fetchConfig,
+      preprocessHandler
+    );
   }
 
   onCallTotalSupply(
     handler: (call: TotalSupplyCallTrace, ctx: WETH9Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      call: TotalSupplyCallTrace,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("0x18160ddd", handler as any, fetchConfig);
+    return super.onEthTrace(
+      "0x18160ddd",
+      handler as any,
+      fetchConfig,
+      preprocessHandler
+    );
   }
 
   onCallTransferFrom(
     handler: (call: TransferFromCallTrace, ctx: WETH9Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      call: TransferFromCallTrace,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("0x23b872dd", handler as any, fetchConfig);
+    return super.onEthTrace(
+      "0x23b872dd",
+      handler as any,
+      fetchConfig,
+      preprocessHandler
+    );
   }
 
   onCallWithdraw(
     handler: (call: WithdrawCallTrace, ctx: WETH9Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      call: WithdrawCallTrace,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("0x2e1a7d4d", handler as any, fetchConfig);
+    return super.onEthTrace(
+      "0x2e1a7d4d",
+      handler as any,
+      fetchConfig,
+      preprocessHandler
+    );
   }
 
   onCallDecimals(
     handler: (call: DecimalsCallTrace, ctx: WETH9Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      call: DecimalsCallTrace,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("0x313ce567", handler as any, fetchConfig);
+    return super.onEthTrace(
+      "0x313ce567",
+      handler as any,
+      fetchConfig,
+      preprocessHandler
+    );
   }
 
   onCallBalanceOf(
     handler: (call: BalanceOfCallTrace, ctx: WETH9Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      call: BalanceOfCallTrace,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("0x70a08231", handler as any, fetchConfig);
+    return super.onEthTrace(
+      "0x70a08231",
+      handler as any,
+      fetchConfig,
+      preprocessHandler
+    );
   }
 
   onCallSymbol(
     handler: (call: SymbolCallTrace, ctx: WETH9Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      call: SymbolCallTrace,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("0x95d89b41", handler as any, fetchConfig);
+    return super.onEthTrace(
+      "0x95d89b41",
+      handler as any,
+      fetchConfig,
+      preprocessHandler
+    );
   }
 
   onCallTransfer(
     handler: (call: TransferCallTrace, ctx: WETH9Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      call: TransferCallTrace,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("0xa9059cbb", handler as any, fetchConfig);
+    return super.onEthTrace(
+      "0xa9059cbb",
+      handler as any,
+      fetchConfig,
+      preprocessHandler
+    );
   }
 
   onCallDeposit(
     handler: (call: DepositCallTrace, ctx: WETH9Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      call: DepositCallTrace,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("0xd0e30db0", handler as any, fetchConfig);
+    return super.onEthTrace(
+      "0xd0e30db0",
+      handler as any,
+      fetchConfig,
+      preprocessHandler
+    );
   }
 
   onCallAllowance(
     handler: (call: AllowanceCallTrace, ctx: WETH9Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      call: AllowanceCallTrace,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("0xdd62ed3e", handler as any, fetchConfig);
+    return super.onEthTrace(
+      "0xdd62ed3e",
+      handler as any,
+      fetchConfig,
+      preprocessHandler
+    );
   }
 
   public static filters = {
@@ -551,7 +667,11 @@ export class WETH9ProcessorTemplate extends BaseProcessorTemplate<
   onEventApproval(
     handler: (event: ApprovalEvent, ctx: WETH9Context) => void,
     filter?: ApprovalEventFilter | ApprovalEventFilter[],
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      event: ApprovalEvent,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
     if (!filter) {
       filter = templateContract.filters["Approval(address,address,uint256)"](
@@ -560,13 +680,17 @@ export class WETH9ProcessorTemplate extends BaseProcessorTemplate<
         null
       );
     }
-    return super.onEthEvent(handler, filter!, fetchConfig);
+    return super.onEthEvent(handler, filter!, fetchConfig, preprocessHandler);
   }
 
   onEventTransfer(
     handler: (event: TransferEvent, ctx: WETH9Context) => void,
     filter?: TransferEventFilter | TransferEventFilter[],
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      event: TransferEvent,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
     if (!filter) {
       filter = templateContract.filters["Transfer(address,address,uint256)"](
@@ -575,24 +699,32 @@ export class WETH9ProcessorTemplate extends BaseProcessorTemplate<
         null
       );
     }
-    return super.onEthEvent(handler, filter!, fetchConfig);
+    return super.onEthEvent(handler, filter!, fetchConfig, preprocessHandler);
   }
 
   onEventDeposit(
     handler: (event: DepositEvent, ctx: WETH9Context) => void,
     filter?: DepositEventFilter | DepositEventFilter[],
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      event: DepositEvent,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
     if (!filter) {
       filter = templateContract.filters["Deposit(address,uint256)"](null, null);
     }
-    return super.onEthEvent(handler, filter!, fetchConfig);
+    return super.onEthEvent(handler, filter!, fetchConfig, preprocessHandler);
   }
 
   onEventWithdrawal(
     handler: (event: WithdrawalEvent, ctx: WETH9Context) => void,
     filter?: WithdrawalEventFilter | WithdrawalEventFilter[],
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (
+      event: WithdrawalEvent,
+      ctx: WETH9Context
+    ) => Promise<PreprocessResult>
   ): this {
     if (!filter) {
       filter = templateContract.filters["Withdrawal(address,uint256)"](
@@ -600,7 +732,7 @@ export class WETH9ProcessorTemplate extends BaseProcessorTemplate<
         null
       );
     }
-    return super.onEthEvent(handler, filter!, fetchConfig);
+    return super.onEthEvent(handler, filter!, fetchConfig, preprocessHandler);
   }
 }
 

package/src/eth/codegen/event-handler.ts

@@ -11,12 +11,13 @@ export function generateEventHandler(event: EventDeclaration, contractName: stri
   onEvent${eventName}(
     handler: (event: ${eventNamePrefix}Event, ctx: ${contractName}Context) => void,
     filter?: ${eventNamePrefix}EventFilter | ${eventNamePrefix}EventFilter[],
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (event: ${eventNamePrefix}Event, ctx: ${contractName}Context) => Promise<PreprocessResult>
   ): this {
     if (!filter) {
       filter = templateContract.filters['${filterName}'](${event.inputs.map(() => 'null').join(',')})
     }
-    return super.onEthEvent(handler, filter!, fetchConfig)
+    return super.onEthEvent(handler, filter!, fetchConfig, preprocessHandler)
   }
   `
 }

package/src/eth/codegen/file.ts

@@ -3,7 +3,7 @@ import {
   createImportsForUsedIdentifiers,
   EventDeclaration,
   getFullSignatureAsSymbolForEvent,
-  getFullSignatureForEvent,
+  getFullSignatureForEvent
 } from 'typechain'
 
 import { reservedKeywords } from '@sentio/ethers-v6/dist/codegen/reserved-keywords.js'
@@ -151,7 +151,7 @@ export class ${contract.name}ProcessorTemplate extends BaseProcessorTemplate<${c
     } else {
       return events.flatMap((e) => [
         `${getFullSignatureAsSymbolForEvent(e)}_Event`,
-        `${getFullSignatureAsSymbolForEvent(e)}_EventFilter`,
+        `${getFullSignatureAsSymbolForEvent(e)}_EventFilter`
       ])
     }
   })
@@ -182,6 +182,7 @@ export class ${contract.name}ProcessorTemplate extends BaseProcessorTemplate<${c
         'getProcessor',
         'getProvider',
         'transformEtherError',
+        'defaultPreprocessHandler',
         'Trace',
         'BindOptions',
         'BaseProcessor',
@@ -194,12 +195,13 @@ export class ${contract.name}ProcessorTemplate extends BaseProcessorTemplate<${c
         'TypedCallTrace',
         'EthContext',
         'EthFetchConfig',
+        'PreprocessResult'
       ],
       // '@sentio/sdk/eth': ['BaseContext'],
       // '@sentio/protos': ['EthFetchConfig'],
       './common.js': ['PromiseOrValue'],
       './index.js': [`${contract.name}__factory`],
-      [`./${contract.name}.js`]: [`${contract.name}`, ...eventsImports, ...uniqueStructImports],
+      [`./${contract.name}.js`]: [`${contract.name}`, ...eventsImports, ...uniqueStructImports]
     },
     source
   )
@@ -232,7 +234,7 @@ export function codeGenTestUtilsFile(contract: Contract): string {
 
   const possibleImports = {
     'ethers/providers': ['LogParams'],
-    '@sentio/sdk/eth': ['EthChainId'],
+    '@sentio/sdk/eth': ['EthChainId']
   } as any
   possibleImports[`./${contract.name}.js`] = Object.values(contract.events).flatMap((events) => {
     if (events.length === 1) {

package/src/eth/codegen/functions-handler.ts

@@ -1,6 +1,6 @@
 import {
   generateOutputComplexTypeAsArray,
-  generateOutputComplexTypesAsObject,
+  generateOutputComplexTypesAsObject
 } from '@sentio/ethers-v6/dist/codegen/types.js'
 import sha3 from 'js-sha3'
 import { FunctionDeclaration, getSignatureForFn } from 'typechain'
@@ -45,9 +45,10 @@ function generateCallHandler(fn: FunctionDeclaration, contractName: string, over
   return `
   onCall${upperFirst(overloadedName ?? fn.name)}(
     handler: (call: ${upperFirst(overloadedName ?? fn.name)}CallTrace, ctx: ${contractName}Context) => void,
-    fetchConfig?: Partial<EthFetchConfig>
+    fetchConfig?: Partial<EthFetchConfig>,
+    preprocessHandler?: (call: ${upperFirst(overloadedName ?? fn.name)}CallTrace, ctx: ${contractName}Context) => Promise<PreprocessResult>
   ): this {
-    return super.onEthTrace("${sighash}", handler as any, fetchConfig);
+    return super.onEthTrace("${sighash}", handler as any, fetchConfig, preprocessHandler);
   }
 `
 }

package/src/eth/context.ts

@@ -1,7 +1,7 @@
 import { BaseContract } from 'ethers'
 import { LogParams, BlockParams, TransactionReceiptParams, TransactionResponseParams } from 'ethers/providers'
 
-import { RecordMetaData } from '@sentio/protos'
+import { PreparedData, RecordMetaData } from '@sentio/protos'
 import { Trace } from './eth.js'
 import { Labels, normalizeLabels } from '../core/index.js'
 import { BaseContext } from '../core/base-context.js'
@@ -12,12 +12,13 @@ export abstract class EthContext extends BaseContext {
   address: string
   private readonly log?: LogParams
   readonly block?: BlockParams
-  private readonly trace?: Trace
+  readonly trace?: Trace
   readonly blockNumber: number
   readonly transactionHash?: string
   readonly transaction?: TransactionResponseParams
   readonly transactionReceipt?: TransactionReceiptParams
   readonly timestamp: Date
+  readonly preparedData?: PreparedData
 
   constructor(
     chainId: EthChainId,
@@ -28,7 +29,8 @@ export abstract class EthContext extends BaseContext {
     trace?: Trace,
     transaction?: TransactionResponseParams,
     transactionReceipt?: TransactionReceiptParams,
-    baseLabels?: Labels
+    baseLabels?: Labels,
+    preparedData?: PreparedData
   ) {
     super(baseLabels)
     this.chainId = chainId
@@ -39,6 +41,7 @@ export abstract class EthContext extends BaseContext {
     this.transaction = transaction
     this.transactionReceipt = transactionReceipt
     this.timestamp = timestamp || new Date(0)
+    this.preparedData = preparedData
     if (log) {
       this.blockNumber = log.blockNumber
       this.transactionHash = log.transactionHash
@@ -132,9 +135,10 @@ export class GlobalContext extends EthContext {
     trace?: Trace,
     transaction?: TransactionResponseParams,
     transactionReceipt?: TransactionReceiptParams,
-    baseLabels?: Labels
+    baseLabels?: Labels,
+    preparedData?: PreparedData
   ) {
-    super(chainId, address, timestamp, block, log, trace, transaction, transactionReceipt, baseLabels)
+    super(chainId, address, timestamp, block, log, trace, transaction, transactionReceipt, baseLabels, preparedData)
   }
   protected getContractName(): string {
     return '*'
@@ -165,9 +169,21 @@ export class ContractContext<
     trace?: Trace,
     transaction?: TransactionResponseParams,
     transactionReceipt?: TransactionReceiptParams,
-    baseLabels?: Labels
+    baseLabels?: Labels,
+    preparedData?: PreparedData
   ) {
-    super(chainId, view.address, timestamp, block, log, trace, transaction, transactionReceipt, baseLabels)
+    super(
+      chainId,
+      view.address,
+      timestamp,
+      block,
+      log,
+      trace,
+      transaction,
+      transactionReceipt,
+      baseLabels,
+      preparedData
+    )
     view.context = this
     if (view.callStatic) {
       view.callStatic.context = this