added missing storage slot test, interface doc, updated solhint

Author: d10r

packages/ethereum-contracts/.solhint.json

@@ -16,6 +16,16 @@
         "constructor-syntax": "error",
         "func-visibility": ["error", { "ignoreConstructors": true }],
         "quotes": ["error", "double"],
-        "max-line-length": ["error", 120]
+        "max-line-length": ["error", 120],
+	"use-natspec": "off",
+	"import-path-check": "off",
+	"gas-indexed-events": "off",
+	"gas-struct-packing": "off",
+	"gas-small-strings": "off",
+	"gas-increment-by-one": "off",
+	"gas-strict-inequalities": "off",
+	"gas-calldata-parameters": "off",
+	"function-max-lines": "off",
+	"contract-name-capwords": "off"
     }
 }

packages/ethereum-contracts/contracts/agreements/AgreementLibrary.sol

@@ -7,7 +7,6 @@ import {
     ISuperApp,
     SuperAppDefinitions
 } from "../interfaces/superfluid/ISuperfluid.sol";
-import { ISuperfluidToken } from "../interfaces/superfluid/ISuperfluidToken.sol";
 
 import { SafeCast } from "@openzeppelin-v5/contracts/utils/math/SafeCast.sol";
 

packages/ethereum-contracts/contracts/interfaces/superfluid/ISuperToken.sol

@@ -68,9 +68,18 @@ interface ISuperToken is ISuperfluidToken, IERC20Metadata, IERC777, IERC20Permit
 
     /**
      * @dev Returns the admin address for the SuperToken
+     * The admin account has the exclusive privilege of
+     * - updating the contract (change implementation)
+     * - enabling/disabling a yield backend
+     * - setting another admin
+     * If no admin is set (zero address), this privileges are delegated to the host contract.
      */
     function getAdmin() external view returns (address admin);
 
+    /**
+     * @dev Returns the address of the yield backend contract (see `IYieldBackend`).
+     * The yield backend contract is responsible for managing the yield of the SuperToken.
+     */
     function getYieldBackend() external view returns (address yieldBackend);
 
     /**************************************************************************

packages/ethereum-contracts/contracts/libs/YieldBackendHelperLib.sol

@@ -11,6 +11,7 @@ import { IYieldBackend } from "../interfaces/superfluid/IYieldBackend.sol";
  */
 library YieldBackendHelperLib {
     function dCall(IYieldBackend yieldBackend, bytes memory callData) internal {
+        // solhint-disable-next-line avoid-low-level-calls
         (bool success,) = address(yieldBackend).delegatecall(callData);
         require(success, "yield backend delegatecall failed");
     }

packages/ethereum-contracts/contracts/mocks/SuperTokenMock.t.sol

@@ -64,6 +64,12 @@ contract SuperTokenStorageLayoutTester is SuperToken {
         require (slot == 18 && offset == 0, "_operators changed location");
         // uses 4 slots
 
+        assembly { slot:= _nonces.slot offset := _nonces.offset }
+        require (slot == 22 && offset == 0, "_nonces changed location");
+
+        assembly { slot:= _yieldBackend.slot offset := _yieldBackend.offset }
+        require (slot == 23 && offset == 0, "_yieldBackend changed location");
+
         assembly { slot:= _reserve24.slot offset := _reserve24.offset }
         require (slot == 24 && offset == 0, "_reserve24 changed location");