feat: expand keyed nonces to 0 key specific getters for compatibility (#899)

DhairyaSethi · web-flow · commit f1967d932bea · 2025-10-15T22:52:32.000+05:30
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
diff --git a/.gitignore b/.gitignore
@@ -9,7 +9,6 @@ out/
 .idea
 .vscode
 
-# well, looks strange to ignore package-lock, but we have only pretter and it's temproray
 package-lock.json
 node_modules
 
diff --git a/foundry.toml b/foundry.toml
@@ -34,6 +34,7 @@ runs = 10000
 [profile.gas]
 gas_snapshot_check = true
 test = 'tests/gas'
+isolate = true
 
 [rpc_endpoints]
 mainnet = "${RPC_MAINNET}"
diff --git a/package.json b/package.json
@@ -18,6 +18,6 @@
     "prettier-plugin-solidity": "2.1.0"
   },
   "lint-staged": {
-    "*.{sol,md,py,ts}": "prettier --write"
+    "*.{sol,md,py,ts}": "prettier . --write"
   }
 }
diff --git a/snapshots/Spoke.Operations.ZeroRiskPremium.json b/snapshots/Spoke.Operations.ZeroRiskPremium.json
@@ -1,29 +1,29 @@
 {
-  "borrow: first": "198987",
-  "borrow: second action, same reserve": "179508",
-  "liquidationCall: full": "291049",
-  "liquidationCall: partial": "315143",
-  "permitReserve + repay (multicall)": "235508",
-  "permitReserve + supply (multicall)": "140866",
-  "permitReserve + supply + enable collateral (multicall)": "176163",
+  "borrow: first": "198976",
+  "borrow: second action, same reserve": "179497",
+  "liquidationCall: full": "291027",
+  "liquidationCall: partial": "315121",
+  "permitReserve + repay (multicall)": "235530",
+  "permitReserve + supply (multicall)": "140910",
+  "permitReserve + supply + enable collateral (multicall)": "176141",
   "repay: full": "151572",
   "repay: partial": "176035",
-  "setUserPositionManagerWithSig: disable": "44851",
-  "setUserPositionManagerWithSig: enable": "68880",
-  "supply + enable collateral (multicall)": "154105",
-  "supply: 0 borrows, collateral disabled": "115700",
-  "supply: 0 borrows, collateral enabled": "120097",
-  "supply: 1 borrow": "120089",
-  "supply: second action, same reserve": "102997",
-  "updateUserDynamicConfig: 1 collateral": "73827",
-  "updateUserDynamicConfig: 2 collaterals": "88687",
-  "updateUserRiskPremium: 1 borrow": "95260",
-  "updateUserRiskPremium: 2 borrows": "111352",
-  "usingAsCollateral: 0 borrows, enable": "59042",
-  "usingAsCollateral: 1 borrow, disable": "105595",
-  "usingAsCollateral: 1 borrow, enable": "32364",
-  "usingAsCollateral: 2 borrows, disable": "128060",
-  "usingAsCollateral: 2 borrows, enable": "41942",
+  "setUserPositionManagerWithSig: disable": "44918",
+  "setUserPositionManagerWithSig: enable": "68947",
+  "supply + enable collateral (multicall)": "154083",
+  "supply: 0 borrows, collateral disabled": "115722",
+  "supply: 0 borrows, collateral enabled": "120119",
+  "supply: 1 borrow": "120111",
+  "supply: second action, same reserve": "103019",
+  "updateUserDynamicConfig: 1 collateral": "73761",
+  "updateUserDynamicConfig: 2 collaterals": "88621",
+  "updateUserRiskPremium: 1 borrow": "95282",
+  "updateUserRiskPremium: 2 borrows": "111374",
+  "usingAsCollateral: 0 borrows, enable": "58976",
+  "usingAsCollateral: 1 borrow, disable": "105529",
+  "usingAsCollateral: 1 borrow, enable": "32298",
+  "usingAsCollateral: 2 borrows, disable": "127994",
+  "usingAsCollateral: 2 borrows, enable": "41876",
   "withdraw: 0 borrows, full": "127680",
   "withdraw: 0 borrows, partial": "132727",
   "withdraw: 1 borrow, partial": "161709",
diff --git a/snapshots/Spoke.Operations.json b/snapshots/Spoke.Operations.json
@@ -1,29 +1,29 @@
 {
-  "borrow: first": "269156",
-  "borrow: second action, same reserve": "212677",
-  "liquidationCall: full": "324435",
-  "liquidationCall: partial": "348529",
-  "permitReserve + repay (multicall)": "268887",
-  "permitReserve + supply (multicall)": "140866",
-  "permitReserve + supply + enable collateral (multicall)": "176163",
+  "borrow: first": "269145",
+  "borrow: second action, same reserve": "212666",
+  "liquidationCall: full": "324413",
+  "liquidationCall: partial": "348507",
+  "permitReserve + repay (multicall)": "268909",
+  "permitReserve + supply (multicall)": "140910",
+  "permitReserve + supply + enable collateral (multicall)": "176141",
   "repay: full": "146213",
   "repay: partial": "209414",
-  "setUserPositionManagerWithSig: disable": "44851",
-  "setUserPositionManagerWithSig: enable": "68880",
-  "supply + enable collateral (multicall)": "154105",
-  "supply: 0 borrows, collateral disabled": "115700",
-  "supply: 0 borrows, collateral enabled": "120097",
-  "supply: 1 borrow": "120089",
-  "supply: second action, same reserve": "102997",
-  "updateUserDynamicConfig: 1 collateral": "73827",
-  "updateUserDynamicConfig: 2 collaterals": "88687",
-  "updateUserRiskPremium: 1 borrow": "177347",
-  "updateUserRiskPremium: 2 borrows": "262712",
-  "usingAsCollateral: 0 borrows, enable": "59042",
-  "usingAsCollateral: 1 borrow, disable": "187682",
-  "usingAsCollateral: 1 borrow, enable": "32364",
-  "usingAsCollateral: 2 borrows, disable": "287419",
-  "usingAsCollateral: 2 borrows, enable": "41942",
+  "setUserPositionManagerWithSig: disable": "44918",
+  "setUserPositionManagerWithSig: enable": "68947",
+  "supply + enable collateral (multicall)": "154083",
+  "supply: 0 borrows, collateral disabled": "115722",
+  "supply: 0 borrows, collateral enabled": "120119",
+  "supply: 1 borrow": "120111",
+  "supply: second action, same reserve": "103019",
+  "updateUserDynamicConfig: 1 collateral": "73761",
+  "updateUserDynamicConfig: 2 collaterals": "88621",
+  "updateUserRiskPremium: 1 borrow": "177369",
+  "updateUserRiskPremium: 2 borrows": "262734",
+  "usingAsCollateral: 0 borrows, enable": "58976",
+  "usingAsCollateral: 1 borrow, disable": "187616",
+  "usingAsCollateral: 1 borrow, enable": "32298",
+  "usingAsCollateral: 2 borrows, disable": "287353",
+  "usingAsCollateral: 2 borrows, enable": "41876",
   "withdraw: 0 borrows, full": "127680",
   "withdraw: 0 borrows, partial": "132727",
   "withdraw: 1 borrow, partial": "241296",
diff --git a/src/interfaces/INoncesKeyed.sol b/src/interfaces/INoncesKeyed.sol
@@ -6,12 +6,22 @@ interface INoncesKeyed {
   /// @notice Thrown when nonce being consumed does not match `currentNonce` for `account`.
   error InvalidAccountNonce(address account, uint256 currentNonce);
 
+  /// @notice Allows caller to revoke their next sequential nonce at zero key.
+  /// @dev This does not invalidate nonce at other `key`s namespace.
+  /// @return keyNonce The revoked key-prefixed nonce.
+  function useNonce() external returns (uint256 keyNonce);
+
   /// @notice Allows caller to revoke their next sequential nonce at specified `key`.
   /// @dev This does not invalidate nonce at other `key`s namespace.
   /// @param key The key which specifies namespace of the nonce.
   /// @return keyNonce The revoked key-prefixed nonce.
   function useNonce(uint192 key) external returns (uint256 keyNonce);
 
+  /// @notice Returns the next unused nonce for an address and zero key.
+  /// @param owner The address of the nonce over.
+  /// @return keyNonce The first 24 bytes are for the key, & the last 8 bytes for the nonce.
+  function nonces(address owner) external view returns (uint256 keyNonce);
+
   /// @notice Returns the next unused nonce for an address and key. Result contains the key prefix.
   /// @param owner The address of the nonce over.
   /// @param key The key which specifies namespace of the nonce.
diff --git a/src/utils/NoncesKeyed.sol b/src/utils/NoncesKeyed.sol
@@ -10,11 +10,21 @@ import {INoncesKeyed} from 'src/interfaces/INoncesKeyed.sol';
 contract NoncesKeyed is INoncesKeyed {
   mapping(address owner => mapping(uint192 key => uint64 nonce)) private _nonces;
 
+  /// @inheritdoc INoncesKeyed
+  function useNonce() external returns (uint256) {
+    return _useNonce(msg.sender, 0);
+  }
+
   /// @inheritdoc INoncesKeyed
   function useNonce(uint192 key) external returns (uint256) {
     return _useNonce(msg.sender, key);
   }
 
+  /// @inheritdoc INoncesKeyed
+  function nonces(address owner) external view returns (uint256) {
+    return _pack(0, _nonces[owner][0]);
+  }
+
   /// @inheritdoc INoncesKeyed
   function nonces(address owner, uint192 key) external view returns (uint256) {
     return _pack(key, _nonces[owner][key]);
diff --git a/tests/unit/NoncesKeyed.t.sol b/tests/unit/NoncesKeyed.t.sol
@@ -12,6 +12,24 @@ contract NoncesKeyedTest is Base {
     mock = new NoncesKeyedMock();
   }
 
+  function test_useNonce_zeroKey_monotonic(bytes32) public {
+    vm.setArbitraryStorage(address(mock));
+
+    address owner = vm.randomAddress();
+
+    uint256 keyNonce = mock.nonces(owner);
+    (uint192 key, ) = _unpackNonce(keyNonce);
+    assertEq(key, 0);
+
+    vm.prank(owner);
+    uint256 consumedKeyNonce = mock.useNonce();
+    (key, ) = _unpackNonce(consumedKeyNonce);
+    assertEq(key, 0);
+
+    assertEq(consumedKeyNonce, keyNonce);
+    _assertNonceIncrement(mock, owner, keyNonce);
+  }
+
   function test_useNonce_monotonic(bytes32) public {
     vm.setArbitraryStorage(address(mock));
 

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,6 @@`
`18`	`18`	`"prettier-plugin-solidity": "2.1.0"`
`19`	`19`	`},`
`20`	`20`	`"lint-staged": {`
`21`		`- "*.{sol,md,py,ts}": "prettier --write"`
	`21`	`+ "*.{sol,md,py,ts}": "prettier . --write"`
`22`	`22`	`}`
`23`	`23`	`}`