[SDK] Native privateKeyAccount implementation (#2525)

Signed-off-by: Joaquim Verges <joaquim.verges@gmail.com>
Signed-off-by: jxom  <jakemoxey@gmail.com>
Signed-off-by: greg <gregfromstl@gmail.com>
Signed-off-by: Jonas Daniels <jonas.daniels@outlook.com>
Co-authored-by: Jonas Daniels <jonas.daniels@outlook.com>
Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: Joaquim Verges <joaquim.verges@gmail.com>
Co-authored-by: Manan Tank <manantankm@gmail.com>
Co-authored-by: jxom <jakemoxey@gmail.com>
Co-authored-by: Nacho Iacovino <50103937+nachoiacovino@users.noreply.github.com>
Co-authored-by: Winston Yeo <44563205+ElasticBottle@users.noreply.github.com>
Co-authored-by: iketw <121973632+iketw@users.noreply.github.com>
Co-authored-by: Winston Yeo <winstonyeo99@yahoo.com>
Co-authored-by: Isaac Dubuque <idubuque@umich.edu>

Author: 10 people

.changeset/angry-sheep-work.md

@@ -0,0 +1,5 @@
+---
+"thirdweb": patch
+---
+
+Better private-key account support

legacy_packages/auth/test/evm.test.ts

@@ -6,7 +6,7 @@ import { describe, it, beforeAll, beforeEach, expect } from "vitest";
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 require("dotenv-mono").load();
 
-describe(
+describe.runIf(process.env.TW_SECRET_KEY)(
   "Wallet Authentication - EVM",
   {
     timeout: 60000,

legacy_packages/auth/test/smart-wallet.test.ts

@@ -7,7 +7,7 @@ import { describe, it, beforeEach, beforeAll, expect } from "vitest";
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 require("dotenv-mono").load();
 
-describe(
+describe.runIf(process.env.TW_SECRET_KEY)(
   "Wallet Authentication - EVM - Smart Wallet",
   {
     timeout: 60000,

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

@@ -0,0 +1,53 @@
+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 { typedData } from "~test/typed-data.js";
+import { ANVIL_PKEY_A } from "~test/test-wallets.js";
+
+const account = privateKeyAccount({
+  privateKey: ANVIL_PKEY_A,
+  client: TEST_CLIENT,
+});
+
+describe("walletClient.toViem", () => {
+  let walletClient: WalletClient;
+
+  beforeAll(() => {
+    walletClient = viemAdapter.walletClient.toViem({
+      client: TEST_CLIENT,
+      account,
+      chain: defineChain(31337),
+    });
+  });
+
+  test("should return an viem wallet client", async () => {
+    expect(walletClient).toBeDefined();
+    expect(walletClient.signMessage).toBeDefined();
+  });
+
+  test("should sign typed data", async () => {
+    expect(walletClient.signTypedData).toBeDefined();
+
+    if (!walletClient.account) {
+      throw new Error("Account not found");
+    }
+
+    const signature = await walletClient.signTypedData({
+      ...typedData.basic,
+      primaryType: "Mail",
+      account: walletClient.account,
+    });
+
+    expect(signature).toMatchInlineSnapshot(
+      `"0x32f3d5975ba38d6c2fba9b95d5cbed1febaa68003d3d588d51f2de522ad54117760cfc249470a75232552e43991f53953a3d74edf6944553c6bef2469bb9e5921b"`,
+    );
+  });
+
+  test("should contain a local account", async () => {
+    expect(walletClient.account?.type).toBe("local");
+  });
+});

packages/thirdweb/src/adapters/viem.ts

@@ -4,19 +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 } from "abitype";
+import type { Abi, Address } 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 } from "../wallets/interfaces/wallet.js";
+import { type Account, getAccountKey } from "../wallets/interfaces/wallet.js";
 import { getRpcClient } from "../rpc/rpc.js";
+import { secp256k1 } from "@noble/curves/secp256k1";
+import { toHex } from "../utils/encoding/hex.js";
 
 export const viemAdapter = {
   contract: {
@@ -214,9 +217,26 @@ 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: account.address,
+    account: viemAccountOrAddress,
     chain: viemChain,
     key: "thirdweb-wallet",
   });

packages/thirdweb/src/exports/thirdweb.ts

@@ -108,6 +108,7 @@ export {
   type SimulateOptions,
 } from "../transaction/actions/simulate.js";
 export { waitForReceipt } from "../transaction/actions/wait-for-tx-receipt.js";
+export { signTransaction } from "../transaction/actions/sign-transaction.js";
 
 /**
  * EVENTS

packages/thirdweb/src/exports/transaction.ts

@@ -43,6 +43,10 @@ export {
   simulateTransaction,
   type SimulateOptions,
 } from "../transaction/actions/simulate.js";
+export {
+  signTransaction,
+  type SignTransactionOptions,
+} from "../transaction/actions/sign-transaction.js";
 
 //types & utils
 export {

packages/thirdweb/src/exports/utils.ts

@@ -27,6 +27,16 @@ export {
   resolveSignature,
   resolveSignatures,
 } from "../utils/signatures/resolve-signature.js";
+export { type SignOptions, sign } from "../utils/signatures/sign.js";
+export { signatureToHex } from "../utils/signatures/signature-to-hex.js";
+export {
+  type SignMessageOptions,
+  signMessage,
+} from "../utils/signatures/sign-message.js";
+export {
+  type SignTypedDataOptions,
+  signTypedData,
+} from "../utils/signatures/sign-typed-data.js";
 
 // ------------------------------------------------
 // encoding

packages/thirdweb/src/exports/wallets.ts

@@ -21,6 +21,7 @@ export {
 // private-key
 export {
   privateKeyAccount,
+  privateKeyToAccount,
   type PrivateKeyAccountOptions,
 } from "../wallets/private-key.js";
 

packages/thirdweb/src/exports/wallets/local._ts

@@ -13,4 +13,4 @@ export type {
   LocalWalletLoadOrCreateOptions,
   LocalWalletSaveOptions,
   LocalWalletStorageData,
-} from "../../wallets/local/types._ts";
+} from "../../wallets/local/types._ts";

packages/thirdweb/src/extensions/common/read/getContractMetadata.test.ts

@@ -2,7 +2,7 @@ import { describe, it, expect } from "vitest";
 import { getContractMetadata } from "./getContractMetadata.js";
 import { USDC_CONTRACT } from "../../../../test/src/test-contracts.js";
 
-describe("shared.getContractMetadata", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("shared.getContractMetadata", () => {
   it("should return the correct contract metadata", async () => {
     const metadata = await getContractMetadata({
       contract: USDC_CONTRACT,

packages/thirdweb/src/extensions/erc1155/drops/read/getActiveClaimCondition.test.ts

@@ -3,7 +3,7 @@ import { describe, it, expect } from "vitest";
 import { DROP1155_CONTRACT } from "../../../../../test/src/test-contracts.js";
 import { getActiveClaimCondition } from "./getActiveClaimCondition.js";
 
-describe("erc1155.getClaimConditions", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("erc1155.getClaimConditions", () => {
   it("should return the correct claim conditions", async () => {
     const cc = await getActiveClaimCondition({
       contract: DROP1155_CONTRACT,

packages/thirdweb/src/extensions/erc1155/read/getNFT.test.ts

@@ -3,7 +3,7 @@ import { describe, it, expect } from "vitest";
 import { getNFT } from "./getNFT.js";
 import { DROP1155_CONTRACT } from "~test/test-contracts.js";
 
-describe("erc1155.getNFT", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("erc1155.getNFT", () => {
   it("without owner", async () => {
     const nft = await getNFT({
       contract: DROP1155_CONTRACT,

packages/thirdweb/src/extensions/erc20/read/getBalance.test.ts

@@ -4,7 +4,7 @@ import { getBalance } from "./getBalance.js";
 import { USDC_CONTRACT } from "~test/test-contracts.js";
 import { VITALIK_WALLET } from "~test/addresses.js";
 
-describe("erc20.getBalance", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("erc20.getBalance", () => {
   it("should return the getBalance result", async () => {
     const balance = await getBalance({
       contract: USDC_CONTRACT,

packages/thirdweb/src/extensions/erc721/drops/read/getActiveClaimCondition.test.ts

@@ -3,7 +3,7 @@ import { describe, it, expect } from "vitest";
 import { NFT_DROP_CONTRACT } from "../../../../../test/src/test-contracts.js";
 import { getActiveClaimCondition } from "./getActiveClaimCondition.js";
 
-describe("erc721.getClaimConditions", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("erc721.getClaimConditions", () => {
   it("should return the correct claim conditions", async () => {
     const cc = await getActiveClaimCondition({
       contract: NFT_DROP_CONTRACT,

packages/thirdweb/src/extensions/erc721/read/getAllOwners.test.ts

@@ -3,7 +3,7 @@ import { describe, it, expect } from "vitest";
 import { getAllOwners } from "./getAllOwners.js";
 import { AZUKI_CONTRACT, DOODLES_CONTRACT } from "~test/test-contracts.js";
 
-describe("erc721.getAllOwners", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("erc721.getAllOwners", () => {
   it("works for azuki", async () => {
     const nfts = await getAllOwners({
       contract: AZUKI_CONTRACT,

packages/thirdweb/src/extensions/erc721/read/getNFT.test.ts

@@ -3,7 +3,7 @@ import { describe, it, expect } from "vitest";
 import { getNFT } from "./getNFT.js";
 import { DOODLES_CONTRACT } from "~test/test-contracts.js";
 
-describe("erc721.getNFT", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("erc721.getNFT", () => {
   it("without owner", async () => {
     const nft = await getNFT({
       contract: { ...DOODLES_CONTRACT },

packages/thirdweb/src/extensions/erc721/read/getNFTs.test.ts

@@ -3,7 +3,7 @@ import { describe, it, expect } from "vitest";
 import { getNFTs } from "./getNFTs.js";
 import { AZUKI_CONTRACT, DOODLES_CONTRACT } from "~test/test-contracts.js";
 
-describe("erc721.getNFTs", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("erc721.getNFTs", () => {
   it("works for azuki", async () => {
     const nfts = await getNFTs({
       contract: AZUKI_CONTRACT,

packages/thirdweb/src/extensions/uniswap/read/getUniswapV3Pools.test.ts

@@ -8,7 +8,7 @@ import {
   MOG_CONTRACT_ADDRESS,
 } from "~test/test-contracts.js";
 
-describe("uniswap.getUniswapV3Pool", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("uniswap.getUniswapV3Pool", () => {
   it("should return the WETH/OHM pool address and fee", async () => {
     const pools = await getUniswapV3Pools({
       contract: UNISWAPV3_FACTORY_CONTRACT,

packages/thirdweb/src/react/core/hooks/contract/useEstimate.ts

@@ -0,0 +1,31 @@
+import { useMutation, type UseMutationResult } from "@tanstack/react-query";
+import {
+  estimateGas,
+  type EstimateGasResult,
+} from "../../../../transaction/actions/estimate-gas.js";
+import type { PreparedTransaction } from "../../../../transaction/prepare-transaction.js";
+import { useActiveAccount } from "../wallets/wallet-hooks.js";
+
+/**
+ * A hook to estimate the gas for a given transaction.
+ * @returns A mutation object to estimate gas.
+ * @example
+ * ```jsx
+ * import { useEstimateGas } from "thirdweb/react";
+ * const { mutate: estimateGas, data: gasEstimate } = useEstimateGas();
+ *
+ * // later
+ * const estimatedGas = await estimateGas(tx);
+ * ```
+ */
+export function useEstimateGas(): UseMutationResult<
+  EstimateGasResult,
+  Error,
+  PreparedTransaction
+> {
+  const account = useActiveAccount();
+
+  return useMutation({
+    mutationFn: (transaction) => estimateGas({ transaction, account }),
+  });
+}

packages/thirdweb/src/react/web/ui/ConnectWallet/ConnectWallet.tsx

@@ -26,7 +26,7 @@ import type { Chain } from "../../../../chains/types.js";
 import type { ConnectLocale } from "./locale/types.js";
 import { WalletConnectionContext } from "../../../core/providers/wallet-connection.js";
 import { getDefaultWallets } from "../../wallets/defaultWallets.js";
-import { AutoConnect } from "../../../core/hooks/connection/useAutoConnect.js";
+import { AutoConnect } from "../../../core/hooks/connection/useAutoConnect.jsx";
 import ConnectModal from "./Modal/ConnectModal.js";
 import { useWalletConnectionCtx } from "../../../core/hooks/others/useWalletConnectionCtx.js";
 import { getConnectLocale } from "./locale/getConnectLocale.js";

packages/thirdweb/src/rpc/actions/eth_blockNumber.test.ts

@@ -9,7 +9,7 @@ const rpcClient = getRpcClient({
   client: TEST_CLIENT,
 });
 
-describe("eth_blockNumber", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("eth_blockNumber", () => {
   it("should return the block number", async () => {
     const blockNumber = await eth_blockNumber(rpcClient);
     expect(blockNumber).toEqual(19139495n);

packages/thirdweb/src/rpc/actions/eth_getBalance.test.ts

@@ -18,7 +18,7 @@ const rpcClient = getRpcClient({
   client: TEST_CLIENT,
 });
 
-describe("eth_getBalance", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("eth_getBalance", () => {
   it("should return the correct balance at the given block", async () => {
     const vitalikBalance = await eth_getBalance(rpcClient, {
       address: VITALIK_WALLET,

packages/thirdweb/src/rpc/actions/eth_getLogs.test.ts

@@ -9,7 +9,7 @@ const rpcClient = getRpcClient({
   client: TEST_CLIENT,
 });
 
-describe("eth_getLogs", () => {
+describe.runIf(process.env.TW_SECRET_KEY)("eth_getLogs", () => {
   it("should return unparsed logs, without events", async () => {
     const logs = await eth_getLogs(rpcClient);
     expect(logs).toMatchInlineSnapshot(`[]`);

packages/thirdweb/src/rpc/rpc.ts

@@ -141,6 +141,17 @@ export function getRpcClient(
               inflight.reject(new Error("No response"));
               return;
             }
+            // handle errors in the response
+            if (response instanceof Error) {
+              inflight.reject(response);
+              return;
+            }
+
+            // handle strings as responses??
+            if (typeof response === "string") {
+              inflight.reject(new Error(response));
+              return;
+            }
 
             if ("error" in response) {
               inflight.reject(response.error);

packages/thirdweb/src/transaction/actions/estimate-gas-cost.test.ts

@@ -4,20 +4,23 @@ import { describe, it, expect } from "vitest";
 import { prepareContractCall } from "../prepare-contract-call.js";
 import { estimateGasCost } from "./estimate-gas-cost.js";
 
-describe("transaction: estimateGasCost", () => {
-  it("should estimateGasCost correctly", async () => {
-    const tx = prepareContractCall({
-      contract: USDC_CONTRACT,
-      method: "function transfer(address, uint256) returns (bool)",
-      params: [TEST_WALLET_A, 100n],
+describe.runIf(process.env.TW_SECRET_KEY)(
+  "transaction: estimateGasCost",
+  () => {
+    it("should estimateGasCost correctly", async () => {
+      const tx = prepareContractCall({
+        contract: USDC_CONTRACT,
+        method: "function transfer(address, uint256) returns (bool)",
+        params: [TEST_WALLET_A, 100n],
+      });
+      const result = await estimateGasCost({
+        transaction: tx,
+        from: TEST_WALLET_A,
+      });
+      expect(result).toEqual({
+        ether: "0.001003554133979864",
+        wei: 1003554133979864n,
+      });
     });
-    const result = await estimateGasCost({
-      transaction: tx,
-      from: TEST_WALLET_A,
-    });
-    expect(result).toEqual({
-      ether: "0.001003554133979864",
-      wei: 1003554133979864n,
-    });
-  });
-});
+  },
+);