modules

Documentation

Overview

Package modules provides standard interfaces for extending the Client and Bundler packages with middleware.

Index

• type AiOpHandlerCtx
  • func NewAiOpHandlerContext(op *aiop.AiOperation, aiMiddleware common.Address, chainID *big.Int, ...) (*AiOpHandlerCtx, error)
  • func (c *AiOpHandlerCtx) GetFactoryDepositInfo() *aimiddleware.IDepositManagerDepositInfo
  • func (c *AiOpHandlerCtx) GetPaymasterDepositInfo() *aimiddleware.IDepositManagerDepositInfo
  • func (c *AiOpHandlerCtx) GetPendingFactoryOps() []*aiop.AiOperation
  • func (c *AiOpHandlerCtx) GetPendingPaymasterOps() []*aiop.AiOperation
  • func (c *AiOpHandlerCtx) GetPendingSenderOps() []*aiop.AiOperation
  • func (c *AiOpHandlerCtx) GetSenderDepositInfo() *aimiddleware.IDepositManagerDepositInfo
• type AiOpHandlerFunc
  • func ComposeAiOpHandlerFunc(fns ...AiOpHandlerFunc) AiOpHandlerFunc
• type BatchHandlerCtx
  • func NewBatchHandlerContext(batch []*aiop.AiOperation, aiMiddleware common.Address, chainID *big.Int, ...) *BatchHandlerCtx
  • func (c *BatchHandlerCtx) MarkOpIndexForRemoval(index int, reason string)
• type BatchHandlerFunc
  • func ComposeBatchHandlerFunc(fns ...BatchHandlerFunc) BatchHandlerFunc
• type PendingRemovalItem

Types

type AiOpHandlerCtx

type AiOpHandlerCtx struct {
	AiOp         *aiop.AiOperation
	AiMiddleware common.Address
	ChainID      *big.Int
	// contains filtered or unexported fields
}

AiOpHandlerCtx is the object passed to AiOpHandler functions during the Client's SendAiOperation process.

func NewAiOpHandlerContext

func NewAiOpHandlerContext(
	op *aiop.AiOperation,
	aiMiddleware common.Address,
	chainID *big.Int,
	mem *mempool.Mempool,
	gs stake.GetStakeFunc,
) (*AiOpHandlerCtx, error)

NewAiOpHandlerContext creates a new AiOpHandlerCtx using a given op.

func (*AiOpHandlerCtx) GetFactoryDepositInfo

func (c *AiOpHandlerCtx) GetFactoryDepositInfo() *aimiddleware.IDepositManagerDepositInfo

GetFactoryDepositInfo returns the current AiMiddleware deposit for the factory.

func (*AiOpHandlerCtx) GetPaymasterDepositInfo

func (c *AiOpHandlerCtx) GetPaymasterDepositInfo() *aimiddleware.IDepositManagerDepositInfo

GetPaymasterDepositInfo returns the current AiMiddleware deposit for the paymaster.

func (*AiOpHandlerCtx) GetPendingFactoryOps

func (c *AiOpHandlerCtx) GetPendingFactoryOps() []*aiop.AiOperation

GetPendingFactoryOps returns all pending AiOperations in the mempool by the same factory.

func (*AiOpHandlerCtx) GetPendingPaymasterOps

func (c *AiOpHandlerCtx) GetPendingPaymasterOps() []*aiop.AiOperation

GetPendingPaymasterOps returns all pending AiOperations in the mempool by the same paymaster.

func (*AiOpHandlerCtx) GetPendingSenderOps

func (c *AiOpHandlerCtx) GetPendingSenderOps() []*aiop.AiOperation

GetPendingSenderOps returns all pending AiOperations in the mempool by the same sender.

func (*AiOpHandlerCtx) GetSenderDepositInfo

func (c *AiOpHandlerCtx) GetSenderDepositInfo() *aimiddleware.IDepositManagerDepositInfo

GetSenderDepositInfo returns the current AiMiddleware deposit for the sender.

type AiOpHandlerFunc

type AiOpHandlerFunc func(ctx *AiOpHandlerCtx) error

OpHandlerFunc is an interface to support modular processing of single AiOperations by the Client.

func ComposeAiOpHandlerFunc

func ComposeAiOpHandlerFunc(fns ...AiOpHandlerFunc) AiOpHandlerFunc

ComposeAiOpHandlerFunc combines many AiOpHandlers into one.

type BatchHandlerCtx

type BatchHandlerCtx struct {
	Batch          []*aiop.AiOperation
	PendingRemoval []*PendingRemovalItem
	AiMiddleware   common.Address
	ChainID        *big.Int
	BaseFee        *big.Int
	Tip            *big.Int
	GasPrice       *big.Int
	Data           map[string]any
}

BatchHandlerCtx is the object passed to BatchHandler functions during the Bundler's Run process. It also contains a Data field for adding arbitrary key-value pairs to the context. These values will be logged by the Bundler at the end of each run.

func NewBatchHandlerContext

func NewBatchHandlerContext(
	batch []*aiop.AiOperation,
	aiMiddleware common.Address,
	chainID *big.Int,
	baseFee *big.Int,
	tip *big.Int,
	gasPrice *big.Int,
) *BatchHandlerCtx

NewBatchHandlerContext creates a new BatchHandlerCtx using a copy of the given batch.

func (*BatchHandlerCtx) MarkOpIndexForRemoval

func (c *BatchHandlerCtx) MarkOpIndexForRemoval(index int, reason string)

MarkOpIndexForRemoval will remove the op by index from the batch and add it to the pending removal array. This should be used for ops that are not to be included on-chain and dropped from the mempool.

type BatchHandlerFunc

type BatchHandlerFunc func(ctx *BatchHandlerCtx) error

BatchHandlerFunc is an interface to support modular processing of AiOperation batches by the Bundler.

func ComposeBatchHandlerFunc

func ComposeBatchHandlerFunc(fns ...BatchHandlerFunc) BatchHandlerFunc

ComposeBatchHandlerFunc combines many BatchHandlers into one.

type PendingRemovalItem

type PendingRemovalItem struct {
	Op     *aiop.AiOperation
	Reason string
}