constructor documentation

bgd-labs · Jan 19, 2024 · 10cfee6 · 10cfee6
1 parent aa4a18b
commit 10cfee6
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/src/contracts/PriceCapAdapterStable.sol b/src/contracts/PriceCapAdapterStable.sol
@@ -23,16 +23,22 @@ contract PriceCapAdapterStable is IPriceCapAdapterStable {
 
   int256 internal _priceCap;
 
+  /**
+   * @param aclManager ACL manager contract
+   * @param assetToUsdAggregator the address of (underlyingAsset / USD) price feed
+   * @param adapterDescription the capped (lstAsset / underlyingAsset) pair description
+   * @param priceCap the price cap
+   */
   constructor(
     IACLManager aclManager,
-    IChainlinkAggregator baseToUsdAggregator,
+    IChainlinkAggregator assetToUsdAggregator,
     string memory adapterDescription,
     int256 priceCap
   ) {
-    ASSET_TO_USD_AGGREGATOR = baseToUsdAggregator;
+    ASSET_TO_USD_AGGREGATOR = assetToUsdAggregator;
     ACL_MANAGER = aclManager;
     description = adapterDescription;
-    decimals = baseToUsdAggregator.decimals();
+    decimals = assetToUsdAggregator.decimals();
 
     _setPriceCap(priceCap);
   }