2016-11-28 00:21:01 +00:00
|
|
|
/*
|
|
|
|
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 <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
/**
|
|
|
|
* @author Christian <c@ethdev.com>
|
|
|
|
* @date 2014
|
|
|
|
* Framework for executing contracts and testing them using RPC.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2018-03-14 11:04:04 +00:00
|
|
|
#include <test/Options.h>
|
2017-08-25 09:57:33 +00:00
|
|
|
#include <test/RPCSession.h>
|
2016-11-28 00:21:01 +00:00
|
|
|
|
2019-03-12 14:14:12 +00:00
|
|
|
#include <libsolidity/interface/OptimiserSettings.h>
|
|
|
|
|
2018-11-14 13:59:30 +00:00
|
|
|
#include <liblangutil/EVMVersion.h>
|
2018-02-22 16:21:26 +00:00
|
|
|
|
2016-11-28 00:21:01 +00:00
|
|
|
#include <libdevcore/FixedHash.h>
|
2018-10-18 11:35:20 +00:00
|
|
|
#include <libdevcore/Keccak256.h>
|
2017-08-25 09:57:33 +00:00
|
|
|
|
|
|
|
#include <functional>
|
2016-11-28 00:21:01 +00:00
|
|
|
|
|
|
|
namespace dev
|
|
|
|
{
|
2016-11-28 00:58:07 +00:00
|
|
|
namespace test
|
2016-11-28 00:21:01 +00:00
|
|
|
{
|
|
|
|
using rational = boost::rational<dev::bigint>;
|
|
|
|
/// An Ethereum address: 20 bytes.
|
|
|
|
/// @NOTE This is not endian-specific; it's just a bunch of bytes.
|
|
|
|
using Address = h160;
|
|
|
|
|
|
|
|
// The various denominations; here for ease of use where needed within code.
|
2017-08-25 09:57:33 +00:00
|
|
|
static const u256 wei = 1;
|
|
|
|
static const u256 shannon = u256("1000000000");
|
|
|
|
static const u256 szabo = shannon * 1000;
|
|
|
|
static const u256 finney = szabo * 1000;
|
|
|
|
static const u256 ether = finney * 1000;
|
2016-11-28 00:21:01 +00:00
|
|
|
|
|
|
|
class ExecutionFramework
|
|
|
|
{
|
|
|
|
|
|
|
|
public:
|
|
|
|
ExecutionFramework();
|
2019-03-18 13:08:56 +00:00
|
|
|
explicit ExecutionFramework(std::string const& _ipcPath, langutil::EVMVersion _evmVersion);
|
2018-05-02 11:29:16 +00:00
|
|
|
virtual ~ExecutionFramework() = default;
|
2016-11-28 00:21:01 +00:00
|
|
|
|
|
|
|
virtual bytes const& compileAndRunWithoutCheck(
|
|
|
|
std::string const& _sourceCode,
|
|
|
|
u256 const& _value = 0,
|
|
|
|
std::string const& _contractName = "",
|
|
|
|
bytes const& _arguments = bytes(),
|
|
|
|
std::map<std::string, Address> const& _libraryAddresses = std::map<std::string, Address>()
|
|
|
|
) = 0;
|
|
|
|
|
|
|
|
bytes const& compileAndRun(
|
|
|
|
std::string const& _sourceCode,
|
|
|
|
u256 const& _value = 0,
|
|
|
|
std::string const& _contractName = "",
|
|
|
|
bytes const& _arguments = bytes(),
|
|
|
|
std::map<std::string, Address> const& _libraryAddresses = std::map<std::string, Address>()
|
|
|
|
)
|
|
|
|
{
|
|
|
|
compileAndRunWithoutCheck(_sourceCode, _value, _contractName, _arguments, _libraryAddresses);
|
2018-06-15 10:18:00 +00:00
|
|
|
BOOST_REQUIRE(m_transactionSuccessful);
|
2016-11-28 00:21:01 +00:00
|
|
|
BOOST_REQUIRE(!m_output.empty());
|
|
|
|
return m_output;
|
|
|
|
}
|
|
|
|
|
2016-11-28 11:19:31 +00:00
|
|
|
bytes const& callFallbackWithValue(u256 const& _value)
|
|
|
|
{
|
|
|
|
sendMessage(bytes(), false, _value);
|
|
|
|
return m_output;
|
|
|
|
}
|
|
|
|
|
|
|
|
bytes const & callFallback()
|
|
|
|
{
|
|
|
|
return callFallbackWithValue(0);
|
|
|
|
}
|
|
|
|
|
2017-09-13 15:16:45 +00:00
|
|
|
bytes const& callContractFunctionWithValueNoEncoding(std::string _sig, u256 const& _value, bytes const& _arguments)
|
2016-11-28 00:21:01 +00:00
|
|
|
{
|
|
|
|
FixedHash<4> hash(dev::keccak256(_sig));
|
2017-09-13 15:16:45 +00:00
|
|
|
sendMessage(hash.asBytes() + _arguments, false, _value);
|
2016-11-28 00:21:01 +00:00
|
|
|
return m_output;
|
|
|
|
}
|
|
|
|
|
2017-09-13 15:16:45 +00:00
|
|
|
bytes const& callContractFunctionNoEncoding(std::string _sig, bytes const& _arguments)
|
|
|
|
{
|
|
|
|
return callContractFunctionWithValueNoEncoding(_sig, 0, _arguments);
|
|
|
|
}
|
|
|
|
|
|
|
|
template <class... Args>
|
|
|
|
bytes const& callContractFunctionWithValue(std::string _sig, u256 const& _value, Args const&... _arguments)
|
|
|
|
{
|
|
|
|
return callContractFunctionWithValueNoEncoding(_sig, _value, encodeArgs(_arguments...));
|
|
|
|
}
|
|
|
|
|
2016-11-28 00:21:01 +00:00
|
|
|
template <class... Args>
|
|
|
|
bytes const& callContractFunction(std::string _sig, Args const&... _arguments)
|
|
|
|
{
|
|
|
|
return callContractFunctionWithValue(_sig, 0, _arguments...);
|
|
|
|
}
|
|
|
|
|
|
|
|
template <class CppFunction, class... Args>
|
2016-11-29 21:46:52 +00:00
|
|
|
void testContractAgainstCpp(std::string _sig, CppFunction const& _cppFunction, Args const&... _arguments)
|
2016-11-28 00:21:01 +00:00
|
|
|
{
|
2016-11-29 21:46:52 +00:00
|
|
|
bytes contractResult = callContractFunction(_sig, _arguments...);
|
2016-11-28 00:21:01 +00:00
|
|
|
bytes cppResult = callCppAndEncodeResult(_cppFunction, _arguments...);
|
|
|
|
BOOST_CHECK_MESSAGE(
|
2016-11-29 21:46:52 +00:00
|
|
|
contractResult == cppResult,
|
|
|
|
"Computed values do not match.\nContract: " +
|
|
|
|
toHex(contractResult) +
|
2016-11-28 00:21:01 +00:00
|
|
|
"\nC++: " +
|
|
|
|
toHex(cppResult)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
template <class CppFunction, class... Args>
|
2016-11-29 21:46:52 +00:00
|
|
|
void testContractAgainstCppOnRange(std::string _sig, CppFunction const& _cppFunction, u256 const& _rangeStart, u256 const& _rangeEnd)
|
2016-11-28 00:21:01 +00:00
|
|
|
{
|
|
|
|
for (u256 argument = _rangeStart; argument < _rangeEnd; ++argument)
|
|
|
|
{
|
2016-11-29 21:46:52 +00:00
|
|
|
bytes contractResult = callContractFunction(_sig, argument);
|
2016-11-28 00:21:01 +00:00
|
|
|
bytes cppResult = callCppAndEncodeResult(_cppFunction, argument);
|
|
|
|
BOOST_CHECK_MESSAGE(
|
2016-11-29 21:46:52 +00:00
|
|
|
contractResult == cppResult,
|
|
|
|
"Computed values do not match.\nContract: " +
|
|
|
|
toHex(contractResult) +
|
2016-11-28 00:21:01 +00:00
|
|
|
"\nC++: " +
|
|
|
|
toHex(cppResult) +
|
|
|
|
"\nArgument: " +
|
|
|
|
toHex(encode(argument))
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2017-09-20 12:23:00 +00:00
|
|
|
static std::pair<bool, std::string> compareAndCreateMessage(bytes const& _result, bytes const& _expectation);
|
|
|
|
|
2018-11-07 11:04:46 +00:00
|
|
|
static bytes encode(bool _value) { return encode(uint8_t(_value)); }
|
2016-11-28 00:21:01 +00:00
|
|
|
static bytes encode(int _value) { return encode(u256(_value)); }
|
|
|
|
static bytes encode(size_t _value) { return encode(u256(_value)); }
|
|
|
|
static bytes encode(char const* _value) { return encode(std::string(_value)); }
|
2018-11-07 11:04:46 +00:00
|
|
|
static bytes encode(uint8_t _value) { return bytes(31, 0) + bytes{_value}; }
|
2016-11-28 00:21:01 +00:00
|
|
|
static bytes encode(u256 const& _value) { return toBigEndian(_value); }
|
|
|
|
/// @returns the fixed-point encoding of a rational number with a given
|
|
|
|
/// number of fractional bits.
|
|
|
|
static bytes encode(std::pair<rational, int> const& _valueAndPrecision)
|
|
|
|
{
|
|
|
|
rational const& value = _valueAndPrecision.first;
|
|
|
|
int fractionalBits = _valueAndPrecision.second;
|
|
|
|
return encode(u256((value.numerator() << fractionalBits) / value.denominator()));
|
|
|
|
}
|
|
|
|
static bytes encode(h256 const& _value) { return _value.asBytes(); }
|
|
|
|
static bytes encode(bytes const& _value, bool _padLeft = true)
|
|
|
|
{
|
|
|
|
bytes padding = bytes((32 - _value.size() % 32) % 32, 0);
|
|
|
|
return _padLeft ? padding + _value : _value + padding;
|
|
|
|
}
|
|
|
|
static bytes encode(std::string const& _value) { return encode(asBytes(_value), false); }
|
|
|
|
template <class _T>
|
|
|
|
static bytes encode(std::vector<_T> const& _value)
|
|
|
|
{
|
|
|
|
bytes ret;
|
|
|
|
for (auto const& v: _value)
|
|
|
|
ret += encode(v);
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
template <class FirstArg, class... Args>
|
|
|
|
static bytes encodeArgs(FirstArg const& _firstArg, Args const&... _followingArgs)
|
|
|
|
{
|
|
|
|
return encode(_firstArg) + encodeArgs(_followingArgs...);
|
|
|
|
}
|
|
|
|
static bytes encodeArgs()
|
|
|
|
{
|
|
|
|
return bytes();
|
|
|
|
}
|
2017-10-18 23:12:32 +00:00
|
|
|
|
2016-11-28 00:21:01 +00:00
|
|
|
//@todo might be extended in the future
|
|
|
|
template <class Arg>
|
|
|
|
static bytes encodeDyn(Arg const& _arg)
|
|
|
|
{
|
|
|
|
return encodeArgs(u256(0x20), u256(_arg.size()), _arg);
|
|
|
|
}
|
|
|
|
|
2018-08-10 17:19:21 +00:00
|
|
|
u256 gasLimit() const;
|
|
|
|
u256 gasPrice() const;
|
|
|
|
u256 blockHash(u256 const& _blockNumber) const;
|
|
|
|
u256 const& blockNumber() const {
|
|
|
|
return m_blockNumber;
|
|
|
|
}
|
|
|
|
|
2019-03-05 11:01:44 +00:00
|
|
|
template<typename Range>
|
2019-03-06 21:01:19 +00:00
|
|
|
static bytes encodeArray(bool _dynamicallySized, bool _dynamicallyEncoded, Range const& _elements)
|
2019-03-05 11:01:44 +00:00
|
|
|
{
|
|
|
|
bytes result;
|
|
|
|
if (_dynamicallySized)
|
|
|
|
result += encode(u256(_elements.size()));
|
|
|
|
if (_dynamicallyEncoded)
|
|
|
|
{
|
|
|
|
u256 offset = u256(_elements.size()) * 32;
|
|
|
|
std::vector<bytes> subEncodings;
|
|
|
|
for (auto const& element: _elements)
|
|
|
|
{
|
|
|
|
result += encode(offset);
|
|
|
|
subEncodings.emplace_back(encode(element));
|
|
|
|
offset += subEncodings.back().size();
|
|
|
|
}
|
|
|
|
for (auto const& subEncoding: subEncodings)
|
|
|
|
result += subEncoding;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
for (auto const& element: _elements)
|
|
|
|
result += encode(element);
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
|
2016-11-28 00:21:01 +00:00
|
|
|
private:
|
|
|
|
template <class CppFunction, class... Args>
|
|
|
|
auto callCppAndEncodeResult(CppFunction const& _cppFunction, Args const&... _arguments)
|
|
|
|
-> typename std::enable_if<std::is_void<decltype(_cppFunction(_arguments...))>::value, bytes>::type
|
|
|
|
{
|
|
|
|
_cppFunction(_arguments...);
|
|
|
|
return bytes();
|
|
|
|
}
|
|
|
|
template <class CppFunction, class... Args>
|
|
|
|
auto callCppAndEncodeResult(CppFunction const& _cppFunction, Args const&... _arguments)
|
|
|
|
-> typename std::enable_if<!std::is_void<decltype(_cppFunction(_arguments...))>::value, bytes>::type
|
|
|
|
{
|
|
|
|
return encode(_cppFunction(_arguments...));
|
|
|
|
}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
void sendMessage(bytes const& _data, bool _isCreation, u256 const& _value = 0);
|
|
|
|
void sendEther(Address const& _to, u256 const& _value);
|
2019-04-04 10:04:53 +00:00
|
|
|
void waitForTransaction(std::string const& _txHash) const;
|
2016-11-28 00:21:01 +00:00
|
|
|
size_t currentTimestamp();
|
2017-08-22 17:24:02 +00:00
|
|
|
size_t blockTimestamp(u256 _number);
|
2016-11-28 00:21:01 +00:00
|
|
|
|
|
|
|
/// @returns the (potentially newly created) _ith address.
|
|
|
|
Address account(size_t _i);
|
|
|
|
|
|
|
|
u256 balanceAt(Address const& _addr);
|
|
|
|
bool storageEmpty(Address const& _addr);
|
|
|
|
bool addressHasCode(Address const& _addr);
|
|
|
|
|
|
|
|
RPCSession& m_rpc;
|
|
|
|
|
|
|
|
struct LogEntry
|
|
|
|
{
|
|
|
|
Address address;
|
|
|
|
std::vector<h256> topics;
|
|
|
|
bytes data;
|
|
|
|
};
|
|
|
|
|
2019-02-25 14:29:57 +00:00
|
|
|
langutil::EVMVersion m_evmVersion;
|
2019-03-12 14:14:12 +00:00
|
|
|
solidity::OptimiserSettings m_optimiserSettings = solidity::OptimiserSettings::minimal();
|
2016-12-06 17:38:59 +00:00
|
|
|
bool m_showMessages = false;
|
2018-06-15 10:18:00 +00:00
|
|
|
bool m_transactionSuccessful = true;
|
2016-11-28 00:21:01 +00:00
|
|
|
Address m_sender;
|
|
|
|
Address m_contractAddress;
|
2017-02-07 16:20:05 +00:00
|
|
|
u256 m_blockNumber;
|
2016-11-28 00:21:01 +00:00
|
|
|
u256 const m_gasPrice = 100 * szabo;
|
|
|
|
u256 const m_gas = 100000000;
|
|
|
|
bytes m_output;
|
|
|
|
std::vector<LogEntry> m_logs;
|
|
|
|
u256 m_gasUsed;
|
|
|
|
};
|
|
|
|
|
2017-09-20 12:23:00 +00:00
|
|
|
#define ABI_CHECK(result, expectation) do { \
|
|
|
|
auto abiCheckResult = ExecutionFramework::compareAndCreateMessage((result), (expectation)); \
|
|
|
|
BOOST_CHECK_MESSAGE(abiCheckResult.first, abiCheckResult.second); \
|
|
|
|
} while (0)
|
|
|
|
|
|
|
|
|
2016-11-28 00:21:01 +00:00
|
|
|
}
|
|
|
|
} // end namespaces
|
|
|
|
|