Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add statemutability field to ABI #2732

Merged
merged 2 commits into from
Aug 15, 2017
Merged

Add statemutability field to ABI #2732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12f3257
Add statemutability field to the ABI
axic Jul 17, 2017
1f5ab60
Add test for payable constructor in ABI
axic Aug 15, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
### 0.4.16 (unreleased)

Features:
* ABI JSON: Include new field ``statemutability`` with values ``view``, ``nonpayable`` and ``payable``.
* Parser: Display previous visibility specifier in error if multiple are found.
* Syntax Checker: Support ``pragma experimental <feature>;`` to turn on experimental features.
* Static Analyzer: Warn about large storage structures.
Expand Down
3 changes: 2 additions & 1 deletion docs/abi-spec.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,8 @@ The JSON format for a contract's interface is given by an array of function and/
* `type`: the canonical type of the parameter.
- `outputs`: an array of objects similar to `inputs`, can be omitted if function doesn't return anything;
- `constant`: `true` if function is :ref:`specified to not modify blockchain state <constant-functions>`);
- `payable`: `true` if function accepts ether, defaults to `false`.
- `payable`: `true` if function accepts ether, defaults to `false`;
- `statemutability`: a string with one of the following values: `view` (same as `constant` above), `nonpayable` and `payable` (same as `payable` above).

`type` can be omitted, defaulting to `"function"`.

Expand Down
3 changes: 3 additions & 0 deletions libsolidity/interface/ABI.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Json::Value ABI::generate(ContractDefinition const& _contractDef)
method["name"] = it.second->declaration().name();
method["constant"] = it.second->isConstant();
method["payable"] = it.second->isPayable();
method["statemutability"] = stateMutabilityToString(it.second->stateMutability());
method["inputs"] = formatTypeList(
externalFunctionType->parameterNames(),
externalFunctionType->parameterTypes(),
Expand All @@ -57,6 +58,7 @@ Json::Value ABI::generate(ContractDefinition const& _contractDef)
auto externalFunction = FunctionType(*_contractDef.constructor(), false).interfaceFunctionType();
solAssert(!!externalFunction, "");
method["payable"] = externalFunction->isPayable();
method["statemutability"] = stateMutabilityToString(externalFunction->stateMutability());
method["inputs"] = formatTypeList(
externalFunction->parameterNames(),
externalFunction->parameterTypes(),
Expand All @@ -71,6 +73,7 @@ Json::Value ABI::generate(ContractDefinition const& _contractDef)
Json::Value method;
method["type"] = "fallback";
method["payable"] = externalFunctionType->isPayable();
method["statemutability"] = stateMutabilityToString(externalFunctionType->stateMutability());
abi.append(method);
}
for (auto const& it: _contractDef.interfaceEvents())
Expand Down
54 changes: 54 additions & 0 deletions test/libsolidity/SolidityABIJSON.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ BOOST_AUTO_TEST_CASE(basic_test)
"name": "f",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs": [
{
Expand Down Expand Up @@ -119,6 +120,7 @@ BOOST_AUTO_TEST_CASE(multiple_methods)
"name": "f",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs": [
{
Expand All @@ -137,6 +139,7 @@ BOOST_AUTO_TEST_CASE(multiple_methods)
"name": "g",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs": [
{
Expand Down Expand Up @@ -169,6 +172,7 @@ BOOST_AUTO_TEST_CASE(multiple_params)
"name": "f",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs": [
{
Expand Down Expand Up @@ -207,6 +211,7 @@ BOOST_AUTO_TEST_CASE(multiple_methods_order)
"name": "c",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs": [
{
Expand All @@ -225,6 +230,7 @@ BOOST_AUTO_TEST_CASE(multiple_methods_order)
"name": "f",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs": [
{
Expand Down Expand Up @@ -258,6 +264,7 @@ BOOST_AUTO_TEST_CASE(const_function)
"name": "foo",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs": [
{
Expand All @@ -280,6 +287,7 @@ BOOST_AUTO_TEST_CASE(const_function)
"name": "boo",
"constant": true,
"payable" : false,
"statemutability": "view",
"type": "function",
"inputs": [{
"name": "a",
Expand Down Expand Up @@ -311,6 +319,7 @@ BOOST_AUTO_TEST_CASE(events)
"name": "f",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs": [
{
Expand Down Expand Up @@ -392,6 +401,7 @@ BOOST_AUTO_TEST_CASE(inherited)
"name": "baseFunction",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs":
[{
Expand All @@ -408,6 +418,7 @@ BOOST_AUTO_TEST_CASE(inherited)
"name": "derivedFunction",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs":
[{
Expand Down Expand Up @@ -463,6 +474,7 @@ BOOST_AUTO_TEST_CASE(empty_name_input_parameter_with_named_one)
"name": "f",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs": [
{
Expand Down Expand Up @@ -505,6 +517,7 @@ BOOST_AUTO_TEST_CASE(empty_name_return_parameter)
"name": "f",
"constant": false,
"payable" : false,
"statemutability": "nonpayable",
"type": "function",
"inputs": [
{
Expand Down Expand Up @@ -548,12 +561,44 @@ BOOST_AUTO_TEST_CASE(constructor_abi)
}
],
"payable": false,
"statemutability": "nonpayable",
"type": "constructor"
}
])";
checkInterface(sourceCode, interface);
}

BOOST_AUTO_TEST_CASE(payable_constructor_abi)
{
char const* sourceCode = R"(
contract test {
function test(uint param1, test param2, bool param3) payable {}
}
)";

char const* interface = R"([
{
"inputs": [
{
"name": "param1",
"type": "uint256"
},
{
"name": "param2",
"type": "address"
},
{
"name": "param3",
"type": "bool"
}
],
"payable": true,
"statemutability": "payable",
"type": "constructor"
}
])";
checkInterface(sourceCode, interface);
}

BOOST_AUTO_TEST_CASE(return_param_in_abi)
{
Expand All @@ -574,6 +619,7 @@ BOOST_AUTO_TEST_CASE(return_param_in_abi)
{
"constant" : false,
"payable" : false,
"statemutability": "nonpayable",
"inputs" : [],
"name" : "ret",
"outputs" : [
Expand All @@ -592,6 +638,7 @@ BOOST_AUTO_TEST_CASE(return_param_in_abi)
}
],
"payable": false,
"statemutability": "nonpayable",
"type": "constructor"
}
]
Expand All @@ -613,6 +660,7 @@ BOOST_AUTO_TEST_CASE(strings_and_arrays)
{
"constant" : false,
"payable" : false,
"statemutability": "nonpayable",
"name": "f",
"inputs": [
{ "name": "a", "type": "string" },
Expand Down Expand Up @@ -641,6 +689,7 @@ BOOST_AUTO_TEST_CASE(library_function)
{
"constant" : false,
"payable" : false,
"statemutability": "nonpayable",
"name": "f",
"inputs": [
{ "name": "b", "type": "test.StructType storage" },
Expand Down Expand Up @@ -670,6 +719,7 @@ BOOST_AUTO_TEST_CASE(include_fallback_function)
[
{
"payable": false,
"statemutability": "nonpayable",
"type" : "fallback"
}
]
Expand All @@ -691,6 +741,7 @@ BOOST_AUTO_TEST_CASE(payable_function)
{
"constant" : false,
"payable": false,
"statemutability": "nonpayable",
"inputs": [],
"name": "f",
"outputs": [],
Expand All @@ -699,6 +750,7 @@ BOOST_AUTO_TEST_CASE(payable_function)
{
"constant" : false,
"payable": true,
"statemutability": "payable",
"inputs": [],
"name": "g",
"outputs": [],
Expand All @@ -721,6 +773,7 @@ BOOST_AUTO_TEST_CASE(payable_fallback_function)
[
{
"payable": true,
"statemutability": "payable",
"type" : "fallback"
}
]
Expand All @@ -741,6 +794,7 @@ BOOST_AUTO_TEST_CASE(function_type)
{
"constant" : false,
"payable": false,
"statemutability": "nonpayable",
"inputs": [{
"name": "x",
"type": "function"
Expand Down