aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Beregszaszi <alex@rtfs.hu>2018-09-27 08:53:34 +0800
committerAlex Beregszaszi <alex@rtfs.hu>2018-11-13 21:54:01 +0800
commitb6c32577523914332ce780928941e197e68eaa00 (patch)
tree6855cacc063f32235717d8435c31e9b22477cf4f
parentc237013911aa5bb6102e1262e6aa62178c0f02e0 (diff)
downloaddexon-solidity-b6c32577523914332ce780928941e197e68eaa00.tar
dexon-solidity-b6c32577523914332ce780928941e197e68eaa00.tar.gz
dexon-solidity-b6c32577523914332ce780928941e197e68eaa00.tar.bz2
dexon-solidity-b6c32577523914332ce780928941e197e68eaa00.tar.lz
dexon-solidity-b6c32577523914332ce780928941e197e68eaa00.tar.xz
dexon-solidity-b6c32577523914332ce780928941e197e68eaa00.tar.zst
dexon-solidity-b6c32577523914332ce780928941e197e68eaa00.zip
Remove old libsolc API (compileJSON, compileJSONMulti, compileJSONCallback)
-rw-r--r--Changelog.md3
-rw-r--r--libsolc/CMakeLists.txt2
-rw-r--r--libsolc/libsolc.cpp228
-rw-r--r--libsolc/libsolc.h9
-rw-r--r--test/libsolidity/LibSolc.cpp143
-rw-r--r--test/tools/fuzzer.cpp2
6 files changed, 14 insertions, 373 deletions
diff --git a/Changelog.md b/Changelog.md
index 2e5a3044..c957ca96 100644
--- a/Changelog.md
+++ b/Changelog.md
@@ -11,6 +11,8 @@ How to update your code:
Breaking Changes:
* ABI Encoder: Properly pad data from calldata (``msg.data`` and external function parameters). Use ``abi.encodePacked`` for unpadded encoding.
+ * C API (``libsolc`` / raw ``soljson.js``): Removed the ``version``, ``license``, ``compileSingle``, ``compileJSON``, ``compileJSONCallback`` methods
+ and replaced them with the ``solidity_license``, ``solidity_version`` and ``solidity_compile`` methods.
* Code Generator: Signed right shift uses proper arithmetic shift, i.e. rounding towards negative infinity. Warning: this may silently change the semantics of existing code!
* Code Generator: Revert at runtime if calldata is too short or points out of bounds. This is done inside the ``ABI decoder`` and therefore also applies to ``abi.decode()``.
* Code Generator: Use ``STATICCALL`` for ``pure`` and ``view`` functions. This was already the case in the experimental 0.5.0 mode.
@@ -91,7 +93,6 @@ Language Features:
Compiler Features:
* Build System: Support for Mojave version of macOS added.
- * C API (``libsolc``): Export the ``solidity_license``, ``solidity_version`` and ``solidity_compile`` methods.
* Code Generator: ``CREATE2`` instruction has been updated to match EIP1014 (aka "Skinny CREATE2"). It also is accepted as part of Constantinople.
* Code Generator: ``EXTCODEHASH`` instruction has been added based on EIP1052.
* Type Checker: Nicer error message when trying to reference overloaded identifiers in inline assembly.
diff --git a/libsolc/CMakeLists.txt b/libsolc/CMakeLists.txt
index 63fc1a83..ed14e9fe 100644
--- a/libsolc/CMakeLists.txt
+++ b/libsolc/CMakeLists.txt
@@ -1,5 +1,5 @@
if (EMSCRIPTEN)
- set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -s EXPORTED_FUNCTIONS='[\"_solidity_license\",\"_solidity_version\",\"_solidity_compile\",\"_license\",\"_version\",\"_compileJSON\",\"_compileJSONMulti\",\"_compileJSONCallback\",\"_compileStandard\"]' -s RESERVED_FUNCTION_POINTERS=20")
+ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -s EXPORTED_FUNCTIONS='[\"_solidity_license\",\"_solidity_version\",\"_solidity_compile\"]' -s RESERVED_FUNCTION_POINTERS=20")
add_executable(soljson libsolc.cpp)
target_link_libraries(soljson PRIVATE solidity)
else()
diff --git a/libsolc/libsolc.cpp b/libsolc/libsolc.cpp
index 6931ed08..766e1c0c 100644
--- a/libsolc/libsolc.cpp
+++ b/libsolc/libsolc.cpp
@@ -17,7 +17,7 @@
/**
* @author Christian <c@ethdev.com>
* @date 2014
- * JSON interface for the solidity compiler to be used from Javascript.
+ * Public compiler API.
*/
#include <libsolc/libsolc.h>
@@ -72,193 +72,7 @@ ReadCallback::Callback wrapReadCallback(CStyleReadFileCallback _readCallback = n
return readCallback;
}
-/// Translates a gas value as a string to a JSON number or null
-Json::Value gasToJson(Json::Value const& _value)
-{
- if (_value.isObject())
- {
- Json::Value ret = Json::objectValue;
- for (auto const& sig: _value.getMemberNames())
- ret[sig] = gasToJson(_value[sig]);
- return ret;
- }
-
- if (_value == "infinite")
- return Json::Value(Json::nullValue);
-
- u256 value(_value.asString());
- if (value > std::numeric_limits<Json::LargestUInt>::max())
- return Json::Value(Json::nullValue);
- else
- return Json::Value(Json::LargestUInt(value));
-}
-
-Json::Value translateGasEstimates(Json::Value const& estimates)
-{
- Json::Value output(Json::objectValue);
-
- if (estimates["creation"].isObject())
- {
- Json::Value creation(Json::arrayValue);
- creation[0] = gasToJson(estimates["creation"]["executionCost"]);
- creation[1] = gasToJson(estimates["creation"]["codeDepositCost"]);
- output["creation"] = creation;
- }
- else
- output["creation"] = Json::objectValue;
- output["external"] = gasToJson(estimates.get("external", Json::objectValue));
- output["internal"] = gasToJson(estimates.get("internal", Json::objectValue));
-
- return output;
-}
-
-string compile(StringMap const& _sources, bool _optimize, CStyleReadFileCallback _readCallback)
-{
- /// create new JSON input format
- Json::Value input = Json::objectValue;
- input["language"] = "Solidity";
- input["sources"] = Json::objectValue;
- for (auto const& source: _sources)
- {
- input["sources"][source.first] = Json::objectValue;
- input["sources"][source.first]["content"] = source.second;
- }
- input["settings"] = Json::objectValue;
- input["settings"]["optimizer"] = Json::objectValue;
- input["settings"]["optimizer"]["enabled"] = _optimize;
- input["settings"]["optimizer"]["runs"] = 200;
-
- // Enable all SourceUnit-level outputs.
- input["settings"]["outputSelection"]["*"][""][0] = "*";
- // Enable all Contract-level outputs.
- input["settings"]["outputSelection"]["*"]["*"][0] = "*";
-
- StandardCompiler compiler(wrapReadCallback(_readCallback));
- Json::Value ret = compiler.compile(input);
-
- /// transform JSON to match the old format
- // {
- // "errors": [ "Error 1", "Error 2" ],
- // "sourceList": [ "sourcename1", "sourcename2" ],
- // "sources": {
- // "sourcename1": {
- // "AST": {}
- // }
- // },
- // "contracts": {
- // "Contract1": {
- // "interface": "[...abi...]",
- // "bytecode": "ff0011...",
- // "runtimeBytecode": "ff0011",
- // "opcodes": "PUSH 1 POP STOP",
- // "metadata": "{...metadata...}",
- // "functionHashes": {
- // "test(uint256)": "11ff2233"
- // },
- // "gasEstimates": {
- // "creation": [ 224, 42000 ],
- // "external": {
- // "11ff2233": null,
- // "3322ff11": 1234
- // },
- // "internal": {
- // }
- // },
- // "srcmap" = "0:1:2",
- // "srcmapRuntime" = "0:1:2",
- // "assembly" = {}
- // }
- // }
- // }
- Json::Value output = Json::objectValue;
-
- if (ret.isMember("errors"))
- {
- output["errors"] = Json::arrayValue;
- for (auto const& error: ret["errors"])
- output["errors"].append(
- !error["formattedMessage"].empty() ? error["formattedMessage"] : error["message"]
- );
- }
-
- output["sourceList"] = Json::arrayValue;
- for (auto const& source: _sources)
- output["sourceList"].append(source.first);
-
- if (ret.isMember("sources"))
- {
- output["sources"] = Json::objectValue;
- for (auto const& sourceName: ret["sources"].getMemberNames())
- {
- output["sources"][sourceName] = Json::objectValue;
- output["sources"][sourceName]["AST"] = ret["sources"][sourceName]["legacyAST"];
- }
- }
-
- if (ret.isMember("contracts"))
- {
- output["contracts"] = Json::objectValue;
- for (auto const& sourceName: ret["contracts"].getMemberNames())
- for (auto const& contractName: ret["contracts"][sourceName].getMemberNames())
- {
- Json::Value contractInput = ret["contracts"][sourceName][contractName];
- Json::Value contractOutput = Json::objectValue;
- contractOutput["interface"] = jsonCompactPrint(contractInput["abi"]);
- contractOutput["metadata"] = contractInput["metadata"];
- contractOutput["functionHashes"] = contractInput["evm"]["methodIdentifiers"];
- contractOutput["gasEstimates"] = translateGasEstimates(contractInput["evm"]["gasEstimates"]);
- contractOutput["assembly"] = contractInput["evm"]["legacyAssembly"];
- contractOutput["bytecode"] = contractInput["evm"]["bytecode"]["object"];
- contractOutput["opcodes"] = contractInput["evm"]["bytecode"]["opcodes"];
- contractOutput["srcmap"] = contractInput["evm"]["bytecode"]["sourceMap"];
- contractOutput["runtimeBytecode"] = contractInput["evm"]["deployedBytecode"]["object"];
- contractOutput["srcmapRuntime"] = contractInput["evm"]["deployedBytecode"]["sourceMap"];
- output["contracts"][sourceName + ":" + contractName] = contractOutput;
- }
- }
-
- try
- {
- return jsonCompactPrint(output);
- }
- catch (...)
- {
- return "{\"errors\":[\"Unknown error while generating JSON.\"]}";
- }
-}
-
-string compileMulti(string const& _input, bool _optimize, CStyleReadFileCallback _readCallback = nullptr)
-{
- string errors;
- Json::Value input;
- if (!jsonParseStrict(_input, input, &errors))
- {
- Json::Value jsonErrors(Json::arrayValue);
- jsonErrors.append("Error parsing input JSON: " + errors);
- Json::Value output(Json::objectValue);
- output["errors"] = jsonErrors;
- return jsonCompactPrint(output);
- }
- else
- {
- StringMap sources;
- Json::Value jsonSources = input["sources"];
- if (jsonSources.isObject())
- for (auto const& sourceName: jsonSources.getMemberNames())
- sources[sourceName] = jsonSources[sourceName].asString();
- return compile(sources, _optimize, _readCallback);
- }
-}
-
-string compileSingle(string const& _input, bool _optimize)
-{
- StringMap sources;
- sources[""] = _input;
- return compile(sources, _optimize, nullptr);
-}
-
-
-string compileStandardInternal(string const& _input, CStyleReadFileCallback _readCallback = nullptr)
+string compile(string const& _input, CStyleReadFileCallback _readCallback = nullptr)
{
StandardCompiler compiler(wrapReadCallback(_readCallback));
return compiler.compile(_input);
@@ -270,48 +84,18 @@ static string s_outputBuffer;
extern "C"
{
-extern char const* license() noexcept
+extern char const* solidity_license() noexcept
{
static string fullLicenseText = otherLicenses + licenseText;
return fullLicenseText.c_str();
}
-extern char const* version() noexcept
-{
- return VersionString.c_str();
-}
-extern char const* compileJSON(char const* _input, bool _optimize) noexcept
-{
- s_outputBuffer = compileSingle(_input, _optimize);
- return s_outputBuffer.c_str();
-}
-extern char const* compileJSONMulti(char const* _input, bool _optimize) noexcept
-{
- s_outputBuffer = compileMulti(_input, _optimize);
- return s_outputBuffer.c_str();
-}
-extern char const* compileJSONCallback(char const* _input, bool _optimize, CStyleReadFileCallback _readCallback) noexcept
-{
- s_outputBuffer = compileMulti(_input, _optimize, _readCallback);
- return s_outputBuffer.c_str();
-}
-extern char const* compileStandard(char const* _input, CStyleReadFileCallback _readCallback) noexcept
-{
- s_outputBuffer = compileStandardInternal(_input, _readCallback);
- return s_outputBuffer.c_str();
-}
-extern char const* solidity_license() noexcept
-{
- /// todo: make this the default or an alias
- return license();
-}
extern char const* solidity_version() noexcept
{
- /// todo: make this the default or an alias
- return version();
+ return VersionString.c_str();
}
extern char const* solidity_compile(char const* _input, CStyleReadFileCallback _readCallback) noexcept
{
- /// todo: make this the default or an alias
- return compileStandard(_input, _readCallback);
+ s_outputBuffer = compile(_input, _readCallback);
+ return s_outputBuffer.c_str();
}
}
diff --git a/libsolc/libsolc.h b/libsolc/libsolc.h
index e959b758..4b0ec639 100644
--- a/libsolc/libsolc.h
+++ b/libsolc/libsolc.h
@@ -17,7 +17,7 @@
/**
* @author Christian <c@ethdev.com>
* @date 2014
- * JSON interface for the solidity compiler to be used from Javascript.
+ * Public compiler API.
*/
#include <stdbool.h>
@@ -36,13 +36,6 @@ extern "C" {
/// heap-allocated and are free'd by the caller.
typedef void (*CStyleReadFileCallback)(char const* _path, char** o_contents, char** o_error);
-char const* license() SOLC_NOEXCEPT;
-char const* version() SOLC_NOEXCEPT;
-char const* compileJSON(char const* _input, bool _optimize) SOLC_NOEXCEPT;
-char const* compileJSONMulti(char const* _input, bool _optimize) SOLC_NOEXCEPT;
-char const* compileJSONCallback(char const* _input, bool _optimize, CStyleReadFileCallback _readCallback) SOLC_NOEXCEPT;
-char const* compileStandard(char const* _input, CStyleReadFileCallback _readCallback) SOLC_NOEXCEPT;
-
char const* solidity_license() SOLC_NOEXCEPT;
char const* solidity_version() SOLC_NOEXCEPT;
char const* solidity_compile(char const* _input, CStyleReadFileCallback _readCallback) SOLC_NOEXCEPT;
diff --git a/test/libsolidity/LibSolc.cpp b/test/libsolidity/LibSolc.cpp
index 94fed7e8..09c08700 100644
--- a/test/libsolidity/LibSolc.cpp
+++ b/test/libsolidity/LibSolc.cpp
@@ -40,29 +40,9 @@ namespace test
namespace
{
-Json::Value compileSingle(string const& _input)
-{
- string output(compileJSON(_input.c_str(), dev::test::Options::get().optimize));
- Json::Value ret;
- BOOST_REQUIRE(jsonParseStrict(output, ret));
- return ret;
-}
-
-Json::Value compileMulti(string const& _input, bool _callback)
-{
- string output(
- _callback ?
- compileJSONCallback(_input.c_str(), dev::test::Options::get().optimize, nullptr) :
- compileJSONMulti(_input.c_str(), dev::test::Options::get().optimize)
- );
- Json::Value ret;
- BOOST_REQUIRE(jsonParseStrict(output, ret));
- return ret;
-}
-
Json::Value compile(string const& _input)
{
- string output(compileStandard(_input.c_str(), nullptr));
+ string output(solidity_compile(_input.c_str(), nullptr));
Json::Value ret;
BOOST_REQUIRE(jsonParseStrict(output, ret));
return ret;
@@ -74,113 +54,16 @@ BOOST_AUTO_TEST_SUITE(LibSolc)
BOOST_AUTO_TEST_CASE(read_version)
{
- string output(version());
+ string output(solidity_version());
BOOST_CHECK(output.find(VersionString) == 0);
}
BOOST_AUTO_TEST_CASE(read_license)
{
- string output(license());
+ string output(solidity_license());
BOOST_CHECK(output.find("GNU GENERAL PUBLIC LICENSE") != string::npos);
}
-BOOST_AUTO_TEST_CASE(basic_compilation)
-{
- char const* input = R"(
- {
- "sources": {
- "fileA": "contract A { }"
- }
- }
- )";
- Json::Value result = compileMulti(input, false);
- BOOST_CHECK(result.isObject());
-
- // Compare with compileJSONCallback
- BOOST_CHECK_EQUAL(
- dev::jsonCompactPrint(result),
- dev::jsonCompactPrint(compileMulti(input, true))
- );
-
- BOOST_CHECK(result["contracts"].isObject());
- BOOST_CHECK(result["contracts"]["fileA:A"].isObject());
- Json::Value contract = result["contracts"]["fileA:A"];
- BOOST_CHECK(contract.isObject());
- BOOST_CHECK(contract["interface"].isString());
- BOOST_CHECK_EQUAL(contract["interface"].asString(), "[]");
- BOOST_CHECK(contract["bytecode"].isString());
- BOOST_CHECK_EQUAL(
- dev::test::bytecodeSansMetadata(contract["bytecode"].asString()),
- "6080604052348015600f57600080fd5b50603580601d6000396000f3fe6080604052600080fdfe"
- );
- BOOST_CHECK(contract["runtimeBytecode"].isString());
- BOOST_CHECK_EQUAL(
- dev::test::bytecodeSansMetadata(contract["runtimeBytecode"].asString()),
- "6080604052600080fdfe"
- );
- BOOST_CHECK(contract["functionHashes"].isObject());
- BOOST_CHECK(contract["gasEstimates"].isObject());
- BOOST_CHECK_EQUAL(
- dev::jsonCompactPrint(contract["gasEstimates"]),
- "{\"creation\":[66,10600],\"external\":{},\"internal\":{}}"
- );
- BOOST_CHECK(contract["metadata"].isString());
- BOOST_CHECK(dev::test::isValidMetadata(contract["metadata"].asString()));
- BOOST_CHECK(result["sources"].isObject());
- BOOST_CHECK(result["sources"]["fileA"].isObject());
- BOOST_CHECK(result["sources"]["fileA"]["AST"].isObject());
- BOOST_CHECK_EQUAL(
- dev::jsonCompactPrint(result["sources"]["fileA"]["AST"]),
- "{\"attributes\":{\"absolutePath\":\"fileA\",\"exportedSymbols\":{\"A\":[1]}},"
- "\"children\":[{\"attributes\":{\"baseContracts\":[null],\"contractDependencies\":[null],"
- "\"contractKind\":\"contract\",\"documentation\":null,\"fullyImplemented\":true,\"linearizedBaseContracts\":[1],"
- "\"name\":\"A\",\"nodes\":[null],\"scope\":2},\"id\":1,\"name\":\"ContractDefinition\","
- "\"src\":\"0:14:0\"}],\"id\":2,\"name\":\"SourceUnit\",\"src\":\"0:14:0\"}"
- );
-}
-
-BOOST_AUTO_TEST_CASE(single_compilation)
-{
- Json::Value result = compileSingle("contract A { }");
- BOOST_CHECK(result.isObject());
-
- BOOST_CHECK(result["contracts"].isObject());
- BOOST_CHECK(result["contracts"][":A"].isObject());
- Json::Value contract = result["contracts"][":A"];
- BOOST_CHECK(contract.isObject());
- BOOST_CHECK(contract["interface"].isString());
- BOOST_CHECK_EQUAL(contract["interface"].asString(), "[]");
- BOOST_CHECK(contract["bytecode"].isString());
- BOOST_CHECK_EQUAL(
- dev::test::bytecodeSansMetadata(contract["bytecode"].asString()),
- "6080604052348015600f57600080fd5b50603580601d6000396000f3fe6080604052600080fdfe"
- );
- BOOST_CHECK(contract["runtimeBytecode"].isString());
- BOOST_CHECK_EQUAL(
- dev::test::bytecodeSansMetadata(contract["runtimeBytecode"].asString()),
- "6080604052600080fdfe"
- );
- BOOST_CHECK(contract["functionHashes"].isObject());
- BOOST_CHECK(contract["gasEstimates"].isObject());
- BOOST_CHECK_EQUAL(
- dev::jsonCompactPrint(contract["gasEstimates"]),
- "{\"creation\":[66,10600],\"external\":{},\"internal\":{}}"
- );
- BOOST_CHECK(contract["metadata"].isString());
- BOOST_CHECK(dev::test::isValidMetadata(contract["metadata"].asString()));
- BOOST_CHECK(result["sources"].isObject());
- BOOST_CHECK(result["sources"][""].isObject());
- BOOST_CHECK(result["sources"][""]["AST"].isObject());
- BOOST_CHECK_EQUAL(
- dev::jsonCompactPrint(result["sources"][""]["AST"]),
- "{\"attributes\":{\"absolutePath\":\"\",\"exportedSymbols\":{\"A\":[1]}},"
- "\"children\":[{\"attributes\":{\"baseContracts\":[null],\"contractDependencies\":[null],"
- "\"contractKind\":\"contract\",\"documentation\":null,\"fullyImplemented\":true,\"linearizedBaseContracts\":[1],"
- "\"name\":\"A\",\"nodes\":[null],\"scope\":2},\"id\":1,\"name\":\"ContractDefinition\","
- "\"src\":\"0:14:0\"}],\"id\":2,\"name\":\"SourceUnit\",\"src\":\"0:14:0\"}"
- );
-}
-
BOOST_AUTO_TEST_CASE(standard_compilation)
{
char const* input = R"(
@@ -201,26 +84,6 @@ BOOST_AUTO_TEST_CASE(standard_compilation)
BOOST_CHECK(result.isMember("contracts"));
}
-BOOST_AUTO_TEST_CASE(new_api)
-{
- char const* input = R"(
- {
- "language": "Solidity",
- "sources": {
- "fileA": {
- "content": "contract A { }"
- }
- }
- }
- )";
- BOOST_CHECK_EQUAL(string(version()), string(solidity_version()));
- BOOST_CHECK_EQUAL(string(license()), string(solidity_license()));
- BOOST_CHECK_EQUAL(
- string(compileStandard(input, nullptr)),
- string(solidity_compile(input, nullptr))
- );
-}
-
BOOST_AUTO_TEST_SUITE_END()
}
diff --git a/test/tools/fuzzer.cpp b/test/tools/fuzzer.cpp
index bb020f8c..8633454c 100644
--- a/test/tools/fuzzer.cpp
+++ b/test/tools/fuzzer.cpp
@@ -89,7 +89,7 @@ void testConstantOptimizer(string const& input)
void runCompiler(string input)
{
- string outputString(compileStandard(input.c_str(), nullptr));
+ string outputString(solidity_compile(input.c_str(), nullptr));
Json::Value output;
if (!jsonParseStrict(outputString, output))
{