chore: improve code docs

docs/plugin/DeployOptions.md

@@ -0,0 +1,11 @@
+# DeployOptions
+
+```ts
+export interface DeployOptions {
+  salt?: MatchPrimitiveType<"bytes32", unknown>;
+  isUniquePerChain?: boolean;
+  customNonPayableTxOptions?: NonPayableCallOptions;
+}
+```
+
+### TODO

docs/plugin/NetworkArguments.md

@@ -0,0 +1,10 @@
+# NetworkArguments
+
+```ts
+interface NetworkArgument<Abi extends ContractAbi = any> {
+  args: ContractConstructorArgs<Abi>;
+  initData?: string;
+}
+```
+
+### TODO

packages/plugin/src/MultichainHardhatRuntimeEnvironmentField.ts

@@ -59,13 +59,15 @@ export class MultichainHardhatRuntimeEnvironmentField {
   }
 
   /**
-   * @param contractName name of the contract
-   * @param networkArgs record key is name of the networks on which contract is being deployed
-   * @param args contract contructor args
-   * @param initData optional encoded initilize method, can be encoded with encodeInitData
-   * @param salt optional or generated by default from randombytes(32)
-   * @param isUniquePerChain optional
-   * @param customNonPayableTxOptions non payable options for web3 deploy.method.send(), payable summed fees are always calculated by the method
+   * Deploys a contract to multiple blockchain networks.
+   *
+   * @param contractName - The name of the contract to be deployed.
+   * @param networkArgs - An object mapping network identifiers to their deployment arguments. Each network can have unique settings for the deployment. See [NetworkArguments]{@link https://github.com/ChainSafe/hardhat-plugin-multichain-deploy/docs/plugin/NetworkArguments}.
+   * @param options - Optional settings for the deployment process. These can include various configurations specific to the deployment. See [DeployOptions]{@link https://github.com/ChainSafe/hardhat-plugin-multichain-deploy/docs/plugin/DeployOptions}.
+   * @returns A Promise resolving to a Transaction object or void.
+   *
+   * @example
+   * // TODO
    */
   public async deployMultichain<Abi extends ContractAbi = any>(
     contractName: string,
@@ -82,6 +84,18 @@ export class MultichainHardhatRuntimeEnvironmentField {
     );
   }
 
+  /**
+   * Deploys a contract using its bytecode and ABI to multiple blockchain networks.
+   *
+   * @param contractBytecode - The bytecode of the contract to be deployed. This is the compiled code of the contract.
+   * @param contractAbi - The ABI (Application Binary Interface) of the contract. It defines the methods and structures used to interact with the binary contract.
+   * @param networkArgs - An object mapping network identifiers to their deployment arguments. Each network can have unique settings for the deployment. See [NetworkArguments]{@link https://github.com/ChainSafe/hardhat-plugin-multichain-deploy/docs/plugin/NetworkArguments}.
+   * @param options - Optional settings for the deployment process. These can include various configurations specific to the deployment. See [DeployOptions]{@link https://github.com/ChainSafe/hardhat-plugin-multichain-deploy/docs/plugin/DeployOptions}.
+   * @returns A Promise resolving to a Transaction object or void.
+   *
+   * @example
+   * // TODO: Add example usage
+   */
   public async deployMultichainBytecode<Abi extends ContractAbi = any>(
     contractBytecode: string,
     contractAbi: Abi,

packages/plugin/src/types.ts

@@ -5,13 +5,31 @@ import {
   NonPayableCallOptions,
 } from "web3";
 
+/**
+ * NetworkArgument
+ * @property args - Indicates whether args is providing.
+ * @property initData - Indicates whether the init data.
+ */
+interface NetworkArgument<Abi extends ContractAbi = any> {
+  args: ContractConstructorArgs<Abi>;
+  initData?: string;
+}
+
+/**
+ * NetworkArguments
+ * @property [network] - NetworkArgument
+ */
 export interface NetworkArguments<Abi extends ContractAbi = any> {
-  [network: string]: {
-    args: ContractConstructorArgs<Abi>;
-    initData?: string;
-  };
+  [network: string]: NetworkArgument<Abi>;
 }
 
+/**
+ * Options used for contract deployment
+ *
+ * @property [salt] - Indicates whether salt is present, as Uint8Array or HexString.
+ * @property [isUniquePerChain] - Indicates whether contract address is uniq per deployment.
+ * @property [customNonPayableTxOptions] - Indicates whether the Wisdom component is present.
+ */
 export interface DeployOptions {
   salt?: MatchPrimitiveType<"bytes32", unknown>;
   isUniquePerChain?: boolean;