Class GenericProcessor

Hierarchy (View Summary)

BaseProcessor<
BaseContract,
BoundContractView<BaseContract, ContractView<BaseContract>>,
>
- GenericProcessor

Index

Constructors

constructor

new GenericProcessor(eventABI: string[], options: BindOptions): GenericProcessor
Parameters
- eventABI: string[]
- options: BindOptions
Returns GenericProcessor
Overrides BaseProcessor.constructor
- Defined in packages/sdk/src/eth/generic-processor.ts:13

Properties

blockHandlers

blockHandlers: BlockHandler[] = ...

config

config: BindInternalOptions

eventABI

eventABI: string[]

eventHandlers

eventHandlers: EventsHandler[] = ...

traceHandlers

traceHandlers: TraceHandler[] = ...

Methods

`Protected`CreateBoundContractView

CreateBoundContractView(): BoundContractView<
BaseContract,
ContractView<BaseContract>,
>
Returns BoundContractView<BaseContract, ContractView<BaseContract>>
Overrides BaseProcessor.CreateBoundContractView
- Defined in packages/sdk/src/eth/generic-processor.ts:18

getChainId

getChainId(): EthChainId
Returns EthChainId
Inherited from BaseProcessor.getChainId
- Defined in packages/sdk/src/eth/base-processor.ts:498

onBlockInterval

onBlockInterval(
    handler: (
        block: RichBlock,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
    ) => PromiseOrVoid,
    blockInterval?: number,
    backfillBlockInterval?: number,
    handlerOptions?: HandlerOptions<EthFetchConfig, RichBlock>,
    preprocessHandler?: (
        block: RichBlock,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
        preprocessStore: { [k: string]: any },
    ) => Promise<PreprocessResult>,
): this
Parameters
- handler: (
      block: RichBlock,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
  ) => PromiseOrVoid
- blockInterval: number = 250
- backfillBlockInterval: number = 1000
- OptionalhandlerOptions: HandlerOptions<EthFetchConfig, RichBlock>
- preprocessHandler: (
      block: RichBlock,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
      preprocessStore: { [k: string]: any },
  ) => Promise<PreprocessResult> = defaultPreprocessHandler
Returns this
Inherited from BaseProcessor.onBlockInterval
- Defined in packages/sdk/src/eth/base-processor.ts:676

`Protected`onEthEvent

onEthEvent(
    handler: (
        event: RawEvent | TypedEvent<any, any>,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
    ) => PromiseOrVoid,
    filter: DeferredTopicFilter | DeferredTopicFilter[],
    handlerOptions?: HandlerOptions<EthFetchConfig, TypedEvent<any, any>>,
    preprocessHandler?: (
        event: TypedEvent,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
        preprocessStore: { [k: string]: any },
    ) => Promise<PreprocessResult>,
    handlerName?: string,
): this
Parameters
- handler: (
      event: RawEvent | TypedEvent<any, any>,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
  ) => PromiseOrVoid
- filter: DeferredTopicFilter | DeferredTopicFilter[]
- OptionalhandlerOptions: HandlerOptions<EthFetchConfig, TypedEvent<any, any>>
- preprocessHandler: (
      event: TypedEvent,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
      preprocessStore: { [k: string]: any },
  ) => Promise<PreprocessResult> = defaultPreprocessHandler
- handlerName: string = ...
Returns this
Inherited from BaseProcessor.onEthEvent
- Defined in packages/sdk/src/eth/base-processor.ts:523

`Protected`onEthTrace

onEthTrace(
    signatures: string | string[],
    handler: (
        trace: TypedCallTrace,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
    ) => PromiseOrVoid,
    handlerOptions?: HandlerOptions<EthFetchConfig, TypedCallTrace<any, any>>,
    preprocessHandler?: (
        trace: TypedCallTrace,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
        preprocessStore: { [k: string]: any },
    ) => Promise<PreprocessResult>,
    handlerName?: string,
): this
Parameters
- signatures: string | string[]
- handler: (
      trace: TypedCallTrace,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
  ) => PromiseOrVoid
- OptionalhandlerOptions: HandlerOptions<EthFetchConfig, TypedCallTrace<any, any>>
- preprocessHandler: (
      trace: TypedCallTrace,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
      preprocessStore: { [k: string]: any },
  ) => Promise<PreprocessResult> = defaultPreprocessHandler
- handlerName: string = ...
Returns this
Inherited from BaseProcessor.onEthTrace
- Defined in packages/sdk/src/eth/base-processor.ts:802

onEvent

onEvent(
    handler: (
        event: TypedEvent,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
    ) => PromiseOrVoid,
    handlerOptions?: HandlerOptions<EthFetchConfig, TypedEvent<any, any>>,
    preprocessHandler?: (
        event: TypedEvent,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
        preprocessStore: { [k: string]: any },
    ) => Promise<PreprocessResult>,
): this
Parameters
- handler: (
      event: TypedEvent,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
  ) => PromiseOrVoid
- OptionalhandlerOptions: HandlerOptions<EthFetchConfig, TypedEvent<any, any>>
- preprocessHandler: (
      event: TypedEvent,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
      preprocessStore: { [k: string]: any },
  ) => Promise<PreprocessResult> = defaultPreprocessHandler
Returns this
Inherited from BaseProcessor.onEvent
- Defined in packages/sdk/src/eth/base-processor.ts:502

onInterval

onInterval(
    handler: (
        block: RichBlock,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
    ) => PromiseOrVoid,
    timeInterval: undefined | HandleInterval,
    blockInterval: undefined | HandleInterval,
    handlerOptions?: HandlerOptions<EthFetchConfig, RichBlock>,
    preprocessHandler?: (
        block: RichBlock,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
        preprocessStore: { [k: string]: any },
    ) => Promise<PreprocessResult>,
    handlerName?: string,
): this
Parameters
- handler: (
      block: RichBlock,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
  ) => PromiseOrVoid
- timeInterval: undefined | HandleInterval
- blockInterval: undefined | HandleInterval
- OptionalhandlerOptions: HandlerOptions<EthFetchConfig, RichBlock>
- preprocessHandler: (
      block: RichBlock,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
      preprocessStore: { [k: string]: any },
  ) => Promise<PreprocessResult> = defaultPreprocessHandler
- handlerName: string = ...
Returns this
Inherited from BaseProcessor.onInterval
- Defined in packages/sdk/src/eth/base-processor.ts:719

onTimeInterval

onTimeInterval(
    handler: (
        block: RichBlock,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
    ) => PromiseOrVoid,
    timeIntervalInMinutes?: number,
    backfillTimeIntervalInMinutes?: number,
    handlerOptions?: HandlerOptions<EthFetchConfig, RichBlock>,
    preprocessHandler?: (
        block: RichBlock,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
        preprocessStore: { [k: string]: any },
    ) => Promise<PreprocessResult>,
): this
Parameters
- handler: (
      block: RichBlock,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
  ) => PromiseOrVoid
- timeIntervalInMinutes: number = 60
- backfillTimeIntervalInMinutes: number = 240
- OptionalhandlerOptions: HandlerOptions<EthFetchConfig, RichBlock>
- preprocessHandler: (
      block: RichBlock,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
      preprocessStore: { [k: string]: any },
  ) => Promise<PreprocessResult> = defaultPreprocessHandler
Returns this
Inherited from BaseProcessor.onTimeInterval
- Defined in packages/sdk/src/eth/base-processor.ts:699

onTrace

onTrace(
    handler: (
        event: TypedCallTrace,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
    ) => PromiseOrVoid,
    handlerOptions?: HandlerOptions<EthFetchConfig, TypedCallTrace<any, any>>,
    preprocessHandler?: (
        trace: TypedCallTrace,
        ctx: ContractContext<
            BaseContract,
            BoundContractView<BaseContract, ContractView<BaseContract>>,
        >,
        preprocessStore: { [k: string]: any },
    ) => Promise<PreprocessResult>,
): this
Parameters
- handler: (
      event: TypedCallTrace,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
  ) => PromiseOrVoid
- OptionalhandlerOptions: HandlerOptions<EthFetchConfig, TypedCallTrace<any, any>>
- preprocessHandler: (
      trace: TypedCallTrace,
      ctx: ContractContext<
          BaseContract,
          BoundContractView<BaseContract, ContractView<BaseContract>>,
      >,
      preprocessStore: { [k: string]: any },
  ) => Promise<PreprocessResult> = defaultPreprocessHandler
Returns this
Inherited from BaseProcessor.onTrace
- Defined in packages/sdk/src/eth/base-processor.ts:946

`Static`bind

bind(eventABI: string | string[], options: BindOptions): GenericProcessor
For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.
Parameters
- eventABI: string | string[]
- options: BindOptions
Returns GenericProcessor
- Defined in packages/sdk/src/eth/generic-processor.ts:23

Class GenericProcessor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GenericProcessor

Properties

blockHandlers

config

eventABI

eventHandlers

traceHandlers

Methods

ProtectedCreateBoundContractView

Returns BoundContractView<BaseContract, ContractView<BaseContract>>

getChainId

Returns EthChainId

onBlockInterval

Parameters

Returns this

ProtectedonEthEvent

Parameters

Returns this

ProtectedonEthTrace

Parameters

Returns this

onEvent

Parameters

Returns this

onInterval

Parameters

Returns this

onTimeInterval

Parameters

Returns this

onTrace

Parameters

Returns this

Staticbind

Parameters

Returns GenericProcessor

Settings

On This Page

`Protected`CreateBoundContractView

`Protected`onEthEvent

`Protected`onEthTrace

`Static`bind