github.com/ontio/ontology@v1.14.4/vm/evm/contracts_test.go (about) 1 // Copyright (C) 2021 The Ontology Authors 2 // Copyright 2017 The go-ethereum Authors 3 // This file is part of the go-ethereum library. 4 // 5 // The go-ethereum library is free software: you can redistribute it and/or modify 6 // it under the terms of the GNU Lesser General Public License as published by 7 // the Free Software Foundation, either version 3 of the License, or 8 // (at your option) any later version. 9 // 10 // The go-ethereum library is distributed in the hope that it will be useful, 11 // but WITHOUT ANY WARRANTY; without even the implied warranty of 12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 // GNU Lesser General Public License for more details. 14 // 15 // You should have received a copy of the GNU Lesser General Public License 16 // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>. 17 18 package evm 19 20 import ( 21 "bytes" 22 "encoding/json" 23 "fmt" 24 "io/ioutil" 25 "testing" 26 "time" 27 28 "github.com/ethereum/go-ethereum/common" 29 ) 30 31 // precompiledTest defines the input/output pairs for precompiled contract tests. 32 type precompiledTest struct { 33 Input, Expected string 34 Gas uint64 35 Name string 36 NoBenchmark bool // Benchmark primarily the worst-cases 37 } 38 39 // precompiledFailureTest defines the input/error pairs for precompiled 40 // contract failure tests. 41 type precompiledFailureTest struct { 42 Input string 43 ExpectedError string 44 Name string 45 } 46 47 // allPrecompiles does not map to the actual set of precompiles, as it also contains 48 // repriced versions of precompiles at certain slots 49 var allPrecompiles = map[common.Address]PrecompiledContract{ 50 common.BytesToAddress([]byte{1}): &ecrecover{}, 51 common.BytesToAddress([]byte{2}): &sha256hash{}, 52 common.BytesToAddress([]byte{3}): &ripemd160hash{}, 53 common.BytesToAddress([]byte{4}): &dataCopy{}, 54 common.BytesToAddress([]byte{5}): &bigModExp{eip2565: false}, 55 common.BytesToAddress([]byte{0xf5}): &bigModExp{eip2565: true}, 56 common.BytesToAddress([]byte{6}): &bn256AddIstanbul{}, 57 common.BytesToAddress([]byte{7}): &bn256ScalarMulIstanbul{}, 58 common.BytesToAddress([]byte{8}): &bn256PairingIstanbul{}, 59 common.BytesToAddress([]byte{9}): &blake2F{}, 60 common.BytesToAddress([]byte{10}): &bls12381G1Add{}, 61 common.BytesToAddress([]byte{11}): &bls12381G1Mul{}, 62 common.BytesToAddress([]byte{12}): &bls12381G1MultiExp{}, 63 common.BytesToAddress([]byte{13}): &bls12381G2Add{}, 64 common.BytesToAddress([]byte{14}): &bls12381G2Mul{}, 65 common.BytesToAddress([]byte{15}): &bls12381G2MultiExp{}, 66 common.BytesToAddress([]byte{16}): &bls12381Pairing{}, 67 common.BytesToAddress([]byte{17}): &bls12381MapG1{}, 68 common.BytesToAddress([]byte{18}): &bls12381MapG2{}, 69 } 70 71 // EIP-152 test vectors 72 var blake2FMalformedInputTests = []precompiledFailureTest{ 73 { 74 Input: "", 75 ExpectedError: errBlake2FInvalidInputLength.Error(), 76 Name: "vector 0: empty input", 77 }, 78 { 79 Input: "00000c48c9bdf267e6096a3ba7ca8485ae67bb2bf894fe72f36e3cf1361d5f3af54fa5d182e6ad7f520e511f6c3e2b8c68059b6bbd41fbabd9831f79217e1319cde05b61626300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000300000000000000000000000000000001", 80 ExpectedError: errBlake2FInvalidInputLength.Error(), 81 Name: "vector 1: less than 213 bytes input", 82 }, 83 { 84 Input: "000000000c48c9bdf267e6096a3ba7ca8485ae67bb2bf894fe72f36e3cf1361d5f3af54fa5d182e6ad7f520e511f6c3e2b8c68059b6bbd41fbabd9831f79217e1319cde05b61626300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000300000000000000000000000000000001", 85 ExpectedError: errBlake2FInvalidInputLength.Error(), 86 Name: "vector 2: more than 213 bytes input", 87 }, 88 { 89 Input: "0000000c48c9bdf267e6096a3ba7ca8485ae67bb2bf894fe72f36e3cf1361d5f3af54fa5d182e6ad7f520e511f6c3e2b8c68059b6bbd41fbabd9831f79217e1319cde05b61626300000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000300000000000000000000000000000002", 90 ExpectedError: errBlake2FInvalidFinalFlag.Error(), 91 Name: "vector 3: malformed final block indicator flag", 92 }, 93 } 94 95 func testPrecompiled(addr string, test precompiledTest, t *testing.T) { 96 p := allPrecompiles[common.HexToAddress(addr)] 97 in := common.Hex2Bytes(test.Input) 98 gas := p.RequiredGas(in) 99 t.Run(fmt.Sprintf("%s-Gas=%d", test.Name, gas), func(t *testing.T) { 100 if res, _, err := RunPrecompiledContract(p, in, gas); err != nil { 101 t.Error(err) 102 } else if common.Bytes2Hex(res) != test.Expected { 103 t.Errorf("Expected %v, got %v", test.Expected, common.Bytes2Hex(res)) 104 } 105 if expGas := test.Gas; expGas != gas { 106 t.Errorf("%v: gas wrong, expected %d, got %d", test.Name, expGas, gas) 107 } 108 // Verify that the precompile did not touch the input buffer 109 exp := common.Hex2Bytes(test.Input) 110 if !bytes.Equal(in, exp) { 111 t.Errorf("Precompiled %v modified input data", addr) 112 } 113 }) 114 } 115 116 func testPrecompiledOOG(addr string, test precompiledTest, t *testing.T) { 117 p := allPrecompiles[common.HexToAddress(addr)] 118 in := common.Hex2Bytes(test.Input) 119 gas := p.RequiredGas(in) - 1 120 121 t.Run(fmt.Sprintf("%s-Gas=%d", test.Name, gas), func(t *testing.T) { 122 _, _, err := RunPrecompiledContract(p, in, gas) 123 if err.Error() != "out of gas" { 124 t.Errorf("Expected error [out of gas], got [%v]", err) 125 } 126 // Verify that the precompile did not touch the input buffer 127 exp := common.Hex2Bytes(test.Input) 128 if !bytes.Equal(in, exp) { 129 t.Errorf("Precompiled %v modified input data", addr) 130 } 131 }) 132 } 133 134 func testPrecompiledFailure(addr string, test precompiledFailureTest, t *testing.T) { 135 p := allPrecompiles[common.HexToAddress(addr)] 136 in := common.Hex2Bytes(test.Input) 137 gas := p.RequiredGas(in) 138 t.Run(test.Name, func(t *testing.T) { 139 _, _, err := RunPrecompiledContract(p, in, gas) 140 if err.Error() != test.ExpectedError { 141 t.Errorf("Expected error [%v], got [%v]", test.ExpectedError, err) 142 } 143 // Verify that the precompile did not touch the input buffer 144 exp := common.Hex2Bytes(test.Input) 145 if !bytes.Equal(in, exp) { 146 t.Errorf("Precompiled %v modified input data", addr) 147 } 148 }) 149 } 150 151 func benchmarkPrecompiled(addr string, test precompiledTest, bench *testing.B) { 152 if test.NoBenchmark { 153 return 154 } 155 p := allPrecompiles[common.HexToAddress(addr)] 156 in := common.Hex2Bytes(test.Input) 157 reqGas := p.RequiredGas(in) 158 159 var ( 160 res []byte 161 err error 162 data = make([]byte, len(in)) 163 ) 164 165 bench.Run(fmt.Sprintf("%s-Gas=%d", test.Name, reqGas), func(bench *testing.B) { 166 bench.ReportAllocs() 167 start := time.Now() 168 bench.ResetTimer() 169 for i := 0; i < bench.N; i++ { 170 copy(data, in) 171 res, _, err = RunPrecompiledContract(p, data, reqGas) 172 } 173 bench.StopTimer() 174 elapsed := uint64(time.Since(start)) 175 if elapsed < 1 { 176 elapsed = 1 177 } 178 gasUsed := reqGas * uint64(bench.N) 179 bench.ReportMetric(float64(reqGas), "gas/op") 180 // Keep it as uint64, multiply 100 to get two digit float later 181 mgasps := (100 * 1000 * gasUsed) / elapsed 182 bench.ReportMetric(float64(mgasps)/100, "mgas/s") 183 //Check if it is correct 184 if err != nil { 185 bench.Error(err) 186 return 187 } 188 if common.Bytes2Hex(res) != test.Expected { 189 bench.Error(fmt.Sprintf("Expected %v, got %v", test.Expected, common.Bytes2Hex(res))) 190 return 191 } 192 }) 193 } 194 195 // Benchmarks the sample inputs from the ECRECOVER precompile. 196 func BenchmarkPrecompiledEcrecover(bench *testing.B) { 197 t := precompiledTest{ 198 Input: "38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e000000000000000000000000000000000000000000000000000000000000001b38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e789d1dd423d25f0772d2748d60f7e4b81bb14d086eba8e8e8efb6dcff8a4ae02", 199 Expected: "000000000000000000000000ceaccac640adf55b2028469bd36ba501f28b699d", 200 Name: "", 201 } 202 benchmarkPrecompiled("01", t, bench) 203 } 204 205 // Benchmarks the sample inputs from the SHA256 precompile. 206 func BenchmarkPrecompiledSha256(bench *testing.B) { 207 t := precompiledTest{ 208 Input: "38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e000000000000000000000000000000000000000000000000000000000000001b38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e789d1dd423d25f0772d2748d60f7e4b81bb14d086eba8e8e8efb6dcff8a4ae02", 209 Expected: "811c7003375852fabd0d362e40e68607a12bdabae61a7d068fe5fdd1dbbf2a5d", 210 Name: "128", 211 } 212 benchmarkPrecompiled("02", t, bench) 213 } 214 215 // Benchmarks the sample inputs from the RIPEMD precompile. 216 func BenchmarkPrecompiledRipeMD(bench *testing.B) { 217 t := precompiledTest{ 218 Input: "38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e000000000000000000000000000000000000000000000000000000000000001b38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e789d1dd423d25f0772d2748d60f7e4b81bb14d086eba8e8e8efb6dcff8a4ae02", 219 Expected: "0000000000000000000000009215b8d9882ff46f0dfde6684d78e831467f65e6", 220 Name: "128", 221 } 222 benchmarkPrecompiled("03", t, bench) 223 } 224 225 // Benchmarks the sample inputs from the identiy precompile. 226 func BenchmarkPrecompiledIdentity(bench *testing.B) { 227 t := precompiledTest{ 228 Input: "38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e000000000000000000000000000000000000000000000000000000000000001b38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e789d1dd423d25f0772d2748d60f7e4b81bb14d086eba8e8e8efb6dcff8a4ae02", 229 Expected: "38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e000000000000000000000000000000000000000000000000000000000000001b38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e789d1dd423d25f0772d2748d60f7e4b81bb14d086eba8e8e8efb6dcff8a4ae02", 230 Name: "128", 231 } 232 benchmarkPrecompiled("04", t, bench) 233 } 234 235 // Tests the sample inputs from the ModExp EIP 198. 236 func TestPrecompiledModExp(t *testing.T) { testJson("modexp", "05", t) } 237 func BenchmarkPrecompiledModExp(b *testing.B) { benchJson("modexp", "05", b) } 238 239 func TestPrecompiledModExpEip2565(t *testing.T) { testJson("modexp_eip2565", "f5", t) } 240 func BenchmarkPrecompiledModExpEip2565(b *testing.B) { benchJson("modexp_eip2565", "f5", b) } 241 242 // Tests the sample inputs from the elliptic curve addition EIP 213. 243 func TestPrecompiledBn256Add(t *testing.T) { testJson("bn256Add", "06", t) } 244 func BenchmarkPrecompiledBn256Add(b *testing.B) { benchJson("bn256Add", "06", b) } 245 246 // Tests OOG 247 func TestPrecompiledModExpOOG(t *testing.T) { 248 modexpTests, err := loadJson("modexp") 249 if err != nil { 250 t.Fatal(err) 251 } 252 for _, test := range modexpTests { 253 testPrecompiledOOG("05", test, t) 254 } 255 } 256 257 // Tests the sample inputs from the elliptic curve scalar multiplication EIP 213. 258 func TestPrecompiledBn256ScalarMul(t *testing.T) { testJson("bn256ScalarMul", "07", t) } 259 func BenchmarkPrecompiledBn256ScalarMul(b *testing.B) { benchJson("bn256ScalarMul", "07", b) } 260 261 // Tests the sample inputs from the elliptic curve pairing check EIP 197. 262 func TestPrecompiledBn256Pairing(t *testing.T) { testJson("bn256Pairing", "08", t) } 263 func BenchmarkPrecompiledBn256Pairing(b *testing.B) { benchJson("bn256Pairing", "08", b) } 264 265 func TestPrecompiledBlake2F(t *testing.T) { testJson("blake2F", "09", t) } 266 func BenchmarkPrecompiledBlake2F(b *testing.B) { benchJson("blake2F", "09", b) } 267 268 func TestPrecompileBlake2FMalformedInput(t *testing.T) { 269 for _, test := range blake2FMalformedInputTests { 270 testPrecompiledFailure("09", test, t) 271 } 272 } 273 274 func TestPrecompiledEcrecover(t *testing.T) { testJson("ecRecover", "01", t) } 275 276 func testJson(name, addr string, t *testing.T) { 277 tests, err := loadJson(name) 278 if err != nil { 279 t.Fatal(err) 280 } 281 for _, test := range tests { 282 testPrecompiled(addr, test, t) 283 } 284 } 285 286 func testJsonFail(name, addr string, t *testing.T) { 287 tests, err := loadJsonFail(name) 288 if err != nil { 289 t.Fatal(err) 290 } 291 for _, test := range tests { 292 testPrecompiledFailure(addr, test, t) 293 } 294 } 295 296 func benchJson(name, addr string, b *testing.B) { 297 tests, err := loadJson(name) 298 if err != nil { 299 b.Fatal(err) 300 } 301 for _, test := range tests { 302 benchmarkPrecompiled(addr, test, b) 303 } 304 } 305 306 func TestPrecompiledBLS12381G1Add(t *testing.T) { testJson("blsG1Add", "0a", t) } 307 func TestPrecompiledBLS12381G1Mul(t *testing.T) { testJson("blsG1Mul", "0b", t) } 308 func TestPrecompiledBLS12381G1MultiExp(t *testing.T) { testJson("blsG1MultiExp", "0c", t) } 309 func TestPrecompiledBLS12381G2Add(t *testing.T) { testJson("blsG2Add", "0d", t) } 310 func TestPrecompiledBLS12381G2Mul(t *testing.T) { testJson("blsG2Mul", "0e", t) } 311 func TestPrecompiledBLS12381G2MultiExp(t *testing.T) { testJson("blsG2MultiExp", "0f", t) } 312 func TestPrecompiledBLS12381Pairing(t *testing.T) { testJson("blsPairing", "10", t) } 313 func TestPrecompiledBLS12381MapG1(t *testing.T) { testJson("blsMapG1", "11", t) } 314 func TestPrecompiledBLS12381MapG2(t *testing.T) { testJson("blsMapG2", "12", t) } 315 316 func BenchmarkPrecompiledBLS12381G1Add(b *testing.B) { benchJson("blsG1Add", "0a", b) } 317 func BenchmarkPrecompiledBLS12381G1Mul(b *testing.B) { benchJson("blsG1Mul", "0b", b) } 318 func BenchmarkPrecompiledBLS12381G1MultiExp(b *testing.B) { benchJson("blsG1MultiExp", "0c", b) } 319 func BenchmarkPrecompiledBLS12381G2Add(b *testing.B) { benchJson("blsG2Add", "0d", b) } 320 func BenchmarkPrecompiledBLS12381G2Mul(b *testing.B) { benchJson("blsG2Mul", "0e", b) } 321 func BenchmarkPrecompiledBLS12381G2MultiExp(b *testing.B) { benchJson("blsG2MultiExp", "0f", b) } 322 func BenchmarkPrecompiledBLS12381Pairing(b *testing.B) { benchJson("blsPairing", "10", b) } 323 func BenchmarkPrecompiledBLS12381MapG1(b *testing.B) { benchJson("blsMapG1", "11", b) } 324 func BenchmarkPrecompiledBLS12381MapG2(b *testing.B) { benchJson("blsMapG2", "12", b) } 325 326 // Failure tests 327 func TestPrecompiledBLS12381G1AddFail(t *testing.T) { testJsonFail("blsG1Add", "0a", t) } 328 func TestPrecompiledBLS12381G1MulFail(t *testing.T) { testJsonFail("blsG1Mul", "0b", t) } 329 func TestPrecompiledBLS12381G1MultiExpFail(t *testing.T) { testJsonFail("blsG1MultiExp", "0c", t) } 330 func TestPrecompiledBLS12381G2AddFail(t *testing.T) { testJsonFail("blsG2Add", "0d", t) } 331 func TestPrecompiledBLS12381G2MulFail(t *testing.T) { testJsonFail("blsG2Mul", "0e", t) } 332 func TestPrecompiledBLS12381G2MultiExpFail(t *testing.T) { testJsonFail("blsG2MultiExp", "0f", t) } 333 func TestPrecompiledBLS12381PairingFail(t *testing.T) { testJsonFail("blsPairing", "10", t) } 334 func TestPrecompiledBLS12381MapG1Fail(t *testing.T) { testJsonFail("blsMapG1", "11", t) } 335 func TestPrecompiledBLS12381MapG2Fail(t *testing.T) { testJsonFail("blsMapG2", "12", t) } 336 337 func loadJson(name string) ([]precompiledTest, error) { 338 data, err := ioutil.ReadFile(fmt.Sprintf("testdata/precompiles/%v.json", name)) 339 if err != nil { 340 return nil, err 341 } 342 var testcases []precompiledTest 343 err = json.Unmarshal(data, &testcases) 344 return testcases, err 345 } 346 347 func loadJsonFail(name string) ([]precompiledFailureTest, error) { 348 data, err := ioutil.ReadFile(fmt.Sprintf("testdata/precompiles/fail-%v.json", name)) 349 if err != nil { 350 return nil, err 351 } 352 var testcases []precompiledFailureTest 353 err = json.Unmarshal(data, &testcases) 354 return testcases, err 355 } 356 357 // BenchmarkPrecompiledBLS12381G1MultiExpWorstCase benchmarks the worst case we could find that still fits a gaslimit of 10MGas. 358 func BenchmarkPrecompiledBLS12381G1MultiExpWorstCase(b *testing.B) { 359 task := "0000000000000000000000000000000008d8c4a16fb9d8800cce987c0eadbb6b3b005c213d44ecb5adeed713bae79d606041406df26169c35df63cf972c94be1" + 360 "0000000000000000000000000000000011bc8afe71676e6730702a46ef817060249cd06cd82e6981085012ff6d013aa4470ba3a2c71e13ef653e1e223d1ccfe9" + 361 "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF" 362 input := task 363 for i := 0; i < 4787; i++ { 364 input = input + task 365 } 366 testcase := precompiledTest{ 367 Input: input, 368 Expected: "0000000000000000000000000000000005a6310ea6f2a598023ae48819afc292b4dfcb40aabad24a0c2cb6c19769465691859eeb2a764342a810c5038d700f18000000000000000000000000000000001268ac944437d15923dc0aec00daa9250252e43e4b35ec7a19d01f0d6cd27f6e139d80dae16ba1c79cc7f57055a93ff5", 369 Name: "WorstCaseG1", 370 NoBenchmark: false, 371 } 372 benchmarkPrecompiled("0c", testcase, b) 373 } 374 375 // BenchmarkPrecompiledBLS12381G2MultiExpWorstCase benchmarks the worst case we could find that still fits a gaslimit of 10MGas. 376 func BenchmarkPrecompiledBLS12381G2MultiExpWorstCase(b *testing.B) { 377 task := "000000000000000000000000000000000d4f09acd5f362e0a516d4c13c5e2f504d9bd49fdfb6d8b7a7ab35a02c391c8112b03270d5d9eefe9b659dd27601d18f" + 378 "000000000000000000000000000000000fd489cb75945f3b5ebb1c0e326d59602934c8f78fe9294a8877e7aeb95de5addde0cb7ab53674df8b2cfbb036b30b99" + 379 "00000000000000000000000000000000055dbc4eca768714e098bbe9c71cf54b40f51c26e95808ee79225a87fb6fa1415178db47f02d856fea56a752d185f86b" + 380 "000000000000000000000000000000001239b7640f416eb6e921fe47f7501d504fadc190d9cf4e89ae2b717276739a2f4ee9f637c35e23c480df029fd8d247c7" + 381 "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF" 382 input := task 383 for i := 0; i < 1040; i++ { 384 input = input + task 385 } 386 387 testcase := precompiledTest{ 388 Input: input, 389 Expected: "0000000000000000000000000000000018f5ea0c8b086095cfe23f6bb1d90d45de929292006dba8cdedd6d3203af3c6bbfd592e93ecb2b2c81004961fdcbb46c00000000000000000000000000000000076873199175664f1b6493a43c02234f49dc66f077d3007823e0343ad92e30bd7dc209013435ca9f197aca44d88e9dac000000000000000000000000000000000e6f07f4b23b511eac1e2682a0fc224c15d80e122a3e222d00a41fab15eba645a700b9ae84f331ae4ed873678e2e6c9b000000000000000000000000000000000bcb4849e460612aaed79617255fd30c03f51cf03d2ed4163ca810c13e1954b1e8663157b957a601829bb272a4e6c7b8", 390 Name: "WorstCaseG2", 391 NoBenchmark: false, 392 } 393 benchmarkPrecompiled("0f", testcase, b) 394 }