chore: add jsdoc for getStakedBalanceForChain

MetaMask · Nov 1, 2024 · 7eeffae · 7eeffae
1 parent f3a3c2e
commit 7eeffae
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/assets-controllers/src/AssetsContractController.ts b/packages/assets-controllers/src/AssetsContractController.ts
@@ -703,6 +703,13 @@ export class AssetsContractController {
     return nonZeroBalances;
   }
 
+  /**
+   * Get the staked ethereum balance for an address in a single call.
+   *
+   * @param address - The address to check staked ethereum balance for.
+   * @param networkClientId - Network Client ID to fetch the provider with.
+   * @returns The hex staked ethereum balance for address.
+   */
   async getStakedBalanceForChain(
     address: string,
     networkClientId?: NetworkClientId,