/* This file is part of solidity. solidity is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. solidity is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with solidity. If not, see . */ /** * @author Alex Beregszaszi * @date 2016 * Standard JSON compiler interface. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace std; using namespace solidity; using namespace solidity::yul; using namespace solidity::frontend; using namespace solidity::langutil; namespace { Json::Value formatError( bool _warning, string const& _type, string const& _component, string const& _message, string const& _formattedMessage = "", Json::Value const& _sourceLocation = Json::Value(), Json::Value const& _secondarySourceLocation = Json::Value() ) { Json::Value error = Json::objectValue; error["type"] = _type; error["component"] = _component; error["severity"] = _warning ? "warning" : "error"; error["message"] = _message; error["formattedMessage"] = (_formattedMessage.length() > 0) ? _formattedMessage : _message; if (_sourceLocation.isObject()) error["sourceLocation"] = _sourceLocation; if (_secondarySourceLocation.isArray()) error["secondarySourceLocations"] = _secondarySourceLocation; return error; } Json::Value formatFatalError(string const& _type, string const& _message) { Json::Value output = Json::objectValue; output["errors"] = Json::arrayValue; output["errors"].append(formatError(false, _type, "general", _message)); return output; } Json::Value formatSourceLocation(SourceLocation const* location) { Json::Value sourceLocation; if (location && location->source && !location->source->name().empty()) { sourceLocation["file"] = location->source->name(); sourceLocation["start"] = location->start; sourceLocation["end"] = location->end; } return sourceLocation; } Json::Value formatSecondarySourceLocation(SecondarySourceLocation const* _secondaryLocation) { if (!_secondaryLocation) return {}; Json::Value secondarySourceLocation = Json::arrayValue; for (auto const& location: _secondaryLocation->infos) { Json::Value msg = formatSourceLocation(&location.second); msg["message"] = location.first; secondarySourceLocation.append(msg); } return secondarySourceLocation; } Json::Value formatErrorWithException( util::Exception const& _exception, bool const& _warning, string const& _type, string const& _component, string const& _message, optional _errorId = nullopt ) { string message; string formattedMessage = SourceReferenceFormatter::formatExceptionInformation(_exception, _type); if (string const* description = boost::get_error_info(_exception)) message = ((_message.length() > 0) ? (_message + ":") : "") + *description; else message = _message; Json::Value error = formatError( _warning, _type, _component, message, formattedMessage, formatSourceLocation(boost::get_error_info(_exception)), formatSecondarySourceLocation(boost::get_error_info(_exception)) ); if (_errorId) error["errorCode"] = to_string(_errorId.value().error); return error; } map> requestedContractNames(Json::Value const& _outputSelection) { map> contracts; for (auto const& sourceName: _outputSelection.getMemberNames()) { string key = (sourceName == "*") ? "" : sourceName; for (auto const& contractName: _outputSelection[sourceName].getMemberNames()) { string value = (contractName == "*") ? "" : contractName; contracts[key].insert(value); } } return contracts; } /// Returns true iff @a _hash (hex with 0x prefix) is the Keccak256 hash of the binary data in @a _content. bool hashMatchesContent(string const& _hash, string const& _content) { try { return util::h256(_hash) == util::keccak256(_content); } catch (util::BadHexCharacter const&) { return false; } } bool isArtifactRequested(Json::Value const& _outputSelection, string const& _artifact, bool _wildcardMatchesExperimental) { static set experimental{"ir", "irOptimized", "wast", "ewasm", "ewasm.wast"}; for (auto const& artifact: _outputSelection) /// @TODO support sub-matching, e.g "evm" matches "evm.assembly" if (artifact == _artifact) return true; else if (artifact == "*") { // "ir", "irOptimized", "wast" and "ewasm.wast" can only be matched by "*" if activated. if (experimental.count(_artifact) == 0 || _wildcardMatchesExperimental) return true; } return false; } /// /// @a _outputSelection is a JSON object containing a two-level hashmap, where the first level is the filename, /// the second level is the contract name and the value is an array of artifact names to be requested for that contract. /// @a _file is the current file /// @a _contract is the current contract /// @a _artifact is the current artifact name /// /// @returns true if the @a _outputSelection has a match for the requested target in the specific file / contract. /// /// In @a _outputSelection the use of '*' as a wildcard is permitted. /// /// @TODO optimise this. Perhaps flatten the structure upfront. /// bool isArtifactRequested(Json::Value const& _outputSelection, string const& _file, string const& _contract, string const& _artifact, bool _wildcardMatchesExperimental) { if (!_outputSelection.isObject()) return false; for (auto const& file: { _file, string("*") }) if (_outputSelection.isMember(file) && _outputSelection[file].isObject()) { /// For SourceUnit-level targets (such as AST) only allow empty name, otherwise /// for Contract-level targets try both contract name and wildcard vector contracts{ _contract }; if (!_contract.empty()) contracts.emplace_back("*"); for (auto const& contract: contracts) if ( _outputSelection[file].isMember(contract) && _outputSelection[file][contract].isArray() && isArtifactRequested(_outputSelection[file][contract], _artifact, _wildcardMatchesExperimental) ) return true; } return false; } bool isArtifactRequested(Json::Value const& _outputSelection, string const& _file, string const& _contract, vector const& _artifacts, bool _wildcardMatchesExperimental) { for (auto const& artifact: _artifacts) if (isArtifactRequested(_outputSelection, _file, _contract, artifact, _wildcardMatchesExperimental)) return true; return false; } /// @returns true if any binary was requested, i.e. we actually have to perform compilation. bool isBinaryRequested(Json::Value const& _outputSelection) { if (!_outputSelection.isObject()) return false; // This does not include "evm.methodIdentifiers" on purpose! static vector const outputsThatRequireBinaries{ "*", "ir", "irOptimized", "wast", "wasm", "ewasm.wast", "ewasm.wasm", "evm.deployedBytecode", "evm.deployedBytecode.object", "evm.deployedBytecode.opcodes", "evm.deployedBytecode.sourceMap", "evm.deployedBytecode.linkReferences", "evm.deployedBytecode.immutableReferences", "evm.bytecode", "evm.bytecode.object", "evm.bytecode.opcodes", "evm.bytecode.sourceMap", "evm.bytecode.linkReferences", "evm.gasEstimates", "evm.legacyAssembly", "evm.assembly" }; for (auto const& fileRequests: _outputSelection) for (auto const& requests: fileRequests) for (auto const& output: outputsThatRequireBinaries) if (isArtifactRequested(requests, output, false)) return true; return false; } /// @returns true if any Ewasm code was requested. Note that as an exception, '*' does not /// yet match "ewasm.wast" or "ewasm" bool isEwasmRequested(Json::Value const& _outputSelection) { if (!_outputSelection.isObject()) return false; for (auto const& fileRequests: _outputSelection) for (auto const& requests: fileRequests) for (auto const& request: requests) if (request == "ewasm" || request == "ewasm.wast") return true; return false; } /// @returns true if any Yul IR was requested. Note that as an exception, '*' does not /// yet match "ir" or "irOptimized" bool isIRRequested(Json::Value const& _outputSelection) { if (isEwasmRequested(_outputSelection)) return true; if (!_outputSelection.isObject()) return false; for (auto const& fileRequests: _outputSelection) for (auto const& requests: fileRequests) for (auto const& request: requests) if (request == "ir" || request == "irOptimized") return true; return false; } Json::Value formatLinkReferences(std::map const& linkReferences) { Json::Value ret(Json::objectValue); for (auto const& ref: linkReferences) { string const& fullname = ref.second; size_t colon = fullname.rfind(':'); solAssert(colon != string::npos, ""); string file = fullname.substr(0, colon); string name = fullname.substr(colon + 1); Json::Value fileObject = ret.get(file, Json::objectValue); Json::Value libraryArray = fileObject.get(name, Json::arrayValue); Json::Value entry = Json::objectValue; entry["start"] = Json::UInt(ref.first); entry["length"] = 20; libraryArray.append(entry); fileObject[name] = libraryArray; ret[file] = fileObject; } return ret; } Json::Value formatImmutableReferences(map>> const& _immutableReferences) { Json::Value ret(Json::objectValue); for (auto const& immutableReference: _immutableReferences) { auto const& [identifier, byteOffsets] = immutableReference.second; Json::Value array(Json::arrayValue); for (size_t byteOffset: byteOffsets) { Json::Value byteRange(Json::objectValue); byteRange["start"] = Json::UInt(byteOffset); byteRange["length"] = Json::UInt(32); // immutable references are currently always 32 bytes wide array.append(byteRange); } ret[identifier] = array; } return ret; } Json::Value collectEVMObject(evmasm::LinkerObject const& _object, string const* _sourceMap, bool _runtimeObject) { Json::Value output = Json::objectValue; output["object"] = _object.toHex(); output["opcodes"] = evmasm::disassemble(_object.bytecode); output["sourceMap"] = _sourceMap ? *_sourceMap : ""; output["linkReferences"] = formatLinkReferences(_object.linkReferences); if (_runtimeObject) output["immutableReferences"] = formatImmutableReferences(_object.immutableReferences); return output; } std::optional checkKeys(Json::Value const& _input, set const& _keys, string const& _name) { if (!!_input && !_input.isObject()) return formatFatalError("JSONError", "\"" + _name + "\" must be an object"); for (auto const& member: _input.getMemberNames()) if (!_keys.count(member)) return formatFatalError("JSONError", "Unknown key \"" + member + "\""); return std::nullopt; } std::optional checkRootKeys(Json::Value const& _input) { static set keys{"auxiliaryInput", "language", "settings", "sources"}; return checkKeys(_input, keys, "root"); } std::optional checkSourceKeys(Json::Value const& _input, string const& _name) { static set keys{"content", "keccak256", "urls"}; return checkKeys(_input, keys, "sources." + _name); } std::optional checkAuxiliaryInputKeys(Json::Value const& _input) { static set keys{"smtlib2responses"}; return checkKeys(_input, keys, "auxiliaryInput"); } std::optional checkSettingsKeys(Json::Value const& _input) { static set keys{"parserErrorRecovery", "debug", "evmVersion", "libraries", "metadata", "optimizer", "outputSelection", "remappings"}; return checkKeys(_input, keys, "settings"); } std::optional checkOptimizerKeys(Json::Value const& _input) { static set keys{"details", "enabled", "runs"}; return checkKeys(_input, keys, "settings.optimizer"); } std::optional checkOptimizerDetailsKeys(Json::Value const& _input) { static set keys{"peephole", "jumpdestRemover", "orderLiterals", "deduplicate", "cse", "constantOptimizer", "yul", "yulDetails"}; return checkKeys(_input, keys, "settings.optimizer.details"); } std::optional checkOptimizerDetail(Json::Value const& _details, std::string const& _name, bool& _setting) { if (_details.isMember(_name)) { if (!_details[_name].isBool()) return formatFatalError("JSONError", "\"settings.optimizer.details." + _name + "\" must be Boolean"); _setting = _details[_name].asBool(); } return {}; } std::optional checkOptimizerDetailSteps(Json::Value const& _details, std::string const& _name, string& _setting) { if (_details.isMember(_name)) { if (_details[_name].isString()) { try { yul::OptimiserSuite::validateSequence(_details[_name].asString()); } catch (yul::OptimizerException const& _exception) { return formatFatalError( "JSONError", "Invalid optimizer step sequence in \"settings.optimizer.details." + _name + "\": " + _exception.what() ); } _setting = _details[_name].asString(); } else return formatFatalError("JSONError", "\"settings.optimizer.details." + _name + "\" must be a string"); } return {}; } std::optional checkMetadataKeys(Json::Value const& _input) { if (_input.isObject()) { if (_input.isMember("useLiteralContent") && !_input["useLiteralContent"].isBool()) return formatFatalError("JSONError", "\"settings.metadata.useLiteralContent\" must be Boolean"); static set hashes{"ipfs", "bzzr1", "none"}; if (_input.isMember("bytecodeHash") && !hashes.count(_input["bytecodeHash"].asString())) return formatFatalError("JSONError", "\"settings.metadata.bytecodeHash\" must be \"ipfs\", \"bzzr1\" or \"none\""); } static set keys{"useLiteralContent", "bytecodeHash"}; return checkKeys(_input, keys, "settings.metadata"); } std::optional checkOutputSelection(Json::Value const& _outputSelection) { if (!!_outputSelection && !_outputSelection.isObject()) return formatFatalError("JSONError", "\"settings.outputSelection\" must be an object"); for (auto const& sourceName: _outputSelection.getMemberNames()) { auto const& sourceVal = _outputSelection[sourceName]; if (!sourceVal.isObject()) return formatFatalError( "JSONError", "\"settings.outputSelection." + sourceName + "\" must be an object" ); for (auto const& contractName: sourceVal.getMemberNames()) { auto const& contractVal = sourceVal[contractName]; if (!contractVal.isArray()) return formatFatalError( "JSONError", "\"settings.outputSelection." + sourceName + "." + contractName + "\" must be a string array" ); for (auto const& output: contractVal) if (!output.isString()) return formatFatalError( "JSONError", "\"settings.outputSelection." + sourceName + "." + contractName + "\" must be a string array" ); } } return std::nullopt; } /// Validates the optimizer settings and returns them in a parsed object. /// On error returns the json-formatted error message. std::variant parseOptimizerSettings(Json::Value const& _jsonInput) { if (auto result = checkOptimizerKeys(_jsonInput)) return *result; OptimiserSettings settings = OptimiserSettings::none(); if (_jsonInput.isMember("enabled")) { if (!_jsonInput["enabled"].isBool()) return formatFatalError("JSONError", "The \"enabled\" setting must be a Boolean."); settings = _jsonInput["enabled"].asBool() ? OptimiserSettings::standard() : OptimiserSettings::minimal(); } if (_jsonInput.isMember("runs")) { if (!_jsonInput["runs"].isUInt()) return formatFatalError("JSONError", "The \"runs\" setting must be an unsigned number."); settings.expectedExecutionsPerDeployment = _jsonInput["runs"].asUInt(); } if (_jsonInput.isMember("details")) { Json::Value const& details = _jsonInput["details"]; if (auto result = checkOptimizerDetailsKeys(details)) return *result; if (auto error = checkOptimizerDetail(details, "peephole", settings.runPeephole)) return *error; if (auto error = checkOptimizerDetail(details, "jumpdestRemover", settings.runJumpdestRemover)) return *error; if (auto error = checkOptimizerDetail(details, "orderLiterals", settings.runOrderLiterals)) return *error; if (auto error = checkOptimizerDetail(details, "deduplicate", settings.runDeduplicate)) return *error; if (auto error = checkOptimizerDetail(details, "cse", settings.runCSE)) return *error; if (auto error = checkOptimizerDetail(details, "constantOptimizer", settings.runConstantOptimiser)) return *error; if (auto error = checkOptimizerDetail(details, "yul", settings.runYulOptimiser)) return *error; settings.optimizeStackAllocation = settings.runYulOptimiser; if (details.isMember("yulDetails")) { if (!settings.runYulOptimiser) return formatFatalError("JSONError", "\"Providing yulDetails requires Yul optimizer to be enabled."); if (auto result = checkKeys(details["yulDetails"], {"stackAllocation", "optimizerSteps"}, "settings.optimizer.details.yulDetails")) return *result; if (auto error = checkOptimizerDetail(details["yulDetails"], "stackAllocation", settings.optimizeStackAllocation)) return *error; if (auto error = checkOptimizerDetailSteps(details["yulDetails"], "optimizerSteps", settings.yulOptimiserSteps)) return *error; } } return { std::move(settings) }; } } std::variant StandardCompiler::parseInput(Json::Value const& _input) { InputsAndSettings ret; if (!_input.isObject()) return formatFatalError("JSONError", "Input is not a JSON object."); if (auto result = checkRootKeys(_input)) return *result; ret.language = _input["language"].asString(); Json::Value const& sources = _input["sources"]; if (!sources.isObject() && !sources.isNull()) return formatFatalError("JSONError", "\"sources\" is not a JSON object."); if (sources.empty()) return formatFatalError("JSONError", "No input sources specified."); ret.errors = Json::arrayValue; for (auto const& sourceName: sources.getMemberNames()) { string hash; if (auto result = checkSourceKeys(sources[sourceName], sourceName)) return *result; if (sources[sourceName]["keccak256"].isString()) hash = sources[sourceName]["keccak256"].asString(); if (sources[sourceName]["content"].isString()) { string content = sources[sourceName]["content"].asString(); if (!hash.empty() && !hashMatchesContent(hash, content)) ret.errors.append(formatError( false, "IOError", "general", "Mismatch between content and supplied hash for \"" + sourceName + "\"" )); else ret.sources[sourceName] = content; } else if (sources[sourceName]["urls"].isArray()) { if (!m_readFile) return formatFatalError("JSONError", "No import callback supplied, but URL is requested."); bool found = false; vector failures; for (auto const& url: sources[sourceName]["urls"]) { if (!url.isString()) return formatFatalError("JSONError", "URL must be a string."); ReadCallback::Result result = m_readFile(ReadCallback::kindString(ReadCallback::Kind::ReadFile), url.asString()); if (result.success) { if (!hash.empty() && !hashMatchesContent(hash, result.responseOrErrorMessage)) ret.errors.append(formatError( false, "IOError", "general", "Mismatch between content and supplied hash for \"" + sourceName + "\" at \"" + url.asString() + "\"" )); else { ret.sources[sourceName] = result.responseOrErrorMessage; found = true; break; } } else failures.push_back("Cannot import url (\"" + url.asString() + "\"): " + result.responseOrErrorMessage); } for (auto const& failure: failures) { /// If the import succeeded, let mark all the others as warnings, otherwise all of them are errors. ret.errors.append(formatError( found ? true : false, "IOError", "general", failure )); } } else return formatFatalError("JSONError", "Invalid input source specified."); } Json::Value const& auxInputs = _input["auxiliaryInput"]; if (auto result = checkAuxiliaryInputKeys(auxInputs)) return *result; if (!!auxInputs) { Json::Value const& smtlib2Responses = auxInputs["smtlib2responses"]; if (!!smtlib2Responses) { if (!smtlib2Responses.isObject()) return formatFatalError("JSONError", "\"auxiliaryInput.smtlib2responses\" must be an object."); for (auto const& hashString: smtlib2Responses.getMemberNames()) { util::h256 hash; try { hash = util::h256(hashString); } catch (util::BadHexCharacter const&) { return formatFatalError("JSONError", "Invalid hex encoding of SMTLib2 auxiliary input."); } if (!smtlib2Responses[hashString].isString()) return formatFatalError( "JSONError", "\"smtlib2Responses." + hashString + "\" must be a string." ); ret.smtLib2Responses[hash] = smtlib2Responses[hashString].asString(); } } } Json::Value const& settings = _input.get("settings", Json::Value()); if (auto result = checkSettingsKeys(settings)) return *result; if (settings.isMember("parserErrorRecovery")) { if (!settings["parserErrorRecovery"].isBool()) return formatFatalError("JSONError", "\"settings.parserErrorRecovery\" must be a Boolean."); ret.parserErrorRecovery = settings["parserErrorRecovery"].asBool(); } if (settings.isMember("evmVersion")) { if (!settings["evmVersion"].isString()) return formatFatalError("JSONError", "evmVersion must be a string."); std::optional version = langutil::EVMVersion::fromString(settings["evmVersion"].asString()); if (!version) return formatFatalError("JSONError", "Invalid EVM version requested."); ret.evmVersion = *version; } if (settings.isMember("debug")) { if (auto result = checkKeys(settings["debug"], {"revertStrings"}, "settings.debug")) return *result; if (settings["debug"].isMember("revertStrings")) { if (!settings["debug"]["revertStrings"].isString()) return formatFatalError("JSONError", "settings.debug.revertStrings must be a string."); std::optional revertStrings = revertStringsFromString(settings["debug"]["revertStrings"].asString()); if (!revertStrings) return formatFatalError("JSONError", "Invalid value for settings.debug.revertStrings."); if (*revertStrings == RevertStrings::VerboseDebug) return formatFatalError( "UnimplementedFeatureError", "Only \"default\", \"strip\" and \"debug\" are implemented for settings.debug.revertStrings for now." ); ret.revertStrings = *revertStrings; } } if (settings.isMember("remappings") && !settings["remappings"].isArray()) return formatFatalError("JSONError", "\"settings.remappings\" must be an array of strings."); for (auto const& remapping: settings.get("remappings", Json::Value())) { if (!remapping.isString()) return formatFatalError("JSONError", "\"settings.remappings\" must be an array of strings"); if (auto r = CompilerStack::parseRemapping(remapping.asString())) ret.remappings.emplace_back(std::move(*r)); else return formatFatalError("JSONError", "Invalid remapping: \"" + remapping.asString() + "\""); } if (settings.isMember("optimizer")) { auto optimiserSettings = parseOptimizerSettings(settings["optimizer"]); if (std::holds_alternative(optimiserSettings)) return std::get(std::move(optimiserSettings)); // was an error else ret.optimiserSettings = std::get(std::move(optimiserSettings)); } Json::Value jsonLibraries = settings.get("libraries", Json::Value(Json::objectValue)); if (!jsonLibraries.isObject()) return formatFatalError("JSONError", "\"libraries\" is not a JSON object."); for (auto const& sourceName: jsonLibraries.getMemberNames()) { auto const& jsonSourceName = jsonLibraries[sourceName]; if (!jsonSourceName.isObject()) return formatFatalError("JSONError", "Library entry is not a JSON object."); for (auto const& library: jsonSourceName.getMemberNames()) { if (!jsonSourceName[library].isString()) return formatFatalError("JSONError", "Library address must be a string."); string address = jsonSourceName[library].asString(); if (!boost::starts_with(address, "0x")) return formatFatalError( "JSONError", "Library address is not prefixed with \"0x\"." ); if (address.length() != 42) return formatFatalError( "JSONError", "Library address is of invalid length." ); try { // @TODO use libraries only for the given source ret.libraries[library] = util::h160(address); } catch (util::BadHexCharacter const&) { return formatFatalError( "JSONError", "Invalid library address (\"" + address + "\") supplied." ); } } } Json::Value metadataSettings = settings.get("metadata", Json::Value()); if (auto result = checkMetadataKeys(metadataSettings)) return *result; ret.metadataLiteralSources = metadataSettings.get("useLiteralContent", Json::Value(false)).asBool(); if (metadataSettings.isMember("bytecodeHash")) { auto metadataHash = metadataSettings["bytecodeHash"].asString(); ret.metadataHash = metadataHash == "ipfs" ? CompilerStack::MetadataHash::IPFS : metadataHash == "bzzr1" ? CompilerStack::MetadataHash::Bzzr1 : CompilerStack::MetadataHash::None; } Json::Value outputSelection = settings.get("outputSelection", Json::Value()); if (auto jsonError = checkOutputSelection(outputSelection)) return *jsonError; ret.outputSelection = std::move(outputSelection); return { std::move(ret) }; } Json::Value StandardCompiler::compileSolidity(StandardCompiler::InputsAndSettings _inputsAndSettings) { CompilerStack compilerStack(m_readFile); StringMap sourceList = std::move(_inputsAndSettings.sources); compilerStack.setSources(sourceList); for (auto const& smtLib2Response: _inputsAndSettings.smtLib2Responses) compilerStack.addSMTLib2Response(smtLib2Response.first, smtLib2Response.second); compilerStack.setEVMVersion(_inputsAndSettings.evmVersion); compilerStack.setParserErrorRecovery(_inputsAndSettings.parserErrorRecovery); compilerStack.setRemappings(_inputsAndSettings.remappings); compilerStack.setOptimiserSettings(std::move(_inputsAndSettings.optimiserSettings)); compilerStack.setRevertStringBehaviour(_inputsAndSettings.revertStrings); compilerStack.setLibraries(_inputsAndSettings.libraries); compilerStack.useMetadataLiteralSources(_inputsAndSettings.metadataLiteralSources); compilerStack.setMetadataHash(_inputsAndSettings.metadataHash); compilerStack.setRequestedContractNames(requestedContractNames(_inputsAndSettings.outputSelection)); compilerStack.enableIRGeneration(isIRRequested(_inputsAndSettings.outputSelection)); compilerStack.enableEwasmGeneration(isEwasmRequested(_inputsAndSettings.outputSelection)); Json::Value errors = std::move(_inputsAndSettings.errors); bool const binariesRequested = isBinaryRequested(_inputsAndSettings.outputSelection); try { if (binariesRequested) compilerStack.compile(); else compilerStack.parseAndAnalyze(); for (auto const& error: compilerStack.errors()) { Error const& err = dynamic_cast(*error); errors.append(formatErrorWithException( *error, err.type() == Error::Type::Warning, err.typeName(), "general", "", err.errorId() )); } } /// This is only thrown in a very few locations. catch (Error const& _error) { errors.append(formatErrorWithException( _error, false, _error.typeName(), "general", "Uncaught error: " )); } /// This should not be leaked from compile(). catch (FatalError const& _exception) { errors.append(formatError( false, "FatalError", "general", "Uncaught fatal error: " + boost::diagnostic_information(_exception) )); } catch (CompilerError const& _exception) { errors.append(formatErrorWithException( _exception, false, "CompilerError", "general", "Compiler error (" + _exception.lineInfo() + ")" )); } catch (InternalCompilerError const& _exception) { errors.append(formatErrorWithException( _exception, false, "InternalCompilerError", "general", "Internal compiler error (" + _exception.lineInfo() + ")" )); } catch (UnimplementedFeatureError const& _exception) { errors.append(formatErrorWithException( _exception, false, "UnimplementedFeatureError", "general", "Unimplemented feature (" + _exception.lineInfo() + ")" )); } catch (yul::YulException const& _exception) { errors.append(formatErrorWithException( _exception, false, "YulException", "general", "Yul exception" )); } catch (smtutil::SMTLogicError const& _exception) { errors.append(formatErrorWithException( _exception, false, "SMTLogicException", "general", "SMT logic exception" )); } catch (util::Exception const& _exception) { errors.append(formatError( false, "Exception", "general", "Exception during compilation: " + boost::diagnostic_information(_exception) )); } catch (std::exception const& _e) { errors.append(formatError( false, "Exception", "general", "Unknown exception during compilation" + (_e.what() ? ": " + string(_e.what()) : ".") )); } catch (...) { errors.append(formatError( false, "Exception", "general", "Unknown exception during compilation." )); } bool analysisPerformed = compilerStack.state() >= CompilerStack::State::AnalysisPerformed; bool const compilationSuccess = compilerStack.state() == CompilerStack::State::CompilationSuccessful; if (compilerStack.hasError() && !_inputsAndSettings.parserErrorRecovery) analysisPerformed = false; /// Inconsistent state - stop here to receive error reports from users if (((binariesRequested && !compilationSuccess) || !analysisPerformed) && errors.empty()) return formatFatalError("InternalCompilerError", "No error reported, but compilation failed."); Json::Value output = Json::objectValue; if (errors.size() > 0) output["errors"] = std::move(errors); if (!compilerStack.unhandledSMTLib2Queries().empty()) for (string const& query: compilerStack.unhandledSMTLib2Queries()) output["auxiliaryInputRequested"]["smtlib2queries"]["0x" + util::keccak256(query).hex()] = query; bool const wildcardMatchesExperimental = false; output["sources"] = Json::objectValue; unsigned sourceIndex = 0; for (string const& sourceName: analysisPerformed ? compilerStack.sourceNames() : vector()) { Json::Value sourceResult = Json::objectValue; sourceResult["id"] = sourceIndex++; if (isArtifactRequested(_inputsAndSettings.outputSelection, sourceName, "", "ast", wildcardMatchesExperimental)) sourceResult["ast"] = ASTJsonConverter(false, compilerStack.sourceIndices()).toJson(compilerStack.ast(sourceName)); if (isArtifactRequested(_inputsAndSettings.outputSelection, sourceName, "", "legacyAST", wildcardMatchesExperimental)) sourceResult["legacyAST"] = ASTJsonConverter(true, compilerStack.sourceIndices()).toJson(compilerStack.ast(sourceName)); output["sources"][sourceName] = sourceResult; } Json::Value contractsOutput = Json::objectValue; for (string const& contractName: analysisPerformed ? compilerStack.contractNames() : vector()) { size_t colon = contractName.rfind(':'); solAssert(colon != string::npos, ""); string file = contractName.substr(0, colon); string name = contractName.substr(colon + 1); // ABI, storage layout, documentation and metadata Json::Value contractData(Json::objectValue); if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "abi", wildcardMatchesExperimental)) contractData["abi"] = compilerStack.contractABI(contractName); if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "storageLayout", false)) contractData["storageLayout"] = compilerStack.storageLayout(contractName); if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "metadata", wildcardMatchesExperimental)) contractData["metadata"] = compilerStack.metadata(contractName); if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "userdoc", wildcardMatchesExperimental)) contractData["userdoc"] = compilerStack.natspecUser(contractName); if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "devdoc", wildcardMatchesExperimental)) contractData["devdoc"] = compilerStack.natspecDev(contractName); // IR if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "ir", wildcardMatchesExperimental)) contractData["ir"] = compilerStack.yulIR(contractName); if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "irOptimized", wildcardMatchesExperimental)) contractData["irOptimized"] = compilerStack.yulIROptimized(contractName); // Ewasm if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "ewasm.wast", wildcardMatchesExperimental)) contractData["ewasm"]["wast"] = compilerStack.ewasm(contractName); if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "ewasm.wasm", wildcardMatchesExperimental)) contractData["ewasm"]["wasm"] = compilerStack.ewasmObject(contractName).toHex(); // EVM Json::Value evmData(Json::objectValue); if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "evm.assembly", wildcardMatchesExperimental)) evmData["assembly"] = compilerStack.assemblyString(contractName, sourceList); if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "evm.legacyAssembly", wildcardMatchesExperimental)) evmData["legacyAssembly"] = compilerStack.assemblyJSON(contractName); if (isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "evm.methodIdentifiers", wildcardMatchesExperimental)) evmData["methodIdentifiers"] = compilerStack.methodIdentifiers(contractName); if (compilationSuccess && isArtifactRequested(_inputsAndSettings.outputSelection, file, name, "evm.gasEstimates", wildcardMatchesExperimental)) evmData["gasEstimates"] = compilerStack.gasEstimates(contractName); if (compilationSuccess && isArtifactRequested( _inputsAndSettings.outputSelection, file, name, { "evm.bytecode", "evm.bytecode.object", "evm.bytecode.opcodes", "evm.bytecode.sourceMap", "evm.bytecode.linkReferences" }, wildcardMatchesExperimental )) evmData["bytecode"] = collectEVMObject( compilerStack.object(contractName), compilerStack.sourceMapping(contractName), false ); if (compilationSuccess && isArtifactRequested( _inputsAndSettings.outputSelection, file, name, { "evm.deployedBytecode", "evm.deployedBytecode.object", "evm.deployedBytecode.opcodes", "evm.deployedBytecode.sourceMap", "evm.deployedBytecode.linkReferences", "evm.deployedBytecode.immutableReferences" }, wildcardMatchesExperimental )) evmData["deployedBytecode"] = collectEVMObject( compilerStack.runtimeObject(contractName), compilerStack.runtimeSourceMapping(contractName), true ); if (!evmData.empty()) contractData["evm"] = evmData; if (!contractData.empty()) { if (!contractsOutput.isMember(file)) contractsOutput[file] = Json::objectValue; contractsOutput[file][name] = contractData; } } if (!contractsOutput.empty()) output["contracts"] = contractsOutput; return output; } Json::Value StandardCompiler::compileYul(InputsAndSettings _inputsAndSettings) { if (_inputsAndSettings.sources.size() != 1) return formatFatalError("JSONError", "Yul mode only supports exactly one input file."); if (!_inputsAndSettings.smtLib2Responses.empty()) return formatFatalError("JSONError", "Yul mode does not support smtlib2responses."); if (!_inputsAndSettings.remappings.empty()) return formatFatalError("JSONError", "Field \"settings.remappings\" cannot be used for Yul."); if (!_inputsAndSettings.libraries.empty()) return formatFatalError("JSONError", "Field \"settings.libraries\" cannot be used for Yul."); if (_inputsAndSettings.revertStrings != RevertStrings::Default) return formatFatalError("JSONError", "Field \"settings.debug.revertStrings\" cannot be used for Yul."); Json::Value output = Json::objectValue; AssemblyStack stack( _inputsAndSettings.evmVersion, AssemblyStack::Language::StrictAssembly, _inputsAndSettings.optimiserSettings ); string const& sourceName = _inputsAndSettings.sources.begin()->first; string const& sourceContents = _inputsAndSettings.sources.begin()->second; // Inconsistent state - stop here to receive error reports from users if (!stack.parseAndAnalyze(sourceName, sourceContents) && stack.errors().empty()) return formatFatalError("InternalCompilerError", "No error reported, but compilation failed."); if (!stack.errors().empty()) { Json::Value errors = Json::arrayValue; for (auto const& error: stack.errors()) { auto err = dynamic_pointer_cast(error); errors.append(formatErrorWithException( *error, err->type() == Error::Type::Warning, err->typeName(), "general", "" )); } output["errors"] = errors; return output; } // TODO: move this warning to AssemblyStack output["errors"] = Json::arrayValue; output["errors"].append(formatError(true, "Warning", "general", "Yul is still experimental. Please use the output with care.")); string contractName = stack.parserResult()->name.str(); bool const wildcardMatchesExperimental = true; if (isArtifactRequested(_inputsAndSettings.outputSelection, sourceName, contractName, "ir", wildcardMatchesExperimental)) output["contracts"][sourceName][contractName]["ir"] = stack.print(); stack.optimize(); MachineAssemblyObject object; MachineAssemblyObject runtimeObject; tie(object, runtimeObject) = stack.assembleAndGuessRuntime(); for (string const& objectKind: vector{"bytecode", "deployedBytecode"}) { auto artifacts = util::applyMap( vector{"", ".object", ".opcodes", ".sourceMap", ".linkReferences"}, [&](auto const& _s) { return "evm." + objectKind + _s; } ); if (isArtifactRequested( _inputsAndSettings.outputSelection, sourceName, contractName, artifacts, wildcardMatchesExperimental )) { MachineAssemblyObject const& o = objectKind == "bytecode" ? object : runtimeObject; if (o.bytecode) output["contracts"][sourceName][contractName]["evm"][objectKind] = collectEVMObject(*o.bytecode, o.sourceMappings.get(), false); } } if (isArtifactRequested(_inputsAndSettings.outputSelection, sourceName, contractName, "irOptimized", wildcardMatchesExperimental)) output["contracts"][sourceName][contractName]["irOptimized"] = stack.print(); if (isArtifactRequested(_inputsAndSettings.outputSelection, sourceName, contractName, "evm.assembly", wildcardMatchesExperimental)) output["contracts"][sourceName][contractName]["evm"]["assembly"] = object.assembly; return output; } Json::Value StandardCompiler::compile(Json::Value const& _input) noexcept { YulStringRepository::reset(); try { auto parsed = parseInput(_input); if (std::holds_alternative(parsed)) return std::get(std::move(parsed)); InputsAndSettings settings = std::get(std::move(parsed)); if (settings.language == "Solidity") return compileSolidity(std::move(settings)); else if (settings.language == "Yul") return compileYul(std::move(settings)); else return formatFatalError("JSONError", "Only \"Solidity\" or \"Yul\" is supported as a language."); } catch (Json::LogicError const& _exception) { return formatFatalError("InternalCompilerError", string("JSON logic exception: ") + _exception.what()); } catch (Json::RuntimeError const& _exception) { return formatFatalError("InternalCompilerError", string("JSON runtime exception: ") + _exception.what()); } catch (util::Exception const& _exception) { return formatFatalError("InternalCompilerError", "Internal exception in StandardCompiler::compile: " + boost::diagnostic_information(_exception)); } catch (...) { return formatFatalError("InternalCompilerError", "Internal exception in StandardCompiler::compile"); } } string StandardCompiler::compile(string const& _input) noexcept { Json::Value input; string errors; try { if (!util::jsonParseStrict(_input, input, &errors)) return util::jsonCompactPrint(formatFatalError("JSONError", errors)); } catch (...) { return "{\"errors\":[{\"type\":\"JSONError\",\"component\":\"general\",\"severity\":\"error\",\"message\":\"Error parsing input JSON.\"}]}"; } // cout << "Input: " << input.toStyledString() << endl; Json::Value output = compile(input); // cout << "Output: " << output.toStyledString() << endl; try { return util::jsonCompactPrint(output); } catch (...) { return "{\"errors\":[{\"type\":\"JSONError\",\"component\":\"general\",\"severity\":\"error\",\"message\":\"Error writing output JSON.\"}]}"; } }