Merge pull request #68 from yanghang8612/release_v0.8.22

Release v0.8.22

.circleci/parallel_cli_tests.py

@@ -8,6 +8,7 @@
 # TODO: We should switch to time-based splitting but that requires JUnit XML report support in cmdlineTests.sh.
 tests_to_run_in_parallel = [
     '~ast_import_export',                   # ~7 min
+    '~evmasm_import_export',                # ~5 min
     '~ast_export_with_stop_after_parsing',  # ~4 min
     '~soljson_via_fuzzer',                  # ~3 min
     '~via_ir_equivalence',                  # ~1 min

.circleci/soltest.sh

@@ -36,6 +36,7 @@ set -e
 
 OPTIMIZE=${OPTIMIZE:-"0"}
 EVM=${EVM:-"invalid"}
+CPUs=${CPUs:-3}
 REPODIR="$(realpath "$(dirname "$0")/..")"
 
 IFS=" " read -r -a BOOST_TEST_ARGS <<< "$BOOST_TEST_ARGS"
@@ -67,7 +68,6 @@ get_logfile_basename() {
 # long-running test cases are next to each other.
 CIRCLE_NODE_INDEX=$(((CIRCLE_NODE_INDEX + 23 * INDEX_SHIFT) % CIRCLE_NODE_TOTAL))
 
-CPUs=3
 PIDs=()
 for run in $(seq 0 $((CPUs - 1)))
 do

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.13.0)
 
-set(ETH_CMAKE_DIR   "${CMAKE_CURRENT_LIST_DIR}/cmake"   CACHE PATH "The the path to the cmake directory")
+set(ETH_CMAKE_DIR   "${CMAKE_CURRENT_LIST_DIR}/cmake"   CACHE PATH "The path to the cmake directory")
 list(APPEND CMAKE_MODULE_PATH ${ETH_CMAKE_DIR})
 
 # Set the build type, if none was specified.
@@ -21,7 +21,7 @@ include(EthPolicy)
 eth_policy()
 
 # project name and version should be set after cmake_policy CMP0048
-set(PROJECT_VERSION "0.8.21")
+set(PROJECT_VERSION "0.8.22")
 # OSX target needed in order to support std::visit
 set(CMAKE_OSX_DEPLOYMENT_TARGET "10.14")
 project(solidity VERSION ${PROJECT_VERSION} LANGUAGES C CXX)

Changelog.md

@@ -1,3 +1,30 @@
+### 0.8.22 (2023-10-25)
+
+Language Features:
+ * Allow defining events at file level.
+
+
+Compiler Features:
+ * Code Generator: Remove redundant overflow checks of certain ``for`` loops when the counter variable cannot overflow.
+ * Commandline Interface: Add ``--no-import-callback`` option that prevents the compiler from loading source files not given explicitly on the CLI or in Standard JSON input.
+ * Commandline Interface: Add an experimental ``--import-asm-json`` option that can import EVM assembly in the format used by ``--asm-json``.
+ * Commandline Interface: Use proper severity and coloring also for error messages produced outside of the compilation pipeline.
+ * EVM: Deprecate support for "homestead", "tangerineWhistle", "spuriousDragon" and "byzantium" EVM versions.
+ * Parser: Remove the experimental error recovery mode (``--error-recovery`` / ``settings.parserErrorRecovery``).
+ * SMTChecker: Support user-defined operators.
+ * Yul Optimizer: If ``PUSH0`` is supported, favor zero literals over storing zero values in variables.
+ * Yul Optimizer: Run the ``Rematerializer`` and ``UnusedPruner`` steps at the end of the default clean-up sequence.
+
+
+Bugfixes:
+ * AST: Fix wrong initial ID for Yul nodes in the AST.
+ * Code Generator: Fix output from via-IR code generator being dependent on which files were discovered by import callback. In some cases, a different AST ID assignment would alter the order of functions in internal dispatch, resulting in superficially different but semantically equivalent bytecode.
+ * NatSpec: Fix internal error when requesting userdoc or devdoc for a contract that emits an event defined in a foreign contract or interface.
+ * SMTChecker: Fix encoding error that causes loops to unroll after completion.
+ * SMTChecker: Fix inconsistency on constant condition checks when ``while`` or ``for`` loops are unrolled before the condition check.
+ * Yul Optimizer: Fix replacement decisions during CSE being affected by Yul variable names generated by the compiler, resulting in different (but equivalent) bytecode in some situations.
+
+
 ### 0.8.21 (2023-07-19)
 
 Important Bugfixes:

ReleaseChecklist.md

@@ -3,9 +3,9 @@
 ### Requirements
  - [ ] GitHub account with access to [solidity](https://github.com/ethereum/solidity), [solc-js](https://github.com/ethereum/solc-js),
        [solc-bin](https://github.com/ethereum/solc-bin), [homebrew-ethereum](https://github.com/ethereum/homebrew-ethereum),
-       [solidity-blog](https://github.com/ethereum/solidity-blog) and [solidity-portal](https://github.com/ethereum/solidity-portal) repositories.
+       [solidity-website](https://github.com/ethereum/solidity-website).
  - [ ] DockerHub account with push rights to the [``solc`` image](https://hub.docker.com/r/ethereum/solc).
- - [ ] Lauchpad (Ubuntu One) account with a membership in the ["Ethereum" team](https://launchpad.net/~ethereum) and
+ - [ ] Launchpad (Ubuntu One) account with a membership in the ["Ethereum" team](https://launchpad.net/~ethereum) and
        a gnupg key for your email in the ``ethereum.org`` domain (has to be version 1, gpg2 won't work).
  - [ ] Ubuntu/Debian dependencies of the PPA scripts: ``devscripts``, ``debhelper``, ``dput``, ``git``, ``wget``, ``ca-certificates``.
  - [ ] [npm Registry](https://www.npmjs.com) account added as a collaborator for the [``solc`` package](https://www.npmjs.com/package/solc).
@@ -37,8 +37,8 @@ At least a day before the release:
  - [ ] Prepare drafts of Twitter, Reddit and Solidity Forum announcements.
 
 ### Blog Post
- - [ ] Create a post on [solidity-blog](https://github.com/ethereum/solidity-blog) in the ``Releases`` category and explain some of the new features or concepts.
- - [ ] Create a post on [solidity-blog](https://github.com/ethereum/solidity-blog) in the ``Security Alerts`` category in case of important bug(s).
+ - [ ] Create a post on [solidity-website](https://github.com/ethereum/solidity-website/tree/main/src/posts) in the ``Releases`` category and explain some of the new features or concepts.
+ - [ ] Create a post on [solidity-website](https://github.com/ethereum/solidity-website/tree/main/src/posts) in the ``Security Alerts`` category in case of important bug(s).
 
 ### Changelog
  - [ ] Sort the changelog entries alphabetically and correct any errors you notice. Commit it.
@@ -104,9 +104,9 @@ At least a day before the release:
  - [ ] Make sure the documentation for the new release has been published successfully.
        Go to the [documentation status page at ReadTheDocs](https://readthedocs.org/projects/solidity/) and verify that the new version is listed, works and is marked as default.
  - [ ] Remove "still in progress" warning from the [release notes](https://github.com/ethereum/solidity/releases).
- - [ ] Merge the [blog posts](https://github.com/ethereum/solidity-blog/pulls) related to the release.
+ - [ ] Merge the [blog posts](https://github.com/ethereum/solidity-website/pulls) related to the release.
  - [ ] Create a commit to increase the version number on ``develop`` in ``CMakeLists.txt`` and add a new skeleton changelog entry.
- - [ ] Update the release information section [in the source of soliditylang.org](https://github.com/ethereum/solidity-portal/blob/master/index.html).
+ - [ ] Update the release information section [in the source of soliditylang.org](https://github.com/ethereum/solidity-website/blob/main/src/pages/index.tsx).
  - [ ] Announce on [Twitter](https://twitter.com/solidity_lang), including links to the release and the blog post.
  - [ ] Announce on [Fosstodon](https://fosstodon.org/@solidity/), including links to the release and the blog post.
  - [ ] Share the announcement on Reddit in [``/r/ethdev``](https://reddit.com/r/ethdev/), cross-posted to [``/r/ethereum``](https://reddit.com/r/ethereum/).

cmake/fmtlib.cmake

@@ -4,9 +4,9 @@ FetchContent_Declare(
 	fmtlib
 	PREFIX "${PROJECT_BINARY_DIR}/deps"
 	DOWNLOAD_DIR "${PROJECT_SOURCE_DIR}/deps/downloads"
-	DOWNLOAD_NAME fmt-8.0.1.tar.gz
-	URL https://github.com/fmtlib/fmt/archive/8.0.1.tar.gz
-	URL_HASH SHA256=b06ca3130158c625848f3fb7418f235155a4d389b2abc3a6245fb01cb0eb1e01
+	DOWNLOAD_NAME fmt-9.1.0.tar.gz
+	URL https://github.com/fmtlib/fmt/archive/9.1.0.tar.gz
+	URL_HASH SHA256=5dea48d1fcddc3ec571ce2058e13910a0d4a6bab4cc09a809d8b1dd1c88ae6f2
 )
 
 if (CMAKE_VERSION VERSION_LESS "3.14.0")

docs/060-breaking-changes.rst

@@ -112,7 +112,7 @@ New Error Reporter
 ~~~~~~~~~~~~~~~~~~
 
 A new error reporter was introduced, which aims at producing more accessible error messages on the command-line.
-It is enabled by default, but passing ``--old-reporter`` falls back to the the deprecated old error reporter.
+It is enabled by default, but passing ``--old-reporter`` falls back to the deprecated old error reporter.
 
 Metadata Hash Options
 ~~~~~~~~~~~~~~~~~~~~~

docs/_static/css/custom.css

@@ -16,6 +16,10 @@
 
     --navHeight: 4.5rem;
     --sideWidth: 300px;
+    --maxWidth: 80rem;
+    --desktopInlinePadding: 2rem;
+    --mobileInlinePadding: 1rem;
+    --currentVersionHeight: 45px;
 
     text-rendering: geometricPrecision;
     -webkit-font-smoothing: antialiased;
@@ -56,7 +60,6 @@ html,
 body,
 .wy-grid-for-nav {
     background-color: var(--color-f) !important;
-    position: relative;
 }
 
 body {
@@ -67,6 +70,10 @@ a {
     color: var(--color-c);
 }
 
+a, section {
+    scroll-margin-top: calc(var(--navHeight) + 2rem);
+}
+
 hr {
     margin-block: 2rem;
     border-color: var(--color-d) !important;
@@ -327,7 +334,6 @@ ul.current ul,
 
 .wy-breadcrumbs-aside a,
 .wy-breadcrumbs-aside a:visited,
-/* .wy-breadcrumbs-aside a:not(:visited), */
 a.fa.fa-github,
 a.fa.fa-github:visited,
 a.fa.fa-github:not(:visited),
@@ -361,10 +367,11 @@ footer .rst-footer-buttons {
 
 /* Site wrapper, and two children: header and rest */
 .unified-wrapper {
-    position: fixed;
+    position: relative;
+    display: flex;
+    flex-direction: column;
     inset: 0;
-    top: var(--navHeight);
-    max-width: 80rem;
+    max-width: var(--maxWidth);
     margin-inline: auto;
 }
 
@@ -377,17 +384,16 @@ footer .rst-footer-buttons {
     display: flex;
     align-items: center;
     box-shadow: var(--shadow);
-    backdrop-filter: blur(3px);
 }
 
 .unified-header .inner-header {
     display: flex;
     margin-inline: auto;
     width: 100%;
-    max-width: 80rem;
+    max-width: var(--maxWidth);
     align-items: center;
     justify-content: space-between;
-    padding-inline: 2rem;
+    padding-inline: var(--desktopInlinePadding);
     padding-block: 1rem;
 }
 
@@ -398,6 +404,7 @@ footer .rst-footer-buttons {
     opacity: 95%;
     background: var(--color-f);
     z-index: -1;
+    backdrop-filter: blur(3px);
 }
 
 .unified-header .home-link {
@@ -444,6 +451,7 @@ footer .rst-footer-buttons {
     font-weight: 400;
     box-sizing: content-box;
     border-bottom: 1px solid transparent;
+    white-space: nowrap;
 }
 
 .unified-header .nav-link.active {
@@ -455,34 +463,36 @@ footer .rst-footer-buttons {
     border-bottom: 1px solid var(--color-c);
 }
 
-/* Rest: Grid, with two children: side bar, and content */
+/* Rest: Flex-row, with two children: side bar, and content */
 .unified-wrapper .wy-grid-for-nav {
     position: relative !important;
-    display: grid !important;
-    grid-template-columns: var(--sideWidth) 1fr;
-    gap: 1rem;
+    display: flex;
+    margin-inline: auto;
 }
 
 /* First child: Side bar */
 .unified-wrapper .wy-grid-for-nav nav.wy-nav-side {
-    position: relative;
+    position: fixed;
     display: flex;
     flex-direction: column;
     background: var(--color-f);
     color: var(--color-a);
-    top: 0;
-    bottom: 0;
-    left: 0;
     padding-bottom: unset !important;
-    min-height: unset !important;
     z-index: 10 !important;
-    max-width: var(--sideWidth) !important;
+    min-height: unset !important;
+    width: var(--sideWidth) !important;
+    top: var(--navHeight);
+    bottom: 0;
+    left: auto;
+    overflow: auto;
 }
 
 .unified-wrapper .wy-grid-for-nav nav.wy-nav-side .wy-side-scroll {
-    position: relative !important;
-    width: fit-content !important;
+    position: static !important;
+    width: unset !important;
+    overflow: unset !important;
     height: unset !important;
+    padding-bottom: 2rem;
 }
 
 .unified-wrapper .wy-grid-for-nav nav.wy-nav-side .wy-side-scroll .wy-side-nav-search {
@@ -516,15 +526,15 @@ footer .rst-footer-buttons {
 
 /* Second child: Content */
 .unified-wrapper .wy-grid-for-nav .wy-nav-content {
-    position: relative !important;
-    overflow-y: scroll !important;
     width: 100%;
-    max-width: 100vw !important;
-    padding-inline: 2rem;
+    max-width: unset !important; /* override */
+    padding-inline: var(--desktopInlinePadding);
+    margin-inline-start: var(--sideWidth);
+    margin-top: var(--navHeight);
 }
 
 .unified-wrapper .wy-grid-for-nav .wy-nav-content .rst-content {
-    max-width: 70ch;
+    max-width: min(70ch, calc(100vw -  2 * var(--desktopInlinePadding) - var(--sideWidth)));
     margin-inline: auto;
 }
 
@@ -565,29 +575,15 @@ footer .rst-footer-buttons {
     }
 
     .unified-header .inner-header {
-        padding-inline: 1rem;
-    }
-
-    .unified-wrapper .wy-grid-for-nav {
-        grid-template-columns: 1fr;
+        padding-inline: var(--mobileInlinePadding);
     }
 
     .unified-wrapper .wy-grid-for-nav nav.wy-nav-side {
-        position: absolute;
-        inset-block: 0;
-        inset-inline-start: 0;
-        width: var(--sideWidth);
-        overflow-y: scroll;
         transform: translateX(-100%);
         transition: transform 200ms ease-in-out;
     }
 
     /* Menu open styles */
-    .unified-wrapper .wy-grid-for-nav nav.wy-nav-side {
-        position: absolute;
-
-    }
-
     .unified-wrapper.menu-open nav.wy-nav-side {
         transform: translateX(0);
         transition: transform 200ms ease-in-out;
@@ -612,6 +608,18 @@ footer .rst-footer-buttons {
     a.skip-to-content {
         display: none;
     }
+
+    .wy-nav-content {
+        margin-inline-start: 0 !important;
+    }
+
+    .rst-content {
+        max-width: 100% !important;
+    }
+
+    .wy-side-scroll {
+        padding-bottom: 0 !important;
+    }
 }
 
 ul.search .context {
@@ -658,6 +666,8 @@ ul.search .context {
 .rst-other-versions {
     background: var(--white) !important;
     color: var(--color-a) !important;
+    max-height: calc(100vh - var(--navHeight) - var(--currentVersionHeight));
+    overflow-y: scroll;
 }
 
 .rst-other-versions a {
@@ -778,9 +788,8 @@ button.mobile-menu-button {
     font-family: 'Overpass Mono', monospace;
 }
 
-.wy-breadcrumbs-aside {
-    display: block;
-    padding-top: 0;
+.wy-breadcrumbs>li {
+    padding-top: 8px;
 }
 
 .wy-breadcrumbs-aside a {
@@ -801,8 +810,9 @@ a.skip-to-content {
     padding: 2px 4px;
     font-size: 14px;
     margin-inline-end: auto;
-    margin-inline-start: 2rem;
+    margin-inline-start: 1.5rem;
     color: var(--color-a);
+    white-space: nowrap;
 }
 
 a.skip-to-content:focus {

docs/_static/js/constants.js

@@ -1,11 +1,18 @@
+// Site URL
+const SITE_URL = "https://docs.soliditylang.org"
+const { origin, pathname } = location;
+const pathSplit = pathname.split("/");
+const rootPath = origin.includes(SITE_URL) && pathSplit.length > 3 ? pathSplit.splice(1, 2).join("/") : ''
+const ROOT_URL = `${origin}/${rootPath}`;
+
 // Color mode constants
 const [DARK, LIGHT] = ["dark", "light"];
-const LIGHT_LOGO_PATH = "_static/img/logo.svg";
-const DARK_LOGO_PATH = "_static/img/logo-dark.svg";
-const SUN_ICON_PATH = "_static/img/sun.svg";
-const MOON_ICON_PATH = "_static/img/moon.svg";
-const LIGHT_HAMBURGER_PATH = "_static/img/hamburger-light.svg";
-const DARK_HAMBURGER_PATH = "_static/img/hamburger-dark.svg";
+const LIGHT_LOGO_PATH = `${ROOT_URL}/_static/img/logo.svg`;
+const DARK_LOGO_PATH = `${ROOT_URL}/_static/img/logo-dark.svg`;
+const SUN_ICON_PATH = `${ROOT_URL}/_static/img/sun.svg`;
+const MOON_ICON_PATH = `${ROOT_URL}/_static/img/moon.svg`;
+const LIGHT_HAMBURGER_PATH = `${ROOT_URL}/_static/img/hamburger-light.svg`;
+const DARK_HAMBURGER_PATH = `${ROOT_URL}/_static/img/hamburger-dark.svg`;
 const COLOR_TOGGLE_ICON_CLASS = "color-toggle-icon";
 const SOLIDITY_LOGO_CLASS = "solidity-logo";
 const LS_COLOR_SCHEME = "color-scheme";