Class BaseProcessorTemplate<TContract, TBoundContractView, TProcessor>Abstract

constructor

• new BaseProcessorTemplate<
      TContract extends BaseContract,
      TBoundContractView extends
          BoundContractView<TContract, ContractView<TContract>>,
      TProcessor extends
          BaseProcessor<TContract, TBoundContractView> = BaseProcessor<
          TContract,
          TBoundContractView,
      >,
  >(): BaseProcessorTemplate<TContract, TBoundContractView, TProcessor>

  Type Parameters

  • TContract extends BaseContract
  • TBoundContractView extends BoundContractView<TContract, ContractView<TContract>>
  • TProcessor extends BaseProcessor<TContract, TBoundContractView> = BaseProcessor<TContract, TBoundContractView>

  Returns BaseProcessorTemplate<TContract, TBoundContractView, TProcessor>

blockHandlers

eventHandlers

id

instances

traceHandlers

bind

• bind(options: Omit<BindOptions, "network">, ctx: EthContext): void

  Bind template using {@param options}, using {@param ctx}'s network value if not provided in the option

  Parameters

  • options: Omit<BindOptions, "network">
  • ctx: EthContext

  Returns void

configureHandlerFactory

• configureHandlerFactory(
      factory: (
          instance: TProcessor,
          baseLabels: undefined | { [key: string]: string },
      ) => void,
  ): void

  Parameters

  • factory: (
        instance: TProcessor,
        baseLabels: undefined | { [key: string]: string },
    ) => void

  Returns void

onBlockInterval

• onBlockInterval(
      handler: (
          block: BlockParams,
          ctx: ContractContext<TContract, TBoundContractView>,
      ) => PromiseOrVoid,
      blockInterval?: number,
      backfillBlockInterval?: number,
      fetchConfig?: EthFetchConfig,
      preprocessHandler?: (
          block: BlockParams,
          ctx: ContractContext<TContract, TBoundContractView>,
          preprocessStore: { [k: string]: any },
      ) => Promise<PreprocessResult>,
  ): BaseProcessorTemplate<TContract, TBoundContractView, TProcessor>

  Parameters

  • handler: (
        block: BlockParams,
        ctx: ContractContext<TContract, TBoundContractView>,
    ) => PromiseOrVoid
  • blockInterval: number = 1000
  • backfillBlockInterval: number = 4000
  • OptionalfetchConfig: EthFetchConfig
  • preprocessHandler: (
        block: BlockParams,
        ctx: ContractContext<TContract, TBoundContractView>,
        preprocessStore: { [k: string]: any },
    ) => Promise<PreprocessResult> = defaultPreprocessHandler

  Returns BaseProcessorTemplate<TContract, TBoundContractView, TProcessor>

onInterval

• onInterval(
      handler: (
          block: BlockParams,
          ctx: ContractContext<TContract, TBoundContractView>,
      ) => PromiseOrVoid,
      timeInterval: undefined | HandleInterval,
      blockInterval: undefined | HandleInterval,
      fetchConfig: undefined | EthFetchConfig,
      preprocessHandler?: (
          block: BlockParams,
          ctx: ContractContext<TContract, TBoundContractView>,
          preprocessStore: { [k: string]: any },
      ) => Promise<PreprocessResult>,
  ): BaseProcessorTemplate<TContract, TBoundContractView, TProcessor>

  Parameters

  • handler: (
        block: BlockParams,
        ctx: ContractContext<TContract, TBoundContractView>,
    ) => PromiseOrVoid
  • timeInterval: undefined | HandleInterval
  • blockInterval: undefined | HandleInterval
  • fetchConfig: undefined | EthFetchConfig
  • preprocessHandler: (
        block: BlockParams,
        ctx: ContractContext<TContract, TBoundContractView>,
        preprocessStore: { [k: string]: any },
    ) => Promise<PreprocessResult> = defaultPreprocessHandler

  Returns BaseProcessorTemplate<TContract, TBoundContractView, TProcessor>

onTimeInterval

• onTimeInterval(
      handler: (
          block: BlockParams,
          ctx: ContractContext<TContract, TBoundContractView>,
      ) => PromiseOrVoid,
      timeIntervalInMinutes?: number,
      backfillTimeIntervalInMinutes?: number,
      fetchConfig?: EthFetchConfig,
      preprocessHandler?: (
          block: BlockParams,
          ctx: ContractContext<TContract, TBoundContractView>,
          preprocessStore: { [k: string]: any },
      ) => Promise<PreprocessResult>,
  ): BaseProcessorTemplate<TContract, TBoundContractView, TProcessor>

  Parameters

  • handler: (
        block: BlockParams,
        ctx: ContractContext<TContract, TBoundContractView>,
    ) => PromiseOrVoid
  • timeIntervalInMinutes: number = 60
  • backfillTimeIntervalInMinutes: number = 240
  • OptionalfetchConfig: EthFetchConfig
  • preprocessHandler: (
        block: BlockParams,
        ctx: ContractContext<TContract, TBoundContractView>,
        preprocessStore: { [k: string]: any },
    ) => Promise<PreprocessResult> = defaultPreprocessHandler

  Returns BaseProcessorTemplate<TContract, TBoundContractView, TProcessor>

onTrace

• onTrace(
      signature: string,
      handler: (
          trace: TypedCallTrace,
          ctx: ContractContext<TContract, TBoundContractView>,
      ) => PromiseOrVoid,
      fetchConfig?: Omit<Partial<EthFetchConfig>, "$typeName" | "$unknown">,
      preprocessHandler?: (
          trace: TypedCallTrace,
          ctx: ContractContext<TContract, TBoundContractView>,
          preprocessStore: { [k: string]: any },
      ) => Promise<PreprocessResult>,
  ): BaseProcessorTemplate<TContract, TBoundContractView, TProcessor>

  Parameters

  • signature: string
  • handler: (
        trace: TypedCallTrace,
        ctx: ContractContext<TContract, TBoundContractView>,
    ) => PromiseOrVoid
  • OptionalfetchConfig: Omit<Partial<EthFetchConfig>, "$typeName" | "$unknown">
  • preprocessHandler: (
        trace: TypedCallTrace,
        ctx: ContractContext<TContract, TBoundContractView>,
        preprocessStore: { [k: string]: any },
    ) => Promise<PreprocessResult> = defaultPreprocessHandler

  Returns BaseProcessorTemplate<TContract, TBoundContractView, TProcessor>

startInstance

• startInstance(options: Omit<BindOptions, "network">, ctx: EthContext): void

  Parameters

  • options: Omit<BindOptions, "network">
  • ctx: EthContext

  Returns void