docs: explain arbOSVersion offset (#245)

OffchainLabs · Sep 12, 2024 · 2376ee7 · 2376ee7
1 parent 31c0768
commit 2376ee7
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/precompiles/ArbSys.sol b/src/precompiles/ArbSys.sol
@@ -29,7 +29,8 @@ interface ArbSys {
     function arbChainID() external view returns (uint256);
 
     /**
-     * @notice Get internal version number identifying an ArbOS build
+     * @notice Get internal version number identifying an ArbOS build, this is `55 + nitroArbOS version number`
+     *         e.g. on ArbOS 31 this would return 86. This is the only function that have the 55 offset.
      * @return version number as int
      */
     function arbOSVersion() external view returns (uint256);