Skip to content

Add webhook creation UI to dashboard #7174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 28, 2025

Conversation

AmineAfia
Copy link
Contributor

@AmineAfia AmineAfia commented May 27, 2025


PR-Codex overview

This PR focuses on enhancing the webhook functionality within the dashboard by adding a new createWebhook function, improving the user interface for creating webhooks, and refining error handling and validation processes.

Detailed summary

  • Changed createWebhook from a local function to an exported function.
  • Updated CreateWebhookModal to accept clientId as a prop.
  • Enhanced error messages for invalid webhook URLs.
  • Improved date formatting in WebhooksTable.
  • Added new utility functions for webhook payload and validation.
  • Introduced detailed form steps for webhook creation (Basic Info, Filter Details, Review).
  • Implemented ABI fetching and handling for events and transactions.
  • Added testing functionality for webhooks with user feedback.
  • Enhanced validation using zod for webhook form inputs.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • New Features

    • Introduced a multi-step modal form for creating webhooks, including form validation, ABI integration, and live endpoint testing.
    • Added components for basic info entry, filter configuration, and review before submission.
    • Enabled dynamic ABI fetching and signature extraction for blockchain event and transaction filters.
    • Improved error handling and user feedback throughout the webhook creation flow.
  • Bug Fixes

    • Enhanced validation and error messages for webhook URLs and date handling in tables.
  • Chores

    • Added comprehensive utility modules for ABI processing and webhook payload construction.
    • Implemented robust type definitions and validation schemas for webhook forms.

@vercel vercel bot temporarily deployed to Preview – docs-v2 May 27, 2025 18:05 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 27, 2025 18:05 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 27, 2025 18:05 Inactive
Copy link

vercel bot commented May 27, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 28, 2025 10:11pm
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Skipped (Inspect) May 28, 2025 10:11pm
login ⬜️ Skipped (Inspect) May 28, 2025 10:11pm
thirdweb_playground ⬜️ Skipped (Inspect) May 28, 2025 10:11pm
wallet-ui ⬜️ Skipped (Inspect) May 28, 2025 10:11pm

@vercel vercel bot temporarily deployed to Preview – wallet-ui May 27, 2025 18:05 Inactive
Copy link

changeset-bot bot commented May 27, 2025

⚠️ No Changeset found

Latest commit: c336de3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented May 27, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce a comprehensive multi-step webhook creation flow within the dashboard application. New React components, hooks, and utility modules are added for form handling, ABI processing, signature extraction, and payload construction. The modal dialog for creating webhooks now includes validation, ABI integration, review, and endpoint testing. Supporting types and schemas are defined for robust form validation and payload generation.

Changes

File(s) Change Summary
.../api/insight/webhooks.ts Made CreateWebhookPayload interface internal by removing its export.
.../webhooks/components/BasicInfoStep.tsx Added new BasicInfoStep React component for the first step of webhook creation.
.../webhooks/components/FilterDetailsStep.tsx Added new FilterDetailsStep React component for configuring webhook filters and ABI integration.
.../webhooks/components/ReviewStep.tsx Added new ReviewStep React component for reviewing and testing webhook configuration.
.../webhooks/components/CreateWebhookModal.tsx Fully implemented CreateWebhookModal as a multi-step modal with form state, validation, ABI fetching, review, and submission logic.
.../webhooks/components/WebhooksTable.tsx, .../webhooks/page.tsx Integrated CreateWebhookModal into the UI, passing clientId as a prop; improved error handling in table and added security attribute to docs link.
.../webhooks/components/RelativeTime.tsx Removed usage of cn utility; passed className directly.
.../webhooks/hooks/useAbiProcessing.ts Added useAbiMultiFetch hook for multi-contract, multi-chain ABI fetching and signature extraction.
.../webhooks/hooks/useTestWebhook.ts Improved URL validation in webhook endpoint testing and changed unique ID construction for test tracking.
.../webhooks/utils/abiUtils.ts Added utilities for truncating strings and extracting event/function signatures from ABI data.
.../webhooks/utils/webhookPayloadUtils.ts Added utilities for parsing addresses and building webhook payloads for events and transactions.
.../webhooks/utils/webhookTypes.ts Introduced types, interfaces, validation schema, and step constants for webhook form handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WebhooksTable
    participant CreateWebhookModal
    participant BasicInfoStep
    participant FilterDetailsStep
    participant ReviewStep
    participant API
    participant ABIService

    User->>WebhooksTable: Click "New Webhook"
    WebhooksTable->>CreateWebhookModal: Open modal (with clientId)
    CreateWebhookModal->>BasicInfoStep: Render step 1 (name, URL, filter type)
    User->>BasicInfoStep: Fill form, click "Next"
    BasicInfoStep->>CreateWebhookModal: Validate, go to FilterDetailsStep
    CreateWebhookModal->>FilterDetailsStep: Render step 2 (filters, ABI, etc.)
    User->>FilterDetailsStep: Select chains/addresses, request ABI
    FilterDetailsStep->>ABIService: Fetch ABI for contracts
    ABIService-->>FilterDetailsStep: Return ABI data/signatures
    User->>FilterDetailsStep: Select signature(s), click "Next"
    FilterDetailsStep->>CreateWebhookModal: Validate, go to ReviewStep
    CreateWebhookModal->>ReviewStep: Render step 3 (review/test)
    User->>ReviewStep: Test endpoint (optional)
    ReviewStep->>API: Send test webhook request
    API-->>ReviewStep: Return test result
    User->>ReviewStep: Click "Create"
    ReviewStep->>CreateWebhookModal: Submit webhook data
    CreateWebhookModal->>API: Create webhook
    API-->>CreateWebhookModal: Return success/error
    CreateWebhookModal->>WebhooksTable: Close modal, refresh table
Loading

🪧 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.

Copy link
Contributor Author

AmineAfia commented May 27, 2025


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions github-actions bot added the Dashboard Involves changes to the Dashboard. label May 27, 2025
Copy link

codecov bot commented May 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.66%. Comparing base (c420099) to head (c336de3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #7174   +/-   ##
=======================================
  Coverage   55.66%   55.66%           
=======================================
  Files         904      904           
  Lines       58400    58400           
  Branches     4116     4116           
=======================================
  Hits        32510    32510           
  Misses      25784    25784           
  Partials      106      106           
Flag Coverage Δ
packages 55.66% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

github-actions bot commented May 27, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 61.75 KB (0%) 1.3 s (0%) 156 ms (+99.33% 🔺) 1.4 s
thirdweb (cjs) 344.4 KB (0%) 6.9 s (0%) 583 ms (-7.52% 🔽) 7.5 s
thirdweb (minimal + tree-shaking) 5.69 KB (0%) 114 ms (0%) 40 ms (+605.64% 🔺) 154 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 26 ms (+1437.16% 🔺) 37 ms
thirdweb/react (minimal + tree-shaking) 19.54 KB (0%) 391 ms (0%) 63 ms (+427.42% 🔺) 454 ms

@AmineAfia AmineAfia force-pushed the Add_webhook_testing_functionality_to_dashboard branch from a4f8fe1 to 8136982 Compare May 27, 2025 18:13
@AmineAfia AmineAfia force-pushed the Add_webhook_creation_UI_to_dashboard branch from 8ddca02 to 257d4bf Compare May 27, 2025 18:13
@vercel vercel bot temporarily deployed to Preview – login May 27, 2025 18:13 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 27, 2025 18:13 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 27, 2025 18:13 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 27, 2025 18:13 Inactive
@AmineAfia AmineAfia force-pushed the Add_webhook_creation_UI_to_dashboard branch from 257d4bf to 2221b86 Compare May 27, 2025 18:37
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 27, 2025 18:37 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 27, 2025 18:37 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 27, 2025 18:37 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 27, 2025 18:37 Inactive
@AmineAfia AmineAfia force-pushed the Add_webhook_creation_UI_to_dashboard branch from 2221b86 to 4aab177 Compare May 27, 2025 21:30
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 27, 2025 21:30 Inactive
@graphite-app graphite-app bot force-pushed the Add_webhook_creation_UI_to_dashboard branch from 077694c to 5b753d2 Compare May 28, 2025 21:22
@vercel vercel bot temporarily deployed to Preview – login May 28, 2025 21:22 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 28, 2025 21:22 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 28, 2025 21:22 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 28, 2025 21:22 Inactive
AmineAfia added a commit that referenced this pull request May 28, 2025
<!--

## title your PR with this format: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"

If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):

## Notes for the reviewer

Anything important to call out? Be sure to also clarify these in your comments.

## How to test

Unit tests, playground, etc.

-->

<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on enhancing the `CreateWebhookModal` component and related functionalities for managing webhooks in the dashboard. It introduces new features for creating webhooks, including form validation, ABI fetching, and improved user experience.

### Detailed summary
- Changed `createWebhook` function to be exported.
- Updated `CreateWebhookModal` to accept `clientId` and handle multi-step creation.
- Added form handling with validation using `zod`.
- Implemented steps for basic info, filter details, and review.
- Integrated ABI fetching for events and transactions.
- Enhanced error handling and user feedback with toast notifications.
- Updated `WebhooksTable` to include `clientId` in the modal.
- Improved `RelativeTime` component by removing unused utility function.
- Added utility functions for parsing addresses and building webhook payloads.
- Enhanced form validation for webhook creation with specific constraints.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

<!-- end pr-codex -->

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

- **New Features**
  - Introduced a multi-step modal form for creating webhooks, including form validation, ABI integration, and live endpoint testing.
  - Added components for basic info entry, filter configuration, and review before submission.
  - Enabled dynamic ABI fetching and signature extraction for blockchain event and transaction filters.
  - Improved error handling and user feedback throughout the webhook creation flow.

- **Bug Fixes**
  - Enhanced validation and error messages for webhook URLs and date handling in tables.

- **Chores**
  - Added comprehensive utility modules for ABI processing and webhook payload construction.
  - Implemented robust type definitions and validation schemas for webhook forms.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@AmineAfia AmineAfia force-pushed the Add_webhook_creation_UI_to_dashboard branch from 5b753d2 to b882612 Compare May 28, 2025 21:54
@AmineAfia AmineAfia force-pushed the Add_webhook_testing_functionality_to_dashboard branch from b1e702d to 9058e67 Compare May 28, 2025 21:54
@vercel vercel bot temporarily deployed to Preview – login May 28, 2025 21:54 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 28, 2025 21:54 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 28, 2025 21:54 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 28, 2025 21:54 Inactive
<!--

## title your PR with this format: "[SDK/Dashboard/Portal] Feature/Fix: Concise title for the changes"

If you did not copy the branch name from Linear, paste the issue tag here (format is TEAM-0000):

## Notes for the reviewer

Anything important to call out? Be sure to also clarify these in your comments.

## How to test

Unit tests, playground, etc.

-->

<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on enhancing the `CreateWebhookModal` component and related functionalities in the webhook management system, including form handling, validation, and API integration for creating webhooks.

### Detailed summary
- Changed `createWebhook` function to `export async function createWebhook`.
- Updated `CreateWebhookModal` to accept `clientId` prop.
- Integrated form steps for creating a webhook with validation.
- Added utility functions for parsing addresses and building webhook payloads.
- Improved error handling and user feedback during webhook testing.
- Enhanced UI components for better user experience in the webhook creation process.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}`

<!-- end pr-codex -->

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->

## Summary by CodeRabbit

- **New Features**
  - Introduced a multi-step modal form for creating webhooks, including form validation, ABI integration, and live endpoint testing.
  - Added components for basic info entry, filter configuration, and review before submission.
  - Enabled dynamic ABI fetching and signature extraction for blockchain event and transaction filters.
  - Improved error handling and user feedback throughout the webhook creation flow.

- **Bug Fixes**
  - Enhanced validation and error messages for webhook URLs and date handling in tables.

- **Chores**
  - Added comprehensive utility modules for ABI processing and webhook payload construction.
  - Implemented robust type definitions and validation schemas for webhook forms.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
@graphite-app graphite-app bot force-pushed the Add_webhook_testing_functionality_to_dashboard branch from 9058e67 to c420099 Compare May 28, 2025 22:03
@graphite-app graphite-app bot force-pushed the Add_webhook_creation_UI_to_dashboard branch from b882612 to c336de3 Compare May 28, 2025 22:03
@vercel vercel bot temporarily deployed to Preview – wallet-ui May 28, 2025 22:03 Inactive
@vercel vercel bot temporarily deployed to Preview – docs-v2 May 28, 2025 22:03 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground May 28, 2025 22:03 Inactive
@vercel vercel bot temporarily deployed to Preview – login May 28, 2025 22:03 Inactive
Base automatically changed from Add_webhook_testing_functionality_to_dashboard to main May 28, 2025 22:11
@graphite-app graphite-app bot merged commit c336de3 into main May 28, 2025
22 checks passed
@graphite-app graphite-app bot deleted the Add_webhook_creation_UI_to_dashboard branch May 28, 2025 22:12
@vercel vercel bot temporarily deployed to Production – login May 28, 2025 22:12 Inactive
@vercel vercel bot temporarily deployed to Production – thirdweb_playground May 28, 2025 22:12 Inactive
@vercel vercel bot temporarily deployed to Production – wallet-ui May 28, 2025 22:12 Inactive
@vercel vercel bot temporarily deployed to Production – docs-v2 May 28, 2025 22:12 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dashboard Involves changes to the Dashboard.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants