-
Notifications
You must be signed in to change notification settings - Fork 619
[Docs] Simplify x402 documentation #8173
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
joaquim-verges
merged 1 commit into
main
from
_Docs_Simplify_x402_documentation_and_rename_Facilitator_API_to_Facilitator_
Oct 2, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # Gas Sponsorship Policies | ||
|
|
||
| Sponsorship policies are a way to control the execution of sponsored transactions on your account. | ||
|
|
||
| You can use them to: | ||
|
|
||
| - Set global spend limits. | ||
| - Restrict sponsorship to a particular chain. | ||
| - Restrict sponsorship to a particular contract. | ||
| - Allow/Disallow specific wallets | ||
| - Setup your own server verifier. | ||
|
|
||
| These policies can be set from your project dashboard, under project > account abstraction > settings. | ||
|
|
||
| ## Server Verifier | ||
|
|
||
| The most flexible and powerful way to control the execution of sponsored transactions is to setup your own server verifier. | ||
|
|
||
| In the project dashboard, under project > account abstraction > settings, setup your backend URL and any additional headers you need to pass to the verifier. | ||
|
|
||
| On every user transaction, your backend will be called with the transaction data and the user's wallet address, your endpoint should return a boolean indicating whether the transaction should be sponsored. | ||
|
|
||
| ### Backend endpoint specification: | ||
|
|
||
| Your backend will be called with the following request: | ||
|
|
||
| ```http | ||
| POST https://your-backend-url/verify-transaction | ||
| Content-Type: application/json | ||
| Referer: "https://api.thirdweb.com", | ||
| # additional custom headers | ||
|
|
||
| # request body | ||
| { | ||
| "clientId": string; | ||
| "chainId": number; | ||
| "userOp": { | ||
| sender: string; | ||
| targets: string[]; | ||
| gasLimit: string; | ||
| gasPrice: string; | ||
| data?: { | ||
| targets: string[]; | ||
| callDatas: string[]; | ||
| values: string[]; | ||
| }; | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Your backend should process the request, apply your own policy logic based on the request data and return the following JSON response: | ||
|
|
||
| ```http | ||
| HTTP/1.1 200 OK | ||
| Content-Type: application/json | ||
|
|
||
| { | ||
| "isAllowed": boolean; | ||
| "reason"?: string; | ||
| } | ||
| ``` | ||
|
|
||
| The `isAllowed` field indicates whether the transaction should be sponsored or not. `reason` is an optional field that can be used to provide a reason for the decision. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.