Module foundry_compilers_core::utils

Utility functions

Constants

• BERLIN_SOLC
  Berlin support https://blog.soliditylang.org/2021/06/10/solidity-0.8.5-release-announcement/
• BYZANTIUM_SOLC
  Support for configuring the EVM version https://blog.soliditylang.org/2018/03/08/solidity-0.4.21-release-announcement/
• CANCUN_SOLC
  Cancun support https://soliditylang.org/blog/2024/01/26/solidity-0.8.24-release-announcement/
• CONSTANTINOPLE_SOLC
  Bug fix for configuring the EVM version with Constantinople https://blog.soliditylang.org/2018/03/08/solidity-0.4.21-release-announcement/
• ISTANBUL_SOLC
  Istanbul support https://blog.soliditylang.org/2019/12/09/solidity-0.5.14-release-announcement/
• LONDON_SOLC
  London support https://blog.soliditylang.org/2021/08/11/solidity-0.8.7-release-announcement/
• PARIS_SOLC
  Paris support https://blog.soliditylang.org/2023/02/01/solidity-0.8.18-release-announcement/
• PETERSBURG_SOLC
  Petersburg support https://blog.soliditylang.org/2019/03/05/solidity-0.5.5-release-announcement/
• PRAGUE_SOLC
  Prague support https://github.com/ethereum/solidity/pull/15152 Was merged between 0.8.26 and 0.8.27, so we are expecting it to be available in 0.8.27
• SHANGHAI_SOLC
  Shanghai support https://blog.soliditylang.org/2023/05/10/solidity-0.8.20-release-announcement/
• SOLC_EXTENSIONS
  Extensions acceptable by solc compiler.

Statics

• RE_SOL_IMPORT
  A regex that matches the import path and identifier of a solidity import statement with the named groups “path”, “id”.
• RE_SOL_IMPORT_ALIAS
  A regex that matches an alias within an import statement
• RE_SOL_PRAGMA_VERSION
  A regex that matches the version part of a solidity pragma as follows: pragma solidity ^0.5.2; => ^0.5.2 statement with the named group “version”.
• RE_SOL_SDPX_LICENSE_IDENTIFIER
  A regex that matches the SDPX license identifier statement with the named group “license”.
• RE_THREE_OR_MORE_NEWLINES
  A regex used to remove extra lines in flatenned files
• RE_VYPER_VERSION
  A regex that matches version pragma in a Vyper
• SUPPORTS_BASE_PATH
• SUPPORTS_INCLUDE_PATH

Functions

• canonicalize
  Canonicalize the path, platform-agnostic.
• canonicalized
  Returns the same path config but with canonicalized paths.
• capture_outer_and_inner
  Given the regex and the target string, find all occurrences of named groups within the string. This method returns the tuple of matches (a, b) where a is the match for the entire regex and b is the match for the first named group.
• common_ancestor
  Finds the common ancestor of both paths
• common_ancestor_all
  Find the common ancestor, if any, between the given paths
• create_contract_or_lib_name_regex
  Create a regex that matches any library or contract name inside a file
• create_parent_dir_all
  Creates the parent directory of the file and all its ancestors if it does not exist.
• find_case_sensitive_existing_file
  Attempts to find a file with different case that exists next to the non_existing file
• find_fave_or_alt_path
  Returns the right subpath in a dir
• find_import_paths
  Returns all path parts from any solidity import statement in a string, import "./contracts/Contract.sol"; -> "./contracts/Contract.sol".
• find_version_pragma
  Returns the solidity version pragma from the given input: pragma solidity ^0.5.2; => ^0.5.2
• installed_versions
  Reads the list of Solc versions that have been installed in the machine. The version list is sorted in ascending order. Checks for installed solc versions under the given path as <root>/<major.minor.path>, (e.g.: ~/.svm/0.8.10) and returns them sorted in ascending order
• is_local_source_name
  Attempts to determine if the given source is a local, relative import.
• library_fully_qualified_placeholder
  Returns the 36 char (deprecated) fully qualified name placeholder
• library_hash
  Returns the library placeholder for the given name The placeholder is a 34 character prefix of the hex encoding of the keccak256 hash of the fully qualified library name.
• library_hash_placeholder
  Returns the library hash placeholder as $hex(library_hash(name))$
• normalize_solidity_import_path
  Returns a normalized Solidity file path for the given import path based on the specified directory.
• range_by_offset
  Move a range by a specified offset
• read_json_file
  Reads the json file and deserialize it into the provided type.
• resolve_absolute_library
  Tries to find an absolute import like src/interfaces/IConfig.sol in cwd, moving up the path until the root is reached.
• resolve_library
  Returns the path to the library if the source path is in fact determined to be a library path, and it exists. Note: this does not handle relative imports or remappings.
• sol_source_files
  Same as source_files but only returns files acceptable by Solc compiler.
• solidity_dirs
  Returns a list of unique paths to all folders under root that contain at least one solidity file (*.sol).
• source_files
  Returns a list of absolute paths to all the solidity files under the root, or the file itself, if the path is a solidity file.
• source_files_iter
  Returns an iterator that yields all solidity/yul files funder under the given root path or the root itself, if it is a sol/yul file
• source_name
  Returns the source name for the given source path, the ancestors of the root path.
• strip_prefix
  Strips root from source and returns the relative path.
• strip_prefix_owned
  Strips root from source and returns the relative path.
• write_json_file
  Writes serializes the provided value to JSON and writes it to a file.