fix(adapters): sendTransaction within viemAdapter.walletClient.toViem() (#2662)

Author: jnsdls

.changeset/selfish-trainers-jam.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+fix `sendTransaction` within `viemAdapter.walletClient.toViem()`

packages/thirdweb/src/adapters/ethers6.test.ts

@@ -3,7 +3,7 @@ import * as ethers6 from "ethers6";
 import { privateKeyAccount } from "../wallets/private-key.js";
 import { TEST_CLIENT } from "../../test/src/test-clients.js";
 import { toEthersSigner } from "./ethers6.js";
-import { defineChain } from "../chains/utils.js";
+import { ANVIL_CHAIN } from "../../test/src/chains.js";
 
 const FAKE_PKEY =
   "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef";
@@ -19,7 +19,7 @@ describe("toEthersSigner", () => {
       ethers6,
       TEST_CLIENT,
       account,
-      defineChain(31337),
+      ANVIL_CHAIN,
     );
     expect(signer).toBeDefined();
     expect(signer.signMessage).toBeDefined();
@@ -30,7 +30,7 @@ describe("toEthersSigner", () => {
       ethers6,
       TEST_CLIENT,
       account,
-      defineChain(31337),
+      ANVIL_CHAIN,
     );
     expect(signer.signTypedData).toBeDefined();
 

packages/thirdweb/src/adapters/viem.test.ts

@@ -2,25 +2,25 @@ import { describe, test, expect, beforeAll } from "vitest";
 import { privateKeyAccount } from "../wallets/private-key.js";
 import { TEST_CLIENT } from "../../test/src/test-clients.js";
 import { viemAdapter } from "./viem.js";
-import { defineChain } from "../chains/utils.js";
-import type { WalletClient } from "viem";
+import { zeroAddress } from "viem";
 
 import { typedData } from "~test/typed-data.js";
 import { ANVIL_PKEY_A } from "~test/test-wallets.js";
+import { ANVIL_CHAIN } from "../../test/src/chains.js";
 
 const account = privateKeyAccount({
   privateKey: ANVIL_PKEY_A,
   client: TEST_CLIENT,
 });
 
 describe("walletClient.toViem", () => {
-  let walletClient: WalletClient;
+  let walletClient: ReturnType<typeof viemAdapter.walletClient.toViem>;
 
   beforeAll(() => {
     walletClient = viemAdapter.walletClient.toViem({
       client: TEST_CLIENT,
       account,
-      chain: defineChain(31337),
+      chain: ANVIL_CHAIN,
     });
   });
 
@@ -47,7 +47,19 @@ describe("walletClient.toViem", () => {
     );
   });
 
-  test("should contain a local account", async () => {
-    expect(walletClient.account?.type).toBe("local");
+  test("should contain a json-rpc account", async () => {
+    expect(walletClient.account?.type).toBe("json-rpc");
+  });
+
+  test("should send a transaction", async () => {
+    if (!walletClient.account) {
+      throw new Error("Account not found");
+    }
+    const txHash = await walletClient.sendTransaction({
+      to: zeroAddress,
+      value: 0n,
+    });
+    expect(txHash).toBeDefined();
+    expect(txHash.slice(0, 2)).toBe("0x");
   });
 });

packages/thirdweb/src/adapters/viem.ts

@@ -4,22 +4,22 @@ import {
   type GetContractReturnType,
   type PublicClient,
   type Chain as ViemChain,
-  type Account as ViemAccount,
   type WalletClient,
   createWalletClient,
   custom,
   type TransactionSerializableEIP1559,
 } from "viem";
 import { getContract, type ThirdwebContract } from "../contract/contract.js";
-import type { Abi, Address } from "abitype";
+import type { Abi } from "abitype";
 import type { Chain } from "../chains/types.js";
 import type { ThirdwebClient } from "../client/client.js";
 import { resolveContractAbi } from "../contract/actions/resolve-abi.js";
 import { getRpcUrlForChain } from "../chains/utils.js";
-import { type Account, getAccountKey } from "../wallets/interfaces/wallet.js";
+import type { Account } from "../wallets/interfaces/wallet.js";
 import { getRpcClient } from "../rpc/rpc.js";
-import { secp256k1 } from "@noble/curves/secp256k1";
-import { toHex } from "../utils/encoding/hex.js";
+import { sendTransaction } from "../transaction/actions/send-transaction.js";
+import { prepareTransaction } from "../transaction/prepare-transaction.js";
+import { estimateGas } from "../transaction/actions/estimate-gas.js";
 
 export const viemAdapter = {
   contract: {
@@ -170,7 +170,7 @@ type ToViemWalletClientOptions = {
   chain: Chain;
 };
 
-function toViemWalletClient(options: ToViemWalletClientOptions): WalletClient {
+function toViemWalletClient(options: ToViemWalletClientOptions) {
   const { account, chain, client } = options;
   if (!account) {
     throw new Error("Wallet not connected.");
@@ -194,13 +194,25 @@ function toViemWalletClient(options: ToViemWalletClientOptions): WalletClient {
   const transport = custom({
     request: async (request) => {
       if (request.method === "eth_sendTransaction") {
-        const result = await account.sendTransaction(request.params[0]);
+        const result = await sendTransaction({
+          transaction: prepareTransaction({
+            ...request.params[0],
+            chain,
+            client,
+          }),
+          account: account,
+        });
         return result.transactionHash;
       }
       if (request.method === "eth_estimateGas") {
-        if (account.estimateGas) {
-          return account.estimateGas(request.params[0]);
-        }
+        return estimateGas({
+          transaction: prepareTransaction({
+            ...request.params[0],
+            chain,
+            client,
+          }),
+          account: account,
+        });
       }
       if (request.method === "personal_sign") {
         return account.signMessage({
@@ -217,26 +229,9 @@ function toViemWalletClient(options: ToViemWalletClientOptions): WalletClient {
     },
   });
 
-  // viem defaults to JsonRpcAccounts so we pass the whole account if it's locally generated
-  let viemAccountOrAddress: ViemAccount | Address;
-  const possibleAccountKey = getAccountKey(account);
-  if (possibleAccountKey && account.signTransaction) {
-    viemAccountOrAddress = {
-      ...account,
-      signTransaction: account.signTransaction,
-      source: "custom",
-      type: "local" as const,
-      publicKey: toHex(
-        secp256k1.getPublicKey(possibleAccountKey.slice(2), false),
-      ),
-    };
-  } else {
-    viemAccountOrAddress = account.address;
-  }
-
   return createWalletClient({
     transport,
-    account: viemAccountOrAddress,
+    account: account.address,
     chain: viemChain,
     key: "thirdweb-wallet",
   });

packages/thirdweb/src/wallets/interfaces/wallet.ts

@@ -42,24 +42,6 @@ export type Wallet<TWalletId extends WalletId = WalletId> = {
   getConfig: () => CreateWalletArgs<TWalletId>[1];
 };
 
-// Symbols to track account key internally for downstream adapters
-// eslint-disable-next-line better-tree-shaking/no-top-level-side-effects
-const accountKeySymbol: unique symbol = Symbol("key");
-
-/**
- * @internal
- */
-export function getAccountKey(account: Account): Hex | undefined {
-  return account[accountKeySymbol];
-}
-
-/**
- * @internal
- */
-export function setAccountKey(account: Account, key: Hex) {
-  account[accountKeySymbol] = key;
-}
-
 export type Account = {
   // REQUIRED
   address: Address;
@@ -80,13 +62,4 @@ export type Account = {
   sendBatchTransaction?: (
     txs: SendTransactionOption[],
   ) => Promise<SendTransactionResult>;
-} & (
-  | {
-      // if a private key account, signTransaction will be defined and an accountKeySymbol assigned
-      signTransaction: (tx: TransactionSerializable) => Promise<Hex>;
-      [accountKeySymbol]: Hex;
-    }
-  | {
-      [accountKeySymbol]?: never;
-    }
-);
+};

packages/thirdweb/src/wallets/private-key.test.ts

@@ -15,7 +15,6 @@ test("default", () => {
       "signMessage": [Function],
       "signTransaction": [Function],
       "signTypedData": [Function],
-      Symbol(key): "${ANVIL_PKEY_A}",
     }
   `);
 });

packages/thirdweb/src/wallets/private-key.ts

@@ -9,7 +9,7 @@ import type { ThirdwebClient } from "../client/client.js";
 import { defineChain } from "../chains/utils.js";
 import { getRpcClient } from "../rpc/rpc.js";
 import { eth_sendRawTransaction } from "../rpc/actions/eth_sendRawTransaction.js";
-import { setAccountKey, type Account } from "./interfaces/wallet.js";
+import type { Account } from "./interfaces/wallet.js";
 import { toHex, type Hex } from "../utils/encoding/hex.js";
 import { secp256k1 } from "@noble/curves/secp256k1";
 import { signTransaction } from "../transaction/actions/sign-transaction.js";
@@ -119,6 +119,5 @@ export function privateKeyAccount(options: PrivateKeyAccountOptions): Account {
     },
   };
 
-  setAccountKey(account, privateKey);
   return account satisfies Account;
 }