chore: Remove unused code from LocalWallet (#2798)

Author: jnsdls

.changeset/perfect-ducks-walk.md

@@ -4,13 +4,21 @@
 
 Open "Buy Modal" UI when sending transaction using the `useSendTransaction` hook if the user does not have enough funds to execute the transaction to prompt the user to buy tokens
 
-`useSendTransaction` now takes an optional `config` option to customize the "Buy Modal" UI
+`useSendTransaction` now takes an optional `config` option to customize the "Pay Modal" UI
 
 ```tsx
 const sendTransaction = useSendTransaction({
-  buyModal: {
+  payModal: {
     locale: 'en_US',
     theme: 'light'
   }
 });
+```
+
+You may also explicitly disable the "Pay Modal" UI by setting the `payModal` option to `false`
+
+```tsx
+const sendTransaction = useSendTransaction({
+  payModal: false
+});
 ```

packages/thirdweb/benchmarks/send-transaction.ts

@@ -1,15 +1,15 @@
-import { run, bench, group } from "mitata";
+import { bench, group, run } from "mitata";
 
-import { prepareTransaction } from "../src/transaction/prepare-transaction";
-import { createThirdwebClient } from "../src/client/client";
 import { defineChain } from "../src/chains/utils";
-import { privateKeyAccount } from "../src/wallets/private-key";
+import { createThirdwebClient } from "../src/client/client";
 import { sendTransaction } from "../src/transaction/actions/send-transaction";
+import { prepareTransaction } from "../src/transaction/prepare-transaction";
+import { privateKeyToAccount } from "../src/wallets/private-key";
 
+import * as ethers from "ethers6";
 import * as viem from "viem";
-import { privateKeyToAccount } from "viem/accounts";
+import { privateKeyToAccount as viemPrivateKeyToAccount } from "viem/accounts";
 import { mainnet } from "viem/chains";
-import * as ethers from "ethers6";
 
 const LOCAL_RPC = "http://127.0.0.1:8545";
 const VITALIK_WALLET = "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B";
@@ -27,13 +27,13 @@ const TEST_CHAIN = defineChain({
 const PKEY =
   "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80";
 
-const account = privateKeyAccount({
+const account = privateKeyToAccount({
   privateKey: PKEY,
   client,
 });
 
 // viem setup
-const privateKeyAccountViem = privateKeyToAccount(PKEY);
+const privateKeyAccountViem = viemPrivateKeyToAccount(PKEY);
 const walletClient = viem.createWalletClient({
   account: privateKeyAccountViem,
   transport: viem.http(LOCAL_RPC),

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

@@ -3,10 +3,10 @@ import { describe, expect, test } from "vitest";
 import { ANVIL_CHAIN } from "../../test/src/chains.js";
 import { TEST_CLIENT } from "../../test/src/test-clients.js";
 import { ANVIL_PKEY_A, TEST_ACCOUNT_B } from "../../test/src/test-wallets.js";
-import { privateKeyAccount } from "../wallets/private-key.js";
+import { privateKeyToAccount } from "../wallets/private-key.js";
 import { toEthersSigner } from "./ethers5.js";
 
-const account = privateKeyAccount({
+const account = privateKeyToAccount({
   privateKey: ANVIL_PKEY_A,
   client: TEST_CLIENT,
 });

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

@@ -2,10 +2,10 @@ import { describe, expect, test } from "vitest";
 import { ANVIL_CHAIN } from "../../test/src/chains.js";
 import { TEST_CLIENT } from "../../test/src/test-clients.js";
 import { ANVIL_PKEY_A, TEST_ACCOUNT_B } from "../../test/src/test-wallets.js";
-import { privateKeyAccount } from "../wallets/private-key.js";
+import { privateKeyToAccount } from "../wallets/private-key.js";
 import { ethers6Adapter } from "./ethers6.js";
 
-const account = privateKeyAccount({
+const account = privateKeyToAccount({
   privateKey: ANVIL_PKEY_A,
   client: TEST_CLIENT,
 });

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

@@ -4,10 +4,10 @@ import { ANVIL_PKEY_A } from "~test/test-wallets.js";
 import { typedData } from "~test/typed-data.js";
 import { ANVIL_CHAIN, FORKED_ETHEREUM_CHAIN } from "../../test/src/chains.js";
 import { TEST_CLIENT } from "../../test/src/test-clients.js";
-import { privateKeyAccount } from "../wallets/private-key.js";
+import { privateKeyToAccount } from "../wallets/private-key.js";
 import { viemAdapter } from "./viem.js";
 
-const account = privateKeyAccount({
+const account = privateKeyToAccount({
   privateKey: ANVIL_PKEY_A,
   client: TEST_CLIENT,
 });

packages/thirdweb/src/exports/wallets.ts

@@ -24,9 +24,18 @@ export {
 
 // private-key
 export {
-  privateKeyAccount,
   privateKeyToAccount,
-  type PrivateKeyAccountOptions,
+  /**
+   * @internal
+   * @deprecated - use {@link privateKeyToAccount} instead
+   */
+  privateKeyToAccount as privateKeyAccount,
+  type PrivateKeyToAccountOptions,
+  /**
+   * @internal
+   * @deprecated - use {@link PrivateKeyToAccountOptions} instead
+   */
+  type PrivateKeyToAccountOptions as PrivateKeyAccountOptions,
 } from "../wallets/private-key.js";
 
 // injected

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

@@ -1,4 +1,14 @@
 export {
-  privateKeyAccount,
-  type PrivateKeyAccountOptions,
+  privateKeyToAccount,
+  /**
+   * @internal
+   * @deprecated - use {@link privateKeyToAccount} instead
+   */
+  privateKeyToAccount as privateKeyAccount,
+  type PrivateKeyToAccountOptions,
+  /**
+   * @internal
+   * @deprecated - use {@link PrivateKeyToAccountOptions} instead
+   */
+  type PrivateKeyToAccountOptions as PrivateKeyAccountOptions,
 } from "../../wallets/private-key.js";

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

@@ -31,7 +31,7 @@ type ShowModalData = {
  * @internal
  */
 export function useSendTransactionCore(
-  showBuyModal?: (data: ShowModalData) => void,
+  showPayModal?: (data: ShowModalData) => void,
 ): UseMutationResult<WaitForReceiptOptions, Error, PreparedTransaction> {
   const account = useActiveAccount();
 
@@ -41,7 +41,7 @@ export function useSendTransactionCore(
         throw new Error("No active account");
       }
 
-      if (!showBuyModal) {
+      if (!showPayModal) {
         return sendTransaction({
           transaction: tx,
           account,
@@ -98,7 +98,7 @@ export function useSendTransactionCore(
             }
 
             // if not enough balance - show modal
-            showBuyModal({
+            showPayModal({
               tx,
               sendTx,
               rejectTx: () => {

packages/thirdweb/src/react/web/hooks/useSendTransaction.tsx

@@ -22,7 +22,7 @@ import { LoadingScreen } from "../wallets/shared/LoadingScreen.js";
 export type SendTransactionConfig = {
   /**
    * Configuration for the "Buy Modal" that opens when the user doesn't have enough funds to send a transaction.
-   * Set `buyModal: false` to disable the "Buy Modal" popup
+   * Set `payModal: false` to disable the "Buy Modal" popup
    *
    * This configuration object includes the following properties to configure the "Buy Modal" UI:
    *
@@ -40,7 +40,7 @@ export type SendTransactionConfig = {
    * Refer to [`lightTheme`](https://portal.thirdweb.com/references/typescript/v5/lightTheme)
    * or [`darkTheme`](https://portal.thirdweb.com/references/typescript/v5/darkTheme) helper functions to use the default light or dark theme and customize it.
    */
-  buyModal?:
+  payModal?:
     | {
         locale?: LocaleId;
         supportedTokens?: SupportedTokens;
@@ -66,11 +66,11 @@ export type SendTransactionConfig = {
  * @transaction
  */
 export function useSendTransaction(config: SendTransactionConfig = {}) {
-  const buyModal = config.buyModal;
+  const payModal = config.payModal;
 
   const setRootEl = useContext(SetRootElementContext);
   return useSendTransactionCore(
-    typeof buyModal === "object"
+    typeof payModal === "object"
       ? (data) => {
           setRootEl(
             <TxModal
@@ -81,9 +81,9 @@ export function useSendTransaction(config: SendTransactionConfig = {}) {
                 data.rejectTx();
               }}
               client={data.tx.client}
-              localeId={buyModal?.locale || "en_US"}
-              supportedTokens={buyModal?.supportedTokens || defaultTokens}
-              theme={buyModal?.theme || "dark"}
+              localeId={payModal?.locale || "en_US"}
+              supportedTokens={payModal?.supportedTokens || defaultTokens}
+              theme={payModal?.theme || "dark"}
               txCostWei={data.totalCostWei}
               walletBalanceWei={data.walletBalance.value}
               nativeTokenSymbol={data.walletBalance.symbol}