docs: fix warnings for jsdoc comments (#518)

src/lib/assetBridger/erc20Bridger.ts

@@ -899,9 +899,11 @@ export class Erc20Bridger extends AssetBridger<
 
   /**
    * Checks if the token has been properly registered on both gateways. Mostly useful for tokens that use a custom gateway.
-   * @param erc20ParentAddress
-   * @param parentProvider
-   * @param childProvider
+   *
+   * @param {Object} params
+   * @param {string} params.erc20ParentAddress
+   * @param {Provider} params.parentProvider
+   * @param {Provider} params.childProvider
    * @returns
    */
   public async isRegistered({
@@ -1170,9 +1172,9 @@ export class AdminErc20Bridger extends Erc20Bridger {
 
   /**
    * Get all the gateway set events on the Parent gateway router
-   * @param parentProvider
-   * @param customNetworkParentGatewayRouter
-   * @returns
+   * @param parentProvider The provider for the parent network
+   * @param filter An object containing fromBlock and toBlock to filter events
+   * @returns An array of GatewaySetEvent event arguments
    */
   public async getParentGatewaySetEvents(
     parentProvider: Provider,
@@ -1193,25 +1195,27 @@ export class AdminErc20Bridger extends Erc20Bridger {
   }
 
   /**
-   * Get all the gateway set events on the L2 gateway router
-   * @param parentProvider
-   * @param customNetworkParentGatewayRouter
-   * @returns
+   * Get all the gateway set events on the child gateway router
+   * @param childProvider The provider for the child network
+   * @param filter An object containing fromBlock and toBlock to filter events
+   * @param customNetworkChildGatewayRouter Optional address of the custom network child gateway router
+   * @returns An array of GatewaySetEvent event arguments
+   * @throws {ArbSdkError} If the network is custom and customNetworkChildGatewayRouter is not provided
    */
   public async getChildGatewaySetEvents(
     childProvider: Provider,
     filter: { fromBlock: BlockTag; toBlock: BlockTag },
-    customNetworkL2GatewayRouter?: string
+    customNetworkChildGatewayRouter?: string
   ): Promise<EventArgs<GatewaySetEvent>[]> {
-    if (this.childNetwork.isCustom && !customNetworkL2GatewayRouter) {
+    if (this.childNetwork.isCustom && !customNetworkChildGatewayRouter) {
       throw new ArbSdkError(
-        'Must supply customNetworkL2GatewayRouter for custom network '
+        'Must supply customNetworkChildGatewayRouter for custom network '
       )
     }
     await this.checkChildNetwork(childProvider)
 
     const childGatewayRouterAddress =
-      customNetworkL2GatewayRouter ||
+      customNetworkChildGatewayRouter ||
       this.childNetwork.tokenBridge.childGatewayRouter
 
     const eventFetcher = new EventFetcher(childProvider)

src/lib/inbox/inbox.ts

@@ -418,7 +418,7 @@ export class InboxTools {
    * Sign a transaction with msg.to, msg.value and msg.data.
    * You can use this as a helper to call inboxTools.sendChainSignedMessage
    * above.
-   * @param message A signed transaction which can be sent directly to chain,
+   * @param txRequest A signed transaction which can be sent directly to chain,
    * tx.to, tx.data, tx.value must be provided when not contract creation, if
    * contractCreation is true, no need provide tx.to. tx.gasPrice and tx.nonce
    * can be overrided. (You can also send contract creation transaction by set tx.to

src/lib/message/ChildToParentMessage.ts

@@ -69,9 +69,9 @@ export class ChildToParentMessage {
   /**
    * Instantiates a new `ChildToParentMessageWriter` or `ChildToParentMessageReader` object.
    *
-   * @param {SignerOrProvider} ParentSignerOrProvider Signer or provider to be used for executing or reading the Child-to-Parent message.
+   * @param {SignerOrProvider} parentSignerOrProvider Signer or provider to be used for executing or reading the Child-to-Parent message.
    * @param {ChildToParentTransactionEvent} event The event containing the data of the Child-to-Parent message.
-   * @param {Provider} [ParentProvider] Optional. Used to override the Provider which is attached to `ParentSignerOrProvider` in case you need more control. This will be a required parameter in a future major version update.
+   * @param {Provider} [parentProvider] Optional. Used to override the Provider which is attached to `ParentSignerOrProvider` in case you need more control. This will be a required parameter in a future major version update.
    */
   public static fromEvent<T extends SignerOrProvider>(
     parentSignerOrProvider: T,
@@ -289,9 +289,9 @@ export class ChildToParentMessageWriter extends ChildToParentMessageReader {
   /**
    * Instantiates a new `ChildToParentMessageWriter` object.
    *
-   * @param {Signer} ParentSigner The signer to be used for executing the Child-to-Parent message.
+   * @param {Signer} parentSigner The signer to be used for executing the Child-to-Parent message.
    * @param {ChildToParentTransactionEvent} event The event containing the data of the Child-to-Parent message.
-   * @param {Provider} [ParentProvider] Optional. Used to override the Provider which is attached to `ParentSigner` in case you need more control. This will be a required parameter in a future major version update.
+   * @param {Provider} [parentProvider] Optional. Used to override the Provider which is attached to `parentSigner` in case you need more control. This will be a required parameter in a future major version update.
    */
   constructor(
     parentSigner: Signer,

src/lib/message/ChildToParentMessageClassic.ts

@@ -333,7 +333,7 @@ export class ChildToParentMessageReaderClassic extends ChildToParentMessageClass
   /**
    * Get the status of this message
    * In order to check if the message has been executed proof info must be provided.
-   * @param proofInfo
+   * @param childProvider
    * @returns
    */
   public async status(

src/lib/message/ChildToParentMessageNitro.ts

@@ -524,8 +524,8 @@ export class ChildToParentMessageReaderNitro extends ChildToParentMessageNitro {
 
   /**
    * Check whether the provided network has a BoLD rollup
-   * @param l2Network
-   * @param l1Provider
+   * @param arbitrumNetwork
+   * @param parentProvider
    * @returns
    */
   private async isBold(

src/lib/message/ChildTransaction.ts

@@ -114,7 +114,7 @@ export class ChildTransactionReceipt implements TransactionReceipt {
 
   /**
    * Get any child-to-parent-messages created by this transaction
-   * @param l2SignerOrProvider
+   * @param parentSignerOrProvider
    */
   public async getChildToParentMessages<T extends SignerOrProvider>(
     parentSignerOrProvider: T

src/lib/message/ParentTransaction.ts

@@ -186,7 +186,7 @@ export class ParentTransactionReceipt implements TransactionReceipt {
 
   /**
    * Get any eth deposit messages created by this transaction
-   * @param childSignerOrProvider
+   * @param childProvider
    */
   public async getEthDeposits(
     childProvider: Provider