thirdweb 5.97.2 → 5.97.3

package/src/engine/server-wallet.ts

@@ -0,0 +1,284 @@
+import {
+  type AaExecutionOptions,
+  type AaZksyncExecutionOptions,
+  sendTransaction,
+  signMessage,
+  signTypedData,
+} from "@thirdweb-dev/engine";
+import type { Chain } from "../chains/types.js";
+import type { ThirdwebClient } from "../client/client.js";
+import { encode } from "../transaction/actions/encode.js";
+import { toSerializableTransaction } from "../transaction/actions/to-serializable-transaction.js";
+import type { PreparedTransaction } from "../transaction/prepare-transaction.js";
+import { getThirdwebBaseUrl } from "../utils/domains.js";
+import { type Hex, toHex } from "../utils/encoding/hex.js";
+import { getClientFetch } from "../utils/fetch.js";
+import { stringify } from "../utils/json.js";
+import { resolvePromisedValue } from "../utils/promise/resolve-promised-value.js";
+import type {
+  Account,
+  SendTransactionOption,
+} from "../wallets/interfaces/wallet.js";
+import { waitForTransactionHash } from "./get-status.js";
+
+/**
+ * Options for creating an server wallet.
+ */
+export type ServerWalletOptions = {
+  /**
+   * The thirdweb client to use for authentication to thirdweb services.
+   */
+  client: ThirdwebClient;
+  /**
+   * The vault access token to use your server wallet.
+   */
+  vaultAccessToken: string;
+  /**
+   * The server wallet address to use for sending transactions inside engine.
+   */
+  address: string;
+  /**
+   * The chain to use for signing messages and typed data (smart server wallet only).
+   */
+  chain?: Chain;
+  /**
+   * Optional custom execution options to use for sending transactions and signing data.
+   */
+  executionOptions?:
+    | Omit<AaExecutionOptions, "chainId">
+    | Omit<AaZksyncExecutionOptions, "chainId">;
+};
+
+export type ServerWallet = Account & {
+  enqueueTransaction: (args: {
+    transaction: PreparedTransaction;
+    simulate?: boolean;
+  }) => Promise<{ transactionId: string }>;
+};
+
+/**
+ * Create a server wallet for sending transactions and signing messages via engine (v3+).
+ * @param options - The server wallet options.
+ * @returns An account object that can be used to send transactions and sign messages.
+ * @engine
+ * @example
+ * ### Creating a server wallet
+ * ```ts
+ * import { Engine } from "thirdweb";
+ *
+ * const client = createThirdwebClient({
+ *   secretKey: "<your-project-secret-key>",
+ * });
+ *
+ * const myServerWallet = Engine.serverWallet({
+ *   client,
+ *   address: "<your-server-wallet-address>",
+ *   vaultAccessToken: "<your-vault-access-token>",
+ * });
+ * ```
+ *
+ * ### Sending a transaction
+ * ```ts
+ * // prepare the transaction
+ * const transaction = claimTo({
+ *   contract,
+ *   to: "0x...",
+ *   quantity: 1n,
+ * });
+ *
+ * // enqueue the transaction
+ * const { transactionId } = await myServerWallet.enqueueTransaction({
+ *   transaction,
+ * });
+ * ```
+ *
+ * ### Polling for the transaction to be submitted onchain
+ * ```ts
+ * // optionally poll for the transaction to be submitted onchain
+ * const { transactionHash } = await Engine.waitForTransactionHash({
+ *   client,
+ *   transactionId,
+ * });
+ * console.log("Transaction sent:", transactionHash);
+ * ```
+ *
+ * ### Getting the execution status of a transaction
+ * ```ts
+ * const executionResult = await Engine.getTransactionStatus({
+ *   client,
+ *   transactionId,
+ * });
+ * console.log("Transaction status:", executionResult.status);
+ * ```
+ */
+export function serverWallet(options: ServerWalletOptions): ServerWallet {
+  const { client, vaultAccessToken, address, chain, executionOptions } =
+    options;
+  const headers: HeadersInit = {
+    "x-vault-access-token": vaultAccessToken,
+  };
+
+  const getExecutionOptions = (chainId: number) => {
+    return executionOptions
+      ? {
+          ...executionOptions,
+          chainId: chainId.toString(),
+        }
+      : {
+          from: address,
+          chainId: chainId.toString(),
+        };
+  };
+
+  const enqueueTx = async (transaction: SendTransactionOption) => {
+    const body = {
+      executionOptions: getExecutionOptions(transaction.chainId),
+      params: [
+        {
+          to: transaction.to ?? undefined,
+          data: transaction.data,
+          value: transaction.value?.toString(),
+        },
+      ],
+    };
+
+    const result = await sendTransaction({
+      baseUrl: getThirdwebBaseUrl("engineCloud"),
+      fetch: getClientFetch(client),
+      headers,
+      body,
+    });
+
+    if (result.error) {
+      throw new Error(`Error sending transaction: ${result.error}`);
+    }
+
+    const data = result.data?.result;
+    if (!data) {
+      throw new Error("No data returned from engine");
+    }
+    const transactionId = data.transactions?.[0]?.id;
+    if (!transactionId) {
+      throw new Error("No transactionId returned from engine");
+    }
+    return transactionId;
+  };
+
+  return {
+    address,
+    enqueueTransaction: async (args: {
+      transaction: PreparedTransaction;
+      simulate?: boolean;
+    }) => {
+      let serializedTransaction: SendTransactionOption;
+      if (args.simulate) {
+        serializedTransaction = await toSerializableTransaction({
+          transaction: args.transaction,
+        });
+      } else {
+        const [to, data, value] = await Promise.all([
+          args.transaction.to
+            ? resolvePromisedValue(args.transaction.to)
+            : null,
+          encode(args.transaction),
+          args.transaction.value
+            ? resolvePromisedValue(args.transaction.value)
+            : null,
+        ]);
+        serializedTransaction = {
+          chainId: args.transaction.chain.id,
+          data,
+          to: to ?? undefined,
+          value: value ?? undefined,
+        };
+      }
+      const transactionId = await enqueueTx(serializedTransaction);
+      return { transactionId };
+    },
+    sendTransaction: async (transaction: SendTransactionOption) => {
+      const transactionId = await enqueueTx(transaction);
+      return waitForTransactionHash({
+        client,
+        transactionId,
+      });
+    },
+    signMessage: async (data) => {
+      const { message, chainId } = data;
+      let engineMessage: string | Hex;
+      let isBytes = false;
+      if (typeof message === "string") {
+        engineMessage = message;
+      } else {
+        engineMessage = toHex(message.raw);
+        isBytes = true;
+      }
+
+      const signingChainId = chainId || chain?.id;
+      if (!signingChainId) {
+        throw new Error("Chain ID is required for signing messages");
+      }
+
+      const signResult = await signMessage({
+        baseUrl: getThirdwebBaseUrl("engineCloud"),
+        fetch: getClientFetch(client),
+        headers,
+        body: {
+          executionOptions: getExecutionOptions(signingChainId),
+          params: [
+            {
+              message: engineMessage,
+              messageFormat: isBytes ? "hex" : "text",
+            },
+          ],
+        },
+      });
+
+      if (signResult.error) {
+        throw new Error(
+          `Error signing message: ${stringify(signResult.error)}`,
+        );
+      }
+
+      const signatureResult = signResult.data?.result.results[0];
+      if (signatureResult?.success) {
+        return signatureResult.result.signature as Hex;
+      }
+
+      throw new Error(
+        `Failed to sign message: ${signatureResult?.error?.message || "Unknown error"}`,
+      );
+    },
+    signTypedData: async (typedData) => {
+      const signingChainId = chain?.id;
+      if (!signingChainId) {
+        throw new Error("Chain ID is required for signing messages");
+      }
+
+      const signResult = await signTypedData({
+        baseUrl: getThirdwebBaseUrl("engineCloud"),
+        fetch: getClientFetch(client),
+        headers,
+        body: {
+          executionOptions: getExecutionOptions(signingChainId),
+          // biome-ignore lint/suspicious/noExplicitAny: TODO: fix ts / hey-api type clash
+          params: [typedData as any],
+        },
+      });
+
+      if (signResult.error) {
+        throw new Error(
+          `Error signing message: ${stringify(signResult.error)}`,
+        );
+      }
+
+      const signatureResult = signResult.data?.result.results[0];
+      if (signatureResult?.success) {
+        return signatureResult.result.signature as Hex;
+      }
+
+      throw new Error(
+        `Failed to sign message: ${signatureResult?.error?.message || "Unknown error"}`,
+      );
+    },
+  };
+}

package/src/exports/engine.ts

@@ -0,0 +1 @@
+export * from "../engine/index.js";

package/src/exports/thirdweb.ts

@@ -81,6 +81,11 @@ export * as Bridge from "../bridge/index.js";
  */
 export * as Insight from "../insight/index.js";
 
+/**
+ * ENGINE
+ */
+export * as Engine from "../engine/index.js";
+
 /**
  * WALLETS
  */

package/src/extensions/prebuilts/get-required-transactions.ts

@@ -178,7 +178,7 @@ async function getTransactionsForMaketplaceV3(options: {
   client: ThirdwebClient;
 }): Promise<DeployTransactionResult[]> {
   const { chain, client } = options;
-  const WETHAdress = await computePublishedContractAddress({
+  const WETHAddress = await computePublishedContractAddress({
     chain,
     client,
     contractId: "WETH9",
@@ -195,7 +195,7 @@ async function getTransactionsForMaketplaceV3(options: {
       chain,
       client,
       contractId: "DirectListingsLogic",
-      constructorParams: { _nativeTokenWrapper: WETHAdress },
+      constructorParams: { _nativeTokenWrapper: WETHAddress },
     }).then((c) =>
       c
         ? null
@@ -205,7 +205,7 @@ async function getTransactionsForMaketplaceV3(options: {
       chain,
       client,
       contractId: "EnglishAuctionsLogic",
-      constructorParams: { _nativeTokenWrapper: WETHAdress },
+      constructorParams: { _nativeTokenWrapper: WETHAddress },
     }).then((c) =>
       c
         ? null
@@ -233,7 +233,7 @@ async function getTransactionsForDynamicContract(options: {
   deployMetadata: FetchDeployMetadataResult;
 }): Promise<DeployTransactionResult[]> {
   const { chain, client } = options;
-  const WETHAdress = await computePublishedContractAddress({
+  const WETHAddress = await computePublishedContractAddress({
     chain,
     client,
     contractId: "WETH9",
@@ -255,7 +255,7 @@ async function getTransactionsForDynamicContract(options: {
             contractId: e.extensionName,
             publisher: e.publisherAddress,
             version: e.extensionVersion || "latest",
-            constructorParams: { _nativeTokenWrapper: WETHAdress },
+            constructorParams: { _nativeTokenWrapper: WETHAddress },
           }).then((c) =>
             c
               ? null

package/src/react/native/ui/prebuilt/Account/balance.tsx

@@ -55,7 +55,7 @@ export interface AccountBalanceProps extends Omit<TextProps, "children"> {
    * If not passed, the component will return `null`.
    *
    * You can/should pass a descriptive text/component to this prop, indicating that the
-   * balance was not fetched succesfully
+   * balance was not fetched successfully
    * @example
    * ```tsx
    * <AccountBalance

package/src/react/native/ui/prebuilt/Wallet/name.tsx

@@ -25,7 +25,7 @@ export interface WalletNameProps extends Omit<TextProps, "children"> {
    * If not passed, the component will return `null`.
    *
    * You can/should pass a descriptive text/component to this prop, indicating that the
-   * name was not fetched succesfully
+   * name was not fetched successfully
    * @example
    * ```tsx
    * <WalletName fallbackComponent={<span>Failed to load</span>}

package/src/react/web/ui/prebuilt/Account/balance.tsx

@@ -57,7 +57,7 @@ export interface AccountBalanceProps
    * If not passed, the component will return `null`.
    *
    * You can/should pass a descriptive text/component to this prop, indicating that the
-   * balance was not fetched succesfully
+   * balance was not fetched successfully
    * @example
    * ```tsx
    * <AccountBalance

package/src/react/web/ui/prebuilt/Chain/name.tsx

@@ -45,7 +45,7 @@ export interface ChainNameProps
    * If not passed, the component will return `null`.
    *
    * You can/should pass a descriptive text/component to this prop, indicating that the
-   * name was not fetched succesfully
+   * name was not fetched successfully
    * @example
    * ```tsx
    * <ChainName fallbackComponent={<span>Failed to load</span>}

package/src/react/web/ui/prebuilt/NFT/utils.ts

@@ -17,6 +17,7 @@ export async function getNFTInfo(options: NFTProviderProps): Promise<NFT> {
         }),
         getNFT1155({
           ...options,
+          useIndexer: false, // TODO (insight): switch this call to only call insight once
         }),
       ]).then(([possibleNFT721, possibleNFT1155]) => {
         // getNFT extension always return an NFT object

package/src/react/web/ui/prebuilt/Token/name.tsx

@@ -50,7 +50,7 @@ export interface TokenNameProps
    * If not passed, the component will return `null`.
    *
    * You can/should pass a descriptive text/component to this prop, indicating that the
-   * name was not fetched succesfully
+   * name was not fetched successfully
    * @example
    * ```tsx
    * <TokenName fallbackComponent={"Failed to load"}

package/src/react/web/ui/prebuilt/Token/symbol.tsx

@@ -50,7 +50,7 @@ export interface TokenSymbolProps
    * If not passed, the component will return `null`.
    *
    * You can/should pass a descriptive text/component to this prop, indicating that the
-   * symbol was not fetched succesfully
+   * symbol was not fetched successfully
    * @example
    * ```tsx
    * <TokenSymbol fallbackComponent={"Failed to load"}

package/src/react/web/ui/prebuilt/Wallet/name.tsx

@@ -27,7 +27,7 @@ export interface WalletNameProps
    * If not passed, the component will return `null`.
    *
    * You can/should pass a descriptive text/component to this prop, indicating that the
-   * name was not fetched succesfully
+   * name was not fetched successfully
    * @example
    * ```tsx
    * <WalletName fallbackComponent={<span>Failed to load</span>}

package/src/react/web/wallets/in-app/InAppWalletConnectUI.tsx

@@ -51,7 +51,7 @@ function InAppWalletConnectUI(props: {
     return <LoadingScreen />;
   }
 
-  // if the the modal starts out with the wallet's connect ui instead of wallet selector - going back to main screen requires staying on the same component and clearing the selection data
+  // if the modal starts out with the wallet's connect ui instead of wallet selector - going back to main screen requires staying on the same component and clearing the selection data
   // otherwise, we go back to the wallet selector by calling props.goBack
   const goBackToMain = () => {
     if (initialScreen === props.wallet) {

package/src/storage/upload/mobile.ts

@@ -104,7 +104,7 @@ export async function uploadBatchMobile(
           );
         }
 
-        return reject(new Error("Unknown upload error occured"));
+        return reject(new Error("Unknown upload error occurred"));
       });
 
       xhr.open("POST", `https://${getThirdwebDomains().storage}/ipfs/upload`);

package/src/utils/domain.test.ts

@@ -16,6 +16,7 @@ describe("Thirdweb Domains", () => {
     bundler: "bundler.thirdweb.com",
     analytics: "c.thirdweb.com",
     insight: "insight.thirdweb.com",
+    engineCloud: "engine.thirdweb.com",
   };
 
   beforeEach(() => {

package/src/utils/domains.ts

@@ -39,6 +39,11 @@ type DomainOverrides = {
    * @default "insight.thirdweb.com"
    */
   insight?: string;
+  /**
+   * The base URL for the engine cloud server.
+   * @default "engine.thirdweb.com"
+   */
+  engineCloud?: string;
 };
 
 export const DEFAULT_RPC_URL = "rpc.thirdweb.com";
@@ -49,6 +54,8 @@ const DEFAULT_STORAGE_URL = "storage.thirdweb.com";
 const DEFAULT_BUNDLER_URL = "bundler.thirdweb.com";
 const DEFAULT_ANALYTICS_URL = "c.thirdweb.com";
 const DEFAULT_INSIGHT_URL = "insight.thirdweb.com";
+const DEFAULT_ENGINE_CLOUD_URL = "engine.thirdweb.com";
+
 let domains: { [k in keyof DomainOverrides]-?: string } = {
   rpc: DEFAULT_RPC_URL,
   inAppWallet: DEFAULT_IN_APP_WALLET_URL,
@@ -58,6 +65,7 @@ let domains: { [k in keyof DomainOverrides]-?: string } = {
   bundler: DEFAULT_BUNDLER_URL,
   analytics: DEFAULT_ANALYTICS_URL,
   insight: DEFAULT_INSIGHT_URL,
+  engineCloud: DEFAULT_ENGINE_CLOUD_URL,
 };
 
 export const setThirdwebDomains = (DomainOverrides: DomainOverrides) => {
@@ -70,6 +78,7 @@ export const setThirdwebDomains = (DomainOverrides: DomainOverrides) => {
     bundler: DomainOverrides.bundler ?? DEFAULT_BUNDLER_URL,
     analytics: DomainOverrides.analytics ?? DEFAULT_ANALYTICS_URL,
     insight: DomainOverrides.insight ?? DEFAULT_INSIGHT_URL,
+    engineCloud: DomainOverrides.engineCloud ?? DEFAULT_ENGINE_CLOUD_URL,
   };
 };
 

package/src/utils/fetch.ts

@@ -27,7 +27,11 @@ export function getClientFetch(client: ThirdwebClient, ecosystem?: Ecosystem) {
     const { requestTimeoutMs = DEFAULT_REQUEST_TIMEOUT, ...restInit } =
       init || {};
 
-    let headers = restInit.headers ? new Headers(restInit.headers) : undefined;
+    let headers = restInit.headers
+      ? new Headers(restInit.headers)
+      : typeof url === "object"
+        ? url.headers
+        : undefined;
     const urlString = typeof url === "string" ? url : url.url;
 
     // check if we are making a request to a thirdweb service (we don't want to send any headers to non-thirdweb services)
@@ -60,9 +64,13 @@ export function getClientFetch(client: ThirdwebClient, ecosystem?: Ecosystem) {
         if (client.teamId) {
           headers.set("x-team-id", client.teamId);
         }
-      } else if (secretKey) {
+      }
+
+      if (secretKey) {
         headers.set("x-secret-key", secretKey);
-      } else if (clientId) {
+      }
+
+      if (clientId) {
         headers.set("x-client-id", clientId);
       }
 

package/src/version.ts

@@ -1 +1 @@
-export const version = "5.97.2";
+export const version = "5.97.3";

package/src/wallets/engine/index.ts

@@ -42,6 +42,7 @@ export type EngineAccountOptions = {
 
 /**
  * Creates an account that uses your engine backend wallet for sending transactions and signing messages.
+ * @deprecated This for v2 dedicated engine instances, for v3 and engine cloud use Engine.serverWallet()
  *
  * @param options - The options for the engine account.
  * @returns An account that uses your engine backend wallet.

package/src/wallets/smart/lib/calls.ts

@@ -184,7 +184,7 @@ export function prepareExecute(args: {
   let value = transaction.value || 0n;
   // special handling of hedera chains, decimals for native value is 8 instead of 18 when passed as contract params
   if (transaction.chainId === 295 || transaction.chainId === 296) {
-    value = value / BigInt(10 ** 10);
+    value = BigInt(value) / BigInt(10 ** 10);
   }
   return prepareContractCall({
     contract: accountContract,
@@ -220,7 +220,7 @@ export function prepareBatchExecute(args: {
   const chainId = transactions[0]?.chainId;
   // special handling of hedera chains, decimals for native value is 8 instead of 18 when passed as contract params
   if (chainId === 295 || chainId === 296) {
-    values = values.map((value) => value / BigInt(10 ** 10));
+    values = values.map((value) => BigInt(value) / BigInt(10 ** 10));
   }
   return prepareContractCall({
     contract: accountContract,

package/src/wallets/smart/lib/paymaster.ts

@@ -82,9 +82,9 @@ export async function getPaymasterAndData(args: {
       };
     }
     // check for policy errors
-    if (res.result.policyId && res.result.reason) {
+    if (res.result.reason) {
       console.warn(
-        `Paymaster policy rejected this transaction with reason: ${res.result.reason} (policyId: ${res.result.policyId})`,
+        `Paymaster policy rejected this transaction with reason: ${res.result.reason} ${res.result.policyId ? `(policyId: ${res.result.policyId})` : ""}`,
       );
     }