thirdweb 5.29.1 → 5.29.2-nightly-fb6a07d4b84ba8ea6389ca04c73625f670a0d9c4-20240614172741

package/src/extensions/modular/__generated__/ModularCore/write/transferOwnership.ts

@@ -0,0 +1,146 @@
+import type { AbiParameterToPrimitiveType } from "abitype";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../../../transaction/types.js";
+import { prepareContractCall } from "../../../../../transaction/prepare-contract-call.js";
+import { encodeAbiParameters } from "../../../../../utils/abi/encodeAbiParameters.js";
+import { once } from "../../../../../utils/promise/once.js";
+import type { ThirdwebContract } from "../../../../../contract/contract.js";
+import { detectMethod } from "../../../../../utils/bytecode/detectExtension.js";
+
+/**
+ * Represents the parameters for the "transferOwnership" function.
+ */
+export type TransferOwnershipParams = WithOverrides<{
+  newOwner: AbiParameterToPrimitiveType<{
+    name: "newOwner";
+    type: "address";
+    internalType: "address";
+  }>;
+}>;
+
+export const FN_SELECTOR = "0xf2fde38b" as const;
+const FN_INPUTS = [
+  {
+    name: "newOwner",
+    type: "address",
+    internalType: "address",
+  },
+] as const;
+const FN_OUTPUTS = [] as const;
+
+/**
+ * Checks if the `transferOwnership` method is supported by the given contract.
+ * @param contract The ThirdwebContract.
+ * @returns A promise that resolves to a boolean indicating if the `transferOwnership` method is supported.
+ * @extension MODULAR
+ * @example
+ * ```ts
+ * import { isTransferOwnershipSupported } from "thirdweb/extensions/modular";
+ *
+ * const supported = await isTransferOwnershipSupported(contract);
+ * ```
+ */
+export async function isTransferOwnershipSupported(
+  contract: ThirdwebContract<any>,
+) {
+  return detectMethod({
+    contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+  });
+}
+
+/**
+ * Encodes the parameters for the "transferOwnership" function.
+ * @param options - The options for the transferOwnership function.
+ * @returns The encoded ABI parameters.
+ * @extension MODULAR
+ * @example
+ * ```ts
+ * import { encodeTransferOwnershipParams } "thirdweb/extensions/modular";
+ * const result = encodeTransferOwnershipParams({
+ *  newOwner: ...,
+ * });
+ * ```
+ */
+export function encodeTransferOwnershipParams(
+  options: TransferOwnershipParams,
+) {
+  return encodeAbiParameters(FN_INPUTS, [options.newOwner]);
+}
+
+/**
+ * Encodes the "transferOwnership" function into a Hex string with its parameters.
+ * @param options - The options for the transferOwnership function.
+ * @returns The encoded hexadecimal string.
+ * @extension MODULAR
+ * @example
+ * ```ts
+ * import { encodeTransferOwnership } "thirdweb/extensions/modular";
+ * const result = encodeTransferOwnership({
+ *  newOwner: ...,
+ * });
+ * ```
+ */
+export function encodeTransferOwnership(options: TransferOwnershipParams) {
+  // we do a "manual" concat here to avoid the overhead of the "concatHex" function
+  // we can do this because we know the specific formats of the values
+  return (FN_SELECTOR +
+    encodeTransferOwnershipParams(options).slice(
+      2,
+    )) as `${typeof FN_SELECTOR}${string}`;
+}
+
+/**
+ * Prepares a transaction to call the "transferOwnership" function on the contract.
+ * @param options - The options for the "transferOwnership" function.
+ * @returns A prepared transaction object.
+ * @extension MODULAR
+ * @example
+ * ```ts
+ * import { transferOwnership } from "thirdweb/extensions/modular";
+ *
+ * const transaction = transferOwnership({
+ *  contract,
+ *  newOwner: ...,
+ *  overrides: {
+ *    ...
+ *  }
+ * });
+ *
+ * // Send the transaction
+ * ...
+ *
+ * ```
+ */
+export function transferOwnership(
+  options: BaseTransactionOptions<
+    | TransferOwnershipParams
+    | {
+        asyncParams: () => Promise<TransferOwnershipParams>;
+      }
+  >,
+) {
+  const asyncOptions = once(async () => {
+    return "asyncParams" in options ? await options.asyncParams() : options;
+  });
+
+  return prepareContractCall({
+    contract: options.contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+    params: async () => {
+      const resolvedOptions = await asyncOptions();
+      return [resolvedOptions.newOwner] as const;
+    },
+    value: async () => (await asyncOptions()).overrides?.value,
+    accessList: async () => (await asyncOptions()).overrides?.accessList,
+    gas: async () => (await asyncOptions()).overrides?.gas,
+    gasPrice: async () => (await asyncOptions()).overrides?.gasPrice,
+    maxFeePerGas: async () => (await asyncOptions()).overrides?.maxFeePerGas,
+    maxPriorityFeePerGas: async () =>
+      (await asyncOptions()).overrides?.maxPriorityFeePerGas,
+    nonce: async () => (await asyncOptions()).overrides?.nonce,
+    extraGas: async () => (await asyncOptions()).overrides?.extraGas,
+  });
+}

package/src/extensions/modular/__generated__/ModularCore/write/uninstallExtension.ts

@@ -0,0 +1,159 @@
+import type { AbiParameterToPrimitiveType } from "abitype";
+import type {
+  BaseTransactionOptions,
+  WithOverrides,
+} from "../../../../../transaction/types.js";
+import { prepareContractCall } from "../../../../../transaction/prepare-contract-call.js";
+import { encodeAbiParameters } from "../../../../../utils/abi/encodeAbiParameters.js";
+import { once } from "../../../../../utils/promise/once.js";
+import type { ThirdwebContract } from "../../../../../contract/contract.js";
+import { detectMethod } from "../../../../../utils/bytecode/detectExtension.js";
+
+/**
+ * Represents the parameters for the "uninstallExtension" function.
+ */
+export type UninstallExtensionParams = WithOverrides<{
+  extension: AbiParameterToPrimitiveType<{
+    name: "_extension";
+    type: "address";
+    internalType: "address";
+  }>;
+  data: AbiParameterToPrimitiveType<{
+    name: "_data";
+    type: "bytes";
+    internalType: "bytes";
+  }>;
+}>;
+
+export const FN_SELECTOR = "0x42b7d0c8" as const;
+const FN_INPUTS = [
+  {
+    name: "_extension",
+    type: "address",
+    internalType: "address",
+  },
+  {
+    name: "_data",
+    type: "bytes",
+    internalType: "bytes",
+  },
+] as const;
+const FN_OUTPUTS = [] as const;
+
+/**
+ * Checks if the `uninstallExtension` method is supported by the given contract.
+ * @param contract The ThirdwebContract.
+ * @returns A promise that resolves to a boolean indicating if the `uninstallExtension` method is supported.
+ * @extension MODULAR
+ * @example
+ * ```ts
+ * import { isUninstallExtensionSupported } from "thirdweb/extensions/modular";
+ *
+ * const supported = await isUninstallExtensionSupported(contract);
+ * ```
+ */
+export async function isUninstallExtensionSupported(
+  contract: ThirdwebContract<any>,
+) {
+  return detectMethod({
+    contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+  });
+}
+
+/**
+ * Encodes the parameters for the "uninstallExtension" function.
+ * @param options - The options for the uninstallExtension function.
+ * @returns The encoded ABI parameters.
+ * @extension MODULAR
+ * @example
+ * ```ts
+ * import { encodeUninstallExtensionParams } "thirdweb/extensions/modular";
+ * const result = encodeUninstallExtensionParams({
+ *  extension: ...,
+ *  data: ...,
+ * });
+ * ```
+ */
+export function encodeUninstallExtensionParams(
+  options: UninstallExtensionParams,
+) {
+  return encodeAbiParameters(FN_INPUTS, [options.extension, options.data]);
+}
+
+/**
+ * Encodes the "uninstallExtension" function into a Hex string with its parameters.
+ * @param options - The options for the uninstallExtension function.
+ * @returns The encoded hexadecimal string.
+ * @extension MODULAR
+ * @example
+ * ```ts
+ * import { encodeUninstallExtension } "thirdweb/extensions/modular";
+ * const result = encodeUninstallExtension({
+ *  extension: ...,
+ *  data: ...,
+ * });
+ * ```
+ */
+export function encodeUninstallExtension(options: UninstallExtensionParams) {
+  // we do a "manual" concat here to avoid the overhead of the "concatHex" function
+  // we can do this because we know the specific formats of the values
+  return (FN_SELECTOR +
+    encodeUninstallExtensionParams(options).slice(
+      2,
+    )) as `${typeof FN_SELECTOR}${string}`;
+}
+
+/**
+ * Prepares a transaction to call the "uninstallExtension" function on the contract.
+ * @param options - The options for the "uninstallExtension" function.
+ * @returns A prepared transaction object.
+ * @extension MODULAR
+ * @example
+ * ```ts
+ * import { uninstallExtension } from "thirdweb/extensions/modular";
+ *
+ * const transaction = uninstallExtension({
+ *  contract,
+ *  extension: ...,
+ *  data: ...,
+ *  overrides: {
+ *    ...
+ *  }
+ * });
+ *
+ * // Send the transaction
+ * ...
+ *
+ * ```
+ */
+export function uninstallExtension(
+  options: BaseTransactionOptions<
+    | UninstallExtensionParams
+    | {
+        asyncParams: () => Promise<UninstallExtensionParams>;
+      }
+  >,
+) {
+  const asyncOptions = once(async () => {
+    return "asyncParams" in options ? await options.asyncParams() : options;
+  });
+
+  return prepareContractCall({
+    contract: options.contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+    params: async () => {
+      const resolvedOptions = await asyncOptions();
+      return [resolvedOptions.extension, resolvedOptions.data] as const;
+    },
+    value: async () => (await asyncOptions()).overrides?.value,
+    accessList: async () => (await asyncOptions()).overrides?.accessList,
+    gas: async () => (await asyncOptions()).overrides?.gas,
+    gasPrice: async () => (await asyncOptions()).overrides?.gasPrice,
+    maxFeePerGas: async () => (await asyncOptions()).overrides?.maxFeePerGas,
+    maxPriorityFeePerGas: async () =>
+      (await asyncOptions()).overrides?.maxPriorityFeePerGas,
+    nonce: async () => (await asyncOptions()).overrides?.nonce,
+    extraGas: async () => (await asyncOptions()).overrides?.extraGas,
+  });
+}

package/src/extensions/modular/__generated__/ModularExtension/read/getExtensionConfig.ts

@@ -0,0 +1,122 @@
+import { readContract } from "../../../../../transaction/read-contract.js";
+import type { BaseTransactionOptions } from "../../../../../transaction/types.js";
+
+import { decodeAbiParameters } from "viem";
+import type { Hex } from "../../../../../utils/encoding/hex.js";
+import type { ThirdwebContract } from "../../../../../contract/contract.js";
+import { detectMethod } from "../../../../../utils/bytecode/detectExtension.js";
+
+export const FN_SELECTOR = "0x7c173ecc" as const;
+const FN_INPUTS = [] as const;
+const FN_OUTPUTS = [
+  {
+    name: "",
+    type: "tuple",
+    internalType: "struct IExtensionConfig.ExtensionConfig",
+    components: [
+      {
+        name: "registerInstallationCallback",
+        type: "bool",
+        internalType: "bool",
+      },
+      {
+        name: "requiredInterfaces",
+        type: "bytes4[]",
+        internalType: "bytes4[]",
+      },
+      {
+        name: "supportedInterfaces",
+        type: "bytes4[]",
+        internalType: "bytes4[]",
+      },
+      {
+        name: "callbackFunctions",
+        type: "tuple[]",
+        internalType: "struct IExtensionConfig.CallbackFunction[]",
+        components: [
+          {
+            name: "selector",
+            type: "bytes4",
+            internalType: "bytes4",
+          },
+        ],
+      },
+      {
+        name: "fallbackFunctions",
+        type: "tuple[]",
+        internalType: "struct IExtensionConfig.FallbackFunction[]",
+        components: [
+          {
+            name: "selector",
+            type: "bytes4",
+            internalType: "bytes4",
+          },
+          {
+            name: "permissionBits",
+            type: "uint256",
+            internalType: "uint256",
+          },
+        ],
+      },
+    ],
+  },
+] as const;
+
+/**
+ * Checks if the `getExtensionConfig` method is supported by the given contract.
+ * @param contract The ThirdwebContract.
+ * @returns A promise that resolves to a boolean indicating if the `getExtensionConfig` method is supported.
+ * @extension MODULAR
+ * @example
+ * ```ts
+ * import { isGetExtensionConfigSupported } from "thirdweb/extensions/modular";
+ *
+ * const supported = await isGetExtensionConfigSupported(contract);
+ * ```
+ */
+export async function isGetExtensionConfigSupported(
+  contract: ThirdwebContract<any>,
+) {
+  return detectMethod({
+    contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+  });
+}
+
+/**
+ * Decodes the result of the getExtensionConfig function call.
+ * @param result - The hexadecimal result to decode.
+ * @returns The decoded result as per the FN_OUTPUTS definition.
+ * @extension MODULAR
+ * @example
+ * ```ts
+ * import { decodeGetExtensionConfigResult } from "thirdweb/extensions/modular";
+ * const result = decodeGetExtensionConfigResult("...");
+ * ```
+ */
+export function decodeGetExtensionConfigResult(result: Hex) {
+  return decodeAbiParameters(FN_OUTPUTS, result)[0];
+}
+
+/**
+ * Calls the "getExtensionConfig" function on the contract.
+ * @param options - The options for the getExtensionConfig function.
+ * @returns The parsed result of the function call.
+ * @extension MODULAR
+ * @example
+ * ```ts
+ * import { getExtensionConfig } from "thirdweb/extensions/modular";
+ *
+ * const result = await getExtensionConfig({
+ *  contract,
+ * });
+ *
+ * ```
+ */
+export async function getExtensionConfig(options: BaseTransactionOptions) {
+  return readContract({
+    contract: options.contract,
+    method: [FN_SELECTOR, FN_INPUTS, FN_OUTPUTS] as const,
+    params: [],
+  });
+}

package/src/extensions/prebuilts/deploy-modular-core.test.ts

@@ -0,0 +1,158 @@
+import { describe, expect, it } from "vitest";
+import { ANVIL_CHAIN } from "../../../test/src/chains.js";
+import { TEST_CLIENT } from "../../../test/src/test-clients.js";
+import { TEST_ACCOUNT_A } from "../../../test/src/test-wallets.js";
+import { ADDRESS_ZERO } from "../../constants/addresses.js";
+import { getContract } from "../../contract/contract.js";
+import { sendTransaction } from "../../transaction/actions/send-transaction.js";
+import { installPublishedExtension } from "../modular/ModularCore/write/installPublishedExtension.js";
+import { uninstallExtensionByProxy } from "../modular/ModularCore/write/uninstallExtensionByProxy.js";
+import { uninstallPublishedExtension } from "../modular/ModularCore/write/uninstallPublishedExtension.js";
+import { getInstalledExtensions } from "../modular/__generated__/ModularCore/read/getInstalledExtensions.js";
+import { deployPublishedContract } from "./deploy-published.js";
+
+describe.runIf(process.env.TW_SECRET_KEY)(
+  "deployModularCore",
+  {
+    timeout: 120000,
+  },
+  () => {
+    it("should deploy a published autofactory modular core contract", async () => {
+      const address = await deployPublishedContract({
+        client: TEST_CLIENT,
+        chain: ANVIL_CHAIN,
+        account: TEST_ACCOUNT_A,
+        contractId: "DemoCore",
+        contractParams: [TEST_ACCOUNT_A.address, [], ["0x"]],
+        publisher: "0xFD78F7E2dF2B8c3D5bff0413c96f3237500898B3",
+      });
+      expect(address).toBeDefined();
+      expect(address.length).toBe(42);
+
+      const installedExtensions = await getInstalledExtensions({
+        contract: getContract({
+          client: TEST_CLIENT,
+          chain: ANVIL_CHAIN,
+          address,
+        }),
+      });
+      expect(installedExtensions.length).toBe(0);
+    });
+
+    it("should install and uninstall an extension by proxy address", async () => {
+      // deploy core contract with extension
+      const address = await deployPublishedContract({
+        client: TEST_CLIENT,
+        chain: ANVIL_CHAIN,
+        account: TEST_ACCOUNT_A,
+        contractId: "DemoCore",
+        contractParams: [TEST_ACCOUNT_A.address, [], ["0x"]],
+        publisher: "0xFD78F7E2dF2B8c3D5bff0413c96f3237500898B3",
+      });
+
+      const core = getContract({
+        client: TEST_CLIENT,
+        chain: ANVIL_CHAIN,
+        address,
+      });
+
+      // install extension with published name
+      const installTransaction = installPublishedExtension({
+        contract: core,
+        chain: ANVIL_CHAIN,
+        client: TEST_CLIENT,
+        account: TEST_ACCOUNT_A,
+        extensionName: "DemoExtensionWithFunctions",
+        publisherAddress: "0xFD78F7E2dF2B8c3D5bff0413c96f3237500898B3",
+      });
+      await sendTransaction({
+        transaction: installTransaction,
+        account: TEST_ACCOUNT_A,
+      });
+
+      // get installed extension proxy address
+      let installedExtensions = await getInstalledExtensions({
+        contract: core,
+      });
+      const extensionAddress = installedExtensions[0]?.implementation;
+      expect(extensionAddress).to.not.equal(ADDRESS_ZERO);
+
+      // uninstall extension
+      const uninstallTransaction = uninstallExtensionByProxy({
+        contract: core,
+        chain: ANVIL_CHAIN,
+        client: TEST_CLIENT,
+        extensionProxyAddress: extensionAddress as string,
+        extensionData: "0x",
+      });
+      await sendTransaction({
+        transaction: uninstallTransaction,
+        account: TEST_ACCOUNT_A,
+      });
+
+      installedExtensions = await getInstalledExtensions({
+        contract: core,
+      });
+
+      expect(installedExtensions.length).toBe(0);
+    });
+
+    it("should install and uninstall extensions by publish name", async () => {
+      // deploy core contract with extension
+      const address = await deployPublishedContract({
+        client: TEST_CLIENT,
+        chain: ANVIL_CHAIN,
+        account: TEST_ACCOUNT_A,
+        contractId: "DemoCore",
+        contractParams: [TEST_ACCOUNT_A.address, [], ["0x"]],
+        publisher: "0xFD78F7E2dF2B8c3D5bff0413c96f3237500898B3",
+      });
+
+      const core = getContract({
+        client: TEST_CLIENT,
+        chain: ANVIL_CHAIN,
+        address,
+      });
+
+      // install extension with published name
+      const installTransaction = installPublishedExtension({
+        contract: core,
+        chain: ANVIL_CHAIN,
+        client: TEST_CLIENT,
+        account: TEST_ACCOUNT_A,
+        extensionName: "DemoExtensionWithFunctions",
+        publisherAddress: "0xFD78F7E2dF2B8c3D5bff0413c96f3237500898B3",
+      });
+      await sendTransaction({
+        transaction: installTransaction,
+        account: TEST_ACCOUNT_A,
+      });
+
+      let installedExtensions = await getInstalledExtensions({
+        contract: core,
+      });
+
+      expect(installedExtensions.length).toBe(1);
+
+      // uninstall extension
+      const uninstallTransaction = uninstallPublishedExtension({
+        contract: core,
+        chain: ANVIL_CHAIN,
+        client: TEST_CLIENT,
+        extensionName: "DemoExtensionWithFunctions",
+        publisherAddress: "0xFD78F7E2dF2B8c3D5bff0413c96f3237500898B3",
+        extensionData: "0x",
+      });
+      await sendTransaction({
+        transaction: uninstallTransaction,
+        account: TEST_ACCOUNT_A,
+      });
+
+      installedExtensions = await getInstalledExtensions({
+        contract: core,
+      });
+
+      expect(installedExtensions.length).toBe(0);
+    });
+  },
+);

package/src/utils/any-evm/deploy-metadata.ts

@@ -180,11 +180,14 @@ export type ExtendedMetadata = {
           params: Array<{ name: string; type: string }>;
           customFactoryAddresses: Record<string, string>;
         };
+        modularFactoryInput?: {
+          hooksParamName: string;
+        };
         factoryAddresses?: Record<string, string>;
       }
     | undefined;
   deployType?: "standard" | "autoFactory" | "customFactory";
-  routerType?: "none" | "plugin" | "dynamic";
+  routerType?: "none" | "plugin" | "dynamic" | "modular";
   networksForDeployment?: {
     allNetworks?: boolean;
     networksEnabled?: number[];

package/src/version.ts

@@ -1 +1 @@
-export const version = "5.29.1";
+export const version = "5.29.2-nightly-fb6a07d4b84ba8ea6389ca04c73625f670a0d9c4-20240614172741";