feat: viem wallet client conversion #1565

florrdv · 2025-04-25T19:38:41Z

Pull Request Checklist

Did you add new tests and confirm existing tests pass? (yarn test)
Did you update relevant docs? (docs are found in the site folder, and guidelines for updating/adding docs can be found in the contribution guide)
Do your commits follow the Conventional Commits standard?
Does your PR title also follow the Conventional Commits standard?
If you have a breaking change, is it correctly reflected in your commit message? (e.g. feat!: breaking change)
Did you run lint (yarn lint:check) and fix any issues? (yarn lint:write)
Did you follow the contribution guidelines?

PR-Codex overview

This PR introduces a new method, toViemWalletClient, to the BaseAlchemySigner class, allowing for the adaptation of the signer to a viem WalletClient. It enhances interoperability with viem by providing options for transport and configuration.

Detailed summary

Added a new method toViemWalletClient to BaseAlchemySigner.
Method accepts options for transport and returns a WalletClient.
Implements a fallback transport for handling requests.
Supports signing messages and typed data through the viemAccount.
Provides example usage in the documentation comments.

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

vercel · 2025-04-25T19:38:46Z

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

Name	Status	Preview	Comments	Updated (UTC)
aa-sdk-site	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 28, 2025 11:11pm
aa-sdk-ui-demo	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 28, 2025 11:11pm

graphite-app · 2025-04-25T19:38:47Z

How to use the Graphite Merge Queue

Add the label graphite-merge-queue to this PR to add it to the merge queue.

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

github-actions · 2025-04-25T19:39:12Z

🌿 Documentation Preview

Name	Status	Preview	Updated (UTC)
Alchemy Docs	✅ Ready	🔗 Visit Preview	Apr 28, 2025, 10:56 PM

adamegyed · 2025-04-25T22:44:36Z

account-kit/signer/src/base.ts

+                isHex(params[0])
+                  ? { message: { raw: params[0] } }
+                  : { message: params[0] }


It should be technically possible to sign ascii/utf characters that represent hex characters, and this conversion prevents that by re-interpreting the characters to their raw value if they happen to be hex characters.

I think viem defaults to having the parameters to personal_sign be either a string or an object containing a field called raw - could we continue to use that type here?

That's what the check here is already doing no? Passing raw if hex so that it doesn't get treated as string

No, Adam's saying that this makes it impossible to sign the string "0x1234" because it will get interpreted as bytes 0x12, 0x34. (Or not impossible, but someone would need to pass the hex encoding of the above string, i.e. "0x307831323334"). Adam's saying that the caller should be responsible for specifying whether their string should be interpreted as hex rather than us trying to infer it.

But actually I think it's wrong to accept the type with raw here too. This code is trying to emulate the personal_sign method of the eth-jsonrpc API, and therefore should always interpret the input as hex (Metamask's docs). Getting non-hex input here should be an error.

Ah, good catch. So the real fix here is to just throw an error instead of handling the case of { message: params[0] }, right?

Yeah, I think so.

adamegyed · 2025-04-25T22:45:45Z

account-kit/signer/src/base.ts

+                  : { message: params[0] }
+              );
+            case "eth_signTypedData_v4":
+              return viemAccount.signTypedData(params[1]);


Should we assert params[0] to be the account address?

And probs same above checking that params[1] is the signer too

params[1] is the typed data object, so I don't think there's anything we can assert over that.

moldy530 · 2025-04-25T23:09:28Z

account-kit/signer/src/base.ts

+      account: viemAccount,
+      transport: custom({
+        async request({ method, params }) {
+          switch (method) {


Also eth_sendTx should be handled here as well which should call sign tx then submit it

dphilipson · 2025-04-28T17:32:13Z

account-kit/signer/src/base.ts

+                isHex(params[0])
+                  ? { message: { raw: params[0] } }
+                  : { message: params[0] }


No, Adam's saying that this makes it impossible to sign the string "0x1234" because it will get interpreted as bytes 0x12, 0x34. (Or not impossible, but someone would need to pass the hex encoding of the above string, i.e. "0x307831323334"). Adam's saying that the caller should be responsible for specifying whether their string should be interpreted as hex rather than us trying to infer it.

But actually I think it's wrong to accept the type with raw here too. This code is trying to emulate the personal_sign method of the eth-jsonrpc API, and therefore should always interpret the input as hex (Metamask's docs). Getting non-hex input here should be an error.

dphilipson · 2025-04-28T17:38:21Z

account-kit/signer/src/base.ts

+      account: viemAccount,
+      transport: custom({
+        async request({ method, params }) {
+          switch (method) {


Question: do we also want to implement eth_requestAccounts (Metamask's docs)?

florrdv · 2025-04-30T21:17:10Z

Closing this for now because there's no immediate need to create EIP1193 viem wallet clients.

feat: initial version of viem wallet client conversion

9d3405d

florrdv requested review from Blu-J, Zer0dot, adamegyed, avarobinson, blakecduncan, dancoombs, dphilipson, howydev, jakehobbs, jaypaik, linnall, moldy530 and rthomare as code owners April 25, 2025 19:38

florrdv marked this pull request as draft April 25, 2025 19:39

github-actions bot temporarily deployed to docs-preview April 25, 2025 19:39 Inactive

fix: set default polling interval in accordance with viem

4df6450

vercel bot deployed to Preview – aa-sdk-ui-demo April 25, 2025 19:46 View deployment

fix: remove eth_sign because it's unsupported

332a780

github-actions bot temporarily deployed to docs-preview April 25, 2025 19:56 Inactive

vercel bot deployed to Preview – aa-sdk-ui-demo April 25, 2025 19:58 View deployment

vercel bot deployed to Preview – aa-sdk-site April 25, 2025 20:15 View deployment

chore: cleanup

f894e3a

github-actions bot temporarily deployed to docs-preview April 25, 2025 22:28 Inactive

chore: remove logging

f99f176

vercel bot deployed to Preview – aa-sdk-ui-demo April 25, 2025 22:29 View deployment

florrdv marked this pull request as ready for review April 25, 2025 22:32

github-actions bot temporarily deployed to docs-preview April 25, 2025 22:32 Inactive

vercel bot deployed to Preview – aa-sdk-ui-demo April 25, 2025 22:34 View deployment

vercel bot deployed to Preview – aa-sdk-site April 25, 2025 22:37 View deployment

adamegyed reviewed Apr 25, 2025

View reviewed changes

moldy530 reviewed Apr 25, 2025

View reviewed changes

dphilipson reviewed Apr 28, 2025

View reviewed changes

Merge branch 'main' into flor/feat/viem-wallet-client-conversion

4dc7ebd

github-actions bot temporarily deployed to docs-preview April 28, 2025 22:55 Inactive

vercel bot deployed to Preview – aa-sdk-ui-demo April 28, 2025 23:02 View deployment

vercel bot deployed to Preview – aa-sdk-site April 28, 2025 23:11 View deployment

florrdv closed this Apr 30, 2025

feat: viem wallet client conversion #1565

feat: viem wallet client conversion #1565

Uh oh!

Conversation

florrdv commented Apr 25, 2025 • edited by pr-codex bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Checklist

PR-Codex overview

Detailed summary

Uh oh!

vercel bot commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

graphite-app bot commented Apr 25, 2025

How to use the Graphite Merge Queue

Uh oh!

github-actions bot commented Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌿 Documentation Preview

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dphilipson Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dphilipson Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

florrdv commented Apr 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

florrdv commented Apr 25, 2025 •

edited by pr-codex bot

Loading

vercel bot commented Apr 25, 2025 •

edited

Loading

github-actions bot commented Apr 25, 2025 •

edited

Loading

dphilipson Apr 28, 2025 •

edited

Loading

dphilipson Apr 28, 2025 •

edited

Loading