This repository was archived by the owner on May 11, 2026. It is now read-only.
docs(readme): clarify signer compatibility (ethers v5 vs v6, viem)#349
Open
skyc1e wants to merge 1 commit into
Open
docs(readme): clarify signer compatibility (ethers v5 vs v6, viem)#349skyc1e wants to merge 1 commit into
skyc1e wants to merge 1 commit into
Conversation
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #256.
What changed
Adds a short Signer compatibility section to
README.mdthat states explicitly which signersClobClientaccepts.Why
The original example imports
@ethersproject/wallet(ethers v5) without telling the reader that the library does not require ethers at all, and without flagging the ethers v6 mismatch.src/signer.tscurrently accepts:ethers v6 renamed
_signTypedData→signTypedData, so an ethers v6Walletfails theisEthersTypedDataSignercheck and, if it falls through to the viem path viaisWalletClientSigner, its call signature does not match whatsignTypedDataWithSignerinvokes. That is what issue #256 is describing.The new section:
ethers@^5or@ethersproject/wallet) works.ethersis not a runtime dependency of this package.Scope
README.md), additive section only.Note
Low Risk
Documentation-only change with no runtime or behavioral impact.
Overview
Adds a new Signer compatibility section to
README.mdthat explicitly documents supported signer types forClobClient(recommendedviemWalletClient,ethersv5-compatible signers) and calls out that ethers v6 is not directly supported due to the_signTypedDatarename.Also clarifies that
ethersis not a runtime dependency and only needs to be installed when using an ethers-based signer.Reviewed by Cursor Bugbot for commit b8bd4be. Bugbot is set up for automated code reviews on this repo. Configure here.