/* 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 . */ /** * Utilities to handle the Contract ABI (https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI) */ #include #include using namespace std; using namespace dev; using namespace dev::solidity; Json::Value ABI::generate(ContractDefinition const& _contractDef) { Json::Value abi(Json::arrayValue); for (auto it: _contractDef.interfaceFunctions()) { auto externalFunctionType = it.second->interfaceFunctionType(); solAssert(!!externalFunctionType, ""); Json::Value method; method["type"] = "function"; method["name"] = it.second->declaration().name(); // TODO: deprecate constant in a future release method["constant"] = externalFunctionType->stateMutability() == StateMutability::Pure || it.second->stateMutability() == StateMutability::View; method["payable"] = externalFunctionType->isPayable(); method["stateMutability"] = stateMutabilityToString(externalFunctionType->stateMutability()); method["inputs"] = formatTypeList( externalFunctionType->parameterNames(), externalFunctionType->parameterTypes(), _contractDef.isLibrary() ); method["outputs"] = formatTypeList( externalFunctionType->returnParameterNames(), externalFunctionType->returnParameterTypes(), _contractDef.isLibrary() ); abi.append(method); } if (_contractDef.constructor()) { auto externalFunctionType = FunctionType(*_contractDef.constructor(), false).interfaceFunctionType(); solAssert(!!externalFunctionType, ""); Json::Value method; method["type"] = "constructor"; method["payable"] = externalFunctionType->isPayable(); method["stateMutability"] = stateMutabilityToString(externalFunctionType->stateMutability()); method["inputs"] = formatTypeList( externalFunctionType->parameterNames(), externalFunctionType->parameterTypes(), _contractDef.isLibrary() ); abi.append(method); } if (_contractDef.fallbackFunction()) { auto externalFunctionType = FunctionType(*_contractDef.fallbackFunction(), false).interfaceFunctionType(); solAssert(!!externalFunctionType, ""); Json::Value method; method["type"] = "fallback"; method["payable"] = externalFunctionType->isPayable(); method["stateMutability"] = stateMutabilityToString(externalFunctionType->stateMutability()); abi.append(method); } for (auto const& it: _contractDef.interfaceEvents()) { Json::Value event; event["type"] = "event"; event["name"] = it->name(); event["anonymous"] = it->isAnonymous(); Json::Value params(Json::arrayValue); for (auto const& p: it->parameters()) { auto type = p->annotation().type->interfaceType(false); solAssert(type, ""); Json::Value input; auto param = formatType(p->name(), *type, false); param["indexed"] = p->isIndexed(); params.append(param); } event["inputs"] = params; abi.append(event); } return abi; } Json::Value ABI::formatTypeList( vector const& _names, vector const& _types, bool _forLibrary ) { Json::Value params(Json::arrayValue); solAssert(_names.size() == _types.size(), "Names and types vector size does not match"); for (unsigned i = 0; i < _names.size(); ++i) { solAssert(_types[i], ""); params.append(formatType(_names[i], *_types[i], _forLibrary)); } return params; } Json::Value ABI::formatType(string const& _name, Type const& _type, bool _forLibrary) { Json::Value ret; ret["name"] = _name; string suffix = (_forLibrary && _type.dataStoredIn(DataLocation::Storage)) ? " storage" : ""; if (_type.isValueType() || (_forLibrary && _type.dataStoredIn(DataLocation::Storage))) ret["type"] = _type.canonicalName() + suffix; else if (ArrayType const* arrayType = dynamic_cast(&_type)) { if (arrayType->isByteArray()) ret["type"] = _type.canonicalName() + suffix; else { string suffix; if (arrayType->isDynamicallySized()) suffix = "[]"; else suffix = string("[") + arrayType->length().str() + "]"; solAssert(arrayType->baseType(), ""); Json::Value subtype = formatType("", *arrayType->baseType(), _forLibrary); if (subtype.isMember("components")) { ret["type"] = subtype["type"].asString() + suffix; ret["components"] = subtype["components"]; } else ret["type"] = subtype["type"].asString() + suffix; } } else if (StructType const* structType = dynamic_cast(&_type)) { ret["type"] = "tuple"; ret["components"] = Json::arrayValue; for (auto const& member: structType->members(nullptr)) { solAssert(member.type, ""); auto t = member.type->interfaceType(_forLibrary); solAssert(t, ""); ret["components"].append(formatType(member.name, *t, _forLibrary)); } } else solAssert(false, "Invalid type."); return ret; }