Skip to content

Commit 58e55f8

Browse files
committed
docs: Add comprehensive JSDoc for getInitializeTransaction function
1 parent b04c059 commit 58e55f8

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,21 @@ async function directDeploy(options: {
278278
});
279279
}
280280

281+
/**
282+
* Prepares the initialization transaction for a contract deployment
283+
* @param options - The options for generating the initialize transaction
284+
* @param options.client - The ThirdwebClient instance
285+
* @param options.chain - The blockchain network configuration
286+
* @param options.account - The account performing the initialization
287+
* @param options.implementationContract - The contract implementation to initialize
288+
* @param options.deployMetadata - The metadata for the contract deployment
289+
* @param options.initializeParams - Optional parameters to pass to the initialize function
290+
* @param options.modules - Optional array of modules to install during initialization
291+
* @param options.modules[].deployMetadata - The metadata for the module contract
292+
* @param options.modules[].initializeParams - Optional parameters for module initialization
293+
* @returns The prepared transaction for contract initialization
294+
* @internal
295+
*/
281296
export async function getInitializeTransaction(options: {
282297
client: ThirdwebClient;
283298
chain: Chain;

0 commit comments

Comments
 (0)