docs: cleanup jsdocs

Author: gregfromstl

packages/thirdweb/src/contract/deployment/utils/bootstrap.ts

@@ -34,7 +34,7 @@ import {
  * @returns An object containing:
  * - cloneFactoryContract: The factory contract used for creating clones
  * - implementationContract: The deployed implementation contract
- * @internal
+ * @contract
  */
 export async function getOrDeployInfraForPublishedContract(
   args: ClientAndChainAndAccount & {

packages/thirdweb/src/contract/deployment/utils/clone-factory.ts

@@ -2,14 +2,11 @@ import type { ClientAndChain } from "../../../utils/types.js";
 import { getDeployedInfraContract } from "./infra.js";
 
 /**
- * @internal
  * Retrieves the deployed clone factory contract instance if available
  * @param args - Client and chain information required to locate the contract
  * @returns Promise that resolves to the clone factory contract instance if deployed, null otherwise
- * @remarks
- * This function performs two checks:
- * 1. Verifies if the Forwarder contract is deployed
- * 2. If Forwarder exists, checks if TWCloneFactory is deployed with the Forwarder address
+ *
+ * @contract
  */
 export async function getDeployedCloneFactoryContract(args: ClientAndChain) {
   // check if Forwarder is deployed

packages/thirdweb/src/contract/deployment/utils/infra.ts

@@ -28,7 +28,6 @@ type GetDeployedInfraParams = Prettify<
 >;
 
 /**
- * @internal
  * Retrieves a deployed infrastructure contract instance for the specified contract ID
  * @param options - Configuration options for locating the infrastructure contract
  * @param options.client - ThirdwebClient instance
@@ -38,9 +37,6 @@ type GetDeployedInfraParams = Prettify<
  * @param options.publisher - Optional custom publisher address
  * @param options.version - Optional specific contract version to retrieve
  * @returns Promise that resolves to the contract instance if deployed, null otherwise
- * @remarks
- * This function fetches published contract metadata and attempts to locate an existing deployment
- * of the specified infrastructure contract on the target chain
  */
 export async function getDeployedInfraContract(
   options: GetDeployedInfraParams,

packages/thirdweb/src/exports/deploys.ts

@@ -54,3 +54,9 @@ export {
   type DeployPackContractOptions,
   deployPackContract,
 } from "../extensions/prebuilts/deploy-pack.js";
+
+export { getDeployedCloneFactoryContract } from "../contract/deployment/utils/clone-factory.js";
+export { getDeployedInfraContract } from "../contract/deployment/utils/infra.js";
+export { getAllDefaultConstructorParamsForImplementation } from "../extensions/prebuilts/get-required-transactions.js";
+export { getInitializeTransaction } from "../extensions/prebuilts/deploy-published.js";
+export { getOrDeployInfraForPublishedContract } from "../contract/deployment/utils/bootstrap.js";

packages/thirdweb/src/extensions/prebuilts/deploy-published.ts

@@ -291,7 +291,7 @@ async function directDeploy(options: {
  * @param options.modules[].deployMetadata - The metadata for the module contract
  * @param options.modules[].initializeParams - Optional parameters for module initialization
  * @returns The prepared transaction for contract initialization
- * @internal
+ * @contract
  */
 export async function getInitializeTransaction(options: {
   client: ThirdwebClient;

packages/thirdweb/src/extensions/prebuilts/get-required-transactions.ts

@@ -54,40 +54,40 @@ export async function getRequiredTransactions(
       isZkSync
         ? null
         : getDeployedCreate2Factory({
-            chain,
-            client,
-          }).then((c) =>
-            c
-              ? null
-              : ({ type: "infra", contractId: "Create2Factory" } as const),
-          ),
+          chain,
+          client,
+        }).then((c) =>
+          c
+            ? null
+            : ({ type: "infra", contractId: "Create2Factory" } as const),
+        ),
       isZkSync
         ? null
         : getDeployedInfraContract({
-            chain,
-            client,
-            contractId: "Forwarder",
-          }).then((c) =>
-            c ? null : ({ type: "infra", contractId: "Forwarder" } as const),
-          ),
+          chain,
+          client,
+          contractId: "Forwarder",
+        }).then((c) =>
+          c ? null : ({ type: "infra", contractId: "Forwarder" } as const),
+        ),
       isZkSync
         ? null
         : getDeployedInfraContract({
-            chain,
-            client,
-            contractId: "TWCloneFactory",
-            constructorParams: {
-              _trustedForwarder: await computePublishedContractAddress({
-                chain,
-                client,
-                contractId: "Forwarder",
-              }),
-            },
-          }).then((c) =>
-            c
-              ? null
-              : ({ type: "infra", contractId: "TWCloneFactory" } as const),
-          ),
+          chain,
+          client,
+          contractId: "TWCloneFactory",
+          constructorParams: {
+            _trustedForwarder: await computePublishedContractAddress({
+              chain,
+              client,
+              contractId: "Forwarder",
+            }),
+          },
+        }).then((c) =>
+          c
+            ? null
+            : ({ type: "infra", contractId: "TWCloneFactory" } as const),
+        ),
       // TODO (deploy): add WETH contract check for implementations that need it (check implementation constructor params)
       getTransactionsForImplementation({
         chain,
@@ -104,9 +104,9 @@ export async function getRequiredTransactions(
           c
             ? null
             : ({
-                type: "module",
-                contractId: m.deployMetadata.name,
-              } as const),
+              type: "module",
+              contractId: m.deployMetadata.name,
+            } as const),
         ),
       ),
     ]);
@@ -148,9 +148,9 @@ async function getTransactionsForImplementation(options: {
     c
       ? null
       : ({
-          type: "implementation",
-          contractId: deployMetadata.name,
-        } as const),
+        type: "implementation",
+        contractId: deployMetadata.name,
+      } as const),
   );
   return result ? [result] : [];
 }
@@ -217,7 +217,8 @@ async function getTransactionsForMaketplaceV3(options: {
  * @returns An object containing default constructor parameters:
  * - On zkSync chains: returns an empty object since no parameters are needed
  * - On other chains: returns `trustedForwarder` and `nativeTokenWrapper` addresses
- * @internal
+ *
+ * @contract
  */
 export async function getAllDefaultConstructorParamsForImplementation(args: {
   chain: Chain;