webhook metadata

[d4mr]

Summary by CodeRabbit

• New Features

  • Added support for passing custom user metadata (up to 4KB) with webhook notifications, allowing metadata to be included throughout the webhook lifecycle.
  • Enhanced error handling for externally owned account (EOA) workers by explicitly reporting insufficient funds and adjusting retry logic.
  • Expanded documentation with a detailed guide on the EOA Worker’s transaction processing, error handling, and resilience mechanisms.

• Bug Fixes

  • Improved error handling and robustness in EOA Worker lock release and transaction send flows.

• Documentation

  • Updated and reorganized documentation to reflect new EOA transaction executor features and internal architecture.
  • Removed outdated documentation files and added comprehensive new guides.

• Refactor

  • Unified and streamlined error handling patterns in EOA Worker modules.
  • Improved code readability and import organization in several modules.

• Tests

  • Added unit tests to validate user metadata size restrictions for webhook options.

• Style

  • Reformatted code for clarity and consistency in multiple files.

• Chores

  • Adjusted benchmark throughput ranges and reporting labels for clarity.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This set of changes introduces a new EOA (Externally Owned Account) transaction executor with robust error handling, nonce management, and crash recovery. Documentation is updated and expanded, including a detailed new architecture overview. The webhook system now supports user-provided metadata, and error handling in the EOA worker is refactored for explicitness and resilience.

Changes

File(s)	Change Summary
HOW_IT_WORKS.md	Deleted detailed documentation on EOA Worker architecture and transaction lifecycle.
README.md, README_EOA.md	Enhanced main README with EOA executor overview and directory structure; added new in-depth documentation (README_EOA.md) covering EOA Worker internals, flow, error handling, and failure recovery.
aa-types/src/userop.rs	Reformatted imports and error mapping for readability; no logic changes.
core/src/execution_options/mod.rs	Added user_metadata: Option<String> to WebhookOptions with size validation and tests.
executors/src/eoa/store/hydrate.rs, executors/src/eoa/worker/transaction.rs	Removed unused imports.
executors/src/eoa/worker/error.rs	Added EoaOutOfFunds error variant and handle() method for explicit error-to-job handling; updated retry logic.
executors/src/eoa/worker/mod.rs	Refactored error handling to use .handle(); updated lock release to return and handle errors.
executors/src/eoa/worker/send.rs	Changed insufficient funds handling to return explicit EoaOutOfFunds error instead of silent skip.
executors/src/webhook/envelope.rs	Added user_metadata field to WebhookNotificationEnvelope and propagated through webhook notification lifecycle.
executors/src/webhook/mod.rs	Passed user_metadata to webhook envelope construction for queued webhooks.
twmq/benches/throughput.rs	Updated benchmark output label and reduced tested throughput levels.

Sequence Diagram(s)

sequenceDiagram
    participant Scheduler
    participant EOAWorker
    participant RedisStore
    participant Blockchain
    participant Webhook

    Scheduler->>EOAWorker: Start job for EOA:Chain
    EOAWorker->>RedisStore: Acquire lock
    alt Lock acquired
        EOAWorker->>RedisStore: Recover borrowed txs (crash recovery)
        EOAWorker->>Blockchain: Confirm mined/failed txs (confirmation phase)
        EOAWorker->>RedisStore: Update tx state, recycle nonces if needed
        EOAWorker->>Blockchain: Send new txs (send phase)
        alt Insufficient funds
            EOAWorker->>Scheduler: Return EoaOutOfFunds error (Nack, delay)
        else Success
            EOAWorker->>RedisStore: Update state
            EOAWorker->>Webhook: Queue notification (with user_metadata)
        end
        EOAWorker->>RedisStore: Release lock
    else Lock not acquired
        Scheduler->>EOAWorker: Retry later
    end

Loading

sequenceDiagram
    participant User
    participant System
    participant Webhook

    User->>System: Submit transaction with user_metadata
    System->>System: Store user_metadata in WebhookOptions
    System->>Webhook: Send notification with user_metadata

Loading

sequenceDiagram
    participant EOAWorker
    participant Scheduler

    EOAWorker->>Scheduler: Encounter EoaOutOfFunds error
    Scheduler->>EOAWorker: Nack with 60s delay, requeue last

Loading

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 Clippy (1.86.0)

Updating crates.io index
Updating git repository `ssh://git@github.com/thirdweb-dev/vault.git`

error: failed to get vault-sdk as a dependency of package engine-aa-core v0.1.0 (/aa-core)

Caused by:
failed to load source for dependency vault-sdk

Caused by:
Unable to update ssh://git@github.com/thirdweb-dev/vault.git?branch=pb%2Fupdate-alloy#b0a72f93

Caused by:
failed to create directory /usr/local/git/db/vault-02bb070e2aa0045e

Caused by:
Permission denied (os error 13)

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5259777 and 242e11b.

📒 Files selected for processing (13)

• HOW_IT_WORKS.md (0 hunks)
• README.md (3 hunks)
• README_EOA.md (1 hunks)
• aa-types/src/userop.rs (7 hunks)
• core/src/execution_options/mod.rs (2 hunks)
• executors/src/eoa/store/hydrate.rs (1 hunks)
• executors/src/eoa/worker/error.rs (3 hunks)
• executors/src/eoa/worker/mod.rs (10 hunks)
• executors/src/eoa/worker/send.rs (1 hunks)
• executors/src/eoa/worker/transaction.rs (0 hunks)
• executors/src/webhook/envelope.rs (6 hunks)
• executors/src/webhook/mod.rs (1 hunks)
• twmq/benches/throughput.rs (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.