cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #8529 from MrChico/develop

Browse Source 
CommandLineInterface: add storage-layout option to --combined-json
This commit is contained in:
chriseth 2020-03-26 19:15:23 +01:00 committed by GitHub
commit 4a7d2e590d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Changelog.md
View File

@ -5,7 +5,7 @@ Language Features:
Compiler Features: Compiler Features:
* Metadata: Added support for IPFS hashes of large files that need to be split in multiple chunks. * Metadata: Added support for IPFS hashes of large files that need to be split in multiple chunks.
* Commandline Interface: Enable output of storage layout with `--storage-layout`.
Bugfixes: Bugfixes:
* Inline Assembly: Fix internal error when accessing invalid constant variables. * Inline Assembly: Fix internal error when accessing invalid constant variables.

27
solc/CommandLineInterface.cpp
View File

@ -34,6 +34,7 @@
#include <libsolidity/interface/StandardCompiler.h> #include <libsolidity/interface/StandardCompiler.h>
#include <libsolidity/interface/GasEstimator.h> #include <libsolidity/interface/GasEstimator.h>
#include <libsolidity/interface/DebugSettings.h> #include <libsolidity/interface/DebugSettings.h>
#include <libsolidity/interface/StorageLayout.h>
#include <libyul/AssemblyStack.h> #include <libyul/AssemblyStack.h>
@ -147,6 +148,7 @@ static string const g_strOptimizeYul = "optimize-yul";
static string const g_strOutputDir = "output-dir"; static string const g_strOutputDir = "output-dir";
static string const g_strOverwrite = "overwrite"; static string const g_strOverwrite = "overwrite";
static string const g_strRevertStrings = "revert-strings"; static string const g_strRevertStrings = "revert-strings";
static string const g_strStorageLayout = "storage-layout";
/// Possible arguments to for --revert-strings /// Possible arguments to for --revert-strings
static set<string> const g_revertStringsArgs static set<string> const g_revertStringsArgs
@ -207,6 +209,7 @@ static string const g_argOptimizeRuns = g_strOptimizeRuns;
static string const g_argOutputDir = g_strOutputDir; static string const g_argOutputDir = g_strOutputDir;
static string const g_argSignatureHashes = g_strSignatureHashes; static string const g_argSignatureHashes = g_strSignatureHashes;
static string const g_argStandardJSON = g_strStandardJSON; static string const g_argStandardJSON = g_strStandardJSON;
static string const g_argStorageLayout = g_strStorageLayout;
static string const g_argStrictAssembly = g_strStrictAssembly; static string const g_argStrictAssembly = g_strStrictAssembly;
static string const g_argVersion = g_strVersion; static string const g_argVersion = g_strVersion;
static string const g_stdinFileName = g_stdinFileNameStr; static string const g_stdinFileName = g_stdinFileNameStr;
@ -231,7 +234,8 @@ static set<string> const g_combinedJsonArgs
g_strOpcodes, g_strOpcodes,
g_strSignatureHashes, g_strSignatureHashes,
g_strSrcMap, g_strSrcMap,
g_strSrcMapRuntime g_strSrcMapRuntime,
g_strStorageLayout
}; };
/// Possible arguments to for --machine /// Possible arguments to for --machine
@ -293,7 +297,8 @@ static bool needsHumanTargetedStdout(po::variables_map const& _args)
g_argNatspecUser, g_argNatspecUser,
g_argNatspecDev, g_argNatspecDev,
g_argOpcodes, g_argOpcodes,
g_argSignatureHashes g_argSignatureHashes,
g_argStorageLayout
}) })
if (_args.count(arg)) if (_args.count(arg))
return true; return true;
@ -433,6 +438,18 @@ void CommandLineInterface::handleABI(string const& _contract)
sout() << "Contract JSON ABI" << endl << data << endl; sout() << "Contract JSON ABI" << endl << data << endl;
} }
void CommandLineInterface::handleStorageLayout(string const& _contract)
{
if (!m_args.count(g_argStorageLayout))
return;
string data = jsonCompactPrint(m_compiler->storageLayout(_contract));
if (m_args.count(g_argOutputDir))
createFile(m_compiler->filesystemFriendlyName(_contract) + "_storage.json", data);
else
sout() << "Contract Storage Layout:" << endl << data << endl;
}
void CommandLineInterface::handleNatspec(bool _natspecDev, string const& _contract) void CommandLineInterface::handleNatspec(bool _natspecDev, string const& _contract)
{ {
std::string argName; std::string argName;
@ -833,7 +850,8 @@ Allowed options)",
(g_argSignatureHashes.c_str(), "Function signature hashes of the contracts.") (g_argSignatureHashes.c_str(), "Function signature hashes of the contracts.")
(g_argNatspecUser.c_str(), "Natspec user documentation of all contracts.") (g_argNatspecUser.c_str(), "Natspec user documentation of all contracts.")
(g_argNatspecDev.c_str(), "Natspec developer documentation of all contracts.") (g_argNatspecDev.c_str(), "Natspec developer documentation of all contracts.")
(g_argMetadata.c_str(), "Combined Metadata JSON whose Swarm hash is stored on-chain."); (g_argMetadata.c_str(), "Combined Metadata JSON whose Swarm hash is stored on-chain.")
(g_argStorageLayout.c_str(), "Slots, offsets and types of the contract's state variables.");
desc.add(outputComponents); desc.add(outputComponents);
po::options_description allOptions = desc; po::options_description allOptions = desc;
@ -1276,6 +1294,8 @@ void CommandLineInterface::handleCombinedJSON()
contractData[g_strOpcodes] = evmasm::disassemble(m_compiler->object(contractName).bytecode); contractData[g_strOpcodes] = evmasm::disassemble(m_compiler->object(contractName).bytecode);
if (requests.count(g_strAsm) && m_compiler->compilationSuccessful()) if (requests.count(g_strAsm) && m_compiler->compilationSuccessful())
contractData[g_strAsm] = m_compiler->assemblyJSON(contractName); contractData[g_strAsm] = m_compiler->assemblyJSON(contractName);
if (requests.count(g_strStorageLayout) && m_compiler->compilationSuccessful())
contractData[g_strStorageLayout] = jsonCompactPrint(m_compiler->storageLayout(contractName));
if (requests.count(g_strSrcMap) && m_compiler->compilationSuccessful()) if (requests.count(g_strSrcMap) && m_compiler->compilationSuccessful())
{ {
auto map = m_compiler->sourceMapping(contractName); auto map = m_compiler->sourceMapping(contractName);
@ -1653,6 +1673,7 @@ void CommandLineInterface::outputCompilationResults()
handleSignatureHashes(contract); handleSignatureHashes(contract);
handleMetadata(contract); handleMetadata(contract);
handleABI(contract); handleABI(contract);
handleStorageLayout(contract);
handleNatspec(true, contract); handleNatspec(true, contract);
handleNatspec(false, contract); handleNatspec(false, contract);
} // end of contracts iteration } // end of contracts iteration

1
solc/CommandLineInterface.h
View File

@ -74,6 +74,7 @@ private:
void handleNatspec(bool _natspecDev, std::string const& _contract); void handleNatspec(bool _natspecDev, std::string const& _contract);
void handleGasEstimation(std::string const& _contract); void handleGasEstimation(std::string const& _contract);
void handleFormal(); void handleFormal();
void handleStorageLayout(std::string const& _contract);
/// Fills @a m_sourceCodes initially and @a m_redirects. /// Fills @a m_sourceCodes initially and @a m_redirects.
bool readInputFilesAndConfigureRemappings(); bool readInputFilesAndConfigureRemappings();