Merge pull request #196 from skalenetwork/release-1.0.1

Release 1.0.1
skalenetwork · Oct 24, 2024 · 38b204f · 38b204f
2 parents a8a2555 + 4e389c5
commit 38b204f
Show file tree

Hide file tree

Showing 18 changed files with 367 additions and 415 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -53,7 +53,7 @@ jobs:
         echo "PRERELEASE=$PRERELEASE" >> $GITHUB_ENV
 
     - name: Generate ABI
-      run: npx hardhat run scripts/generateAbi.ts
+      run: yarn exec hardhat run scripts/generateAbi.ts
 
     - name: Store artifacts
       uses: actions/upload-artifact@v4
@@ -65,6 +65,7 @@ jobs:
       uses: ncipollo/release-action@v1
       with:
         tag: ${{ env.VERSION }}
+        commit: ${{ github.sha }}
         prerelease: ${{ env.PRERELEASE }}
         artifacts: "data/*-abi.json"
 

diff --git a/.solhint.json b/.solhint.json
@@ -1,6 +1,7 @@
 {
   "extends": "solhint:all",
   "rules": {
+    "foundry-test-functions": "off",
     "not-rely-on-time": "off",
 
     "code-complexity": "error",
@@ -14,8 +15,14 @@
       }
     ],
     "function-max-lines": "error",
+    "gas-increment-by-one": "error",
+    "gas-indexed-events": "error",
+    "gas-length-in-loops": "error",
+    "gas-strict-inequalities": "error",
+    "imports-order": "error",
     "max-line-length": ["error", 100],
     "max-states-count": "error",
+    "named-parameters-mapping": "error",
     "no-empty-blocks": "error",
     "no-global-import": "error",
     "no-unused-import": "error",

diff --git a/contracts/Paymaster.sol b/contracts/Paymaster.sol
@@ -23,24 +23,25 @@ pragma solidity ^0.8.19;
 
 // cspell:words structs IERC20
 
-import {IERC20} from "@openzeppelin/contracts/interfaces/IERC20.sol";
-import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
-import {AccessManagedUpgradeable}
+import { AccessManagedUpgradeable }
 from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
-
-import {
-    SchainPriceIsNotSet,
-    SkaleTokenIsNotSet,
-    SklPriceIsNotSet,
-    SklPriceIsOutdated
-} from "./errors/Parameters.sol";
+import { IERC20 } from "@openzeppelin/contracts/interfaces/IERC20.sol";
+import { EnumerableSet }
+from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
+import { DateTimeUtils, Seconds, Timestamp, Months }
+from "@skalenetwork/paymaster-interfaces/DateTimeUtils.sol";
+import { IPaymaster, SchainHash, USD, ValidatorId }
+from "@skalenetwork/paymaster-interfaces/IPaymaster.sol";
+import { SKL } from "@skalenetwork/paymaster-interfaces/types/Skl.sol";
+import { SchainPriceIsNotSet, SkaleTokenIsNotSet, SklPriceIsNotSet, SklPriceIsOutdated }
+from "./errors/Parameters.sol";
 import {
     ReplenishmentPeriodIsTooBig,
     ReplenishmentPeriodIsTooSmall,
     TooSmallAllowance,
     TransferFailure
 } from "./errors/Replenishment.sol";
-import {SchainNotFound, SchainAddingError, SchainDeletionError} from "./errors/Schain.sol";
+import { SchainNotFound, SchainAddingError, SchainDeletionError } from "./errors/Schain.sol";
 import {
     ValidatorNotFound,
     ValidatorAddingError,
@@ -49,22 +50,9 @@ import {
     ValidatorDeletionError,
     ValidatorHasBeenRemoved
 } from "./errors/Validator.sol";
-import {
-    IPaymaster,
-    SchainHash,
-    USD,
-    ValidatorId
-} from "@skalenetwork/paymaster-interfaces/IPaymaster.sol";
-import {TypedMap} from "./structs/typed/TypedMap.sol";
-import {SKL} from "@skalenetwork/paymaster-interfaces/types/Skl.sol";
-import {
-    DateTimeUtils,
-    Seconds,
-    Timestamp,
-    Months
-} from "@skalenetwork/paymaster-interfaces/DateTimeUtils.sol";
-import {SequenceLibrary} from "./Sequence.sol";
-import {TimelineLibrary} from "./Timeline.sol";
+import { SequenceLibrary } from "./Sequence.sol";
+import { TypedMap } from "./structs/typed/TypedMap.sol";
+import { TimelineLibrary } from "./Timeline.sol";
 
 
 contract Paymaster is AccessManagedUpgradeable, IPaymaster {
@@ -106,7 +94,7 @@ contract Paymaster is AccessManagedUpgradeable, IPaymaster {
         TypedMap.AddressToValidatorIdMap addressToValidatorId;
     }
 
-    mapping(SchainHash => Schain) public schains;
+    mapping(SchainHash schainHash => Schain schain) public schains;
     EnumerableSet.Bytes32Set private _schainHashes;
 
     ValidatorData private _validatorData;
@@ -121,7 +109,7 @@ contract Paymaster is AccessManagedUpgradeable, IPaymaster {
     TimelineLibrary.Timeline private _totalRewards;
     SequenceLibrary.Sequence private _totalNodesHistory;
 
-    mapping (DebtId => Payment) public debts;
+    mapping (DebtId debtId => Payment payment) public debts;
     DebtId public debtsBegin;
     DebtId public debtsEnd;
 
@@ -451,8 +439,9 @@ contract Paymaster is AccessManagedUpgradeable, IPaymaster {
     }
 
     function getSchainsNames() external view override returns (string[] memory names) {
-        names = new string[](getSchainsNumber());
-        for (uint256 i = 0; i < names.length; ++i) {
+        uint256 length = getSchainsNumber();
+        names = new string[](length);
+        for (uint256 i = 0; i < length; ++i) {
             names[i] = _getSchain(SchainHash.wrap(_schainHashes.at(i))).name;
         }
     }
@@ -523,7 +512,7 @@ contract Paymaster is AccessManagedUpgradeable, IPaymaster {
                 firstUnpaidDebt = validator.firstUnpaidDebt;
             }
             validator.nodesHistory.clear(before);
-            if (Timestamp.wrap(0) != validator.deleted && validator.deleted <= before) {
+            if (Timestamp.wrap(0) != validator.deleted && !(validator.deleted > before)) {
                 _removeValidator(validator);
             }
         }
@@ -631,12 +620,12 @@ contract Paymaster is AccessManagedUpgradeable, IPaymaster {
         returns (bool debtWasCreated)
     {
         debtWasCreated = false;
-        if (current <= payment.from) {
+        if (!(current > payment.from)) {
             // payment for the future
             _totalRewards.add(payment.from, payment.to, SKL.unwrap(payment.amount));
         } else {
             debtWasCreated = true;
-            if (payment.to <= current) {
+            if (!(payment.to > current)) {
                 // payment for the past
                 _addDebt(
                     payment,
@@ -875,7 +864,7 @@ contract Paymaster is AccessManagedUpgradeable, IPaymaster {
         returns (uint256 newNodesNumber)
     {
         newNodesNumber = currentNodesNumber;
-        while (nodesIterator.hasNext() && nodesIterator.nextTimestamp <= cursor) {
+        while (nodesIterator.hasNext() && !(nodesIterator.nextTimestamp > cursor)) {
             if (nodesIterator.step(nodesHistory)) {
                 newNodesNumber = nodesHistory.getValue(nodesIterator);
             }

diff --git a/contracts/Sequence.sol b/contracts/Sequence.sol
@@ -67,7 +67,7 @@ library SequenceLibrary {
     function add(Sequence storage sequence, Timestamp timestamp, uint256 value) internal {
         uint256 length = sequence.ids.length();
         if (length > 0) {
-            if (timestamp <= _getNodeByIndex(sequence, length - 1).timestamp) {
+            if (!(timestamp > _getNodeByIndex(sequence, length - 1).timestamp)) {
                 revert CannotAddToThePast();
             }
         }
@@ -143,7 +143,7 @@ library SequenceLibrary {
         if(iterator.idIndex == _BEFORE_FIRST_ELEMENT) {
             return 0;
         }
-        if(iterator.idIndex >= iterator.sequenceSize) {
+        if(!(iterator.idIndex < iterator.sequenceSize)) {
             return _getNodeByIndex(sequence, iterator.sequenceSize - 1).value;
         }
         return _getNodeByIndex(sequence, iterator.idIndex).value;
@@ -187,7 +187,7 @@ library SequenceLibrary {
         if (iterator.idIndex == _BEFORE_FIRST_ELEMENT) {
             iterator.idIndex = 0;
         } else {
-            iterator.idIndex += 1;
+            ++iterator.idIndex;
         }
         if (iterator.idIndex + 1 < iterator.sequenceSize) {
             iterator.nextTimestamp = _getNodeByIndex(sequence, iterator.idIndex + 1).timestamp;

diff --git a/contracts/Timeline.sol b/contracts/Timeline.sol
@@ -23,13 +23,13 @@ pragma solidity ^0.8.19;
 
 // cspell:words deque structs
 
-import {TypedDoubleEndedQueue} from "./structs/typed/TypedDoubleEndedQueue.sol";
-import {TypedPriorityQueue} from "./structs/typed/TypedPriorityQueue.sol";
 import {
     DateTimeUtils,
     Seconds,
     Timestamp
 } from "@skalenetwork/paymaster-interfaces/DateTimeUtils.sol";
+import {TypedDoubleEndedQueue} from "./structs/typed/TypedDoubleEndedQueue.sol";
+import {TypedPriorityQueue} from "./structs/typed/TypedPriorityQueue.sol";
 
 
 library TimelineLibrary {
@@ -85,7 +85,7 @@ library TimelineLibrary {
     // Library internal functions should not have leading underscore
     // solhint-disable-next-line private-vars-leading-underscore
     function process(Timeline storage timeline, Timestamp until) internal {
-        if (until <= timeline.processedUntil) {
+        if (!(timeline.processedUntil < until)) {
             return;
         }
 
@@ -176,7 +176,7 @@ library TimelineLibrary {
             valuesAmount > 0;
             --valuesAmount
         ) {
-            if (before <= _getValueByIndex(timeline, 0).timestamp) {
+            if (!(before > _getValueByIndex(timeline, 0).timestamp)) {
                 break;
             }
             ValueId valueId = timeline.valuesQueue.popFront();
@@ -246,7 +246,7 @@ library TimelineLibrary {
             return 0;
         }
         Timestamp firstValueTimestamp = _getValueByIndex(timeline, 0).timestamp;
-        if (to <= firstValueTimestamp) {
+        if (!(to > firstValueTimestamp)) {
             return 0;
         }
         if (from < firstValueTimestamp) {
@@ -406,14 +406,14 @@ library TimelineLibrary {
         if (timestamp < _getValueByIndex(timeline, 0).timestamp) {
             revert TimestampIsOutOfValues();
         }
-        if (_getCurrentValue(timeline).timestamp <= timestamp) {
+        if (!(_getCurrentValue(timeline).timestamp > timestamp)) {
             return timeline.valuesQueue.length() - 1;
         }
         uint256 left = 0;
         uint256 right = timeline.valuesQueue.length() - 1;
         while (left + 1 < right) {
             uint256 middle = (left + right) / 2;
-            if (_getValueByIndex(timeline, middle).timestamp <= timestamp) {
+            if (!(_getValueByIndex(timeline, middle).timestamp > timestamp)) {
                 left = middle;
             } else {
                 right = middle;
@@ -424,7 +424,7 @@ library TimelineLibrary {
 
     function _createValue(Timeline storage timeline, Value memory value) private {
         if(!timeline.valuesQueue.empty() &&
-            value.timestamp <= _getCurrentValue(timeline).timestamp) {
+            !(value.timestamp > _getCurrentValue(timeline).timestamp)) {
             revert CannotSetValueInThePast();
         }
         ValueId valuesEnd = timeline.valuesEnd;

diff --git a/contracts/errors/Validator.sol b/contracts/errors/Validator.sol
@@ -21,8 +21,8 @@
 
 pragma solidity ^0.8.18;
 
-import {ValidatorId} from "@skalenetwork/paymaster-interfaces/IPaymaster.sol";
 import {Timestamp} from "@skalenetwork/paymaster-interfaces/DateTimeUtils.sol";
+import {ValidatorId} from "@skalenetwork/paymaster-interfaces/IPaymaster.sol";
 
 
 error ValidatorNotFound(

diff --git a/contracts/interfaces/test/IFastForwardPaymaster.sol b/contracts/interfaces/test/IFastForwardPaymaster.sol
@@ -21,8 +21,8 @@
 
 pragma solidity ^0.8.18;
 
-import {Seconds, Timestamp} from "../../Paymaster.sol";
-import {IPaymaster} from "@skalenetwork/paymaster-interfaces/IPaymaster.sol";
+import { IPaymaster } from "@skalenetwork/paymaster-interfaces/IPaymaster.sol";
+import { Seconds, Timestamp } from "./../../Paymaster.sol";
 
 
 interface IFastForwardPaymaster is IPaymaster {

diff --git a/contracts/structs/Heap.sol b/contracts/structs/Heap.sol
@@ -40,11 +40,11 @@ library HeapLibrary {
     }
 
     event HeapValueAdded(
-        uint256 value
+        uint256 indexed value
     );
 
     event HeapValueRemoved(
-        uint256 value
+        uint256 indexed value
     );
 
     // Library internal functions should not have leading underscore
@@ -154,7 +154,7 @@ library HeapLibrary {
         }
         NodeId parent = _getParentNode(node);
         uint256 parentValue = _getValue(heap, parent);
-        if (parentValue <= value) {
+        if (!(parentValue > value)) {
             _setValue(heap, node, value);
         } else {
             _setValue(heap, node, parentValue);
@@ -220,7 +220,7 @@ library HeapLibrary {
     }
 
     function _exists(NodeId node, NodeId lastNode) private pure returns (bool result) {
-        return NodeId.unwrap(node) <= NodeId.unwrap(lastNode);
+        return !(NodeId.unwrap(node) > NodeId.unwrap(lastNode));
     }
 
     function _getValue(Heap storage heap, NodeId node) private view returns (uint256 value) {

diff --git a/contracts/structs/typed/TypedPriorityQueue.sol b/contracts/structs/typed/TypedPriorityQueue.sol
@@ -23,8 +23,8 @@ pragma solidity ^0.8.20;
 
 // cspell:words structs
 
-import {PriorityQueueLibrary} from "../PriorityQueue.sol";
-import {TimelineLibrary} from "../../Timeline.sol";
+import { TimelineLibrary } from "./../../Timeline.sol";
+import { PriorityQueueLibrary } from "./../PriorityQueue.sol";
 
 
 library TypedPriorityQueue {

diff --git a/contracts/test/FastForwardPaymaster.sol b/contracts/test/FastForwardPaymaster.sol
@@ -21,8 +21,8 @@
 
 pragma solidity ^0.8.19;
 
-import {DateTimeUtils, Paymaster, Seconds, Timestamp} from "../Paymaster.sol";
-import {IFastForwardPaymaster, IPaymaster} from "../interfaces/test/IFastForwardPaymaster.sol";
+import { IFastForwardPaymaster, IPaymaster } from "./../interfaces/test/IFastForwardPaymaster.sol";
+import { DateTimeUtils, Paymaster, Seconds, Timestamp } from "./../Paymaster.sol";
 
 
 contract FastForwardPaymaster is Paymaster, IFastForwardPaymaster {

diff --git a/contracts/test/SequenceTester.sol b/contracts/test/SequenceTester.sol
@@ -21,9 +21,9 @@
 
 pragma solidity ^0.8.19;
 
-import {ISequenceTester} from "../interfaces/test/ISequenceTester.sol";
-import {SequenceLibrary} from "../Sequence.sol";
-import {Timestamp} from "@skalenetwork/paymaster-interfaces/DateTimeUtils.sol";
+import { Timestamp } from "@skalenetwork/paymaster-interfaces/DateTimeUtils.sol";
+import { ISequenceTester } from "./../interfaces/test/ISequenceTester.sol";
+import { SequenceLibrary } from "./../Sequence.sol";
 
 
 contract SequenceTester is ISequenceTester {

diff --git a/contracts/test/TimelineTester.sol b/contracts/test/TimelineTester.sol
@@ -23,9 +23,9 @@ pragma solidity ^0.8.19;
 
 // cspell:words structs
 
-import {ITimelineTester} from "../interfaces/test/ITimelineTester.sol";
-import {TimelineLibrary} from "../Timeline.sol";
-import {Timestamp} from "@skalenetwork/paymaster-interfaces/DateTimeUtils.sol";
+import { Timestamp } from "@skalenetwork/paymaster-interfaces/DateTimeUtils.sol";
+import { ITimelineTester } from "./../interfaces/test/ITimelineTester.sol";
+import { TimelineLibrary } from "./../Timeline.sol";
 
 
 contract TimelineTester is ITimelineTester {