mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
Implement typechecked abi.encodeCall()
This commit is contained in:
@@ -1996,6 +1996,7 @@ void TypeChecker::typeCheckABIEncodeFunctions(
|
||||
_functionType->kind() == FunctionType::Kind::ABIEncode ||
|
||||
_functionType->kind() == FunctionType::Kind::ABIEncodePacked ||
|
||||
_functionType->kind() == FunctionType::Kind::ABIEncodeWithSelector ||
|
||||
_functionType->kind() == FunctionType::Kind::ABIEncodeCall ||
|
||||
_functionType->kind() == FunctionType::Kind::ABIEncodeWithSignature,
|
||||
"ABI function has unexpected FunctionType::Kind."
|
||||
);
|
||||
@@ -2020,6 +2021,13 @@ void TypeChecker::typeCheckABIEncodeFunctions(
|
||||
// Perform standard function call type checking
|
||||
typeCheckFunctionGeneralChecks(_functionCall, _functionType);
|
||||
|
||||
// No further generic checks needed as we do a precise check for ABIEncodeCall
|
||||
if (_functionType->kind() == FunctionType::Kind::ABIEncodeCall)
|
||||
{
|
||||
typeCheckABIEncodeCallFunction(_functionCall);
|
||||
return;
|
||||
}
|
||||
|
||||
// Check additional arguments for variadic functions
|
||||
vector<ASTPointer<Expression const>> const& arguments = _functionCall.arguments();
|
||||
for (size_t i = 0; i < arguments.size(); ++i)
|
||||
@@ -2078,6 +2086,110 @@ void TypeChecker::typeCheckABIEncodeFunctions(
|
||||
}
|
||||
}
|
||||
|
||||
void TypeChecker::typeCheckABIEncodeCallFunction(FunctionCall const& _functionCall)
|
||||
{
|
||||
vector<ASTPointer<Expression const>> const& arguments = _functionCall.arguments();
|
||||
|
||||
// Expecting first argument to be the function pointer and second to be a tuple.
|
||||
if (arguments.size() != 2)
|
||||
{
|
||||
m_errorReporter.typeError(
|
||||
6219_error,
|
||||
_functionCall.location(),
|
||||
"Expected two arguments: a function pointer followed by a tuple."
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
auto const functionPointerType = dynamic_cast<FunctionTypePointer>(type(*arguments.front()));
|
||||
|
||||
if (!functionPointerType)
|
||||
{
|
||||
m_errorReporter.typeError(
|
||||
5511_error,
|
||||
arguments.front()->location(),
|
||||
"Expected first argument to be a function pointer, not \"" +
|
||||
type(*arguments.front())->canonicalName() +
|
||||
"\"."
|
||||
);
|
||||
return;
|
||||
}
|
||||
|
||||
if (functionPointerType->kind() != FunctionType::Kind::External)
|
||||
{
|
||||
string msg = "Function must be \"public\" or \"external\".";
|
||||
SecondarySourceLocation ssl{};
|
||||
|
||||
if (functionPointerType->hasDeclaration())
|
||||
{
|
||||
ssl.append("Function is declared here:", functionPointerType->declaration().location());
|
||||
if (functionPointerType->declaration().scope() == m_currentContract)
|
||||
msg += " Did you forget to prefix \"this.\"?";
|
||||
}
|
||||
|
||||
m_errorReporter.typeError(3509_error, arguments[0]->location(), ssl, msg);
|
||||
return;
|
||||
}
|
||||
|
||||
solAssert(!functionPointerType->takesArbitraryParameters(), "Function must have fixed parameters.");
|
||||
|
||||
// Tuples with only one component become that component
|
||||
vector<ASTPointer<Expression const>> callArguments;
|
||||
|
||||
auto const* tupleType = dynamic_cast<TupleType const*>(type(*arguments[1]));
|
||||
if (tupleType)
|
||||
{
|
||||
auto const& argumentTuple = dynamic_cast<TupleExpression const&>(*arguments[1].get());
|
||||
callArguments = decltype(callArguments){argumentTuple.components().begin(), argumentTuple.components().end()};
|
||||
}
|
||||
else
|
||||
callArguments.push_back(arguments[1]);
|
||||
|
||||
if (functionPointerType->parameterTypes().size() != callArguments.size())
|
||||
{
|
||||
if (tupleType)
|
||||
m_errorReporter.typeError(
|
||||
7788_error,
|
||||
_functionCall.location(),
|
||||
"Expected " +
|
||||
to_string(functionPointerType->parameterTypes().size()) +
|
||||
" instead of " +
|
||||
to_string(callArguments.size()) +
|
||||
" components for the tuple parameter."
|
||||
);
|
||||
else
|
||||
m_errorReporter.typeError(
|
||||
7515_error,
|
||||
_functionCall.location(),
|
||||
"Expected a tuple with " +
|
||||
to_string(functionPointerType->parameterTypes().size()) +
|
||||
" components instead of a single non-tuple parameter."
|
||||
);
|
||||
}
|
||||
|
||||
// Use min() to check as much as we can before failing fatally
|
||||
size_t const numParameters = min(callArguments.size(), functionPointerType->parameterTypes().size());
|
||||
|
||||
for (size_t i = 0; i < numParameters; i++)
|
||||
{
|
||||
Type const& argType = *type(*callArguments[i]);
|
||||
BoolResult result = argType.isImplicitlyConvertibleTo(*functionPointerType->parameterTypes()[i]);
|
||||
if (!result)
|
||||
m_errorReporter.typeError(
|
||||
5407_error,
|
||||
callArguments[i]->location(),
|
||||
"Cannot implicitly convert component at position " +
|
||||
to_string(i) +
|
||||
" from \"" +
|
||||
argType.canonicalName() +
|
||||
"\" to \"" +
|
||||
functionPointerType->parameterTypes()[i]->canonicalName() +
|
||||
"\"" +
|
||||
(result.message().empty() ? "." : ": " + result.message())
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
void TypeChecker::typeCheckBytesConcatFunction(
|
||||
FunctionCall const& _functionCall,
|
||||
FunctionType const* _functionType
|
||||
@@ -2507,6 +2619,7 @@ bool TypeChecker::visit(FunctionCall const& _functionCall)
|
||||
case FunctionType::Kind::ABIEncodePacked:
|
||||
case FunctionType::Kind::ABIEncodeWithSelector:
|
||||
case FunctionType::Kind::ABIEncodeWithSignature:
|
||||
case FunctionType::Kind::ABIEncodeCall:
|
||||
{
|
||||
typeCheckABIEncodeFunctions(_functionCall, functionType);
|
||||
returnTypes = functionType->returnParameterTypes();
|
||||
|
||||
@@ -110,6 +110,9 @@ private:
|
||||
FunctionTypePointer _functionType
|
||||
);
|
||||
|
||||
/// Performs checks specific to the ABI encode functions of type ABIEncodeCall
|
||||
void typeCheckABIEncodeCallFunction(FunctionCall const& _functionCall);
|
||||
|
||||
/// Performs general checks and checks specific to bytes concat function call
|
||||
void typeCheckBytesConcatFunction(
|
||||
FunctionCall const& _functionCall,
|
||||
|
||||
@@ -367,6 +367,7 @@ void ViewPureChecker::endVisit(MemberAccess const& _memberAccess)
|
||||
{MagicType::Kind::ABI, "encode"},
|
||||
{MagicType::Kind::ABI, "encodePacked"},
|
||||
{MagicType::Kind::ABI, "encodeWithSelector"},
|
||||
{MagicType::Kind::ABI, "encodeCall"},
|
||||
{MagicType::Kind::ABI, "encodeWithSignature"},
|
||||
{MagicType::Kind::Message, "data"},
|
||||
{MagicType::Kind::Message, "sig"},
|
||||
|
||||
@@ -2935,6 +2935,7 @@ string FunctionType::richIdentifier() const
|
||||
case Kind::ABIEncode: id += "abiencode"; break;
|
||||
case Kind::ABIEncodePacked: id += "abiencodepacked"; break;
|
||||
case Kind::ABIEncodeWithSelector: id += "abiencodewithselector"; break;
|
||||
case Kind::ABIEncodeCall: id += "abiencodecall"; break;
|
||||
case Kind::ABIEncodeWithSignature: id += "abiencodewithsignature"; break;
|
||||
case Kind::ABIDecode: id += "abidecode"; break;
|
||||
case Kind::MetaType: id += "metatype"; break;
|
||||
@@ -3499,6 +3500,7 @@ bool FunctionType::isPure() const
|
||||
m_kind == Kind::ABIEncode ||
|
||||
m_kind == Kind::ABIEncodePacked ||
|
||||
m_kind == Kind::ABIEncodeWithSelector ||
|
||||
m_kind == Kind::ABIEncodeCall ||
|
||||
m_kind == Kind::ABIEncodeWithSignature ||
|
||||
m_kind == Kind::ABIDecode ||
|
||||
m_kind == Kind::MetaType ||
|
||||
@@ -4001,6 +4003,15 @@ MemberList::MemberMap MagicType::nativeMembers(ASTNode const*) const
|
||||
true,
|
||||
StateMutability::Pure
|
||||
)},
|
||||
{"encodeCall", TypeProvider::function(
|
||||
TypePointers{},
|
||||
TypePointers{TypeProvider::array(DataLocation::Memory)},
|
||||
strings{},
|
||||
strings{1, ""},
|
||||
FunctionType::Kind::ABIEncodeCall,
|
||||
true,
|
||||
StateMutability::Pure
|
||||
)},
|
||||
{"encodeWithSignature", TypeProvider::function(
|
||||
TypePointers{TypeProvider::array(DataLocation::Memory, true)},
|
||||
TypePointers{TypeProvider::array(DataLocation::Memory)},
|
||||
|
||||
@@ -1237,6 +1237,7 @@ public:
|
||||
ABIEncode,
|
||||
ABIEncodePacked,
|
||||
ABIEncodeWithSelector,
|
||||
ABIEncodeCall,
|
||||
ABIEncodeWithSignature,
|
||||
ABIDecode,
|
||||
GasLeft, ///< gasleft()
|
||||
|
||||
@@ -1236,28 +1236,47 @@ bool ExpressionCompiler::visit(FunctionCall const& _functionCall)
|
||||
case FunctionType::Kind::ABIEncode:
|
||||
case FunctionType::Kind::ABIEncodePacked:
|
||||
case FunctionType::Kind::ABIEncodeWithSelector:
|
||||
case FunctionType::Kind::ABIEncodeCall:
|
||||
case FunctionType::Kind::ABIEncodeWithSignature:
|
||||
{
|
||||
bool const isPacked = function.kind() == FunctionType::Kind::ABIEncodePacked;
|
||||
bool const hasSelectorOrSignature =
|
||||
function.kind() == FunctionType::Kind::ABIEncodeWithSelector ||
|
||||
function.kind() == FunctionType::Kind::ABIEncodeCall ||
|
||||
function.kind() == FunctionType::Kind::ABIEncodeWithSignature;
|
||||
|
||||
TypePointers argumentTypes;
|
||||
TypePointers targetTypes;
|
||||
for (unsigned i = 0; i < arguments.size(); ++i)
|
||||
|
||||
ASTNode::listAccept(arguments, *this);
|
||||
|
||||
if (function.kind() == FunctionType::Kind::ABIEncodeCall)
|
||||
{
|
||||
arguments[i]->accept(*this);
|
||||
// Do not keep the selector as part of the ABI encoded args
|
||||
if (!hasSelectorOrSignature || i > 0)
|
||||
argumentTypes.push_back(arguments[i]->annotation().type);
|
||||
solAssert(arguments.size() == 2);
|
||||
|
||||
auto const functionPtr = dynamic_cast<FunctionTypePointer>(arguments[0]->annotation().type);
|
||||
solAssert(functionPtr);
|
||||
solAssert(functionPtr->sizeOnStack() == 2);
|
||||
|
||||
// Account for tuples with one component which become that component
|
||||
if (auto const tupleType = dynamic_cast<TupleType const*>(arguments[1]->annotation().type))
|
||||
argumentTypes = tupleType->components();
|
||||
else
|
||||
argumentTypes.emplace_back(arguments[1]->annotation().type);
|
||||
}
|
||||
else
|
||||
for (unsigned i = 0; i < arguments.size(); ++i)
|
||||
{
|
||||
// Do not keep the selector as part of the ABI encoded args
|
||||
if (!hasSelectorOrSignature || i > 0)
|
||||
argumentTypes.push_back(arguments[i]->annotation().type);
|
||||
}
|
||||
|
||||
utils().fetchFreeMemoryPointer();
|
||||
// stack now: [<selector>] <arg1> .. <argN> <free_mem>
|
||||
// stack now: [<selector/functionPointer/signature>] <arg1> .. <argN> <free_mem>
|
||||
|
||||
// adjust by 32(+4) bytes to accommodate the length(+selector)
|
||||
m_context << u256(32 + (hasSelectorOrSignature ? 4 : 0)) << Instruction::ADD;
|
||||
// stack now: [<selector>] <arg1> .. <argN> <data_encoding_area_start>
|
||||
// stack now: [<selector/functionPointer/signature>] <arg1> .. <argN> <data_encoding_area_start>
|
||||
|
||||
if (isPacked)
|
||||
{
|
||||
@@ -1270,7 +1289,7 @@ bool ExpressionCompiler::visit(FunctionCall const& _functionCall)
|
||||
utils().abiEncode(argumentTypes, TypePointers());
|
||||
}
|
||||
utils().fetchFreeMemoryPointer();
|
||||
// stack: [<selector>] <data_encoding_area_end> <bytes_memory_ptr>
|
||||
// stack: [<selector/functionPointer/signature>] <data_encoding_area_end> <bytes_memory_ptr>
|
||||
|
||||
// size is end minus start minus length slot
|
||||
m_context.appendInlineAssembly(R"({
|
||||
@@ -1278,16 +1297,17 @@ bool ExpressionCompiler::visit(FunctionCall const& _functionCall)
|
||||
})", {"mem_end", "mem_ptr"});
|
||||
m_context << Instruction::SWAP1;
|
||||
utils().storeFreeMemoryPointer();
|
||||
// stack: [<selector>] <memory ptr>
|
||||
// stack: [<selector/functionPointer/signature>] <memory ptr>
|
||||
|
||||
if (hasSelectorOrSignature)
|
||||
{
|
||||
// stack: <selector> <memory pointer>
|
||||
// stack: <selector/functionPointer/signature> <memory pointer>
|
||||
solAssert(arguments.size() >= 1, "");
|
||||
Type const* selectorType = arguments[0]->annotation().type;
|
||||
utils().moveIntoStack(selectorType->sizeOnStack());
|
||||
Type const* dataOnStack = selectorType;
|
||||
// stack: <memory pointer> <selector>
|
||||
|
||||
// stack: <memory pointer> <selector/functionPointer/signature>
|
||||
if (function.kind() == FunctionType::Kind::ABIEncodeWithSignature)
|
||||
{
|
||||
// hash the signature
|
||||
@@ -1299,7 +1319,7 @@ bool ExpressionCompiler::visit(FunctionCall const& _functionCall)
|
||||
else
|
||||
{
|
||||
utils().fetchFreeMemoryPointer();
|
||||
// stack: <memory pointer> <selector> <free mem ptr>
|
||||
// stack: <memory pointer> <signature> <free mem ptr>
|
||||
utils().packedEncode(TypePointers{selectorType}, TypePointers());
|
||||
utils().toSizeAfterFreeMemoryPointer();
|
||||
m_context << Instruction::KECCAK256;
|
||||
@@ -1308,10 +1328,16 @@ bool ExpressionCompiler::visit(FunctionCall const& _functionCall)
|
||||
dataOnStack = TypeProvider::fixedBytes(32);
|
||||
}
|
||||
}
|
||||
else
|
||||
else if (function.kind() == FunctionType::Kind::ABIEncodeCall)
|
||||
{
|
||||
solAssert(function.kind() == FunctionType::Kind::ABIEncodeWithSelector, "");
|
||||
// stack: <memory pointer> <functionPointer>
|
||||
// Extract selector from the stack
|
||||
m_context << Instruction::SWAP1 << Instruction::POP;
|
||||
// Conversion will be done below
|
||||
dataOnStack = TypeProvider::uint(32);
|
||||
}
|
||||
else
|
||||
solAssert(function.kind() == FunctionType::Kind::ABIEncodeWithSelector, "");
|
||||
|
||||
utils().convertType(*dataOnStack, FixedBytesType(4), true);
|
||||
|
||||
|
||||
@@ -1104,29 +1104,57 @@ void IRGeneratorForStatements::endVisit(FunctionCall const& _functionCall)
|
||||
case FunctionType::Kind::ABIEncode:
|
||||
case FunctionType::Kind::ABIEncodePacked:
|
||||
case FunctionType::Kind::ABIEncodeWithSelector:
|
||||
case FunctionType::Kind::ABIEncodeCall:
|
||||
case FunctionType::Kind::ABIEncodeWithSignature:
|
||||
{
|
||||
bool const isPacked = functionType->kind() == FunctionType::Kind::ABIEncodePacked;
|
||||
solAssert(functionType->padArguments() != isPacked, "");
|
||||
bool const hasSelectorOrSignature =
|
||||
functionType->kind() == FunctionType::Kind::ABIEncodeWithSelector ||
|
||||
functionType->kind() == FunctionType::Kind::ABIEncodeCall ||
|
||||
functionType->kind() == FunctionType::Kind::ABIEncodeWithSignature;
|
||||
|
||||
TypePointers argumentTypes;
|
||||
TypePointers targetTypes;
|
||||
vector<string> argumentVars;
|
||||
for (size_t i = 0; i < arguments.size(); ++i)
|
||||
string selector;
|
||||
vector<ASTPointer<Expression const>> argumentsOfEncodeFunction;
|
||||
|
||||
if (functionType->kind() == FunctionType::Kind::ABIEncodeCall)
|
||||
{
|
||||
// ignore selector
|
||||
if (hasSelectorOrSignature && i == 0)
|
||||
continue;
|
||||
argumentTypes.emplace_back(&type(*arguments[i]));
|
||||
targetTypes.emplace_back(type(*arguments[i]).fullEncodingType(false, true, isPacked));
|
||||
argumentVars += IRVariable(*arguments[i]).stackSlots();
|
||||
solAssert(arguments.size() == 2, "");
|
||||
// Account for tuples with one component which become that component
|
||||
if (type(*arguments[1]).category() == Type::Category::Tuple)
|
||||
{
|
||||
auto const& tupleExpression = dynamic_cast<TupleExpression const&>(*arguments[1]);
|
||||
for (auto component: tupleExpression.components())
|
||||
argumentsOfEncodeFunction.push_back(component);
|
||||
}
|
||||
else
|
||||
argumentsOfEncodeFunction.push_back(arguments[1]);
|
||||
}
|
||||
else
|
||||
for (size_t i = 0; i < arguments.size(); ++i)
|
||||
{
|
||||
// ignore selector
|
||||
if (hasSelectorOrSignature && i == 0)
|
||||
continue;
|
||||
argumentsOfEncodeFunction.push_back(arguments[i]);
|
||||
}
|
||||
|
||||
for (auto const& argument: argumentsOfEncodeFunction)
|
||||
{
|
||||
argumentTypes.emplace_back(&type(*argument));
|
||||
targetTypes.emplace_back(type(*argument).fullEncodingType(false, true, isPacked));
|
||||
argumentVars += IRVariable(*argument).stackSlots();
|
||||
}
|
||||
|
||||
string selector;
|
||||
if (functionType->kind() == FunctionType::Kind::ABIEncodeWithSignature)
|
||||
if (functionType->kind() == FunctionType::Kind::ABIEncodeCall)
|
||||
selector = convert(
|
||||
IRVariable(*arguments[0]).part("functionSelector"),
|
||||
*TypeProvider::fixedBytes(4)
|
||||
).name();
|
||||
else if (functionType->kind() == FunctionType::Kind::ABIEncodeWithSignature)
|
||||
{
|
||||
// hash the signature
|
||||
Type const& selectorType = type(*arguments.front());
|
||||
@@ -1833,7 +1861,7 @@ void IRGeneratorForStatements::endVisit(MemberAccess const& _memberAccess)
|
||||
|
||||
define(_memberAccess) << requestedValue << "\n";
|
||||
}
|
||||
else if (set<string>{"encode", "encodePacked", "encodeWithSelector", "encodeWithSignature", "decode"}.count(member))
|
||||
else if (set<string>{"encode", "encodePacked", "encodeWithSelector", "encodeCall", "encodeWithSignature", "decode"}.count(member))
|
||||
{
|
||||
// no-op
|
||||
}
|
||||
|
||||
@@ -637,6 +637,7 @@ void SMTEncoder::endVisit(FunctionCall const& _funCall)
|
||||
case FunctionType::Kind::ABIEncode:
|
||||
case FunctionType::Kind::ABIEncodePacked:
|
||||
case FunctionType::Kind::ABIEncodeWithSelector:
|
||||
case FunctionType::Kind::ABIEncodeCall:
|
||||
case FunctionType::Kind::ABIEncodeWithSignature:
|
||||
visitABIFunction(_funCall);
|
||||
break;
|
||||
@@ -3041,6 +3042,7 @@ set<FunctionCall const*> SMTEncoder::collectABICalls(ASTNode const* _node)
|
||||
case FunctionType::Kind::ABIEncode:
|
||||
case FunctionType::Kind::ABIEncodePacked:
|
||||
case FunctionType::Kind::ABIEncodeWithSelector:
|
||||
case FunctionType::Kind::ABIEncodeCall:
|
||||
case FunctionType::Kind::ABIEncodeWithSignature:
|
||||
case FunctionType::Kind::ABIDecode:
|
||||
abiCalls.insert(&_funCall);
|
||||
|
||||
@@ -236,6 +236,15 @@ void SymbolicState::buildABIFunctions(set<FunctionCall const*> const& _abiFuncti
|
||||
else
|
||||
solAssert(false, "Unexpected argument of abi.decode");
|
||||
}
|
||||
else if (t->kind() == FunctionType::Kind::ABIEncodeCall)
|
||||
{
|
||||
// abi.encodeCall : (functionPointer, tuple_of_args_or_one_non_tuple_arg(arguments)) -> bytes
|
||||
solAssert(args.size() == 2, "Unexpected number of arguments for abi.encodeCall");
|
||||
|
||||
outTypes.emplace_back(TypeProvider::bytesMemory());
|
||||
inTypes.emplace_back(args.at(0)->annotation().type);
|
||||
inTypes.emplace_back(args.at(1)->annotation().type);
|
||||
}
|
||||
else
|
||||
{
|
||||
outTypes = returnTypes;
|
||||
|
||||
Reference in New Issue
Block a user