Merge pull request #2704 from ethereum/newEncoder

New ABI encoder
2023-10-03 13:03:40 +00:00 · 2017-08-14 17:04:00 +02:00
parent 0a04a35a2e 63b556b206
commit 2411f5d839
13 changed files with 1530 additions and 72 deletions
@@ -42,11 +42,36 @@ namespace test
 	BOOST_CHECK_EQUAL(toHex(m_logs[0].data), toHex(DATA)); \
 } while (false)

+static string const NewEncoderPragma = "pragma experimental ABIEncoderV2;\n";
+
+#define NEW_ENCODER(CODE) \
+{ \
+	sourceCode = NewEncoderPragma + sourceCode; \
+	{ CODE } \
+}
+
+#define BOTH_ENCODERS(CODE) \
+{ \
+	{ CODE } \
+	NEW_ENCODER(CODE) \
+}
+
 BOOST_FIXTURE_TEST_SUITE(ABIEncoderTest, SolidityExecutionFramework)

+BOOST_AUTO_TEST_CASE(both_encoders_macro)
+{
+	// This tests that the "both encoders macro" at least runs twice and
+	// modifies the source.
+	string sourceCode;
+	int runs = 0;
+	BOTH_ENCODERS(runs++;)
+	BOOST_CHECK(sourceCode == NewEncoderPragma);
+	BOOST_CHECK_EQUAL(runs, 2);
+}
+
 BOOST_AUTO_TEST_CASE(value_types)
 {
-	char const* sourceCode = R"(
+	string sourceCode = R"(
 		contract C {
 			event E(uint a, uint16 b, uint24 c, int24 d, bytes3 x, bool, C);
 			function f() {
@@ -59,16 +84,18 @@ BOOST_AUTO_TEST_CASE(value_types)
 			}
 		}
 	)";
-	compileAndRun(sourceCode);
-	callContractFunction("f()");
-	REQUIRE_LOG_DATA(encodeArgs(
-		10, u256(65534), u256(0x121212), u256(-1), string("\x1b\xab\xab"), true, u160(u256(-5))
-	));
+	BOTH_ENCODERS(
+		compileAndRun(sourceCode);
+		callContractFunction("f()");
+		REQUIRE_LOG_DATA(encodeArgs(
+			10, u256(65534), u256(0x121212), u256(-1), string("\x1b\xab\xab"), true, u160(u256(-5))
+		));
+	)
 }

 BOOST_AUTO_TEST_CASE(string_literal)
 {
-	char const* sourceCode = R"(
+	string sourceCode = R"(
 		contract C {
 			event E(string, bytes20, string);
 			function f() {
@@ -76,19 +103,21 @@ BOOST_AUTO_TEST_CASE(string_literal)
 			}
 		}
 	)";
-	compileAndRun(sourceCode);
-	callContractFunction("f()");
-	REQUIRE_LOG_DATA(encodeArgs(
-		0x60, string("abcde"), 0xa0,
-		6, string("abcdef"),
-		0x8b, string("abcdefabcdefgehabcabcasdfjklabcdefabcedefghabcabcasdfjklabcdefabcdefghabcabcasdfjklabcdeefabcdefghabcabcasdefjklabcdefabcdefghabcabcasdfjkl")
-	));
+	BOTH_ENCODERS(
+		compileAndRun(sourceCode);
+		callContractFunction("f()");
+		REQUIRE_LOG_DATA(encodeArgs(
+			0x60, string("abcde"), 0xa0,
+			6, string("abcdef"),
+			0x8b, string("abcdefabcdefgehabcabcasdfjklabcdefabcedefghabcabcasdfjklabcdefabcdefghabcabcasdfjklabcdeefabcdefghabcabcasdefjklabcdefabcdefghabcabcasdfjkl")
+		));
+	)
 }


 BOOST_AUTO_TEST_CASE(enum_type_cleanup)
 {
-	char const* sourceCode = R"(
+	string sourceCode = R"(
 		contract C {
 			enum E { A, B }
 			function f(uint x) returns (E en) {
@@ -96,15 +125,17 @@ BOOST_AUTO_TEST_CASE(enum_type_cleanup)
 			}
 		}
 	)";
-	compileAndRun(sourceCode);
-	BOOST_CHECK(callContractFunction("f(uint256)", 0) == encodeArgs(0));
-	BOOST_CHECK(callContractFunction("f(uint256)", 1) == encodeArgs(1));
-	BOOST_CHECK(callContractFunction("f(uint256)", 2) == encodeArgs());
+	BOTH_ENCODERS(
+		compileAndRun(sourceCode);
+		BOOST_CHECK(callContractFunction("f(uint256)", 0) == encodeArgs(0));
+		BOOST_CHECK(callContractFunction("f(uint256)", 1) == encodeArgs(1));
+		BOOST_CHECK(callContractFunction("f(uint256)", 2) == encodeArgs());
+	)
 }

 BOOST_AUTO_TEST_CASE(conversion)
 {
-	char const* sourceCode = R"(
+	string sourceCode = R"(
 		contract C {
 			event E(bytes4, bytes4, uint16, uint8, int16, int8);
 			function f() {
@@ -118,17 +149,96 @@ BOOST_AUTO_TEST_CASE(conversion)
 			}
 		}
 	)";
+	BOTH_ENCODERS(
+		compileAndRun(sourceCode);
+		callContractFunction("f()");
+		REQUIRE_LOG_DATA(encodeArgs(
+			string(3, 0) + string("\x0a"), string("\xf1\xf2"),
+			0xff, 0xff, u256(-1), u256(1)
+		));
+	)
+}
+
+BOOST_AUTO_TEST_CASE(memory_array_one_dim)
+{
+	string sourceCode = R"(
+		contract C {
+			event E(uint a, int16[] b, uint c);
+			function f() {
+				int16[] memory x = new int16[](3);
+				assembly {
+					for { let i := 0 } lt(i, 3) { i := add(i, 1) } {
+						mstore(add(x, mul(add(i, 1), 0x20)), add(0xfffffffe, i))
+					}
+				}
+				E(10, x, 11);
+			}
+		}
+	)";
+
 	compileAndRun(sourceCode);
 	callContractFunction("f()");
-	REQUIRE_LOG_DATA(encodeArgs(
-		string(3, 0) + string("\x0a"), string("\xf1\xf2"),
-		0xff, 0xff, u256(-1), u256(1)
-	));
+	// The old encoder does not clean array elements.
+	REQUIRE_LOG_DATA(encodeArgs(10, 0x60, 11, 3, u256("0xfffffffe"), u256("0xffffffff"), u256("0x100000000")));
+
+	compileAndRun(NewEncoderPragma + sourceCode);
+	callContractFunction("f()");
+	REQUIRE_LOG_DATA(encodeArgs(10, 0x60, 11, 3, u256(-2), u256(-1), u256(0)));
+}
+
+BOOST_AUTO_TEST_CASE(memory_array_two_dim)
+{
+	string sourceCode = R"(
+		contract C {
+			event E(uint a, int16[][2] b, uint c);
+			function f() {
+				int16[][2] memory x;
+				x[0] = new int16[](3);
+				x[1] = new int16[](2);
+				x[0][0] = 7;
+				x[0][1] = int16(0x010203040506);
+				x[0][2] = -1;
+				x[1][0] = 4;
+				x[1][1] = 5;
+				E(10, x, 11);
+			}
+		}
+	)";
+	NEW_ENCODER(
+		compileAndRun(sourceCode);
+		callContractFunction("f()");
+		REQUIRE_LOG_DATA(encodeArgs(10, 0x60, 11, 0x40, 0xc0, 3, 7, 0x0506, u256(-1), 2, 4, 5));
+	)
+}
+
+BOOST_AUTO_TEST_CASE(memory_byte_array)
+{
+	string sourceCode = R"(
+		contract C {
+			event E(uint a, bytes[] b, uint c);
+			function f() {
+				bytes[] memory x = new bytes[](2);
+				x[0] = "abcabcdefghjklmnopqrsuvwabcdefgijklmnopqrstuwabcdefgijklmnoprstuvw";
+				x[1] = "abcdefghijklmnopqrtuvwabcfghijklmnopqstuvwabcdeghijklmopqrstuvw";
+				E(10, x, 11);
+			}
+		}
+	)";
+	NEW_ENCODER(
+		compileAndRun(sourceCode);
+		callContractFunction("f()");
+		REQUIRE_LOG_DATA(encodeArgs(
+			10, 0x60, 11,
+			2, 0x40, 0xc0,
+			66, string("abcabcdefghjklmnopqrsuvwabcdefgijklmnopqrstuwabcdefgijklmnoprstuvw"),
+			63, string("abcdefghijklmnopqrtuvwabcfghijklmnopqstuvwabcdeghijklmopqrstuvw")
+		));
+	)
 }

 BOOST_AUTO_TEST_CASE(storage_byte_array)
 {
-	char const* sourceCode = R"(
+	string sourceCode = R"(
 		contract C {
 			bytes short;
 			bytes long;
@@ -140,18 +250,20 @@ BOOST_AUTO_TEST_CASE(storage_byte_array)
 			}
 		}
 	)";
-	compileAndRun(sourceCode);
-	callContractFunction("f()");
-	REQUIRE_LOG_DATA(encodeArgs(
-		0x40, 0x80,
-		31, string("123456789012345678901234567890a"),
-		75, string("ffff123456789012345678901234567890afffffffff123456789012345678901234567890a")
-	));
+	BOTH_ENCODERS(
+		compileAndRun(sourceCode);
+		callContractFunction("f()");
+		REQUIRE_LOG_DATA(encodeArgs(
+			0x40, 0x80,
+			31, string("123456789012345678901234567890a"),
+			75, string("ffff123456789012345678901234567890afffffffff123456789012345678901234567890a")
+		));
+	)
 }

 BOOST_AUTO_TEST_CASE(storage_array)
 {
-	char const* sourceCode = R"(
+	string sourceCode = R"(
 		contract C {
 			address[3] addr;
 			event E(address[3] a);
@@ -165,14 +277,16 @@ BOOST_AUTO_TEST_CASE(storage_array)
 			}
 		}
 	)";
-	compileAndRun(sourceCode);
-	callContractFunction("f()");
-	REQUIRE_LOG_DATA(encodeArgs(u160(-1), u160(-2), u160(-3)));
+	BOTH_ENCODERS(
+		compileAndRun(sourceCode);
+		callContractFunction("f()");
+		REQUIRE_LOG_DATA(encodeArgs(u160(-1), u160(-2), u160(-3)));
+	)
 }

 BOOST_AUTO_TEST_CASE(storage_array_dyn)
 {
-	char const* sourceCode = R"(
+	string sourceCode = R"(
 		contract C {
 			address[] addr;
 			event E(address[] a);
@@ -184,14 +298,16 @@ BOOST_AUTO_TEST_CASE(storage_array_dyn)
 			}
 		}
 	)";
-	compileAndRun(sourceCode);
-	callContractFunction("f()");
-	REQUIRE_LOG_DATA(encodeArgs(0x20, 3, u160(1), u160(2), u160(3)));
+	BOTH_ENCODERS(
+		compileAndRun(sourceCode);
+		callContractFunction("f()");
+		REQUIRE_LOG_DATA(encodeArgs(0x20, 3, u160(1), u160(2), u160(3)));
+	)
 }

 BOOST_AUTO_TEST_CASE(storage_array_compact)
 {
-	char const* sourceCode = R"(
+	string sourceCode = R"(
 		contract C {
 			int72[] x;
 			event E(int72[]);
@@ -208,16 +324,18 @@ BOOST_AUTO_TEST_CASE(storage_array_compact)
 			}
 		}
 	)";
-	compileAndRun(sourceCode);
-	callContractFunction("f()");
-	REQUIRE_LOG_DATA(encodeArgs(
-		0x20, 8, u256(-1), 2, u256(-3), 4, u256(-5), 6, u256(-7), 8
-	));
+	BOTH_ENCODERS(
+		compileAndRun(sourceCode);
+		callContractFunction("f()");
+		REQUIRE_LOG_DATA(encodeArgs(
+			0x20, 8, u256(-1), 2, u256(-3), 4, u256(-5), 6, u256(-7), 8
+		));
+	)
 }

 BOOST_AUTO_TEST_CASE(external_function)
 {
-	char const* sourceCode = R"(
+	string sourceCode = R"(
 		contract C {
 			event E(function(uint) external returns (uint), function(uint) external returns (uint));
 			function(uint) external returns (uint) g;
@@ -227,15 +345,17 @@ BOOST_AUTO_TEST_CASE(external_function)
 			}
 		}
 	)";
-	compileAndRun(sourceCode);
-	callContractFunction("f(uint256)");
-	string functionIdF = asString(m_contractAddress.ref()) + asString(FixedHash<4>(dev::keccak256("f(uint256)")).ref());
-	REQUIRE_LOG_DATA(encodeArgs(functionIdF, functionIdF));
+	BOTH_ENCODERS(
+		compileAndRun(sourceCode);
+		callContractFunction("f(uint256)");
+		string functionIdF = asString(m_contractAddress.ref()) + asString(FixedHash<4>(dev::keccak256("f(uint256)")).ref());
+		REQUIRE_LOG_DATA(encodeArgs(functionIdF, functionIdF));
+	)
 }

 BOOST_AUTO_TEST_CASE(external_function_cleanup)
 {
-	char const* sourceCode = R"(
+	string sourceCode = R"(
 		contract C {
 			event E(function(uint) external returns (uint), function(uint) external returns (uint));
 			// This test relies on the fact that g is stored in slot zero.
@@ -247,9 +367,35 @@ BOOST_AUTO_TEST_CASE(external_function_cleanup)
 			}
 		}
 	)";
-	compileAndRun(sourceCode);
-	callContractFunction("f(uint256)");
-	REQUIRE_LOG_DATA(encodeArgs(string(24, char(-1)), string(24, char(-1))));
+	BOTH_ENCODERS(
+		compileAndRun(sourceCode);
+		callContractFunction("f(uint256)");
+		REQUIRE_LOG_DATA(encodeArgs(string(24, char(-1)), string(24, char(-1))));
+	)
+}
+
+BOOST_AUTO_TEST_CASE(calldata)
+{
+	string sourceCode = R"(
+		contract C {
+			event E(bytes);
+			function f(bytes a) external {
+				E(a);
+			}
+		}
+	)";
+	string s("abcdef");
+	string t("abcdefgggggggggggggggggggggggggggggggggggggggghhheeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeggg");
+	bool newEncoder = false;
+	BOTH_ENCODERS(
+		compileAndRun(sourceCode);
+		callContractFunction("f(bytes)", 0x20, s.size(), s);
+		// The old encoder did not pad to multiples of 32 bytes
+		REQUIRE_LOG_DATA(encodeArgs(0x20, s.size()) + (newEncoder ? encodeArgs(s) : asBytes(s)));
+		callContractFunction("f(bytes)", 0x20, t.size(), t);
+		REQUIRE_LOG_DATA(encodeArgs(0x20, t.size()) + (newEncoder ? encodeArgs(t) : asBytes(t)));
+		newEncoder = true;
+	)
 }

 BOOST_AUTO_TEST_SUITE_END()
@@ -3128,7 +3128,7 @@ BOOST_AUTO_TEST_CASE(event_really_lots_of_data)
 	callContractFunction("deposit()");
 	BOOST_REQUIRE_EQUAL(m_logs.size(), 1);
 	BOOST_CHECK_EQUAL(m_logs[0].address, m_contractAddress);
-	BOOST_CHECK(m_logs[0].data == encodeArgs(10, 0x60, 15, 4) + FixedHash<4>(dev::keccak256("deposit()")).asBytes());
+	BOOST_CHECK_EQUAL(toHex(m_logs[0].data), toHex(encodeArgs(10, 0x60, 15, 4) + FixedHash<4>(dev::keccak256("deposit()")).asBytes()));
 	BOOST_REQUIRE_EQUAL(m_logs[0].topics.size(), 1);
 	BOOST_CHECK_EQUAL(m_logs[0].topics[0], dev::keccak256(string("Deposit(uint256,bytes,uint256)")));
 }
@@ -3152,7 +3152,7 @@ BOOST_AUTO_TEST_CASE(event_really_lots_of_data_from_storage)
 	callContractFunction("deposit()");
 	BOOST_REQUIRE_EQUAL(m_logs.size(), 1);
 	BOOST_CHECK_EQUAL(m_logs[0].address, m_contractAddress);
-	BOOST_CHECK(m_logs[0].data == encodeArgs(10, 0x60, 15, 3, string("ABC")));
+	BOOST_CHECK_EQUAL(toHex(m_logs[0].data), toHex(encodeArgs(10, 0x60, 15, 3, string("ABC"))));
 	BOOST_REQUIRE_EQUAL(m_logs[0].topics.size(), 1);
 	BOOST_CHECK_EQUAL(m_logs[0].topics[0], dev::keccak256(string("Deposit(uint256,bytes,uint256)")));
 }
@@ -4432,10 +4432,12 @@ BOOST_AUTO_TEST_CASE(array_copy_storage_abi)
 	// NOTE: This does not really test copying from storage to ABI directly,
 	// because it will always copy to memory first.
 	char const* sourceCode = R"(
+		pragma experimental ABIEncoderV2;
 		contract c {
 			uint8[] x;
 			uint16[] y;
 			uint24[] z;
+			uint24[][] w;
 			function test1() returns (uint8[]) {
 				for (uint i = 0; i < 101; ++i)
 					x.push(uint8(i));
@@ -4451,6 +4453,13 @@ BOOST_AUTO_TEST_CASE(array_copy_storage_abi)
 					z.push(uint24(i));
 				return z;
 			}
+			function test4() returns (uint24[][]) {
+				w.length = 5;
+				for (uint i = 0; i < 5; ++i)
+					for (uint j = 0; j < 101; ++j)
+						w[i].push(uint24(j));
+				return w;
+			}
 		}
 	)";
 	compileAndRun(sourceCode);
@@ -4460,6 +4469,14 @@ BOOST_AUTO_TEST_CASE(array_copy_storage_abi)
 	BOOST_CHECK(callContractFunction("test1()") == encodeArgs(0x20, 101) + valueSequence);
 	BOOST_CHECK(callContractFunction("test2()") == encodeArgs(0x20, 101) + valueSequence);
 	BOOST_CHECK(callContractFunction("test3()") == encodeArgs(0x20, 101) + valueSequence);
+	BOOST_CHECK(callContractFunction("test4()") ==
+		encodeArgs(0x20, 5, 0xa0, 0xa0 + 102 * 32 * 1, 0xa0 + 102 * 32 * 2, 0xa0 + 102 * 32 * 3, 0xa0 + 102 * 32 * 4) +
+		encodeArgs(101) + valueSequence +
+		encodeArgs(101) + valueSequence +
+		encodeArgs(101) + valueSequence +
+		encodeArgs(101) + valueSequence +
+		encodeArgs(101) + valueSequence
+	);
 }

 BOOST_AUTO_TEST_CASE(array_copy_storage_abi_signed)