Merge develop into breaking

.circleci/config.yml

@@ -30,6 +30,45 @@ parameters:
 orbs:
   win: circleci/windows@2.2.0
 
+commands:
+  gitter_notify:
+    description: "Posts a notification to the main room on Gitter (if not running on a PR)."
+    parameters:
+      event:
+        type: enum
+        enum: ["failure", "success"]
+      condition:
+        type: string
+    steps:
+      - run:
+          name: "Gitter notification"
+          when: << parameters.condition >>
+          command: |
+            [[ "<< parameters.event >>" == "failure" ]] && message=" ❌ Nightly job **${CIRCLE_JOB}** failed on **${CIRCLE_BRANCH}**. Please see [build #${CIRCLE_BUILD_NUM}](${CIRCLE_BUILD_URL}) for details."
+            [[ "<< parameters.event >>" == "success" ]] && message=" ✅ Nightly job **${CIRCLE_JOB}** succeeded on **${CIRCLE_BRANCH}**. Please see [build #${CIRCLE_BUILD_NUM}](${CIRCLE_BUILD_URL}) for details."
+
+            curl "https://api.gitter.im/v1/rooms/${GITTER_NOTIFY_ROOM_ID}/chatMessages" \
+              --request POST \
+              --include \
+              --header "Content-Type: application/json" \
+              --header "Accept: application/json" \
+              --header "Authorization: Bearer ${GITTER_API_TOKEN}" \
+              --data "{\"text\":\"${message}\"}"
+
+  gitter_notify_failure:
+    description: "Posts a failure notification to the main room on Gitter (if not running on a PR)."
+    steps:
+      - gitter_notify:
+          event: failure
+          condition: on_fail
+
+  gitter_notify_success:
+    description: "Posts a success notification to the main room on Gitter (if not running on a PR)."
+    steps:
+      - gitter_notify:
+          event: success
+          condition: on_success
+
 defaults:
 
   # --------------------------------------------------------------------------
@@ -91,10 +130,14 @@ defaults:
       path: upload/
 
   # compiled tool executable target
-  - artifacts_tools: &artifacts_tools
+  - artifact_solidity_upgrade: &artifact_solidity_upgrade
       path: build/tools/solidity-upgrade
       destination: solidity-upgrade
 
+  - artifact_yul_phaser: &artifact_yul_phaser
+      path: build/tools/yul-phaser
+      destination: yul-phaser
+
   # compiled executable targets
   - artifacts_executables: &artifacts_executables
       root: build
@@ -263,28 +306,6 @@ defaults:
       requires:
         - b_win_release
 
-  # --------------------------------------------------------------------------
-  # Notification Templates
-  - gitter_notify_failure: &gitter_notify_failure
-      name: Gitter notify failure
-      command: >-
-        curl -X POST -i
-        -i -H "Content-Type: application/json"
-        -H "Accept: application/json"
-        -H "Authorization: Bearer $GITTER_API_TOKEN" "https://api.gitter.im/v1/rooms/$GITTER_NOTIFY_ROOM_ID/chatMessages"
-        -d '{"text":" ❌ Nightly job **'$CIRCLE_JOB'** failed on **'$CIRCLE_BRANCH'**. Please see '$CIRCLE_BUILD_URL' for details."}'
-      when: on_fail
-
-  - gitter_notify_success: &gitter_notify_success
-      name: Gitter notify success
-      command: >-
-        curl -X POST -i
-        -i -H "Content-Type: application/json"
-        -H "Accept: application/json"
-        -H "Authorization: Bearer $GITTER_API_TOKEN" "https://api.gitter.im/v1/rooms/$GITTER_NOTIFY_ROOM_ID/chatMessages"
-        -d '{"text":" ✅ Nightly job **'$CIRCLE_JOB'** succeeded on **'$CIRCLE_BRANCH'**. Please see '$CIRCLE_BUILD_URL' for details."}'
-      when: on_success
-
 # -----------------------------------------------------------------------------------------------
 jobs:
 
@@ -447,7 +468,8 @@ jobs:
       - checkout
       - run: *run_build
       - store_artifacts: *artifacts_solc
-      - store_artifacts: *artifacts_tools
+      - store_artifacts: *artifact_solidity_upgrade
+      - store_artifacts: *artifact_yul_phaser
       - persist_to_workspace: *artifacts_executables
 
   # x64 ASAN build, for testing for memory related bugs
@@ -502,7 +524,7 @@ jobs:
     steps:
       - checkout
       - run: *run_build
-      - run: *gitter_notify_failure
+      - gitter_notify_failure
       - store_artifacts: *artifacts_solc
       - persist_to_workspace: *artifacts_executables
 
@@ -595,8 +617,8 @@ jobs:
             git clone https://github.com/ethereum/solidity-fuzzing-corpus /tmp/solidity-fuzzing-corpus
             mkdir -p test_results
             scripts/regressions.py -o test_results
-      - run: *gitter_notify_failure
-      - run: *gitter_notify_success
+      - gitter_notify_failure
+      - gitter_notify_success
       - store_test_results: *store_test_results
       - store_artifacts: *artifacts_test_results
 
@@ -644,7 +666,8 @@ jobs:
             - /usr/local/Homebrew
       - run: *run_build
       - store_artifacts: *artifacts_solc
-      - store_artifacts: *artifacts_tools
+      - store_artifacts: *artifact_solidity_upgrade
+      - store_artifacts: *artifact_yul_phaser
       - persist_to_workspace:
           root: .
           paths:
@@ -807,7 +830,7 @@ jobs:
       - when:
           condition: true
           <<: *steps_soltest
-      - run: *gitter_notify_failure
+      - gitter_notify_failure
 
   t_ubu_ubsan_clang_cli:
     docker:
@@ -816,7 +839,7 @@ jobs:
       - when:
           condition: true
           <<: *steps_cmdline_tests
-      - run: *gitter_notify_failure
+      - gitter_notify_failure
 
   t_ems_solcjs:
     docker:
@@ -840,6 +863,32 @@ jobs:
             npm --version
             test/externalTests/solc-js/solc-js.sh /tmp/workspace/soljson.js $(cat /tmp/workspace/version.txt)
 
+  t_ems_ext_hardhat:
+    docker:
+      - image: circleci/node
+    environment:
+      TERM: xterm
+      HARDHAT_TESTS_SOLC_PATH: /tmp/workspace/soljson.js
+    steps:
+      - checkout
+      - attach_workspace:
+          at: /tmp/workspace
+      - run: git clone --depth 1 https://github.com/nomiclabs/hardhat.git
+      - run:
+          name: Install dependencies
+          command: |
+            cd hardhat
+            yarn
+      - run:
+          name: Run hardhat-core test suite
+          command: |
+            HARDHAT_TESTS_SOLC_VERSION=$(scripts/get_version.sh)
+            export HARDHAT_TESTS_SOLC_VERSION
+
+            # NOTE: This is expected to work without running `yarn build` first.
+            cd hardhat/packages/hardhat-core
+            yarn test
+
   t_ems_ext:
     parameters:
       project:
@@ -874,8 +923,8 @@ jobs:
       - when:
           condition: <<parameters.gitter_notify>>
           steps:
-            - run: *gitter_notify_failure
-            - run: *gitter_notify_success
+            - gitter_notify_failure
+            - gitter_notify_success
 
   b_win: &b_win
     executor:
@@ -1110,6 +1159,7 @@ workflows:
       # Emscripten build and tests that take 15 minutes or less
       - b_ems: *workflow_trigger_on_tags
       - t_ems_solcjs: *workflow_emscripten
+      - t_ems_ext_hardhat: *workflow_emscripten
 
       - t_ems_ext:
           <<: *workflow_emscripten

Changelog.md

@@ -7,23 +7,29 @@ Language Features:
 Compiler Features:
  * Commandline Interface: Accept nested brackets in step sequences passed to ``--yul-optimizations``.
  * Commandline Interface: Add ``--debug-info`` option for selecting how much extra debug information should be included in the produced EVM assembly and Yul code.
+ * Commandline Interface: Use different colors when printing errors, warnings and infos.
  * SMTChecker: Output values for ``block.*``, ``msg.*`` and ``tx.*`` variables that are present in the called functions.
+ * SMTChecker: Report contract invariants and reentrancy properties. This can be enabled via the CLI option ``--model-checker-invariants`` or the Standard JSON option ``settings.modelChecker.invariants``.
  * Standard JSON: Accept nested brackets in step sequences passed to ``settings.optimizer.details.yulDetails.optimizerSteps``.
  * Standard JSON: Add ``settings.debug.debugInfo`` option for selecting how much extra debug information should be included in the produced EVM assembly and Yul code.
 
 
 Bugfixes:
  * Code Generator: Fix constructor source mappings for immutables.
+ * Commandline Interface: Disallow ``--error-recovery`` option outside of the compiler mode.
+ * Commandline Interface: Don't return zero exit code when writing linked files to disk fails.
  * Commandline Interface: Fix extra newline character being appended to sources passed through standard input, affecting their hashes.
  * Commandline Interface: Report output selection options unsupported by the selected input mode instead of ignoring them.
- * Commandline Interface: Don't return zero exit code when writing linked files to disk fails.
+ * Commandline Interface: When linking only accept exact matches for library names passed to the ``--libraries`` option. Library names not prefixed with a file name used to match any library with that name.
  * SMTChecker: Fix internal error in magic type access (``block``, ``msg``, ``tx``).
  * TypeChecker: Fix internal error when using user defined value types in public library functions.
+ * TypeChecker: Fix internal error when using arrays and structs with user defined value types before declaration.
+ * TypeChecker: Improved error message for constant variables with (nested) mapping types.
+ * Yul Assembler: Fix internal error when function names are not unique.
  * Yul IR Generator: Do not output empty switches/if-bodies for empty contracts.
 
 
 
-
 ### 0.8.9 (2021-09-29)
 
 Important Bugfixes:

docs/contributing.rst

@@ -212,7 +212,7 @@ editing of failing contracts using your preferred text editor. Let's try to brea
     // ----
     // DeclarationError: (36-52): Identifier already declared.
 
-Running ``./build/test/isoltest`` again results in a test failure:
+Running ``./build/test/tools/isoltest`` again results in a test failure:
 
 .. code-block:: text
 

docs/control-structures.rst

@@ -288,7 +288,7 @@ which only need to be created if there is a dispute.
     re-created at the same address after having been destroyed. Yet, it is possible
     for that newly created contract to have a different deployed bytecode even
     though the creation bytecode has been the same (which is a requirement because
-    otherwise the address would change). This is due to the fact that the compiler
+    otherwise the address would change). This is due to the fact that the constructor
     can query external state that might have changed between the two creations
     and incorporate that into the deployed bytecode before it is stored.
 

docs/index.rst

@@ -18,7 +18,7 @@ and multi-signature wallets.
 
 When deploying contracts, you should use the latest released
 version of Solidity. Apart from exceptional cases, only the latest version receives
-`security fixes<https://github.com/ethereum/solidity/security/policy#supported-versions>`.
+`security fixes <https://github.com/ethereum/solidity/security/policy#supported-versions>`_.
 Furthermore, breaking changes as well as
 new features are introduced regularly. We currently use
 a 0.x version number `to indicate this fast pace of change <https://semver.org/#spec-item-4>`_.

docs/ir/ir-breaking-changes.rst

@@ -268,7 +268,7 @@ In the new code generator, function pointers use the AST IDs of the functions as
 calls through function pointers always have to use an internal dispatch function that uses the ``switch`` statement to select
 the right function.
 
-The ID ``0`` is reserved for uninitialized function pointers which then cause a panic in the disptach function when called.
+The ID ``0`` is reserved for uninitialized function pointers which then cause a panic in the dispatch function when called.
 
 In the old code generator, internal function pointers are initialized with a special function that always causes a panic.
 This causes a storage write at construction time for internal function pointers in storage.

docs/smtchecker.rst

@@ -412,7 +412,7 @@ is already "locked", so it would not be possible to change the value of ``x``,
 regardless of what the unknown called code does.
 
 If we "forget" to use the ``mutex`` modifier on function ``set``, the
-SMTChecker is able to synthesize the behavior of the externally called code so
+SMTChecker is able to synthesize the behaviour of the externally called code so
 that the assertion fails:
 
 .. code-block:: text
@@ -518,6 +518,23 @@ which has the following form:
         "source2.sol": ["contract2", "contract3"]
     }
 
+Reported Inferred Inductive Invariants
+======================================
+
+For properties that were proved safe with the CHC engine,
+the SMTChecker can retrieve inductive invariants that were inferred by the Horn
+solver as part of the proof.
+Currently two types of invariants can be reported to the user:
+
+- Contract Invariants: these are properties over the contract's state variables
+  that are true before and after every possible transaction that the contract may ever run. For example, ``x >= y``, where ``x`` and ``y`` are a contract's state variables.
+- Reentrancy Properties: they represent the behavior of the contract
+  in the presence of external calls to unknown code. These properties can express a relation
+  between the value of the state variables before and after the external call, where the external call is free to do anything, including making reentrant calls to the analyzed contract. Primed variables represent the state variables' values after said external call. Example: ``lock -> x = x'``.
+
+The user can choose the type of invariants to be reported using the CLI option ``--model-checker-invariants "contract,reentrancy"`` or as an array in the field ``settings.modelChecker.invariants`` in the :ref:`JSON input<compiler-api>`.
+By default the SMTChecker does not report invariants.
+
 Division and Modulo With Slack Variables
 ========================================
 

docs/using-the-compiler.rst

@@ -418,6 +418,8 @@ Input Description
           "divModWithSlacks": true,
           // Choose which model checker engine to use: all (default), bmc, chc, none.
           "engine": "chc",
+          // Choose which types of invariants should be reported to the user: contract, reentrancy.
+          "invariants": ["contract", "reentrancy"],
           // Choose whether to output all unproved targets. The default is `false`.
           "showUnproved": true,
           // Choose which solvers should be used, if available.

docs/yul.rst

@@ -959,10 +959,13 @@ to ``loadimmutable("name")`` in the runtime code.
 
 linkersymbol
 ^^^^^^^^^^^^
-
-The function ``linkersymbol("fq_library_name")`` is a placeholder for an address literal to be
-substituted by the linker. Its first and only argument must be a string literal and represents the
-fully qualified library name used with the ``--libraries`` option.
+The function ``linkersymbol("library_id")`` is a placeholder for an address literal to be substituted
+by the linker.
+Its first and only argument must be a string literal and uniquely represents the address to be inserted.
+Identifiers can be arbitrary but when the compiler produces Yul code from Solidity sources,
+it uses a library name qualified with the name of the source unit that defines that library.
+To link the code with a particular library address, the same identifier must be provided to the
+``--libraries`` option on the command line.
 
 For example this code
 

libevmasm/LinkerObject.cpp

@@ -73,14 +73,6 @@ LinkerObject::matchLibrary(
 )
 {
 	auto it = _libraryAddresses.find(_linkRefName);
-	if (it != _libraryAddresses.end())
-		return &it->second;
-	// If the user did not supply a fully qualified library name,
-	// try to match only the simple library name
-	size_t colon = _linkRefName.find(':');
-	if (colon == string::npos)
-		return nullptr;
-	it = _libraryAddresses.find(_linkRefName.substr(colon + 1));
 	if (it != _libraryAddresses.end())
 		return &it->second;
 	return nullptr;

liblangutil/ErrorReporter.cpp

@@ -261,3 +261,8 @@ void ErrorReporter::info(
 {
 	error(_error, Error::Type::Info, _location, _description);
 }
+
+void ErrorReporter::info(ErrorId _error, string const& _description)
+{
+	error(_error, Error::Type::Info, SourceLocation(), _description);
+}

liblangutil/ErrorReporter.h

@@ -72,6 +72,8 @@ class ErrorReporter
 		std::string const& _description
 	);
 
+	void info(ErrorId _error, std::string const& _description);
+
 	void declarationError(
 		ErrorId _error,
 		SourceLocation const& _location,

liblangutil/Exceptions.cpp

@@ -23,6 +23,9 @@
 
 #include <liblangutil/Exceptions.h>
 
+#include <boost/algorithm/string/case_conv.hpp>
+#include <boost/algorithm/string/trim.hpp>
+
 using namespace std;
 using namespace solidity;
 using namespace solidity::langutil;
@@ -71,3 +74,15 @@ Error::Error(
 	if (!_description.empty())
 		*this << util::errinfo_comment(_description);
 }
+
+optional<Error::Severity> Error::severityFromString(string _input)
+{
+	boost::algorithm::to_lower(_input);
+	boost::algorithm::trim(_input);
+
+	for (Severity severity: {Severity::Error, Severity::Warning, Severity::Info})
+		if (_input == formatErrorSeverityLowercase(severity))
+			return severity;
+
+	return nullopt;
+}

liblangutil/Exceptions.h

@@ -258,6 +258,8 @@ class Error: virtual public util::Exception
 		solAssert(false, "");
 	}
 
+	static std::optional<Severity> severityFromString(std::string _input);
+
 private:
 	ErrorId m_errorId;
 	Type m_type;