From 263178aa95a043427f4f8787150f0eebf74daba1 Mon Sep 17 00:00:00 2001 From: memosr Date: Fri, 15 May 2026 21:39:07 +0300 Subject: [PATCH] fix: correct NatSpec tags, typo, and parameter naming MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Three small but real fixes in dispute-game and system config contracts: 1. FaultDisputeGameV2.sol (line 567) and PermissionedDisputeGameV2.sol (line 52) — Change @notice to @param for the _disputed parameter. The wrong tag means NatSpec tooling renders the parameter as undocumented and treats the description as a stray contract notice. 2. FaultDisputeGameV2.sol (line 575) — Fix backtick-wrapped type reference PreimageOralce → PreimageOracle. 3. SystemConfig.sol (lines 479-482) — Rename internal function parameter _dAFootprintGasScalar → _daFootprintGasScalar to match the public wrapper, the storage variable, and the NatSpec @param tag at line 473. --- src/L1/SystemConfig.sol | 6 +++--- src/L1/proofs/v2/FaultDisputeGameV2.sol | 4 ++-- src/L1/proofs/v2/PermissionedDisputeGameV2.sol | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/L1/SystemConfig.sol b/src/L1/SystemConfig.sol index b5498da1..8f88691a 100644 --- a/src/L1/SystemConfig.sol +++ b/src/L1/SystemConfig.sol @@ -476,10 +476,10 @@ contract SystemConfig is ProxyAdminOwnedBase, OwnableUpgradeable, Reinitializabl } /// @notice Internal function for updating the DA footprint gas scalar. - function _setDAFootprintGasScalar(uint16 _dAFootprintGasScalar) internal { - daFootprintGasScalar = _dAFootprintGasScalar; + function _setDAFootprintGasScalar(uint16 _daFootprintGasScalar) internal { + daFootprintGasScalar = _daFootprintGasScalar; - bytes memory data = abi.encode(_dAFootprintGasScalar); + bytes memory data = abi.encode(_daFootprintGasScalar); emit ConfigUpdate(VERSION, UpdateType.DA_FOOTPRINT_GAS_SCALAR, data); } diff --git a/src/L1/proofs/v2/FaultDisputeGameV2.sol b/src/L1/proofs/v2/FaultDisputeGameV2.sol index 41345127..69e4157a 100644 --- a/src/L1/proofs/v2/FaultDisputeGameV2.sol +++ b/src/L1/proofs/v2/FaultDisputeGameV2.sol @@ -564,7 +564,7 @@ contract FaultDisputeGameV2 is Clone, ISemver { } /// @notice Defend an agreed upon `Claim`. - /// @notice _disputed The `Claim` being defended. + /// @param _disputed The `Claim` being defended. /// @param _parentIndex Index of the claim to defend in the `claimData` array. This must match the `_disputed` /// claim. /// @param _claim The `Claim` at the relative defense position. @@ -572,7 +572,7 @@ contract FaultDisputeGameV2 is Clone, ISemver { move(_disputed, _parentIndex, _claim, false); } - /// @notice Posts the requested local data to the VM's `PreimageOralce`. + /// @notice Posts the requested local data to the VM's `PreimageOracle`. /// @param _ident The local identifier of the data to post. /// @param _execLeafIdx The index of the leaf claim in an execution subgame that requires the local data for a step. /// @param _partOffset The offset of the data to post. diff --git a/src/L1/proofs/v2/PermissionedDisputeGameV2.sol b/src/L1/proofs/v2/PermissionedDisputeGameV2.sol index 4a79a9b2..5999d773 100644 --- a/src/L1/proofs/v2/PermissionedDisputeGameV2.sol +++ b/src/L1/proofs/v2/PermissionedDisputeGameV2.sol @@ -49,7 +49,7 @@ contract PermissionedDisputeGameV2 is FaultDisputeGameV2 { } /// @notice Generic move function, used for both `attack` and `defend` moves. - /// @notice _disputed The disputed `Claim`. + /// @param _disputed The disputed `Claim`. /// @param _challengeIndex The index of the claim being moved against. This must match the `_disputed` claim. /// @param _claim The claim at the next logical position in the game. /// @param _isAttack Whether or not the move is an attack or defense.