chore: add jdocs

paraswap · Jan 29, 2025 · 0a2ddba · 0a2ddba
1 parent ed5740b
commit 0a2ddba
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/tests/tenderly-simulation-new.ts b/tests/tenderly-simulation-new.ts
@@ -348,6 +348,12 @@ export class TenderlySimulatorNew {
     };
   }
 
+  /**
+   * Finds the slot of the `balanceOf` mapping in given token contract's storage.
+   * Supports `Solidity` and `Vyper` contracts
+   * @param chainId token chain id
+   * @param token token address
+   */
   async findTokenBalanceOfSlot(
     chainId: number,
     token: string,
@@ -419,6 +425,12 @@ export class TenderlySimulatorNew {
     );
   }
 
+  /**
+   * Finds the slot of the `allowance` mapping in given token contract's storage
+   * Supports `Solidity` and `Vyper` contracts
+   * @param chainId token chain id
+   * @param token token address
+   */
   async findTokenAllowanceSlot(
     chainId: number,
     token: string,
@@ -495,6 +507,11 @@ export class TenderlySimulatorNew {
     );
   }
 
+  /**
+   * Returns storage slots for the given token contract.
+   * @param chainId Token chain ID
+   * @param token Token address. Doesn't have to be normalized
+   */
   async getTokenStorageSlots(
     chainId: number,
     token: string,