Skip to content

Improve agw-client README examples and paymaster usage#420

Open
0x4tl4nt wants to merge 1 commit intoAbstract-Foundation:mainfrom
0x4tl4nt:0x4tl4nt-patch-1
Open

Improve agw-client README examples and paymaster usage#420
0x4tl4nt wants to merge 1 commit intoAbstract-Foundation:mainfrom
0x4tl4nt:0x4tl4nt-patch-1

Conversation

@0x4tl4nt
Copy link
Copy Markdown

@0x4tl4nt 0x4tl4nt commented Mar 25, 2026

Description

Updated examples in packages/agw-client/README.md to improve correctness, consistency, and usability.

  1. Removed unused and potentially incorrect ChainEIP712 import from viem.
  2. Aligned type usage with the rest of the package (viem/zksync).
  3. Replaced placeholder paymasterInput: '0x' with a working example using getGeneralPaymasterInput
  4. Clarified paymaster usage in sendTransaction (fields instead of a single object).
  5. Improved example readability and structure (headings, links, formatting).

PR-Codex overview

This PR focuses on updating the README.md for the agw-client package by modifying the way paymasterInput is handled in the transaction process and clarifying the explanation of Paymaster usage.

Detailed summary

  • Removed the import of ChainEIP712 from viem.
  • Added import of getGeneralPaymasterInput from viem/zksync.
  • Updated paymasterInput to use getGeneralPaymasterInput({ innerInput: '0x' }).
  • Clarified the explanation of Paymaster usage in the documentation.

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

Description

Updated examples in packages/agw-client/README.md to improve correctness, consistency, and usability.

Removed unused and potentially incorrect ChainEIP712 import from viem
Aligned type usage with the rest of the package (viem/zksync)
Replaced placeholder paymasterInput: '0x' with a working example using getGeneralPaymasterInput
Clarified paymaster usage in sendTransaction (fields instead of a single object)
Improved example readability and structure (headings, links, formatting)

These changes make the examples consistent with the actual implementation and ensure they can be copied and used with minimal adjustments.
@cursor
Copy link
Copy Markdown

cursor bot commented Mar 25, 2026

PR Summary

Low Risk
Documentation-only changes, mainly correcting code snippets for paymaster inputs and imports; no runtime code paths are modified.

Overview
Updates packages/agw-client/README.md examples for correctness by removing the unused ChainEIP712 import and switching the paymaster snippet to use getGeneralPaymasterInput (instead of a placeholder '0x'). Also clarifies that sendTransaction takes paymaster and paymasterInput fields directly when describing sponsored transactions.

Written by Cursor Bugbot for commit 11f5bb7. This will update automatically on new commits. Configure here.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 25, 2026

⚠️ No Changeset found

Latest commit: 11f5bb7

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant