Class GenericProcessor

Hierarchy (view full)

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

Index

Constructors

constructor

new GenericProcessor(eventABI, options): 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:386

onBlockInterval

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

`Protected`onEthEvent

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

`Protected`onEthTrace

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

onEvent

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

onInterval

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

onTimeInterval

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

onTrace

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

`Static`bind

bind(eventABI, options): 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 full)

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

Parameters

Returns PromiseOrVoid

Parameters

[k: string]: any

Returns Promise<PreprocessResult>

Returns this

ProtectedonEthEvent

Parameters

Parameters

Returns PromiseOrVoid

Parameters

[k: string]: any

Returns Promise<PreprocessResult>

Returns this

ProtectedonEthTrace

Parameters

Parameters

Returns PromiseOrVoid

Parameters

[k: string]: any

Returns Promise<PreprocessResult>

Returns this

onEvent

Parameters

Parameters

Returns PromiseOrVoid

Parameters

[k: string]: any

Returns Promise<PreprocessResult>

Returns this

onInterval

Parameters

Parameters

Returns PromiseOrVoid

Parameters

[k: string]: any

Returns Promise<PreprocessResult>

Returns this

onTimeInterval

Parameters

Parameters

Returns PromiseOrVoid

Parameters

[k: string]: any

Returns Promise<PreprocessResult>

Returns this

onTrace

Parameters

Parameters

Returns PromiseOrVoid

Parameters

[k: string]: any

Returns Promise<PreprocessResult>

Returns this

Staticbind

Parameters

Returns GenericProcessor

`Protected`CreateBoundContractView

`Protected`onEthEvent

`Protected`onEthTrace

`Static`bind