thirdweb 5.32.2 → 5.33.0

package/dist/esm/auth/verifySignature.js

@@ -1,132 +0,0 @@
-import { recoverAddress } from "viem";
-import { getContract } from "../contract/contract.js";
-import { isValidSignature } from "../extensions/erc1271/__generated__/isValidSignature/read/isValidSignature.js";
-import { isHex } from "../utils/encoding/hex.js";
-import { hashMessage } from "../utils/hashing/hashMessage.js";
-/**
- * Verifies the signature of a message using an Ethereum account's EOA (Externally Owned Account).
- * @param options - The options for verifying the signature.
- * @returns A boolean indicating whether the signature is valid.
- * @throws An error if the signature is invalid.
- * @example
- * ```ts
- * import { verifyEOASignature } from 'thirdweb/auth';
- *
- * const isValid = await verifyEOASignature({
- *  message: '0x1234567890123456789012345678901234567890',
- *  signature: '0x1234567890123456789012345678901234567890',
- *  address: '0x1234567890123456789012345678901234567890',
- * });
- * ```
- * @auth
- */
-export async function verifyEOASignature(options) {
-    const messageHash = hashMessage(options.message);
-    if (!isHex(options.signature)) {
-        return false;
-    }
-    const recoveredAddress = await recoverAddress({
-        hash: messageHash,
-        signature: options.signature,
-    });
-    if (recoveredAddress.toLowerCase() === options.address.toLowerCase()) {
-        return true;
-    }
-    return false;
-}
-const EIP1271_MAGICVALUE = "0x1626ba7e";
-/**
- * Verifies the signature of a contract wallet.
- * @param options - The parameters for verifying the signature.
- * @returns A boolean indicating whether the signature is valid.
- * @throws An error if the signature is invalid.
- * @example
- * ```ts
- * import { verifyContractWalletSignature } from 'thirdweb/auth';
- *
- * const isValid = await verifyContractWalletSignature({
- *  message: '0x1234567890123456789012345678901234567890',
- *  signature: '0x1234567890123456789012345678901234567890',
- *  address: '0x1234567890123456789012345678901234567890',
- *  chain: ...,
- *  client: ...,
- * });
- * ```
- * @auth
- */
-export async function verifyContractWalletSignature(options) {
-    if (!isHex(options.signature)) {
-        throw new Error("Invalid signature");
-    }
-    const contract = getContract({
-        address: options.address,
-        chain: options.chain,
-        client: options.client,
-    });
-    const messageHash = hashMessage(options.message);
-    const result = await isValidSignature({
-        contract,
-        hash: messageHash,
-        signature: options.signature,
-    });
-    return result === EIP1271_MAGICVALUE;
-}
-/**
- * Verifies the signature based on the provided options.
- * Handles smart contract wallet signatures and EOA signatures.
- * **IMPORTANT: in order to check smart contract signatures, a chain and client must be provided.**
- * @param options - The options for signature verification.
- * @returns A boolean indicating whether the signature is valid or not.
- * @example
- * ```ts
- * import { verifySignature } from 'thirdweb/auth';
- *
- * const isValid = await verifySignature({
- *  message: 'Your message to sign',
- *  signature: '0x91db0222ec371a8c18d3b187a6d2e77789bffca1b96826ef6b8708e0d4a66c80312fc3ae95b8fbc147265abf539bb6f360152be61a0e1411d7f5771a599e769a1c',
- *  address: '0xda9C7A86AeE76701FC1c23ae548e8E93Ba3e42A5',
- *  client: thirdwebClient,
- *  chain: chain
- * });
- * ```
- * @auth
- */
-let warningTriggered = false;
-export async function verifySignature(options) {
-    try {
-        const isValidEOASig = await verifyEOASignature(options);
-        if (isValidEOASig) {
-            return true;
-        }
-    }
-    catch {
-        // no-op, we skip to contract signature check
-    }
-    if (isVerifyContractWalletSignatureParams(options)) {
-        try {
-            return await verifyContractWalletSignature(options);
-        }
-        catch {
-            // no-op we skip to return false
-        }
-    }
-    else if (!warningTriggered) {
-        // We only trigger this warning once
-        warningTriggered = true;
-        console.error(`
-      Failed to verify EOA signature and no chain or client provided.
-
-      If you mean to use a smart account, please provide a chain and client.
-      For more information on how to setup a smart account with Auth, see https://portal.thirdweb.com/connect/auth
-    `);
-    }
-    // if we reach here, we have no way to verify the signature
-    return false;
-}
-function isVerifyContractWalletSignatureParams(options) {
-    return ("chain" in options &&
-        options.chain !== undefined &&
-        "client" in options &&
-        options.client !== undefined);
-}
-//# sourceMappingURL=verifySignature.js.map

package/dist/esm/auth/verifySignature.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"verifySignature.js","sourceRoot":"","sources":["../../../src/auth/verifySignature.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AAGtC,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,+EAA+E,CAAC;AACjH,OAAO,EAAE,KAAK,EAAE,MAAM,0BAA0B,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAS9D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,OAAiC;IACxE,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,cAAc,CAAC;QAC5C,IAAI,EAAE,WAAW;QACjB,SAAS,EAAE,OAAO,CAAC,SAAS;KAC7B,CAAC,CAAC;IAEH,IAAI,gBAAgB,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC;QACrE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AASD,MAAM,kBAAkB,GAAG,YAAY,CAAC;AAExC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,6BAA6B,CACjD,OAA4C;IAE5C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,QAAQ,GAAG,WAAW,CAAC;QAC3B,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,KAAK,EAAE,OAAO,CAAC,KAAK;QACpB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IAEH,MAAM,WAAW,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAEjD,MAAM,MAAM,GAAG,MAAM,gBAAgB,CAAC;QACpC,QAAQ;QACR,IAAI,EAAE,WAAW;QACjB,SAAS,EAAE,OAAO,CAAC,SAAS;KAC7B,CAAC,CAAC;IAEH,OAAO,MAAM,KAAK,kBAAkB,CAAC;AACvC,CAAC;AAMD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,IAAI,gBAAgB,GAAG,KAAK,CAAC;AAC7B,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,OAA8B;IAClE,IAAI,CAAC;QACH,MAAM,aAAa,GAAG,MAAM,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACxD,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,6CAA6C;IAC/C,CAAC;IACD,IAAI,qCAAqC,CAAC,OAAO,CAAC,EAAE,CAAC;QACnD,IAAI,CAAC;YACH,OAAO,MAAM,6BAA6B,CAAC,OAAO,CAAC,CAAC;QACtD,CAAC;QAAC,MAAM,CAAC;YACP,gCAAgC;QAClC,CAAC;IACH,CAAC;SAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC7B,oCAAoC;QACpC,gBAAgB,GAAG,IAAI,CAAC;QACxB,OAAO,CAAC,KAAK,CAAC;;;;;KAKb,CAAC,CAAC;IACL,CAAC;IACD,2DAA2D;IAC3D,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,qCAAqC,CAC5C,OAA8B;IAE9B,OAAO,CACL,OAAO,IAAI,OAAO;QAClB,OAAO,CAAC,KAAK,KAAK,SAAS;QAC3B,QAAQ,IAAI,OAAO;QACnB,OAAO,CAAC,MAAM,KAAK,SAAS,CAC7B,CAAC;AACJ,CAAC"}

package/dist/types/auth/verifySignature.d.ts

@@ -1,53 +0,0 @@
-import type { Chain } from "../chains/types.js";
-import type { ThirdwebClient } from "../client/client.js";
-import type { Prettify } from "../utils/type-utils.js";
-export type VerifyEOASignatureParams = {
-    message: string;
-    signature: string;
-    address: string;
-};
-/**
- * Verifies the signature of a message using an Ethereum account's EOA (Externally Owned Account).
- * @param options - The options for verifying the signature.
- * @returns A boolean indicating whether the signature is valid.
- * @throws An error if the signature is invalid.
- * @example
- * ```ts
- * import { verifyEOASignature } from 'thirdweb/auth';
- *
- * const isValid = await verifyEOASignature({
- *  message: '0x1234567890123456789012345678901234567890',
- *  signature: '0x1234567890123456789012345678901234567890',
- *  address: '0x1234567890123456789012345678901234567890',
- * });
- * ```
- * @auth
- */
-export declare function verifyEOASignature(options: VerifyEOASignatureParams): Promise<boolean>;
-export type VerifyContractWalletSignatureParams = Prettify<VerifyEOASignatureParams & {
-    chain: Chain;
-    client: ThirdwebClient;
-}>;
-/**
- * Verifies the signature of a contract wallet.
- * @param options - The parameters for verifying the signature.
- * @returns A boolean indicating whether the signature is valid.
- * @throws An error if the signature is invalid.
- * @example
- * ```ts
- * import { verifyContractWalletSignature } from 'thirdweb/auth';
- *
- * const isValid = await verifyContractWalletSignature({
- *  message: '0x1234567890123456789012345678901234567890',
- *  signature: '0x1234567890123456789012345678901234567890',
- *  address: '0x1234567890123456789012345678901234567890',
- *  chain: ...,
- *  client: ...,
- * });
- * ```
- * @auth
- */
-export declare function verifyContractWalletSignature(options: VerifyContractWalletSignatureParams): Promise<boolean>;
-export type VerifySignatureParams = Prettify<VerifyEOASignatureParams & Partial<VerifyContractWalletSignatureParams>>;
-export declare function verifySignature(options: VerifySignatureParams): Promise<boolean>;
-//# sourceMappingURL=verifySignature.d.ts.map

package/dist/types/auth/verifySignature.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"verifySignature.d.ts","sourceRoot":"","sources":["../../../src/auth/verifySignature.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAK1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAEvD,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,kBAAkB,CAAC,OAAO,EAAE,wBAAwB,oBAgBzE;AAED,MAAM,MAAM,mCAAmC,GAAG,QAAQ,CACxD,wBAAwB,GAAG;IACzB,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,EAAE,cAAc,CAAC;CACxB,CACF,CAAC;AAIF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,6BAA6B,CACjD,OAAO,EAAE,mCAAmC,oBAqB7C;AAED,MAAM,MAAM,qBAAqB,GAAG,QAAQ,CAC1C,wBAAwB,GAAG,OAAO,CAAC,mCAAmC,CAAC,CACxE,CAAC;AAuBF,wBAAsB,eAAe,CAAC,OAAO,EAAE,qBAAqB,oBA2BnE"}

package/src/auth/verifySignature.test.ts

@@ -1,53 +0,0 @@
-import { describe, expect, test } from "vitest";
-import { TEST_ACCOUNT_A } from "../../test/src/test-wallets.js";
-import { verifyEOASignature } from "./verifySignature.js";
-
-describe("verifyEOASignature", () => {
-  test("should return true for a valid signature", async () => {
-    const message = "Hello world!";
-
-    const signature = await TEST_ACCOUNT_A.signMessage({ message });
-
-    const result = await verifyEOASignature({
-      address: TEST_ACCOUNT_A.address,
-      message,
-      signature,
-    });
-    expect(result).toBe(true);
-  });
-
-  test("should return false for an invalid signature", async () => {
-    const options = {
-      message: "Hello, world!",
-      signature: "invalid",
-      address: "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
-    };
-
-    const result = await verifyEOASignature(options);
-    expect(result).toBe(false);
-  });
-
-  test("should return false for a different address", async () => {
-    const message = "Hello, world!";
-    const signature = await TEST_ACCOUNT_A.signMessage({ message });
-
-    const result = await verifyEOASignature({
-      address: "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
-      message,
-      signature,
-    });
-    expect(result).toBe(false);
-  });
-
-  test("should return false for a different message", async () => {
-    const message = "Hello, world!";
-    const signature = await TEST_ACCOUNT_A.signMessage({ message });
-
-    const result = await verifyEOASignature({
-      address: TEST_ACCOUNT_A.address,
-      message: "Hello, world",
-      signature,
-    });
-    expect(result).toBe(false);
-  });
-});

package/src/auth/verifySignature.ts

@@ -1,166 +0,0 @@
-import { recoverAddress } from "viem";
-import type { Chain } from "../chains/types.js";
-import type { ThirdwebClient } from "../client/client.js";
-import { getContract } from "../contract/contract.js";
-import { isValidSignature } from "../extensions/erc1271/__generated__/isValidSignature/read/isValidSignature.js";
-import { isHex } from "../utils/encoding/hex.js";
-import { hashMessage } from "../utils/hashing/hashMessage.js";
-import type { Prettify } from "../utils/type-utils.js";
-
-export type VerifyEOASignatureParams = {
-  message: string;
-  signature: string;
-  address: string;
-};
-
-/**
- * Verifies the signature of a message using an Ethereum account's EOA (Externally Owned Account).
- * @param options - The options for verifying the signature.
- * @returns A boolean indicating whether the signature is valid.
- * @throws An error if the signature is invalid.
- * @example
- * ```ts
- * import { verifyEOASignature } from 'thirdweb/auth';
- *
- * const isValid = await verifyEOASignature({
- *  message: '0x1234567890123456789012345678901234567890',
- *  signature: '0x1234567890123456789012345678901234567890',
- *  address: '0x1234567890123456789012345678901234567890',
- * });
- * ```
- * @auth
- */
-export async function verifyEOASignature(options: VerifyEOASignatureParams) {
-  const messageHash = hashMessage(options.message);
-
-  if (!isHex(options.signature)) {
-    return false;
-  }
-
-  const recoveredAddress = await recoverAddress({
-    hash: messageHash,
-    signature: options.signature,
-  });
-
-  if (recoveredAddress.toLowerCase() === options.address.toLowerCase()) {
-    return true;
-  }
-  return false;
-}
-
-export type VerifyContractWalletSignatureParams = Prettify<
-  VerifyEOASignatureParams & {
-    chain: Chain;
-    client: ThirdwebClient;
-  }
->;
-
-const EIP1271_MAGICVALUE = "0x1626ba7e";
-
-/**
- * Verifies the signature of a contract wallet.
- * @param options - The parameters for verifying the signature.
- * @returns A boolean indicating whether the signature is valid.
- * @throws An error if the signature is invalid.
- * @example
- * ```ts
- * import { verifyContractWalletSignature } from 'thirdweb/auth';
- *
- * const isValid = await verifyContractWalletSignature({
- *  message: '0x1234567890123456789012345678901234567890',
- *  signature: '0x1234567890123456789012345678901234567890',
- *  address: '0x1234567890123456789012345678901234567890',
- *  chain: ...,
- *  client: ...,
- * });
- * ```
- * @auth
- */
-export async function verifyContractWalletSignature(
-  options: VerifyContractWalletSignatureParams,
-) {
-  if (!isHex(options.signature)) {
-    throw new Error("Invalid signature");
-  }
-
-  const contract = getContract({
-    address: options.address,
-    chain: options.chain,
-    client: options.client,
-  });
-
-  const messageHash = hashMessage(options.message);
-
-  const result = await isValidSignature({
-    contract,
-    hash: messageHash,
-    signature: options.signature,
-  });
-
-  return result === EIP1271_MAGICVALUE;
-}
-
-export type VerifySignatureParams = Prettify<
-  VerifyEOASignatureParams & Partial<VerifyContractWalletSignatureParams>
->;
-
-/**
- * Verifies the signature based on the provided options.
- * Handles smart contract wallet signatures and EOA signatures.
- * **IMPORTANT: in order to check smart contract signatures, a chain and client must be provided.**
- * @param options - The options for signature verification.
- * @returns A boolean indicating whether the signature is valid or not.
- * @example
- * ```ts
- * import { verifySignature } from 'thirdweb/auth';
- *
- * const isValid = await verifySignature({
- *  message: 'Your message to sign',
- *  signature: '0x91db0222ec371a8c18d3b187a6d2e77789bffca1b96826ef6b8708e0d4a66c80312fc3ae95b8fbc147265abf539bb6f360152be61a0e1411d7f5771a599e769a1c',
- *  address: '0xda9C7A86AeE76701FC1c23ae548e8E93Ba3e42A5',
- *  client: thirdwebClient,
- *  chain: chain
- * });
- * ```
- * @auth
- */
-let warningTriggered = false;
-export async function verifySignature(options: VerifySignatureParams) {
-  try {
-    const isValidEOASig = await verifyEOASignature(options);
-    if (isValidEOASig) {
-      return true;
-    }
-  } catch {
-    // no-op, we skip to contract signature check
-  }
-  if (isVerifyContractWalletSignatureParams(options)) {
-    try {
-      return await verifyContractWalletSignature(options);
-    } catch {
-      // no-op we skip to return false
-    }
-  } else if (!warningTriggered) {
-    // We only trigger this warning once
-    warningTriggered = true;
-    console.error(`
-      Failed to verify EOA signature and no chain or client provided.
-
-      If you mean to use a smart account, please provide a chain and client.
-      For more information on how to setup a smart account with Auth, see https://portal.thirdweb.com/connect/auth
-    `);
-  }
-  // if we reach here, we have no way to verify the signature
-  return false;
-}
-
-function isVerifyContractWalletSignatureParams(
-  options: VerifySignatureParams,
-): options is VerifyContractWalletSignatureParams {
-  return (
-    "chain" in options &&
-    options.chain !== undefined &&
-    "client" in options &&
-    options.client !== undefined
-  );
-}