Skip to content
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
base: main
Choose a base branch
from
Open

docs(readme): clarify signer compatibility (ethers v5 vs v6, viem) #349

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ const signatureType = 1;

See [examples](examples/) for more information

### Signer compatibility

`ClobClient` accepts the following signer types:

- **viem `WalletClient`** (recommended) — see [Using viem WalletClient](#using-viem-walletclient).
- **ethers v5** — any signer exposing `_signTypedData` and `getAddress`, including `Wallet` from `ethers@^5` or the standalone `@ethersproject/wallet` package (used in the example above).
- **ethers v6 is not directly supported.** v6 renamed `_signTypedData` to `signTypedData`, which this client's ethers path still requires. If you are on ethers v6, use a viem `WalletClient` instead.

`ethers` is not a runtime dependency of this package — install it only if you pass an ethers signer.

### Using viem WalletClient

```ts
Expand Down