English documentation updates up to v0.8.24-96-ga4399962c (2024-02-22)

CMakeLists.txt

@@ -1,11 +1,11 @@
 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.
 if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
-	if(EXISTS "${CMAKE_SOURCE_DIR}/.git")
+	if(EXISTS "${PROJECT_SOURCE_DIR}/.git")
 		set(DEFAULT_BUILD_TYPE "RelWithDebInfo")
 	else()
 		set(DEFAULT_BUILD_TYPE "Release")
@@ -21,7 +21,7 @@ include(EthPolicy)
 eth_policy()
 
 # project name and version should be set after cmake_policy CMP0048
-set(PROJECT_VERSION "0.8.12")
+set(PROJECT_VERSION "0.8.25")
 # OSX target needed in order to support std::visit
 set(CMAKE_OSX_DEPLOYMENT_TARGET "10.14")
 project(solidity VERSION ${PROJECT_VERSION} LANGUAGES C CXX)
@@ -35,6 +35,8 @@ endif()
 option(SOLC_LINK_STATIC "Link solc executable statically on supported platforms" OFF)
 option(SOLC_STATIC_STDLIBS "Link solc against static versions of libgcc and libstdc++ on supported platforms" OFF)
 option(STRICT_Z3_VERSION "Use the latest version of Z3" ON)
+option(PEDANTIC "Enable extra warnings and pedantic build flags. Treat all warnings as errors." ON)
+option(PROFILE_OPTIMIZER_STEPS "Output performance metrics for the optimiser steps." OFF)
 
 # Setup cccache.
 include(EthCcache)
@@ -48,6 +50,14 @@ include_directories(SYSTEM ${JSONCPP_INCLUDE_DIR})
 
 find_package(Threads)
 
+if(NOT PEDANTIC)
+  message(WARNING "-- Pedantic build flags turned off. Warnings will not make compilation fail. This is NOT recommended in development builds.")
+endif()
+
+if (PROFILE_OPTIMIZER_STEPS)
+    add_definitions(-DPROFILE_OPTIMIZER_STEPS)
+endif()
+
 # Figure out what compiler and system are we using
 include(EthCompilerSettings)
 
@@ -56,17 +66,22 @@ include(EthUtils)
 
 # Create license.h from LICENSE.txt and template
 # Converting to char array is required due to MSVC's string size limit.
-file(READ ${CMAKE_SOURCE_DIR}/LICENSE.txt LICENSE_TEXT HEX)
+file(READ ${PROJECT_SOURCE_DIR}/LICENSE.txt LICENSE_TEXT HEX)
 string(REGEX MATCHALL ".." LICENSE_TEXT "${LICENSE_TEXT}")
 string(REGEX REPLACE ";" ",\n\t0x" LICENSE_TEXT "${LICENSE_TEXT}")
 set(LICENSE_TEXT "0x${LICENSE_TEXT}")
 
-configure_file("${CMAKE_SOURCE_DIR}/cmake/templates/license.h.in" include/license.h)
+configure_file("${PROJECT_SOURCE_DIR}/cmake/templates/license.h.in" include/license.h)
 
 include(EthOptions)
 configure_project(TESTS)
+<<<<<<< HEAD
 set(LATEST_Z3_VERSION "4.8.13")
 set(MINIMUM_Z3_VERSION "4.8.0")
+=======
+set(LATEST_Z3_VERSION "4.12.1")
+set(MINIMUM_Z3_VERSION "4.8.16")
+>>>>>>> english/develop
 find_package(Z3)
 if (${Z3_FOUND})
   if (${STRICT_Z3_VERSION})
@@ -130,6 +145,7 @@ add_subdirectory(libevmasm)
 add_subdirectory(libyul)
 add_subdirectory(libsolidity)
 add_subdirectory(libsolc)
+add_subdirectory(libstdlib)
 add_subdirectory(tools)
 
 if (NOT EMSCRIPTEN)

docs/050-breaking-changes.rst

@@ -89,13 +89,23 @@ Pour la plupart des sujets, le compilateur fournira des suggestions.
   fonction et constructeur, et ``external`` à chaque fonction de fallback ou d'interface
   d'interface qui ne spécifie pas déjà sa visibilité.
 
+<<<<<<< HEAD
 * La localisation explicite des données pour toutes les variables de type struct, array ou mapping est
   maintenant obligatoire. Ceci s'applique également aux paramètres des fonctions et aux
   de retour.  Par exemple, changez ``uint[] x = m_x`` en ``uint[] storage x =
   m_x``, et ``fonction f(uint[][] x)`` en ``fonction f(uint[][] mémoire x)``
   où "memory" est l'emplacement des données et peut être remplacé par "storage" ou "calldata".
   ``calldata`` en conséquence.  Notez que les fonctions ``externes`` requièrent des
   paramètres dont l'emplacement des données est ``calldata``.
+=======
+* Explicit data location for all variables of struct, array or mapping types is
+  now mandatory. This is also applied to function parameters and return
+  variables.  For example, change ``uint[] x = z`` to ``uint[] storage x =
+  z``, and ``function f(uint[][] x)`` to ``function f(uint[][] memory x)``
+  where ``memory`` is the data location and might be replaced by ``storage`` or
+  ``calldata`` accordingly.  Note that ``external`` functions require
+  parameters with a data location of ``calldata``.
+>>>>>>> english/develop
 
 * Les types de contrats n'incluent plus les membres ``addresses`` afin de
   afin de séparer les espaces de noms.  Par conséquent, il est maintenant nécessaire de
@@ -139,8 +149,13 @@ Pour la plupart des sujets, le compilateur fournira des suggestions.
   payante " ou créez une nouvelle fonction interne pour la logique du programme qui
   utilise ``msg.value``.
 
+<<<<<<< HEAD
 * Pour des raisons de clarté, l'interface de la ligne de commande exige maintenant ``-`` si l'
   l'entrée standard est utilisée comme source.
+=======
+* For clarity reasons, the command-line interface now requires ``-`` if the
+  standard input is used as source.
+>>>>>>> english/develop
 
 Éléments dépréciés
 ===================
@@ -149,6 +164,7 @@ Cette section liste les changements qui déprécient des fonctionnalités ou des
 plusieurs de ces changements étaient déjà activés dans le mode expérimental
 ``v0.5.0``.
 
+<<<<<<< HEAD
 Interfaces en ligne de commande et JSON
 --------------------------------
 
@@ -162,6 +178,21 @@ Interfaces en ligne de commande et JSON
 
 * Les options de ligne de commande ``--clone-bin`` et ``--combined-json clone-bin`` ont été supprimées.
   ont été supprimées.
+=======
+Command-line and JSON Interfaces
+--------------------------------
+
+* The command-line option ``--formal`` (used to generate Why3 output for
+  further formal verification) was deprecated and is now removed.  A new
+  formal verification module, the SMTChecker, is enabled via ``pragma
+  experimental SMTChecker;``.
+
+* The command-line option ``--julia`` was renamed to ``--yul`` due to the
+  renaming of the intermediate language ``Julia`` to ``Yul``.
+
+* The ``--clone-bin`` and ``--combined-json clone-bin`` command-line options
+  were removed.
+>>>>>>> english/develop
 
 * Les remappages avec un préfixe vide ne sont pas autorisés.
 
@@ -485,7 +516,7 @@ Nouvelle version :
             return data;
         }
 
-        using address_make_payable for address;
+        using AddressMakePayable for address;
         // Data location for 'arr' must be specified
         function g(uint[] memory /* arr */, bytes8 x, OtherContract otherContract, address unknownContract) public payable {
             // 'otherContract.transfer' is not provided.
@@ -502,7 +533,7 @@ Nouvelle version :
             // 'address payable' should be used whenever possible.
             // To increase clarity, we suggest the use of a library for
             // the conversion (provided after the contract in this example).
-            address payable addr = unknownContract.make_payable();
+            address payable addr = unknownContract.makePayable();
             require(addr.send(1 ether));
 
             // Since uint32 (4 bytes) is smaller than bytes8 (8 bytes),
@@ -518,8 +549,8 @@ Nouvelle version :
 
     // We can define a library for explicitly converting ``address``
     // to ``address payable`` as a workaround.
-    library address_make_payable {
-        function make_payable(address x) internal pure returns (address payable) {
+    library AddressMakePayable {
+        function makePayable(address x) internal pure returns (address payable) {
             return address(uint160(x));
         }
     }

docs/060-breaking-changes.rst

@@ -12,8 +12,13 @@ Pour la liste complète, consultez
 Changements dont le compilateur pourrait ne pas être averti
 =========================================
 
+<<<<<<< HEAD
 Cette section liste les changements pour lesquels le comportement de votre code pourrait
 changer sans que le compilateur vous en avertisse.
+=======
+This section lists changes where the behavior of your code might
+change without the compiler telling you about it.
+>>>>>>> english/develop
 
 * Le type résultant d'une exponentiation est le type de la base. Il s'agissait auparavant du plus petit type
   qui peut contenir à la fois le type de la base et le type de l'exposant, comme pour les opérations symétriques.
@@ -53,9 +58,17 @@ Pour la plupart des sujets, le compilateur fournira des suggestions.
   Si le nom contient un point, son préfixe jusqu'au point ne doit pas entrer en conflit avec une déclaration en dehors du bloc d'assemblage en ligne.
   d'assemblage.
 
+<<<<<<< HEAD
 * Le shadowing de variables d'état est désormais interdit.  Un contrat dérivé peut seulement
   déclarer une variable d'état ``x``, que s'il n'y a pas de variable d'état visible avec le même nom
   d'état visible portant le même nom dans l'une de ses bases.
+=======
+* In inline assembly, opcodes that do not take arguments are now represented as "built-in functions" instead of standalone identifiers. So ``gas`` is now ``gas()``.
+
+* State variable shadowing is now disallowed.  A derived contract can only
+  declare a state variable ``x``, if there is no visible state variable with
+  the same name in any of its bases.
+>>>>>>> english/develop
 
 
 Changements sémantiques et syntaxiques
@@ -102,25 +115,45 @@ ou qui étaient plus difficiles à réaliser.
 Changements d'interface
 =================
 
+<<<<<<< HEAD
 Cette section liste les changements qui ne sont pas liés au langage lui-même, mais qui ont un effet sur les interfaces du compilateur.
 le compilateur. Ces modifications peuvent changer la façon dont vous utilisez le compilateur sur la ligne de commande, la façon dont vous utilisez son interface programmable, ou la façon dont vous analysez la sortie qu'il produit.
 ou comment vous analysez la sortie qu'il produit.
+=======
+This section lists changes that are unrelated to the language itself, but that have an effect on the interfaces of
+the compiler. These may change the way how you use the compiler on the command-line, how you use its programmable
+interface, or how you analyze the output produced by it.
+>>>>>>> english/develop
 
 Nouveau rapporteur d'erreurs
 ~~~~~~~~~~~~~~~~~~
 
+<<<<<<< HEAD
 Un nouveau rapporteur d'erreur a été introduit, qui vise à produire des messages d'erreur plus accessibles sur la ligne de commande.
 Il est activé par défaut, mais si vous passez ``--old-reporter``, vous revenez à l'ancien rapporteur d'erreurs, qui est déprécié.
+=======
+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 deprecated old error reporter.
+>>>>>>> english/develop
 
 Options de hachage des métadonnées
 ~~~~~~~~~~~~~~~~~~~~~
 
+<<<<<<< HEAD
 Le compilateur ajoute maintenant le hash `IPFS <https://ipfs.io/>`_ du fichier de métadonnées à la fin du bytecode par défaut.
 (pour plus de détails, voir la documentation sur :doc:`contract metadata <metadata>`). Avant la version 0.6.0, le compilateur ajoutait la balise
 `Swarm <https://ethersphere.github.io/swarm-home/>`_ hash par défaut, et afin de toujours supporter ce comportement,
 la nouvelle option de ligne de commande ``--metadata-hash`` a été introduite. Elle permet de sélectionner le hachage à produire et à ajouter
 ajouté, en passant soit ``ipfs`` soit ``swarm`` comme valeur à l'option de ligne de commande ``--metadata-hash``.
 Passer la valeur ``none`` supprime complètement le hachage.
+=======
+The compiler now appends the `IPFS <https://ipfs.io/>`_ hash of the metadata file to the end of the bytecode by default
+(for details, see documentation on :doc:`contract metadata <metadata>`). Before 0.6.0, the compiler appended the
+`Swarm <https://ethersphere.github.io/swarm-home/>`_ hash by default, and in order to still support this behavior,
+the new command-line option ``--metadata-hash`` was introduced. It allows you to select the hash to be produced and
+appended, by passing either ``ipfs`` or ``swarm`` as value to the ``--metadata-hash`` command-line option.
+Passing the value ``none`` completely removes the hash.
+>>>>>>> english/develop
 
 Ces changements peuvent également être utilisés via l'interface :ref:`Standard JSON Interface<compiler-api>` et affecter les métadonnées JSON générées par le compilateur.
 
@@ -169,8 +202,19 @@ Cette section donne des instructions détaillées sur la façon de mettre à jou
 * Choisissez des identifiants uniques pour les déclarations de variables dans l'assemblage en ligne qui n'entrent pas en conflit avec les déclarations en dehors de l'assemblage en ligne.
   avec des déclarations en dehors du bloc d'assemblage en ligne.
 
+<<<<<<< HEAD
 * Ajoutez "virtual" à chaque fonction non interface que vous avez l'intention de remplacer. Ajoutez ``virtual`` à toutes les fonctions sans implémentation en dehors des interfaces.
   à toutes les fonctions sans implémentation en dehors des interfaces. Pour l'héritage simple, ajoutez
   ``override`` à chaque fonction de remplacement. Pour l'héritage multiple, ajoutez ``override(A, B, ..)``,
   où vous listez entre parenthèses tous les contrats qui définissent la fonction surchargée. Lorsque
   plusieurs bases définissent la même fonction, le contrat qui hérite doit remplacer toutes les fonctions conflictuelles.
+=======
+* Add ``virtual`` to every non-interface function you intend to override. Add ``virtual``
+  to all functions without implementation outside interfaces. For single inheritance, add
+  ``override`` to every overriding function. For multiple inheritance, add ``override(A, B, ..)``,
+  where you list all contracts that define the overridden function in the parentheses. When
+  multiple bases define the same function, the inheriting contract must override all conflicting functions.
+
+* In inline assembly, add ``()`` to all opcodes that do not otherwise accept an argument.
+  For example, change ``pc`` to ``pc()``, and ``gas`` to ``gas()``.
+>>>>>>> english/develop

docs/080-breaking-changes.rst

@@ -10,20 +10,34 @@ le changelog de la version `0.8.0 <https://github.com/ethereum/solidity/releases
 Changements silencieux de la sémantique
 ===============================
 
+<<<<<<< HEAD
 Cette section répertorie les modifications où le code existant change de comportement sans que
 le compilateur vous en informe.
 
 * Les opérations arithmétiques s'inversent en cas de sous-dépassement et de dépassement. Vous pouvez utiliser ``unchecked { ... }`` pour utiliser
   le comportement d'enveloppement précédent.
+=======
+This section lists changes where existing code changes its behavior without
+the compiler notifying you about it.
+
+* Arithmetic operations revert on underflow and overflow. You can use ``unchecked { ... }`` to use
+  the previous wrapping behavior.
+>>>>>>> english/develop
 
   Les vérifications pour le débordement sont très communes, donc nous les avons faites par défaut pour augmenter la lisibilité du code,
   même si cela entraîne une légère augmentation du coût de l'essence.
 
 * ABI coder v2 est activé par défaut.
 
+<<<<<<< HEAD
   Vous pouvez choisir d'utiliser l'ancien comportement en utilisant ``pragma abicoder v1;``.
   Le pragma ``pragma experimental ABIEncoderV2;`` est toujours valide, mais il est déprécié et n'a aucun effet.
   Si vous voulez être explicite, veuillez utiliser le pragma ``pragma abicoder v2;`` à la place.
+=======
+  You can choose to use the old behavior using ``pragma abicoder v1;``.
+  The pragma ``pragma experimental ABIEncoderV2;`` is still valid, but it is deprecated and has no effect.
+  If you want to be explicit, please use ``pragma abicoder v2;`` instead.
+>>>>>>> english/develop
 
   Notez que ABI coder v2 supporte plus de types que v1 et effectue plus de contrôles d'intégrité sur les entrées.
   ABI coder v2 rend certains appels de fonctions plus coûteux et il peut aussi faire des appels de contrats
@@ -57,8 +71,13 @@ Nouvelles restrictions
 
 Cette section énumère les changements qui pourraient empêcher les contrats existants de se compiler.
 
+<<<<<<< HEAD
 * Il existe de nouvelles restrictions liées aux conversions explicites de littéraux. Le comportement précédent dans
   les cas suivants était probablement ambigu :
+=======
+* There are new restrictions related to explicit conversions of literals. The previous behavior in
+  the following cases was likely ambiguous:
+>>>>>>> english/develop
 
   1. Les conversions explicites de littéraux négatifs et de littéraux plus grands que ``type(uint160).max`` en
      ``adresse`` sont interdites.
@@ -106,7 +125,11 @@ Cette section énumère les changements qui pourraient empêcher les contrats ex
 
 * Les fonctions globales ``log0``, ``log1``, ``log2``, ``log3`` et ``log4`` ont été supprimées.
 
+<<<<<<< HEAD
   Ce sont des fonctions de bas niveau qui étaient largement inutilisées. Leur comportement est accessible depuis l'assemblage en ligne.
+=======
+  These are low-level functions that were largely unused. Their behavior can be accessed from inline assembly.
+>>>>>>> english/develop
 
 * Les définitions de ``enum`` ne peuvent pas contenir plus de 256 membres.
 
@@ -163,6 +186,7 @@ Changements d'interface
 Comment mettre à jour votre code
 =======================
 
+<<<<<<< HEAD
 - Si vous comptez sur l'arithmétique enveloppante, entourez chaque opération de ``unchecked { ... }``.
 - Optionnel : Si vous utilisez SafeMath ou une bibliothèque similaire, changez ``x.add(y)`` en ``x + y``, ``x.mul(y)`` en ``x * y`` etc.
 - Ajoutez ``pragma abicoder v1;`` si vous voulez rester avec l'ancien codeur ABI.
@@ -174,3 +198,16 @@ Comment mettre à jour votre code
 - Remplacez ``x**y**z`` par ``(x**y)**z``.
 - Utilisez l'assemblage en ligne en remplacement de ``log0``, ..., ``log4``.
 - Négation des entiers non signés en les soustrayant de la valeur maximale du type et en ajoutant 1 (par exemple, ``type(uint256).max - x + 1``, tout en s'assurant que `x` n'est pas zéro)
+=======
+- If you rely on wrapping arithmetic, surround each operation with ``unchecked { ... }``.
+- Optional: If you use SafeMath or a similar library, change ``x.add(y)`` to ``x + y``, ``x.mul(y)`` to ``x * y`` etc.
+- Add ``pragma abicoder v1;`` if you want to stay with the old ABI coder.
+- Optionally remove ``pragma experimental ABIEncoderV2`` or ``pragma abicoder v2`` since it is redundant.
+- Change ``byte`` to ``bytes1``.
+- Add intermediate explicit type conversions if required.
+- Combine ``c.f{gas: 10000}{value: 1}()`` to ``c.f{gas: 10000, value: 1}()``.
+- Change ``msg.sender.transfer(x)`` to ``payable(msg.sender).transfer(x)`` or use a stored variable of ``address payable`` type.
+- Change ``x**y**z`` to ``(x**y)**z``.
+- Use inline assembly as a replacement for ``log0``, ..., ``log4``.
+- Negate unsigned integers by subtracting them from the maximum value of the type and adding 1 (e.g. ``type(uint256).max - x + 1``, while ensuring that ``x`` is not zero)
+>>>>>>> english/develop

docs/Makefile

@@ -34,7 +34,6 @@ help:
 	@echo "  epub       to make an epub"
 	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
-	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
 	@echo "  text       to make text files"
 	@echo "  man        to make manual pages"
 	@echo "  texinfo    to make Texinfo files"
@@ -116,12 +115,6 @@ latexpdf:
 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
-latexpdfja:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through platex and dvipdfmx..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
 text:
 	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
 	@echo