Skip to content

Commit aa3d3cb

Browse files
committed
docs: Add comprehensive JSDoc for getDeployedInfraContract function
1 parent 99e748d commit aa3d3cb

File tree

1 file changed

+12
-0
lines changed
  • packages/thirdweb/src/contract/deployment/utils

1 file changed

+12
-0
lines changed

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,18 @@ type GetDeployedInfraParams = Prettify<
2929

3030
/**
3131
* @internal
32+
* Retrieves a deployed infrastructure contract instance for the specified contract ID
33+
* @param options - Configuration options for locating the infrastructure contract
34+
* @param options.client - ThirdwebClient instance
35+
* @param options.chain - Target blockchain network
36+
* @param options.contractId - Identifier for the infrastructure contract (e.g. "WETH9", "Forwarder")
37+
* @param options.constructorParams - Optional constructor parameters for contract initialization
38+
* @param options.publisher - Optional custom publisher address
39+
* @param options.version - Optional specific contract version to retrieve
40+
* @returns Promise that resolves to the contract instance if deployed, null otherwise
41+
* @remarks
42+
* This function fetches published contract metadata and attempts to locate an existing deployment
43+
* of the specified infrastructure contract on the target chain
3244
*/
3345
export async function getDeployedInfraContract(
3446
options: GetDeployedInfraParams,

0 commit comments

Comments
 (0)