******************************** Layout of a Solidity Source File ******************************** Source files can contain an arbitrary number of :ref:`contract definitions`, import_ directives, :ref:`pragma directives` and :ref:`struct`, :ref:`enum`, :ref:`function`, :ref:`error` and :ref:`constant variable` definitions. .. index:: ! license, spdx SPDX License Identifier ======================= Trust in smart contract can be better established if their source code is available. Since making source code available always touches on legal problems with regards to copyright, the Solidity compiler encourages the use of machine-readable `SPDX license identifiers `_. Every source file should start with a comment indicating its license: ``// SPDX-License-Identifier: MIT`` The compiler does not validate that the license is part of the `list allowed by SPDX `_, but it does include the supplied string in the :ref:`bytecode metadata `. If you do not want to specify a license or if the source code is not open-source, please use the special value ``UNLICENSED``. Supplying this comment of course does not free you from other obligations related to licensing like having to mention a specific license header in each source file or the original copyright holder. The comment is recognized by the compiler anywhere in the file at the file level, but it is recommended to put it at the top of the file. More information about how to use SPDX license identifiers can be found at the `SPDX website `_. .. index:: ! pragma .. _pragma: Pragmas ======= The ``pragma`` keyword is used to enable certain compiler features or checks. A pragma directive is always local to a source file, so you have to add the pragma to all your files if you want to enable it in your whole project. If you :ref:`import` another file, the pragma from that file does *not* automatically apply to the importing file. .. index:: ! pragma, version .. _version_pragma: Version Pragma -------------- Source files can (and should) be annotated with a version pragma to reject compilation with future compiler versions that might introduce incompatible changes. We try to keep these to an absolute minimum and introduce them in a way that changes in semantics also require changes in the syntax, but this is not always possible. Because of this, it is always a good idea to read through the changelog at least for releases that contain breaking changes. These releases always have versions of the form ``0.x.0`` or ``x.0.0``. The version pragma is used as follows: ``pragma solidity ^0.5.2;`` A source file with the line above does not compile with a compiler earlier than version 0.5.2, and it also does not work on a compiler starting from version 0.6.0 (this second condition is added by using ``^``). Because there will be no breaking changes until version ``0.6.0``, you can be sure that your code compiles the way you intended. The exact version of the compiler is not fixed, so that bugfix releases are still possible. It is possible to specify more complex rules for the compiler version, these follow the same syntax used by `npm `_. .. note:: Using the version pragma *does not* change the version of the compiler. It also *does not* enable or disable features of the compiler. It just instructs the compiler to check whether its version matches the one required by the pragma. If it does not match, the compiler issues an error. ABI Coder Pragma ---------------- By using ``pragma abicoder v1`` or ``pragma abicoder v2`` you can select between the two implementations of the ABI encoder and decoder. The new ABI coder (v2) is able to encode and decode arbitrarily nested arrays and structs. It might produce less optimal code and has not received as much testing as the old encoder, but is considered non-experimental as of Solidity 0.6.0. You still have to explicitly activate it using ``pragma abicoder v2;``. Since it will be activated by default starting from Solidity 0.8.0, there is the option to select the old coder using ``pragma abicoder v1;``. The set of types supported by the new encoder is a strict superset of the ones supported by the old one. Contracts that use it can interact with ones that do not without limitations. The reverse is possible only as long as the non-``abicoder v2`` contract does not try to make calls that would require decoding types only supported by the new encoder. The compiler can detect this and will issue an error. Simply enabling ``abicoder v2`` for your contract is enough to make the error go away. .. note:: This pragma applies to all the code defined in the file where it is activated, regardless of where that code ends up eventually. This means that a contract whose source file is selected to compile with ABI coder v1 can still contain code that uses the new encoder by inheriting it from another contract. This is allowed if the new types are only used internally and not in external function signatures. .. note:: Up to Solidity 0.7.4, it was possible to select the ABI coder v2 by using ``pragma experimental ABIEncoderV2``, but it was not possible to explicitly select coder v1 because it was the default. .. index:: ! pragma, experimental .. _experimental_pragma: Experimental Pragma ------------------- The second pragma is the experimental pragma. It can be used to enable features of the compiler or language that are not yet enabled by default. The following experimental pragmas are currently supported: ABIEncoderV2 ~~~~~~~~~~~~ Because the ABI coder v2 is not considered experimental anymore, it can be selected via ``pragma abicoder v2`` (please see above) since Solidity 0.7.4. .. _smt_checker: SMTChecker ~~~~~~~~~~ This component has to be enabled when the Solidity compiler is built and therefore it is not available in all Solidity binaries. The :ref:`build instructions` explain how to activate this option. It is activated for the Ubuntu PPA releases in most versions, but not for the Docker images, Windows binaries or the statically-built Linux binaries. It can be activated for solc-js via the `smtCallback `_ if you have an SMT solver installed locally and run solc-js via node (not via the browser). If you use ``pragma experimental SMTChecker;``, then you get additional :ref:`safety warnings` which are obtained by querying an SMT solver. The component does not yet support all features of the Solidity language and likely outputs many warnings. In case it reports unsupported features, the analysis may not be fully sound. .. index:: source file, ! import, module, source unit .. _import: Importing other Source Files ============================ Syntax and Semantics -------------------- Solidity supports import statements to help modularise your code that are similar to those available in JavaScript (from ES6 on). However, Solidity does not support the concept of a `default export `_. At a global level, you can use import statements of the following form: :: import "filename"; This statement imports all global symbols from "filename" (and symbols imported there) into the current global scope (different than in ES6 but backwards-compatible for Solidity). This form is not recommended for use, because it unpredictably pollutes the namespace. If you add new top-level items inside "filename", they automatically appear in all files that import like this from "filename". It is better to import specific symbols explicitly. The following example creates a new global symbol ``symbolName`` whose members are all the global symbols from ``"filename"``: :: import * as symbolName from "filename"; which results in all global symbols being available in the format ``symbolName.symbol``. A variant of this syntax that is not part of ES6, but possibly useful is: :: import "filename" as symbolName; which is equivalent to ``import * as symbolName from "filename";``. If there is a naming collision, you can rename symbols while importing. For example, the code below creates new global symbols ``alias`` and ``symbol2`` which reference ``symbol1`` and ``symbol2`` from inside ``"filename"``, respectively. :: import {symbol1 as alias, symbol2} from "filename"; .. index:: virtual filesystem, source unit name, import; path, filesystem path Import paths ------------ The paths used in imports in a general case do not have to be filesystem paths. The compiler maintains an internal database (:ref:`virtual filesystem `) where each compiled source unit is assigned a unique *source unit name* which is an opaque and unstructured identifier. The import path is translated into a source unit name and used to find the corresponding source unit in this database. If you directly provide source code to the compiler using the :ref:`Standard JSON interface `, you can choose arbitrary source unit names and use them in your imports, completely ignoring the actual filesystem. While this mechanism provides a lot of freedom, in most cases the source files do reside on disk and it is convenient if the compiler can find and load them automatically. For this reason, if the source unit name corresponding to the import path is not found in the virtual filesystem, the compiler invokes the file loader. If you are using the command-line interface, the file loader simply assumes that the source unit name passed to it is a path and tries to load the file from the actual filesystem. The `JavaScript interface `_ is a bit more flexible in that regard and allows the user to provide a callback to load the file. `The Remix IDE `_ uses this mechanism to allow files to be imported directly from github. The compiler recognizes two kinds of imports, based on how the import path looks like: - All the imports mentioned in the previous section are :ref:`direct imports `. In this case the import path simply becomes the source unit name. Examples: .. code-block:: solidity import "contracts/lib/token.sol" as token1; import "@contracts/lib/token.sol" as token2; import "/contracts/lib/token.sol" as token3; import "https://example.com/contracts/lib/token.sol" as token4; - The other kind is a :ref:`relative import `. Such an import must start with ``./`` or ``../``: .. code-block:: solidity import "./contracts/lib/token.sol" as token1; import "../contracts/lib/token.sol" as token2; Unlike in case of a direct import, the compiler does assume that the import path is actually a path. The source unit name is a result of combining the source unit name of the importing file with the part of the path provided in the statement. There are several compiler features that can affect import paths. Imports can be redirected using :ref:`import remapping ` while the way file loader resolves relative paths depends on :ref:`base path `. For a complete description of the virtual filesystem and the path resolution logic used by the compiler see :ref:`Path Resolution `. .. index:: ! comment, natspec Comments ======== Single-line comments (``//``) and multi-line comments (``/*...*/``) are possible. :: // This is a single-line comment. /* This is a multi-line comment. */ .. note:: A single-line comment is terminated by any unicode line terminator (LF, VF, FF, CR, NEL, LS or PS) in UTF-8 encoding. The terminator is still part of the source code after the comment, so if it is not an ASCII symbol (these are NEL, LS and PS), it will lead to a parser error. Additionally, there is another type of comment called a NatSpec comment, which is detailed in the :ref:`style guide`. They are written with a triple slash (``///``) or a double asterisk block (``/** ... */``) and they should be used directly above function declarations or statements.