thirdweb 5.48.0-nightly-cbd6fd87d0120c6013ef354fe8ff22293e4c08e2-20240820000346 → 5.48.0

package/src/adapters/ethers6.ts

@@ -45,10 +45,50 @@ function assertEthers6(
   }
 }
 
+/**
+ * The ethers6 adapter provides a way to convert between Thirdweb contracts, accounts, and providers.
+ * @example
+ *
+ * ### Converting a Thirdweb account to an ethers.js signer
+ * ```ts
+ * import { ethers6Adapter } from "thirdweb/adapters/ethers6";
+ * const signer = await ethers6Adapter.signer.toEthers({ client, chain, account });
+ * ```
+ *
+ * ### Converting an ethers.js signer into a Thirdweb account
+ * ```ts
+ * import { ethers6Adapter } from "thirdweb/adapters/ethers6";
+ * const account = await ethers6Adapter.signer.fromEthers({ signer });
+ * ```
+ *
+ * ### Converting a Thirdweb contract to an ethers.js Contract
+ * ```ts
+ * import { ethers6Adapter } from "thirdweb/adapters/ethers6";
+ * const ethersContract = await ethers6Adapter.contract.toEthers({ thirdwebContract });
+ * ```
+ *
+ * ### Converting a Thirdweb client and chain ID into an ethers.js provider
+ * ```ts
+ * import { ethers6Adapter } from "thirdweb/adapters/ethers6";
+ * const provider = ethers6Adapter.provider.toEthers({ client, chain });
+ * ```
+ */
 export const ethers6Adapter = /* @__PURE__ */ (() => {
   const ethers = universalethers;
 
   return {
+    /**
+     * Converts a Thirdweb client and chain ID into an ethers.js provider.
+     * @param options - The options for converting the Thirdweb client and chain ID into an ethers.js provider.
+     * @param options.client - The Thirdweb client.
+     * @param options.chain - The chain.
+     * @returns The ethers.js provider.
+     * @example
+     * ```ts
+     * import { ethers6Adapter } from "thirdweb/adapters/ethers6";
+     * const provider = ethers6Adapter.provider.toEthers({ client, chain });
+     * ```
+     */
     provider: {
       /**
        * Converts a Thirdweb client and chain ID into an ethers.js provider.
@@ -67,12 +107,29 @@ export const ethers6Adapter = /* @__PURE__ */ (() => {
         return toEthersProvider(ethers, options.client, options.chain);
       },
     },
+    /**
+     * Converts a ThirdwebContract to an ethers.js Contract or the other way around.
+     * @example
+     *
+     * ### toEthers
+     * ```ts
+     * import { ethers6Adapter } from "thirdweb/adapters/ethers6";
+     * const ethersContract = await ethers6Adapter.contract.toEthers({ thirdwebContract, account });
+     * ```
+     *
+     * ### fromEthers
+     * ```ts
+     * import { ethers6Adapter } from "thirdweb/adapters";
+     * const contract = ethers6Adapter.contract.fromEthers({ client, chain, ethersContract });
+     * ```
+     */
     contract: {
       /**
        * Converts a ThirdwebContract to an ethers.js Contract.
-       * @param options - The options for converting the ThirdwebContract to an ethers.js Contract.
+       * @param options - The options for converting a ThirdwebContract to an ethers.js Contract.
        * @param options.thirdwebContract - The ThirdwebContract to convert.
-       * @returns A Promise that resolves to an ethers.js Contract.
+       * @param options.account - The account to use for signing the transaction.
+       * @returns The ethers.js Contract.
        * @example
        * ```ts
        * import { ethers6Adapter } from "thirdweb/adapters/ethers6";
@@ -91,18 +148,15 @@ export const ethers6Adapter = /* @__PURE__ */ (() => {
         );
       },
       /**
-       * Creates a ThirdwebContract instance from an ethers.js contract.
-       * @param options - The options for creating the ThirdwebContract instance.
-       * @returns A promise that resolves to a ThirdwebContract instance.
+       * Creates a ThirdwebContract from an ethers.js Contract.
+       * @param options - The options for creating a ThirdwebContract from an ethers.js Contract.
+       * @param options.ethersContract - The ethers.js Contract to convert.
+       * @param options.chain - The chain.
+       * @returns The ThirdwebContract.
        * @example
        * ```ts
        * import { ethers6Adapter } from "thirdweb/adapters/ethers6";
-       *
-       * const twContract = await ethers6Adapter.contract.fromEthersContract({
-       *  client,
-       *  ethersContract,
-       *  chainId,
-       * });
+       * const contract = ethers6Adapter.contract.fromEthers({ ethersContract, chain });
        * ```
        */
       fromEthers: (options: FromEthersContractOptions) => {
@@ -110,16 +164,32 @@ export const ethers6Adapter = /* @__PURE__ */ (() => {
         return fromEthersContract(options);
       },
     },
+    /**
+     * Converts an ethers6 Signer into an Wallet object or the other way around.
+     * @example
+     *
+     * ### fromEthersSigner
+     * ```ts
+     * import { ethers6Adapter } from "thirdweb/adapters/ethers6";
+     * const signer = ethers6Adapter.signer.fromEthersSigner({ signer });
+     * ```
+     *
+     * ### toEthersSigner
+     * ```ts
+     * import { ethers6Adapter } from "thirdweb/adapters/ethers6";
+     * const signer = await ethers6Adapter.signer.toEthers({ client, chain, account });
+     * ```
+     */
     signer: {
       /**
-       * Converts an ethers6 Signer into an Wallet object.
-       * @param options - The options for converting the ethers6 Signer into a Wallet object.
+       * Converts an ethers6 Signer into an thirdweb account.
+       * @param options - The options for converting the ethers6 Signer into a thirdweb account.
        * @param options.signer - The ethers6 Signer object.
-       * @returns - A Promise that resolves to an Wallet object.
+       * @returns - A Promise that resolves to a thirdweb account.
        * @example
        * ```ts
        * import { ethers6Adapter } from "thirdweb/adapters/ethers6";
-       * const wallet = await ethers6Adapter.signer.fromEthersSigner({ signer });
+       * const account = await ethers6Adapter.signer.fromEthers({ signer });
        * ```
        */
       fromEthers: (options: { signer: ethers6.Signer }) => {

package/src/adapters/viem.ts

@@ -21,34 +21,87 @@ import { sendTransaction } from "../transaction/actions/send-transaction.js";
 import { prepareTransaction } from "../transaction/prepare-transaction.js";
 import type { Account } from "../wallets/interfaces/wallet.js";
 
+/**
+ * Converts thirdweb accounts and contracts to viem wallet clients and contract objects or the other way around.
+ * @example
+ *
+ * ### Converting a thirdweb account to a viem wallet client
+ *
+ * ```ts
+ * import { viemAdapter } from "thirdweb/adapters/viem";
+ *
+ * const walletClient = viemAdapter.walletClient.toViem({
+ *  account,
+ *  client,
+ *  chain: ethereum,
+ * });
+ * ```
+ *
+ * ### Converting a viem wallet client to a thirdweb account
+ * ```ts
+ * import { viemAdapter } from "thirdweb/adapters";
+ *
+ * const account = viemAdapter.walletClient.fromViem({
+ *   walletClient,
+ * });
+ * ```
+ *
+ * ### Converting a thirdweb contract to a viem contract
+ * ```ts
+ * import { viemAdapter } from "thirdweb/adapters";
+ *  const viemContract = await viemAdapter.contract.toViem({ thirdwebContract });
+ * ```
+ *
+ * ### Converting a viem contract to a thirdweb contract
+ * ```ts
+ * import { viemAdapter } from "thirdweb/adapters/viem";
+ *
+ * const contract = viemAdapter.contract.fromViem({
+ *  viemContract: viemContract,
+ *  chain: ethereum,
+ *  client,
+ * });
+ * ```
+ *
+ * ### Converting a thirdweb client to a public viem client
+ * ```ts
+ * import { viemAdapter } from "thirdweb/adapters";
+ *
+ * const publicClient = viemAdapter.publicClient.toViem({
+ *  chain: ethereum,
+ *  client,
+ * });
+ * ```
+ *
+ */
 export const viemAdapter = {
+  /**
+   * Creates a ThirdwebContract from a Viem contract or the other way around.
+   * @param options - The options for creating the contract.
+   * @returns The ThirdwebContract.
+   * @example
+   *
+   * ### fromViem
+   *
+   * ```ts
+   * import { viemAdapter } from "thirdweb/adapters/viem";
+   *
+   * const contract = viemAdapter.contract.fromViem({
+   *  viemContract: viemContract,
+   *  chain: ethereum,
+   *  client,
+   * });
+   * ```
+   *
+   * ### toViem
+   *
+   * ```ts
+   * import { viemAdapter } from "thirdweb/adapters";
+   *  const viemContract = await viemAdapter.contract.toViem({ thirdwebContract });
+   * ```
+   */
   contract: {
-    /**
-     * Creates a ThirdwebContract from a Viem contract.
-     * @param options - The options for creating the contract.
-     * @returns The ThirdwebContract.
-     * @example
-     * ```ts
-     * import { viemAdapter } from "thirdweb/adapters/viem";
-     *
-     * const contract = viemAdapter.contract.fromViem({
-     *  viemContract: viemContract,
-     *  chain: ethereum,
-     *  client,
-     * });
-     * ```
-     */
     fromViem: fromViemContract,
-    /**
-     * Converts a ThirdwebContract instance to a Viem contract representation.
-     * @param contract The ThirdwebContract instance to convert.
-     * @returns A promise that resolves to the Viem contract representation.
-     * @example
-     * ```ts
-     * import { viemAdapter } from "thirdweb/adapters";
-     *  const viemContract = await viemAdapter.contract.toViem({ thirdwebContract });
-     * ```
-     */
     toViem: toViemContract,
   },
 
@@ -70,35 +123,55 @@ export const viemAdapter = {
     toViem: toViemPublicClient,
   },
 
+  /**
+   * Converts a thirdweb account to a Viem Wallet client or the other way around.
+   * @param options - The options for creating the Viem Wallet client.
+   * @returns The Viem Wallet client.
+   * @example
+   *
+   * ### toViem
+   * ```ts
+   * import { viemAdapter } from "thirdweb/adapters/viem";
+   *
+   * const walletClient = viemAdapter.walletClient.toViem({
+   *  account,
+   *  client,
+   *  chain: ethereum,
+   * });
+   * ```
+   *
+   * ### fromViem
+   * ```ts
+   * import { viemAdapter } from "thirdweb/adapters";
+   *
+   * const account = viemAdapter.walletClient.fromViem({
+   *   walletClient,
+   * });
+   * ```
+   */
   walletClient: {
     /**
-     * Converts options to a Viem Wallet client.
-     * @param options - The options for creating the Viem Wallet client.
-     * @returns The Viem Wallet client.
+     * Converts a Thirdweb wallet to a Viem wallet client.
+     * @param options - The options for converting a Thirdweb wallet to a Viem wallet client.
+     * @param options.account - The Thirdweb wallet to convert.
+     * @returns A Promise that resolves to a Viem wallet client.
      * @example
      * ```ts
-     * import { viemAdapter } from "thirdweb/adapters/viem";
-     *
-     * const walletClient = viemAdapter.walletClient.toViem({
-     *  account,
-     *  client,
-     *  chain: ethereum,
-     * });
+     * import { viemAdapter } from "thirdweb/adapters";
+     * const walletClient = viemAdapter.walletClient.toViem({ account, client, chain });
      * ```
      */
     toViem: toViemWalletClient,
-
     /**
-     * Converts a Viem Wallet client to an Account.
-     * @param options - The options for creating the Account.
-     * @returns The Account.
+     * Converts a Viem wallet client to a Thirdweb wallet.
+     * @param options - The options for converting a Viem wallet client to a Thirdweb wallet.
+     * @param options.walletClient - The Viem wallet client to convert.
+     * @returns A Promise that resolves to a Thirdweb wallet.
      * @example
      * ```ts
-     * import { viemAdapter } from "thirdweb/adapters/viem";
-     *
-     * const account = viemAdapter.walletClient.fromViem({
-     *   walletClient,
-     * });
+     * import { viemAdapter } from "thirdweb/adapters";
+     * const account = viemAdapter.walletClient.fromViem({ walletClient });
+     * ```
      */
     fromViem: fromViemWalletClient,
   },

package/src/contract/actions/compiler-metadata.ts

@@ -6,8 +6,10 @@ import type { Abi } from "abitype";
 export type PublishedMetadata = {
   name: string;
   abi: Abi;
-  // biome-ignore lint/suspicious/noExplicitAny: TODO: fix later
-  metadata: Record<string, any>;
+  // biome-ignore lint/suspicious/noExplicitAny: TODO: fix later by updating this type to match the specs here: https://docs.soliditylang.org/en/latest/metadata.html
+  metadata: Record<string, any> & {
+    sources: Record<string, { content: string } | { urls: string[] }>;
+  };
   info: {
     title?: string;
     author?: string;

package/src/react/core/design-system/index.ts

@@ -170,6 +170,7 @@ export const fontSize = {
 };
 
 export const spacing = {
+  "4xs": "2px",
   "3xs": "4px",
   xxs: "6px",
   xs: "8px",

package/src/react/core/hooks/transaction/useSendTransaction.ts

@@ -1,7 +1,9 @@
 import { type UseMutationResult, useMutation } from "@tanstack/react-query";
 import type { Chain } from "../../../../chains/types.js";
+import { getGasPrice } from "../../../../gas/get-gas-price.js";
 import type { BuyWithCryptoStatus } from "../../../../pay/buyWithCrypto/getStatus.js";
 import type { BuyWithFiatStatus } from "../../../../pay/buyWithFiat/getStatus.js";
+import { estimateGasCost } from "../../../../transaction/actions/estimate-gas-cost.js";
 import type { GaslessOptions } from "../../../../transaction/actions/gasless/types.js";
 import { sendTransaction } from "../../../../transaction/actions/send-transaction.js";
 import type { WaitForReceiptOptions } from "../../../../transaction/actions/wait-for-tx-receipt.js";
@@ -12,6 +14,7 @@ import { getWalletBalance } from "../../../../wallets/utils/getWalletBalance.js"
 import type { LocaleId } from "../../../web/ui/types.js";
 import type { Theme } from "../../design-system/index.js";
 import type { SupportedTokens } from "../../utils/defaultTokens.js";
+import { hasSponsoredTransactionsEnabled } from "../../utils/wallet.js";
 
 /**
  * Configuration for the "Pay Modal" that opens when the user doesn't have enough funds to send a transaction.
@@ -158,16 +161,31 @@ export function useSendTransactionCore(args: {
             const nativeValue = _nativeValue || 0n;
             const erc20Value = _erc20Value?.amountWei || 0n;
 
-            const balance = await getWalletBalance({
-              client: tx.client,
-              address: account.address,
-              chain: tx.chain,
-              tokenAddress: _erc20Value?.tokenAddress,
-            });
+            const [nativeBalance, erc20Balance, gasCost] = await Promise.all([
+              getWalletBalance({
+                client: tx.client,
+                address: account.address,
+                chain: tx.chain,
+              }),
+              _erc20Value?.tokenAddress
+                ? getWalletBalance({
+                    client: tx.client,
+                    address: account.address,
+                    chain: tx.chain,
+                  })
+                : undefined,
+              getTotalTxCostForBuy(tx, account.address),
+            ]);
+
+            const gasSponsored = hasSponsoredTransactionsEnabled(wallet);
+            const txGasCost = gasSponsored ? 0n : gasCost;
+            const nativeCost = nativeValue + txGasCost;
 
             const shouldShowModal =
-              (erc20Value > 0n && balance.value < erc20Value) ||
-              (nativeValue > 0n && balance.value < nativeValue);
+              (erc20Value > 0n &&
+                erc20Balance &&
+                erc20Balance.value < erc20Value) ||
+              (nativeCost > 0n && nativeBalance.value < nativeCost);
 
             if (shouldShowModal) {
               showPayModal({
@@ -189,3 +207,42 @@ export function useSendTransactionCore(args: {
     },
   });
 }
+
+export async function getTotalTxCostForBuy(
+  tx: PreparedTransaction,
+  from?: string,
+) {
+  try {
+    const gasCost = await estimateGasCost({
+      transaction: tx,
+      from,
+    });
+
+    const bufferCost = gasCost.wei / 10n;
+
+    // Note: get tx.value AFTER estimateGasCost
+    const txValue = await resolvePromisedValue(tx.value);
+
+    // add 10% extra gas cost to the estimate to ensure user buys enough to cover the tx cost
+    return gasCost.wei + bufferCost + (txValue || 0n);
+  } catch (e) {
+    if (from) {
+      // try again without passing from
+      return await getTotalTxCostForBuy(tx);
+    }
+    // fallback if both fail, use the tx value + 2M * gas price
+    const value = await resolvePromisedValue(tx.value);
+
+    const gasPrice = await getGasPrice({
+      client: tx.client,
+      chain: tx.chain,
+    });
+
+    const buffer = 2_000_000n * gasPrice;
+
+    if (!value) {
+      return 0n + buffer;
+    }
+    return value + buffer;
+  }
+}