Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 13747x 13747x 13747x 13747x 13747x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 12809x 12809x 12809x 12809x 12809x 12809x 12809x 12809x 12809x 12809x 12809x 12809x 12809x 12809x 12809x 12809x 10113x 31879x 31879x 31879x 31879x 31879x 10113x 10113x 12809x 12809x 12809x 28x 28x 28x 28x 12809x 12809x 12809x 9785x 9785x 9785x 12809x 12809x 12809x 12809x 12809x 12809x 3872x 3872x 3872x 3872x 3872x 3872x 3872x 10113x 10113x 10113x 10113x 3872x 3872x 3872x 3872x 3872x 12809x 12809x 12809x 68897x 68897x 68897x 12809x 12809x 12809x 939x 939x 939x 12809x 12809x 12809x 55819x 30854x 55819x 55819x 12809x 12809x 12809x 14245x 14245x 14245x 14245x 12809x 12809x 28x 28x 92x 92x 92x 28x 28x 12809x 1x 1x 1x 2696x 2696x 2696x 2696x 2696x 2696x 2696x 2696x 2696x 2696x 2696x 32628x 32628x 32628x 32628x 32628x 32628x 32628x 32628x 32628x 32628x 32628x 32628x 32628x 32628x 18889x 18889x 18889x 18889x 18889x 3872x 3872x 3872x 18889x 3872x 3872x 3872x 3872x 3872x 3872x 3872x 3872x 3872x 15017x 6337x 6337x 6337x 6337x 11145x 2404x 2404x 2404x 2404x 2404x 2404x 1898x 1898x 1898x 1898x 2404x 2404x 2404x 18889x 18889x 18889x 13739x 13739x 32628x 11841x 11841x 11841x 11841x 1931x 1931x 1931x 9910x 11841x 9325x 9325x 9325x 585x 585x 585x 585x 1898x 1898x 1898x 1898x 1898x 1898x 1898x 1898x 2696x 2696x 2696x 1x 1x 882x 882x 882x 882x 882x 1x 1x 1x 1x 460x 460x 425x 425x 425x 460x 460x 460x 1x 1x 25566x 25566x 25566x 27044x 27044x 27044x 1478x 1478x 27044x 1478x 1478x 25566x 25566x 25566x 1x 1x 441x 441x 441x 441x 441x 441x 441x 441x 441x 441x 441x 441x 53x 53x 441x 53x 53x 53x 1x 1x 942x 942x 942x 1x 1x 491x 491x 491x 491x 1x 554x 554x 554x 1x 1x 1x 9395x 9395x 9395x 9395x 9395x 9242x 9395x 2013x 2013x 2013x 2013x 9395x 2032x 2032x 2032x 2032x 9242x 9242x 9242x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 2404x 14729x 14729x 14729x 2930x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 22399x 22399x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 22397x 22397x 22397x 22397x 22399x 3078x 3078x 22399x 19319x 3000x 3000x 3000x 19319x 16319x 16319x 19319x 22397x 22399x 22397x 22397x 22397x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 36920x 36920x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 31438x 31438x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 260x 260x 260x 260x 260x 260x 260x 6x 260x 254x 254x 260x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 260x 260x 260x 260x 260x 260x 260x 260x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 14729x 15024x 14467x 15024x 2142x 2142x 2142x 2142x 15024x 12255x 12255x 12255x 12255x 2930x 2930x 2930x 2930x 12255x 9325x 9325x 9325x 9325x 12255x 12255x 12255x 12255x 12255x 12255x 2404x 2404x 2404x 2404x 2404x 2404x 2404x 12255x 12255x 12255x 12255x 15x 15x 15x 12255x 12255x 12255x 12255x 12255x 12255x 12255x 70x 70x 15024x 15024x 15024x 15024x 15024x 11x 11x 11x 70x 70x 70x 70x 15024x 70x 15024x 70x 70x 70x 15024x 15024x 14729x 14729x 14729x 14729x 14729x 15024x 15024x 14729x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 939x 451x 451x 451x 451x 451x 451x 451x 451x 451x 488x 939x 451x 451x 451x 451x 451x 451x 451x 451x 451x 28x 451x 451x 451x 451x 939x 37x 37x 37x 37x 37x 37x 37x 37x 37x 37x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 591x 1x 1x 1x 1x 1x 1x 496x 496x 496x 496x 496x 496x 496x 496x 496x 496x 496x 496x 496x 496x 496x 496x 1x 877x 877x 877x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5x 5x 5x 5x 5x 5x 5x 5x 1x 1x 1x 1x 1x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 1x 1x 1x 1x 1x 1x 5x 5x 1x 1x 1x 1x 1x 1x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 107x 107x 33x 33x 33x 33x 33x 146x 146x 146x 146x 146x 146x 146x 146x 146x 33x 33x 33x 33x 33x 33x 33x 33x 33x 33x 39x 39x 39x 6x 6x 6x 6x 39x 30x 30x 30x 30x 30x 30x 30x 3x 3x 39x 39x 33x 33x 33x 33x 33x 33x 39x 39x 33x 1x 1x 1x 1x 1x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 67x 131x 131x 131x 64x 64x 64x 64x 131x 66x 66x 66x 66x 66x 66x 66x 66x 1x 1x 131x 131x 131x 67x 67x 67x 67x 67x 67x 131x 131x 67x 1x 1x 1x 1x 1x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 28x 12x 12x 12x 12x 12x 12x 16x 16x 16x 16x 28x 28x 16x 16x 16x 16x 28x 28x 28x 16x 16x 16x 16x 16x 28x 28x 28x 28x 28x 28x 28x 28x 28x 1x 1x 1x 1x 1x 1x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 267x 267x 458x 458x 458x 458x 458x 727x 727x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 726x 726x 726x 727x 726x 726x 726x 727x 726x 726x 458x 458x 458x 458x 458x 458x 458x 458x 458x 458x 491x 491x 491x 33x 33x 33x 33x 491x 425x 425x 425x 425x 425x 425x 388x 388x 425x 425x 425x 425x 425x 425x 425x 33x 33x 33x 33x 491x 7x 7x 7x 4x 4x 3x 3x 1x 1x 3x 7x 1x 1x 7x 33x 33x 33x 33x 33x 491x 491x 491x 491x 458x 458x 458x 458x 458x 458x 491x 491x 458x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* A fragment is a single item from an ABI, which may represent any of:
*
* - [Functions](FunctionFragment)
* - [Events](EventFragment)
* - [Constructors](ConstructorFragment)
* - Custom [Errors](ErrorFragment)
* - [Fallback or Receive](FallbackFragment) functions
*
* @_subsection api/abi/abi-coder:Fragments [about-fragments]
*/
import {
defineProperties, getBigInt, getNumber,
assert, assertPrivate, assertArgument
} from "../utils/index.js";
import { id } from "../hash/index.js";
/**
* A Type description in a [JSON ABI format](link-solc-jsonabi).
*/
export interface JsonFragmentType {
/**
* The parameter name.
*/
readonly name?: string;
/**
* If the parameter is indexed.
*/
readonly indexed?: boolean;
/**
* The type of the parameter.
*/
readonly type?: string;
/**
* The internal Solidity type.
*/
readonly internalType?: string;
/**
* The components for a tuple.
*/
readonly components?: ReadonlyArray<JsonFragmentType>;
}
/**
* A fragment for a method, event or error in a [JSON ABI format](link-solc-jsonabi).
*/
export interface JsonFragment {
/**
* The name of the error, event, function, etc.
*/
readonly name?: string;
/**
* The type of the fragment (e.g. ``event``, ``"function"``, etc.)
*/
readonly type?: string;
/**
* If the event is anonymous.
*/
readonly anonymous?: boolean;
/**
* If the function is payable.
*/
readonly payable?: boolean;
/**
* If the function is constant.
*/
readonly constant?: boolean;
/**
* The mutability state of the function.
*/
readonly stateMutability?: string;
/**
* The input parameters.
*/
readonly inputs?: ReadonlyArray<JsonFragmentType>;
/**
* The output parameters.
*/
readonly outputs?: ReadonlyArray<JsonFragmentType>;
/**
* The gas limit to use when sending a transaction for this function.
*/
readonly gas?: string;
};
/**
* The format to serialize the output as.
*
* **``"sighash"``** - the bare formatting, used to compute the selector
* or topic hash; this format cannot be reversed (as it discards ``indexed``)
* so cannot by used to export an [[Interface]].
*
* **``"minimal"``** - Human-Readable ABI with minimal spacing and without
* names, so it is compact, but will result in Result objects that cannot
* be accessed by name.
*
* **``"full"``** - Full Human-Readable ABI, with readable spacing and names
* intact; this is generally the recommended format.
*
* **``"json"``** - The [JSON ABI format](link-solc-jsonabi).
*/
export type FormatType = "sighash" | "minimal" | "full" | "json";
// [ "a", "b" ] => { "a": 1, "b": 1 }
function setify(items: Array<string>): ReadonlySet<string> {
const result: Set<string> = new Set();
items.forEach((k) => result.add(k));
return Object.freeze(result);
}
const _kwVisibDeploy = "external public payable override";
const KwVisibDeploy = setify(_kwVisibDeploy.split(" "));
// Visibility Keywords
const _kwVisib = "constant external internal payable private public pure view override";
const KwVisib = setify(_kwVisib.split(" "));
const _kwTypes = "constructor error event fallback function receive struct";
const KwTypes = setify(_kwTypes.split(" "));
const _kwModifiers = "calldata memory storage payable indexed";
const KwModifiers = setify(_kwModifiers.split(" "));
const _kwOther = "tuple returns";
// All Keywords
const _keywords = [ _kwTypes, _kwModifiers, _kwOther, _kwVisib ].join(" ");
const Keywords = setify(_keywords.split(" "));
// Single character tokens
const SimpleTokens: Record<string, string> = {
"(": "OPEN_PAREN", ")": "CLOSE_PAREN",
"[": "OPEN_BRACKET", "]": "CLOSE_BRACKET",
",": "COMMA", "@": "AT"
};
// Parser regexes to consume the next token
const regexWhitespacePrefix = new RegExp("^(\\s*)");
const regexNumberPrefix = new RegExp("^([0-9]+)");
const regexIdPrefix = new RegExp("^([a-zA-Z$_][a-zA-Z0-9$_]*)");
// Parser regexs to check validity
const regexId = new RegExp("^([a-zA-Z$_][a-zA-Z0-9$_]*)$");
const regexType = new RegExp("^(address|bool|bytes([0-9]*)|string|u?int([0-9]*))$");
/**
* @ignore:
*/
type Token = Readonly<{
// Type of token (e.g. TYPE, KEYWORD, NUMBER, etc)
type: string;
// Offset into the original source code
offset: number;
// Actual text content of the token
text: string;
// The parenthesis depth
depth: number;
// If a parenthesis, the offset (in tokens) that balances it
match: number;
// For parenthesis and commas, the offset (in tokens) to the
// previous/next parenthesis or comma in the list
linkBack: number;
linkNext: number;
// If a BRACKET, the value inside
value: number;
}>;
class TokenString {
#offset: number;
#tokens: ReadonlyArray<Token>;
get offset(): number { return this.#offset; }
get length(): number { return this.#tokens.length - this.#offset; }
constructor(tokens: ReadonlyArray<Token>) {
this.#offset = 0;
this.#tokens = tokens.slice();
}
clone(): TokenString { return new TokenString(this.#tokens); }
reset(): void { this.#offset = 0; }
#subTokenString(from: number = 0, to: number = 0): TokenString {
return new TokenString(this.#tokens.slice(from, to).map((t) => {
return Object.freeze(Object.assign({ }, t, {
match: (t.match - from),
linkBack: (t.linkBack - from),
linkNext: (t.linkNext - from),
}));
}));
}
// Pops and returns the value of the next token, if it is a keyword in allowed; throws if out of tokens
popKeyword(allowed: ReadonlySet<string>): string {
const top = this.peek();
if (top.type !== "KEYWORD" || !allowed.has(top.text)) { throw new Error(`expected keyword ${ top.text }`); }
return this.pop().text;
}
// Pops and returns the value of the next token if it is `type`; throws if out of tokens
popType(type: string): string {
if (this.peek().type !== type) {
const top = this.peek();
throw new Error(`expected ${ type }; got ${ top.type } ${ JSON.stringify(top.text) }`);
}
return this.pop().text;
}
// Pops and returns a "(" TOKENS ")"
popParen(): TokenString {
const top = this.peek();
if (top.type !== "OPEN_PAREN") { throw new Error("bad start"); }
const result = this.#subTokenString(this.#offset + 1, top.match + 1);
this.#offset = top.match + 1;
return result;
}
// Pops and returns the items within "(" ITEM1 "," ITEM2 "," ... ")"
popParams(): Array<TokenString> {
const top = this.peek();
if (top.type !== "OPEN_PAREN") { throw new Error("bad start"); }
const result: Array<TokenString> = [ ];
while(this.#offset < top.match - 1) {
const link = this.peek().linkNext;
result.push(this.#subTokenString(this.#offset + 1, link));
this.#offset = link;
}
this.#offset = top.match + 1;
return result;
}
// Returns the top Token, throwing if out of tokens
peek(): Token {
if (this.#offset >= this.#tokens.length) {
throw new Error("out-of-bounds");
}
return this.#tokens[this.#offset];
}
// Returns the next value, if it is a keyword in `allowed`
peekKeyword(allowed: ReadonlySet<string>): null | string {
const top = this.peekType("KEYWORD");
return (top != null && allowed.has(top)) ? top: null;
}
// Returns the value of the next token if it is `type`
peekType(type: string): null | string {
if (this.length === 0) { return null; }
const top = this.peek();
return (top.type === type) ? top.text: null;
}
// Returns the next token; throws if out of tokens
pop(): Token {
const result = this.peek();
this.#offset++;
return result;
}
toString(): string {
const tokens: Array<string> = [ ];
for (let i = this.#offset; i < this.#tokens.length; i++) {
const token = this.#tokens[i];
tokens.push(`${ token.type }:${ token.text }`);
}
return `<TokenString ${ tokens.join(" ") }>`
}
}
type Writeable<T> = { -readonly [P in keyof T]: T[P] };
function lex(text: string): TokenString {
const tokens: Array<Token> = [ ];
const throwError = (message: string) => {
const token = (offset < text.length) ? JSON.stringify(text[offset]): "$EOI";
throw new Error(`invalid token ${ token } at ${ offset }: ${ message }`);
};
let brackets: Array<number> = [ ];
let commas: Array<number> = [ ];
let offset = 0;
while (offset < text.length) {
// Strip off any leading whitespace
let cur = text.substring(offset);
let match = cur.match(regexWhitespacePrefix);
if (match) {
offset += match[1].length;
cur = text.substring(offset);
}
const token = { depth: brackets.length, linkBack: -1, linkNext: -1, match: -1, type: "", text: "", offset, value: -1 };
tokens.push(token);
let type = (SimpleTokens[cur[0]] || "");
if (type) {
token.type = type;
token.text = cur[0];
offset++;
if (type === "OPEN_PAREN") {
brackets.push(tokens.length - 1);
commas.push(tokens.length - 1);
} else if (type == "CLOSE_PAREN") {
if (brackets.length === 0) { throwError("no matching open bracket"); }
token.match = brackets.pop() as number;
(<Writeable<Token>>(tokens[token.match])).match = tokens.length - 1;
token.depth--;
token.linkBack = commas.pop() as number;
(<Writeable<Token>>(tokens[token.linkBack])).linkNext = tokens.length - 1;
} else if (type === "COMMA") {
token.linkBack = commas.pop() as number;
(<Writeable<Token>>(tokens[token.linkBack])).linkNext = tokens.length - 1;
commas.push(tokens.length - 1);
} else if (type === "OPEN_BRACKET") {
token.type = "BRACKET";
} else if (type === "CLOSE_BRACKET") {
// Remove the CLOSE_BRACKET
let suffix = (tokens.pop() as Token).text;
if (tokens.length > 0 && tokens[tokens.length - 1].type === "NUMBER") {
const value = (tokens.pop() as Token).text;
suffix = value + suffix;
(<Writeable<Token>>(tokens[tokens.length - 1])).value = getNumber(value);
}
if (tokens.length === 0 || tokens[tokens.length - 1].type !== "BRACKET") {
throw new Error("missing opening bracket");
}
(<Writeable<Token>>(tokens[tokens.length - 1])).text += suffix;
}
continue;
}
match = cur.match(regexIdPrefix);
if (match) {
token.text = match[1];
offset += token.text.length;
if (Keywords.has(token.text)) {
token.type = "KEYWORD";
continue;
}
if (token.text.match(regexType)) {
token.type = "TYPE";
continue;
}
token.type = "ID";
continue;
}
match = cur.match(regexNumberPrefix);
if (match) {
token.text = match[1];
token.type = "NUMBER";
offset += token.text.length;
continue;
}
throw new Error(`unexpected token ${ JSON.stringify(cur[0]) } at position ${ offset }`);
}
return new TokenString(tokens.map((t) => Object.freeze(t)));
}
// Check only one of `allowed` is in `set`
function allowSingle(set: ReadonlySet<string>, allowed: ReadonlySet<string>): void {
let included: Array<string> = [ ];
for (const key in allowed.keys()) {
if (set.has(key)) { included.push(key); }
}
if (included.length > 1) { throw new Error(`conflicting types: ${ included.join(", ") }`); }
}
// Functions to process a Solidity Signature TokenString from left-to-right for...
// ...the name with an optional type, returning the name
function consumeName(type: string, tokens: TokenString): string {
if (tokens.peekKeyword(KwTypes)) {
const keyword = tokens.pop().text;
if (keyword !== type) {
throw new Error(`expected ${ type }, got ${ keyword }`);
}
}
return tokens.popType("ID");
}
// ...all keywords matching allowed, returning the keywords
function consumeKeywords(tokens: TokenString, allowed?: ReadonlySet<string>): ReadonlySet<string> {
const keywords: Set<string> = new Set();
while (true) {
const keyword = tokens.peekType("KEYWORD");
if (keyword == null || (allowed && !allowed.has(keyword))) { break; }
tokens.pop();
if (keywords.has(keyword)) { throw new Error(`duplicate keywords: ${ JSON.stringify(keyword) }`); }
keywords.add(keyword);
}
return Object.freeze(keywords);
}
// ...all visibility keywords, returning the coalesced mutability
function consumeMutability(tokens: TokenString): "payable" | "nonpayable" | "view" | "pure" {
let modifiers = consumeKeywords(tokens, KwVisib);
// Detect conflicting modifiers
allowSingle(modifiers, setify("constant payable nonpayable".split(" ")));
allowSingle(modifiers, setify("pure view payable nonpayable".split(" ")));
// Process mutability states
if (modifiers.has("view")) { return "view"; }
if (modifiers.has("pure")) { return "pure"; }
if (modifiers.has("payable")) { return "payable"; }
if (modifiers.has("nonpayable")) { return "nonpayable"; }
// Process legacy `constant` last
if (modifiers.has("constant")) { return "view"; }
return "nonpayable";
}
// ...a parameter list, returning the ParamType list
function consumeParams(tokens: TokenString, allowIndexed?: boolean): Array<ParamType> {
return tokens.popParams().map((t) => ParamType.from(t, allowIndexed));
}
// ...a gas limit, returning a BigNumber or null if none
function consumeGas(tokens: TokenString): null | bigint {
if (tokens.peekType("AT")) {
tokens.pop();
if (tokens.peekType("NUMBER")) {
return getBigInt(tokens.pop().text);
}
throw new Error("invalid gas");
}
return null;
}
function consumeEoi(tokens: TokenString): void {
if (tokens.length) {
throw new Error(`unexpected tokens at offset ${ tokens.offset }: ${ tokens.toString() }`);
}
}
const regexArrayType = new RegExp(/^(.*)\[([0-9]*)\]$/);
function verifyBasicType(type: string): string {
const match = type.match(regexType);
assertArgument(match, "invalid type", "type", type);
if (type === "uint") { return "uint256"; }
if (type === "int") { return "int256"; }
if (match[2]) {
// bytesXX
const length = parseInt(match[2]);
assertArgument(length !== 0 && length <= 32, "invalid bytes length", "type", type);
} else if (match[3]) {
// intXX or uintXX
const size = parseInt(match[3] as string);
assertArgument(size !== 0 && size <= 256 && (size % 8) === 0, "invalid numeric width", "type", type);
}
return type;
}
// Make the Fragment constructors effectively private
const _guard = { };
/**
* When [walking](ParamType-walk) a [[ParamType]], this is called
* on each component.
*/
export type ParamTypeWalkFunc = (type: string, value: any) => any;
/**
* When [walking asynchronously](ParamType-walkAsync) a [[ParamType]],
* this is called on each component.
*/
export type ParamTypeWalkAsyncFunc = (type: string, value: any) => any | Promise<any>;
const internal = Symbol.for("_ethers_internal");
const ParamTypeInternal = "_ParamTypeInternal";
const ErrorFragmentInternal = "_ErrorInternal";
const EventFragmentInternal = "_EventInternal";
const ConstructorFragmentInternal = "_ConstructorInternal";
const FallbackFragmentInternal = "_FallbackInternal";
const FunctionFragmentInternal = "_FunctionInternal";
const StructFragmentInternal = "_StructInternal";
/**
* Each input and output of a [[Fragment]] is an Array of **ParamType**.
*/
export class ParamType {
/**
* The local name of the parameter (or ``""`` if unbound)
*/
readonly name!: string;
/**
* The fully qualified type (e.g. ``"address"``, ``"tuple(address)"``,
* ``"uint256[3][]"``)
*/
readonly type!: string;
/**
* The base type (e.g. ``"address"``, ``"tuple"``, ``"array"``)
*/
readonly baseType!: string;
/**
* True if the parameters is indexed.
*
* For non-indexable types this is ``null``.
*/
readonly indexed!: null | boolean;
/**
* The components for the tuple.
*
* For non-tuple types this is ``null``.
*/
readonly components!: null | ReadonlyArray<ParamType>;
/**
* The array length, or ``-1`` for dynamic-lengthed arrays.
*
* For non-array types this is ``null``.
*/
readonly arrayLength!: null | number;
/**
* The type of each child in the array.
*
* For non-array types this is ``null``.
*/
readonly arrayChildren!: null | ParamType;
/**
* @private
*/
constructor(guard: any, name: string, type: string, baseType: string, indexed: null | boolean, components: null | ReadonlyArray<ParamType>, arrayLength: null | number, arrayChildren: null | ParamType) {
assertPrivate(guard, _guard, "ParamType");
Object.defineProperty(this, internal, { value: ParamTypeInternal });
if (components) { components = Object.freeze(components.slice()); }
if (baseType === "array") {
if (arrayLength == null || arrayChildren == null) {
throw new Error("");
}
} else if (arrayLength != null || arrayChildren != null) {
throw new Error("");
}
if (baseType === "tuple") {
if (components == null) { throw new Error(""); }
} else if (components != null) {
throw new Error("");
}
defineProperties<ParamType>(this, {
name, type, baseType, indexed, components, arrayLength, arrayChildren
});
}
/**
* Return a string representation of this type.
*
* For example,
*
* ``sighash" => "(uint256,address)"``
*
* ``"minimal" => "tuple(uint256,address) indexed"``
*
* ``"full" => "tuple(uint256 foo, address bar) indexed baz"``
*/
format(format?: FormatType): string {
if (format == null) { format = "sighash"; }
if (format === "json") {
const name = this.name || "";
if (this.isArray()) {
const result = JSON.parse(this.arrayChildren.format("json"));
result.name = name;
result.type += `[${ (this.arrayLength < 0 ? "": String(this.arrayLength)) }]`;
return JSON.stringify(result);
}
const result: any = {
type: ((this.baseType === "tuple") ? "tuple": this.type),
name
};
if (typeof(this.indexed) === "boolean") { result.indexed = this.indexed; }
if (this.isTuple()) {
result.components = this.components.map((c) => JSON.parse(c.format(format)));
}
return JSON.stringify(result);
}
let result = "";
// Array
if (this.isArray()) {
result += this.arrayChildren.format(format);
result += `[${ (this.arrayLength < 0 ? "": String(this.arrayLength)) }]`;
} else {
if (this.isTuple()) {
result += "(" + this.components.map(
(comp) => comp.format(format)
).join((format === "full") ? ", ": ",") + ")";
} else {
result += this.type;
}
}
if (format !== "sighash") {
if (this.indexed === true) { result += " indexed"; }
if (format === "full" && this.name) {
result += " " + this.name;
}
}
return result;
}
/**
* Returns true if %%this%% is an Array type.
*
* This provides a type gaurd ensuring that [[arrayChildren]]
* and [[arrayLength]] are non-null.
*/
isArray(): this is (ParamType & { arrayChildren: ParamType, arrayLength: number }) {
return (this.baseType === "array")
}
/**
* Returns true if %%this%% is a Tuple type.
*
* This provides a type gaurd ensuring that [[components]]
* is non-null.
*/
isTuple(): this is (ParamType & { components: ReadonlyArray<ParamType> }) {
return (this.baseType === "tuple");
}
/**
* Returns true if %%this%% is an Indexable type.
*
* This provides a type gaurd ensuring that [[indexed]]
* is non-null.
*/
isIndexable(): this is (ParamType & { indexed: boolean }) {
return (this.indexed != null);
}
/**
* Walks the **ParamType** with %%value%%, calling %%process%%
* on each type, destructing the %%value%% recursively.
*/
walk(value: any, process: ParamTypeWalkFunc): any {
if (this.isArray()) {
if (!Array.isArray(value)) { throw new Error("invalid array value"); }
if (this.arrayLength !== -1 && value.length !== this.arrayLength) {
throw new Error("array is wrong length");
}
const _this = this;
return value.map((v) => (_this.arrayChildren.walk(v, process)));
}
if (this.isTuple()) {
if (!Array.isArray(value)) { throw new Error("invalid tuple value"); }
if (value.length !== this.components.length) {
throw new Error("array is wrong length");
}
const _this = this;
return value.map((v, i) => (_this.components[i].walk(v, process)));
}
return process(this.type, value);
}
#walkAsync(promises: Array<Promise<void>>, value: any, process: ParamTypeWalkAsyncFunc, setValue: (value: any) => void): void {
if (this.isArray()) {
if (!Array.isArray(value)) { throw new Error("invalid array value"); }
if (this.arrayLength !== -1 && value.length !== this.arrayLength) {
throw new Error("array is wrong length");
}
const childType = this.arrayChildren;
const result = value.slice();
result.forEach((value, index) => {
childType.#walkAsync(promises, value, process, (value: any) => {
result[index] = value;
});
});
setValue(result);
return;
}
if (this.isTuple()) {
const components = this.components;
// Convert the object into an array
let result: Array<any>;
if (Array.isArray(value)) {
result = value.slice();
} else {
if (value == null || typeof(value) !== "object") {
throw new Error("invalid tuple value");
}
result = components.map((param) => {
if (!param.name) { throw new Error("cannot use object value with unnamed components"); }
if (!(param.name in value)) {
throw new Error(`missing value for component ${ param.name }`);
}
return value[param.name];
});
}
if (result.length !== this.components.length) {
throw new Error("array is wrong length");
}
result.forEach((value, index) => {
components[index].#walkAsync(promises, value, process, (value: any) => {
result[index] = value;
});
});
setValue(result);
return;
}
const result = process(this.type, value);
if (result.then) {
promises.push((async function() { setValue(await result); })());
} else {
setValue(result);
}
}
/**
* Walks the **ParamType** with %%value%%, asynchronously calling
* %%process%% on each type, destructing the %%value%% recursively.
*
* This can be used to resolve ENS names by walking and resolving each
* ``"address"`` type.
*/
async walkAsync(value: any, process: ParamTypeWalkAsyncFunc): Promise<any> {
const promises: Array<Promise<void>> = [ ];
const result: [ any ] = [ value ];
this.#walkAsync(promises, value, process, (value: any) => {
result[0] = value;
});
if (promises.length) { await Promise.all(promises); }
return result[0];
}
/**
* Creates a new **ParamType** for %%obj%%.
*
* If %%allowIndexed%% then the ``indexed`` keyword is permitted,
* otherwise the ``indexed`` keyword will throw an error.
*/
static from(obj: any, allowIndexed?: boolean): ParamType {
if (ParamType.isParamType(obj)) { return obj; }
if (typeof(obj) === "string") {
try {
return ParamType.from(lex(obj), allowIndexed);
} catch (error) {
assertArgument(false, "invalid param type", "obj", obj);
}
} else if (obj instanceof TokenString) {
let type = "", baseType = "";
let comps: null | Array<ParamType> = null;
if (consumeKeywords(obj, setify([ "tuple" ])).has("tuple") || obj.peekType("OPEN_PAREN")) {
// Tuple
baseType = "tuple";
comps = obj.popParams().map((t) => ParamType.from(t));
type = `tuple(${ comps.map((c) => c.format()).join(",") })`;
} else {
// Normal
type = verifyBasicType(obj.popType("TYPE"));
baseType = type;
}
// Check for Array
let arrayChildren: null | ParamType = null;
let arrayLength: null | number = null;
while (obj.length && obj.peekType("BRACKET")) {
const bracket = obj.pop(); //arrays[i];
arrayChildren = new ParamType(_guard, "", type, baseType, null, comps, arrayLength, arrayChildren);
arrayLength = bracket.value;
type += bracket.text;
baseType = "array";
comps = null;
}
let indexed: null | boolean = null;
const keywords = consumeKeywords(obj, KwModifiers);
if (keywords.has("indexed")) {
if (!allowIndexed) { throw new Error(""); }
indexed = true;
}
const name = (obj.peekType("ID") ? obj.pop().text: "");
if (obj.length) { throw new Error("leftover tokens"); }
return new ParamType(_guard, name, type, baseType, indexed, comps, arrayLength, arrayChildren);
}
const name = obj.name;
assertArgument(!name || (typeof(name) === "string" && name.match(regexId)),
"invalid name", "obj.name", name);
let indexed = obj.indexed;
if (indexed != null) {
assertArgument(allowIndexed, "parameter cannot be indexed", "obj.indexed", obj.indexed);
indexed = !!indexed;
}
let type = obj.type;
let arrayMatch = type.match(regexArrayType);
if (arrayMatch) {
const arrayLength = parseInt(arrayMatch[2] || "-1");
const arrayChildren = ParamType.from({
type: arrayMatch[1],
components: obj.components
});
return new ParamType(_guard, name || "", type, "array", indexed, null, arrayLength, arrayChildren);
}
if (type === "tuple" || type.startsWith("tuple("/* fix: ) */) || type.startsWith("(" /* fix: ) */)) {
const comps = (obj.components != null) ? obj.components.map((c: any) => ParamType.from(c)): null;
const tuple = new ParamType(_guard, name || "", type, "tuple", indexed, comps, null, null);
// @TODO: use lexer to validate and normalize type
return tuple;
}
type = verifyBasicType(obj.type);
return new ParamType(_guard, name || "", type, type, indexed, null, null, null);
}
/**
* Returns true if %%value%% is a **ParamType**.
*/
static isParamType(value: any): value is ParamType {
return (value && value[internal] === ParamTypeInternal);
}
}
/**
* The type of a [[Fragment]].
*/
export type FragmentType = "constructor" | "error" | "event" | "fallback" | "function" | "struct";
/**
* An abstract class to represent An individual fragment from a parse ABI.
*/
export abstract class Fragment {
/**
* The type of the fragment.
*/
readonly type!: FragmentType;
/**
* The inputs for the fragment.
*/
readonly inputs!: ReadonlyArray<ParamType>;
/**
* @private
*/
constructor(guard: any, type: FragmentType, inputs: ReadonlyArray<ParamType>) {
assertPrivate(guard, _guard, "Fragment");
inputs = Object.freeze(inputs.slice());
defineProperties<Fragment>(this, { type, inputs });
}
/**
* Returns a string representation of this fragment as %%format%%.
*/
abstract format(format?: FormatType): string;
/**
* Creates a new **Fragment** for %%obj%%, wich can be any supported
* ABI frgament type.
*/
static from(obj: any): Fragment {
if (typeof(obj) === "string") {
// Try parsing JSON...
try {
Fragment.from(JSON.parse(obj));
} catch (e) { }
// ...otherwise, use the human-readable lexer
return Fragment.from(lex(obj));
}
if (obj instanceof TokenString) {
// Human-readable ABI (already lexed)
const type = obj.peekKeyword(KwTypes);
switch (type) {
case "constructor": return ConstructorFragment.from(obj);
case "error": return ErrorFragment.from(obj);
case "event": return EventFragment.from(obj);
case "fallback": case "receive":
return FallbackFragment.from(obj);
case "function": return FunctionFragment.from(obj);
case "struct": return StructFragment.from(obj);
}
} else if (typeof(obj) === "object") {
// JSON ABI
switch (obj.type) {
case "constructor": return ConstructorFragment.from(obj);
case "error": return ErrorFragment.from(obj);
case "event": return EventFragment.from(obj);
case "fallback": case "receive":
return FallbackFragment.from(obj);
case "function": return FunctionFragment.from(obj);
case "struct": return StructFragment.from(obj);
}
assert(false, `unsupported type: ${ obj.type }`, "UNSUPPORTED_OPERATION", {
operation: "Fragment.from"
});
}
assertArgument(false, "unsupported frgament object", "obj", obj);
}
/**
* Returns true if %%value%% is a [[ConstructorFragment]].
*/
static isConstructor(value: any): value is ConstructorFragment {
return ConstructorFragment.isFragment(value);
}
/**
* Returns true if %%value%% is an [[ErrorFragment]].
*/
static isError(value: any): value is ErrorFragment {
return ErrorFragment.isFragment(value);
}
/**
* Returns true if %%value%% is an [[EventFragment]].
*/
static isEvent(value: any): value is EventFragment {
return EventFragment.isFragment(value);
}
/**
* Returns true if %%value%% is a [[FunctionFragment]].
*/
static isFunction(value: any): value is FunctionFragment {
return FunctionFragment.isFragment(value);
}
/**
* Returns true if %%value%% is a [[StructFragment]].
*/
static isStruct(value: any): value is StructFragment {
return StructFragment.isFragment(value);
}
}
/**
* An abstract class to represent An individual fragment
* which has a name from a parse ABI.
*/
export abstract class NamedFragment extends Fragment {
/**
* The name of the fragment.
*/
readonly name!: string;
/**
* @private
*/
constructor(guard: any, type: FragmentType, name: string, inputs: ReadonlyArray<ParamType>) {
super(guard, type, inputs);
assertArgument(typeof(name) === "string" && name.match(regexId),
"invalid identifier", "name", name);
inputs = Object.freeze(inputs.slice());
defineProperties<NamedFragment>(this, { name });
}
}
function joinParams(format: FormatType, params: ReadonlyArray<ParamType>): string {
return "(" + params.map((p) => p.format(format)).join((format === "full") ? ", ": ",") + ")";
}
/**
* A Fragment which represents a //Custom Error//.
*/
export class ErrorFragment extends NamedFragment {
/**
* @private
*/
constructor(guard: any, name: string, inputs: ReadonlyArray<ParamType>) {
super(guard, "error", name, inputs);
Object.defineProperty(this, internal, { value: ErrorFragmentInternal });
}
/**
* The Custom Error selector.
*/
get selector(): string {
return id(this.format("sighash")).substring(0, 10);
}
/**
* Returns a string representation of this fragment as %%format%%.
*/
format(format?: FormatType): string {
if (format == null) { format = "sighash"; }
if (format === "json") {
return JSON.stringify({
type: "error",
name: this.name,
inputs: this.inputs.map((input) => JSON.parse(input.format(format))),
});
}
const result: Array<string> = [ ];
if (format !== "sighash") { result.push("error"); }
result.push(this.name + joinParams(format, this.inputs));
return result.join(" ");
}
/**
* Returns a new **ErrorFragment** for %%obj%%.
*/
static from(obj: any): ErrorFragment {
if (ErrorFragment.isFragment(obj)) { return obj; }
if (typeof(obj) === "string") {
return ErrorFragment.from(lex(obj));
} else if (obj instanceof TokenString) {
const name = consumeName("error", obj);
const inputs = consumeParams(obj);
consumeEoi(obj);
return new ErrorFragment(_guard, name, inputs);
}
return new ErrorFragment(_guard, obj.name,
obj.inputs ? obj.inputs.map(ParamType.from): [ ]);
}
/**
* Returns ``true`` and provides a type guard if %%value%% is an
* **ErrorFragment**.
*/
static isFragment(value: any): value is ErrorFragment {
return (value && value[internal] === ErrorFragmentInternal);
}
}
/**
* A Fragment which represents an Event.
*/
export class EventFragment extends NamedFragment {
/**
* Whether this event is anonymous.
*/
readonly anonymous!: boolean;
/**
* @private
*/
constructor(guard: any, name: string, inputs: ReadonlyArray<ParamType>, anonymous: boolean) {
super(guard, "event", name, inputs);
Object.defineProperty(this, internal, { value: EventFragmentInternal });
defineProperties<EventFragment>(this, { anonymous });
}
/**
* The Event topic hash.
*/
get topicHash(): string {
return id(this.format("sighash"));
}
/**
* Returns a string representation of this event as %%format%%.
*/
format(format?: FormatType): string {
if (format == null) { format = "sighash"; }
if (format === "json") {
return JSON.stringify({
type: "event",
anonymous: this.anonymous,
name: this.name,
inputs: this.inputs.map((i) => JSON.parse(i.format(format)))
});
}
const result: Array<string> = [ ];
if (format !== "sighash") { result.push("event"); }
result.push(this.name + joinParams(format, this.inputs));
if (format !== "sighash" && this.anonymous) { result.push("anonymous"); }
return result.join(" ");
}
/**
* Return the topic hash for an event with %%name%% and %%params%%.
*/
static getTopicHash(name: string, params?: Array<any>): string {
params = (params || []).map((p) => ParamType.from(p));
const fragment = new EventFragment(_guard, name, params, false);
return fragment.topicHash;
}
/**
* Returns a new **EventFragment** for %%obj%%.
*/
static from(obj: any): EventFragment {
if (EventFragment.isFragment(obj)) { return obj; }
if (typeof(obj) === "string") {
try {
return EventFragment.from(lex(obj));
} catch (error) {
assertArgument(false, "invalid event fragment", "obj", obj);
}
} else if (obj instanceof TokenString) {
const name = consumeName("event", obj);
const inputs = consumeParams(obj, true);
const anonymous = !!consumeKeywords(obj, setify([ "anonymous" ])).has("anonymous");
consumeEoi(obj);
return new EventFragment(_guard, name, inputs, anonymous);
}
return new EventFragment(_guard, obj.name,
obj.inputs ? obj.inputs.map((p: any) => ParamType.from(p, true)): [ ], !!obj.anonymous);
}
/**
* Returns ``true`` and provides a type guard if %%value%% is an
* **EventFragment**.
*/
static isFragment(value: any): value is EventFragment {
return (value && value[internal] === EventFragmentInternal);
}
}
/**
* A Fragment which represents a constructor.
*/
export class ConstructorFragment extends Fragment {
/**
* Whether the constructor can receive an endowment.
*/
readonly payable!: boolean;
/**
* The recommended gas limit for deployment or ``null``.
*/
readonly gas!: null | bigint;
/**
* @private
*/
constructor(guard: any, type: FragmentType, inputs: ReadonlyArray<ParamType>, payable: boolean, gas: null | bigint) {
super(guard, type, inputs);
Object.defineProperty(this, internal, { value: ConstructorFragmentInternal });
defineProperties<ConstructorFragment>(this, { payable, gas });
}
/**
* Returns a string representation of this constructor as %%format%%.
*/
format(format?: FormatType): string {
assert(format != null && format !== "sighash", "cannot format a constructor for sighash",
"UNSUPPORTED_OPERATION", { operation: "format(sighash)" });
if (format === "json") {
return JSON.stringify({
type: "constructor",
stateMutability: (this.payable ? "payable": "undefined"),
payable: this.payable,
gas: ((this.gas != null) ? this.gas: undefined),
inputs: this.inputs.map((i) => JSON.parse(i.format(format)))
});
}
const result = [ `constructor${ joinParams(format, this.inputs) }` ];
if (this.payable) { result.push("payable"); }
if (this.gas != null) { result.push(`@${ this.gas.toString() }`); }
return result.join(" ");
}
/**
* Returns a new **ConstructorFragment** for %%obj%%.
*/
static from(obj: any): ConstructorFragment {
if (ConstructorFragment.isFragment(obj)) { return obj; }
if (typeof(obj) === "string") {
try {
return ConstructorFragment.from(lex(obj));
} catch (error) {
assertArgument(false, "invalid constuctor fragment", "obj", obj);
}
} else if (obj instanceof TokenString) {
consumeKeywords(obj, setify([ "constructor" ]));
const inputs = consumeParams(obj);
const payable = !!consumeKeywords(obj, KwVisibDeploy).has("payable");
const gas = consumeGas(obj);
consumeEoi(obj);
return new ConstructorFragment(_guard, "constructor", inputs, payable, gas);
}
return new ConstructorFragment(_guard, "constructor",
obj.inputs ? obj.inputs.map(ParamType.from): [ ],
!!obj.payable, (obj.gas != null) ? obj.gas: null);
}
/**
* Returns ``true`` and provides a type guard if %%value%% is a
* **ConstructorFragment**.
*/
static isFragment(value: any): value is ConstructorFragment {
return (value && value[internal] === ConstructorFragmentInternal);
}
}
/**
* A Fragment which represents a method.
*/
export class FallbackFragment extends Fragment {
/**
* If the function can be sent value during invocation.
*/
readonly payable!: boolean;
constructor(guard: any, inputs: ReadonlyArray<ParamType>, payable: boolean) {
super(guard, "fallback", inputs);
Object.defineProperty(this, internal, { value: FallbackFragmentInternal });
defineProperties<FallbackFragment>(this, { payable });
}
/**
* Returns a string representation of this fallback as %%format%%.
*/
format(format?: FormatType): string {
const type = ((this.inputs.length === 0) ? "receive": "fallback");
if (format === "json") {
const stateMutability = (this.payable ? "payable": "nonpayable");
return JSON.stringify({ type, stateMutability });
}
return `${ type }()${ this.payable ? " payable": "" }`;
}
/**
* Returns a new **FallbackFragment** for %%obj%%.
*/
static from(obj: any): FallbackFragment {
if (FallbackFragment.isFragment(obj)) { return obj; }
if (typeof(obj) === "string") {
try {
return FallbackFragment.from(lex(obj));
} catch (error) {
assertArgument(false, "invalid fallback fragment", "obj", obj);
}
} else if (obj instanceof TokenString) {
const errorObj = obj.toString();
const topIsValid = obj.peekKeyword(setify([ "fallback", "receive" ]));
assertArgument(topIsValid, "type must be fallback or receive", "obj", errorObj);
const type = obj.popKeyword(setify([ "fallback", "receive" ]));
// receive()
if (type === "receive") {
const inputs = consumeParams(obj);
assertArgument(inputs.length === 0, `receive cannot have arguments`, "obj.inputs", inputs);
consumeKeywords(obj, setify([ "payable" ]));
consumeEoi(obj);
return new FallbackFragment(_guard, [ ], true);
}
// fallback() [payable]
// fallback(bytes) [payable] returns (bytes)
let inputs = consumeParams(obj);
if (inputs.length) {
assertArgument(inputs.length === 1 && inputs[0].type === "bytes",
"invalid fallback inputs", "obj.inputs",
inputs.map((i) => i.format("minimal")).join(", "));
} else {
inputs = [ ParamType.from("bytes") ];
}
const mutability = consumeMutability(obj);
assertArgument(mutability === "nonpayable" || mutability === "payable", "fallback cannot be constants", "obj.stateMutability", mutability);
if (consumeKeywords(obj, setify([ "returns" ])).has("returns")) {
const outputs = consumeParams(obj);
assertArgument(outputs.length === 1 && outputs[0].type === "bytes",
"invalid fallback outputs", "obj.outputs",
outputs.map((i) => i.format("minimal")).join(", "));
}
consumeEoi(obj);
return new FallbackFragment(_guard, inputs, mutability === "payable");
}
if (obj.type === "receive") {
return new FallbackFragment(_guard, [ ], true);
}
if (obj.type === "fallback") {
const inputs = [ ParamType.from("bytes") ];
const payable = (obj.stateMutability === "payable");
return new FallbackFragment(_guard, inputs, payable);
}
assertArgument(false, "invalid fallback description", "obj", obj);
}
/**
* Returns ``true`` and provides a type guard if %%value%% is a
* **FallbackFragment**.
*/
static isFragment(value: any): value is FallbackFragment {
return (value && value[internal] === FallbackFragmentInternal);
}
}
/**
* A Fragment which represents a method.
*/
export class FunctionFragment extends NamedFragment {
/**
* If the function is constant (e.g. ``pure`` or ``view`` functions).
*/
readonly constant!: boolean;
/**
* The returned types for the result of calling this function.
*/
readonly outputs!: ReadonlyArray<ParamType>;
/**
* The state mutability (e.g. ``payable``, ``nonpayable``, ``view``
* or ``pure``)
*/
readonly stateMutability!: "payable" | "nonpayable" | "view" | "pure";
/**
* If the function can be sent value during invocation.
*/
readonly payable!: boolean;
/**
* The recommended gas limit to send when calling this function.
*/
readonly gas!: null | bigint;
/**
* @private
*/
constructor(guard: any, name: string, stateMutability: "payable" | "nonpayable" | "view" | "pure", inputs: ReadonlyArray<ParamType>, outputs: ReadonlyArray<ParamType>, gas: null | bigint) {
super(guard, "function", name, inputs);
Object.defineProperty(this, internal, { value: FunctionFragmentInternal });
outputs = Object.freeze(outputs.slice());
const constant = (stateMutability === "view" || stateMutability === "pure");
const payable = (stateMutability === "payable");
defineProperties<FunctionFragment>(this, { constant, gas, outputs, payable, stateMutability });
}
/**
* The Function selector.
*/
get selector(): string {
return id(this.format("sighash")).substring(0, 10);
}
/**
* Returns a string representation of this function as %%format%%.
*/
format(format?: FormatType): string {
if (format == null) { format = "sighash"; }
if (format === "json") {
return JSON.stringify({
type: "function",
name: this.name,
constant: this.constant,
stateMutability: ((this.stateMutability !== "nonpayable") ? this.stateMutability: undefined),
payable: this.payable,
gas: ((this.gas != null) ? this.gas: undefined),
inputs: this.inputs.map((i) => JSON.parse(i.format(format))),
outputs: this.outputs.map((o) => JSON.parse(o.format(format))),
});
}
const result: Array<string> = [];
if (format !== "sighash") { result.push("function"); }
result.push(this.name + joinParams(format, this.inputs));
if (format !== "sighash") {
if (this.stateMutability !== "nonpayable") {
result.push(this.stateMutability);
}
if (this.outputs && this.outputs.length) {
result.push("returns");
result.push(joinParams(format, this.outputs));
}
if (this.gas != null) { result.push(`@${ this.gas.toString() }`); }
}
return result.join(" ");
}
/**
* Return the selector for a function with %%name%% and %%params%%.
*/
static getSelector(name: string, params?: Array<any>): string {
params = (params || []).map((p) => ParamType.from(p));
const fragment = new FunctionFragment(_guard, name, "view", params, [ ], null);
return fragment.selector;
}
/**
* Returns a new **FunctionFragment** for %%obj%%.
*/
static from(obj: any): FunctionFragment {
if (FunctionFragment.isFragment(obj)) { return obj; }
if (typeof(obj) === "string") {
try {
return FunctionFragment.from(lex(obj));
} catch (error) {
assertArgument(false, "invalid function fragment", "obj", obj);
}
} else if (obj instanceof TokenString) {
const name = consumeName("function", obj);
const inputs = consumeParams(obj);
const mutability = consumeMutability(obj);
let outputs: Array<ParamType> = [ ];
if (consumeKeywords(obj, setify([ "returns" ])).has("returns")) {
outputs = consumeParams(obj);
}
const gas = consumeGas(obj);
consumeEoi(obj);
return new FunctionFragment(_guard, name, mutability, inputs, outputs, gas);
}
let stateMutability = obj.stateMutability;
// Use legacy Solidity ABI logic if stateMutability is missing
if (stateMutability == null) {
stateMutability = "payable";
if (typeof(obj.constant) === "boolean") {
stateMutability = "view";
if (!obj.constant) {
stateMutability = "payable"
if (typeof(obj.payable) === "boolean" && !obj.payable) {
stateMutability = "nonpayable";
}
}
} else if (typeof(obj.payable) === "boolean" && !obj.payable) {
stateMutability = "nonpayable";
}
}
// @TODO: verifyState for stateMutability (e.g. throw if
// payable: false but stateMutability is "nonpayable")
return new FunctionFragment(_guard, obj.name, stateMutability,
obj.inputs ? obj.inputs.map(ParamType.from): [ ],
obj.outputs ? obj.outputs.map(ParamType.from): [ ],
(obj.gas != null) ? obj.gas: null);
}
/**
* Returns ``true`` and provides a type guard if %%value%% is a
* **FunctionFragment**.
*/
static isFragment(value: any): value is FunctionFragment {
return (value && value[internal] === FunctionFragmentInternal);
}
}
/**
* A Fragment which represents a structure.
*/
export class StructFragment extends NamedFragment {
/**
* @private
*/
constructor(guard: any, name: string, inputs: ReadonlyArray<ParamType>) {
super(guard, "struct", name, inputs);
Object.defineProperty(this, internal, { value: StructFragmentInternal });
}
/**
* Returns a string representation of this struct as %%format%%.
*/
format(): string {
throw new Error("@TODO");
}
/**
* Returns a new **StructFragment** for %%obj%%.
*/
static from(obj: any): StructFragment {
if (typeof(obj) === "string") {
try {
return StructFragment.from(lex(obj));
} catch (error) {
assertArgument(false, "invalid struct fragment", "obj", obj);
}
} else if (obj instanceof TokenString) {
const name = consumeName("struct", obj);
const inputs = consumeParams(obj);
consumeEoi(obj);
return new StructFragment(_guard, name, inputs);
}
return new StructFragment(_guard, obj.name, obj.inputs ? obj.inputs.map(ParamType.from): [ ]);
}
// @TODO: fix this return type
/**
* Returns ``true`` and provides a type guard if %%value%% is a
* **StructFragment**.
*/
static isFragment(value: any): value is FunctionFragment {
return (value && value[internal] === StructFragmentInternal);
}
}
|