Class IotaAddressProcessorTemplate

Hierarchy

IotaObjectOrAddressProcessorTemplate<
    (objects: IotaMoveObject[], ctx: IotaAddressContext) => PromiseOrVoid,
    IotaBindOptions,
    IotaAddressProcessor,
>
- IotaAddressProcessorTemplate

Index

Constructors

constructor

new IotaAddressProcessorTemplate(): IotaAddressProcessorTemplate
Returns IotaAddressProcessorTemplate
Inherited from IotaObjectOrAddressProcessorTemplate< (objects: IotaMoveObject[], ctx: IotaAddressContext) => PromiseOrVoid, IotaBindOptions, IotaAddressProcessor >.constructor
- Defined in packages/sdk/src/iota/iota-object-processor-template.ts:44

Properties

id

id: number

instances

instances: Set<string> = ...

objectHandlers

objectHandlers: ObjectHandler<
    (
        objects: { dataType: "moveObject"; fields: MoveStruct; type: string }[],
        ctx: IotaAddressContext,
    ) => PromiseOrVoid,
>[] = []

Methods

bind

bind(options: IotaBindOptions, ctx: IotaContext): void
Parameters
- options: IotaBindOptions
- ctx: IotaContext
Returns void
Inherited from IotaObjectOrAddressProcessorTemplate.bind
- Defined in packages/sdk/src/iota/iota-object-processor-template.ts:52

createProcessor

createProcessor(options: IotaBindOptions): IotaAddressProcessor
Parameters
- options: IotaBindOptions
Returns IotaAddressProcessor
Overrides IotaObjectOrAddressProcessorTemplate.createProcessor
- Defined in packages/sdk/src/iota/iota-object-processor-template.ts:247

onCheckpointInterval

onCheckpointInterval(
    handler: (
        objects: { dataType: "moveObject"; fields: MoveStruct; type: string }[],
        ctx: IotaAddressContext,
    ) => PromiseOrVoid,
    checkpointInterval?: number,
    backfillCheckpointInterval?: number,
    type?: string,
    fetchConfig?: Partial<MoveAccountFetchConfig>,
): this
Parameters
- handler: (
  objects: { dataType: "moveObject"; fields: MoveStruct; type: string }[],
  ctx: IotaAddressContext,
  ) => PromiseOrVoid
- checkpointInterval: number = 100000
- backfillCheckpointInterval: number = 400000
- Optionaltype: string
- OptionalfetchConfig: Partial<MoveAccountFetchConfig>
Returns this
Inherited from IotaObjectOrAddressProcessorTemplate.onCheckpointInterval
- Defined in packages/sdk/src/iota/iota-object-processor-template.ts:217

`Protected`onInterval

onInterval(
    handler: (
        objects: { dataType: "moveObject"; fields: MoveStruct; type: string }[],
        ctx: IotaAddressContext,
    ) => PromiseOrVoid,
    timeInterval: undefined | HandleInterval,
    checkpointInterval: undefined | HandleInterval,
    type: undefined | string,
    fetchConfig: undefined | Partial<MoveAccountFetchConfig>,
): this
Parameters
- handler: (
  objects: { dataType: "moveObject"; fields: MoveStruct; type: string }[],
  ctx: IotaAddressContext,
  ) => PromiseOrVoid
- timeInterval: undefined | HandleInterval
- checkpointInterval: undefined | HandleInterval
- type: undefined | string
- fetchConfig: undefined | Partial<MoveAccountFetchConfig>
Returns this
Inherited from IotaObjectOrAddressProcessorTemplate.onInterval
- Defined in packages/sdk/src/iota/iota-object-processor-template.ts:180

onTimeInterval

onTimeInterval(
    handler: (
        objects: { dataType: "moveObject"; fields: MoveStruct; type: string }[],
        ctx: IotaAddressContext,
    ) => PromiseOrVoid,
    timeIntervalInMinutes?: number,
    backfillTimeIntervalInMinutes?: number,
    type?: string,
    fetchConfig?: Partial<MoveAccountFetchConfig>,
): this
Parameters
- handler: (
  objects: { dataType: "moveObject"; fields: MoveStruct; type: string }[],
  ctx: IotaAddressContext,
  ) => PromiseOrVoid
- timeIntervalInMinutes: number = 60
- backfillTimeIntervalInMinutes: number = 240
- Optionaltype: string
- OptionalfetchConfig: Partial<MoveAccountFetchConfig>
Returns this
Inherited from IotaObjectOrAddressProcessorTemplate.onTimeInterval
- Defined in packages/sdk/src/iota/iota-object-processor-template.ts:198

onTransactionBlock

onTransactionBlock(
    handler: (
        transaction: IotaTransactionBlockResponse,
        ctx: IotaContext,
    ) => void,
    filter?: TransactionFilter,
    fetchConfig?: Partial<MoveFetchConfig>,
): this
Parameters
- handler: (transaction: IotaTransactionBlockResponse, ctx: IotaContext) => void
- Optionalfilter: TransactionFilter
- OptionalfetchConfig: Partial<MoveFetchConfig>
Returns this
- Defined in packages/sdk/src/iota/iota-object-processor-template.ts:256

startInstance

startInstance(options: IotaBindOptions, ctx: IotaContext): void
Parameters
- options: IotaBindOptions
- ctx: IotaContext
Returns void
Inherited from IotaObjectOrAddressProcessorTemplate.startInstance
- Defined in packages/sdk/src/iota/iota-object-processor-template.ts:89

unbind

unbind(options: IotaBindOptions, ctx: IotaContext): void
Parameters
- options: IotaBindOptions
- ctx: IotaContext
Returns void
Inherited from IotaObjectOrAddressProcessorTemplate.unbind
- Defined in packages/sdk/src/iota/iota-object-processor-template.ts:120

Class IotaAddressProcessorTemplate

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns IotaAddressProcessorTemplate

Properties

id

instances

objectHandlers

Methods

bind

Parameters

Returns void

createProcessor

Parameters

Returns IotaAddressProcessor

onCheckpointInterval

Parameters

Returns this

`Protected`onInterval

Parameters

Returns this

onTimeInterval

Parameters

Returns this

onTransactionBlock

Parameters

Returns this

startInstance

Parameters

Returns void

unbind

Parameters

Returns void

Settings

On This Page

Class IotaAddressProcessorTemplate

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns IotaAddressProcessorTemplate

Properties

id

instances

objectHandlers

Methods

bind

Parameters

Returns void

createProcessor

Parameters

Returns IotaAddressProcessor

onCheckpointInterval

Parameters

Returns this

ProtectedonInterval

Parameters

Returns this

onTimeInterval

Parameters

Returns this

onTransactionBlock

Parameters

Returns this

startInstance

Parameters

Returns void

unbind

Parameters

Returns void

Settings

On This Page

`Protected`onInterval