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 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340
use crate::config::ActionCosts; use crate::config::ExtCosts::*; use crate::config::VMConfig; use crate::context::VMContext; use crate::dependencies::{External, MemoryLike}; use crate::gas_counter::GasCounter; use crate::types::{ AccountId, Balance, EpochHeight, Gas, ProfileData, PromiseIndex, PromiseResult, ProtocolVersion, ReceiptIndex, ReturnData, StorageUsage, }; use crate::utils::split_method_names; use crate::{ExtCosts, HostError, VMLogicError, ValuePtr}; use byteorder::ByteOrder; use near_runtime_fees::RuntimeFeesConfig; use near_runtime_utils::is_account_id_64_len_hex; use near_vm_errors::InconsistentStateError; use serde::{Deserialize, Serialize}; use std::collections::HashMap; use std::mem::size_of; type Result<T> = ::std::result::Result<T, VMLogicError>; const LEGACY_DEFAULT_PROTOCOL_VERSION: ProtocolVersion = 34; const IMPLICIT_ACCOUNT_CREATION_PROTOCOL_VERSION: ProtocolVersion = 35; pub struct VMLogic<'a> { /// Provides access to the components outside the Wasm runtime for operations on the trie and /// receipts creation. ext: &'a mut dyn External, /// Part of Context API and Economics API that was extracted from the receipt. context: VMContext, /// Parameters of Wasm and economic parameters. config: &'a VMConfig, /// Fees for creating (async) actions on runtime. fees_config: &'a RuntimeFeesConfig, /// If this method execution is invoked directly as a callback by one or more contract calls the /// results of the methods that made the callback are stored in this collection. promise_results: &'a [PromiseResult], /// Pointer to the guest memory. memory: &'a mut dyn MemoryLike, /// Keeping track of the current account balance, which can decrease when we create promises /// and attach balance to them. current_account_balance: Balance, /// Current amount of locked tokens, does not automatically change when staking transaction is /// issued. current_account_locked_balance: Balance, /// Storage usage of the current account at the moment current_storage_usage: StorageUsage, gas_counter: GasCounter, /// What method returns. return_data: ReturnData, /// Logs written by the runtime. logs: Vec<String>, /// Registers can be used by the guest to store blobs of data without moving them across /// host-guest boundary. registers: HashMap<u64, Vec<u8>>, /// The DAG of promises, indexed by promise id. promises: Vec<Promise>, /// Record the accounts towards which the receipts are directed. receipt_to_account: HashMap<ReceiptIndex, AccountId>, /// Tracks the total log length. The sum of length of all logs. total_log_length: u64, /// Current protocol version that is used for the function call. current_protocol_version: ProtocolVersion, } /// Promises API allows to create a DAG-structure that defines dependencies between smart contract /// calls. A single promise can be created with zero or several dependencies on other promises. /// * If a promise was created from a receipt (using `promise_create` or `promise_then`) it's a /// `Receipt`; /// * If a promise was created by merging several promises (using `promise_and`) then /// it's a `NotReceipt`, but has receipts of all promises it depends on. #[derive(Debug)] enum Promise { Receipt(ReceiptIndex), NotReceipt(Vec<ReceiptIndex>), } macro_rules! memory_get { ($_type:ty, $name:ident) => { fn $name(&mut self, offset: u64) -> Result<$_type> { let mut array = [0u8; size_of::<$_type>()]; self.memory_get_into(offset, &mut array)?; Ok(<$_type>::from_le_bytes(array)) } }; } macro_rules! memory_set { ($_type:ty, $name:ident) => { fn $name(&mut self, offset: u64, value: $_type) -> Result<()> { self.memory_set_slice(offset, &value.to_le_bytes()) } }; } impl<'a> VMLogic<'a> { pub fn new_with_protocol_version( ext: &'a mut dyn External, context: VMContext, config: &'a VMConfig, fees_config: &'a RuntimeFeesConfig, promise_results: &'a [PromiseResult], memory: &'a mut dyn MemoryLike, profile: Option<ProfileData>, current_protocol_version: ProtocolVersion, ) -> Self { ext.reset_touched_nodes_counter(); // Overflow should be checked before calling VMLogic. let current_account_balance = context.account_balance + context.attached_deposit; let current_storage_usage = context.storage_usage; let max_gas_burnt = if context.is_view { config.limit_config.max_gas_burnt_view } else { config.limit_config.max_gas_burnt }; let current_account_locked_balance = context.account_locked_balance; let gas_counter = GasCounter::new( config.ext_costs.clone(), max_gas_burnt, context.prepaid_gas, context.is_view, profile, ); Self { ext, context, config, fees_config, promise_results, memory, current_account_balance, current_account_locked_balance, current_storage_usage, gas_counter, return_data: ReturnData::None, logs: vec![], registers: HashMap::new(), promises: vec![], receipt_to_account: HashMap::new(), total_log_length: 0, current_protocol_version, } } /// Legacy initialization method that doesn't pass the protocol version and uses the last /// protocol version before the change was introduced. pub fn new( ext: &'a mut dyn External, context: VMContext, config: &'a VMConfig, fees_config: &'a RuntimeFeesConfig, promise_results: &'a [PromiseResult], memory: &'a mut dyn MemoryLike, profile: Option<ProfileData>, ) -> Self { Self::new_with_protocol_version( ext, context, config, fees_config, promise_results, memory, profile, LEGACY_DEFAULT_PROTOCOL_VERSION, ) } // ########################### // # Memory helper functions # // ########################### fn try_fit_mem(&mut self, offset: u64, len: u64) -> Result<()> { if self.memory.fits_memory(offset, len) { Ok(()) } else { Err(HostError::MemoryAccessViolation.into()) } } fn memory_get_into(&mut self, offset: u64, buf: &mut [u8]) -> Result<()> { self.gas_counter.pay_base(read_memory_base)?; self.gas_counter.pay_per_byte(read_memory_byte, buf.len() as _)?; self.try_fit_mem(offset, buf.len() as _)?; self.memory.read_memory(offset, buf); Ok(()) } fn memory_get_vec(&mut self, offset: u64, len: u64) -> Result<Vec<u8>> { self.gas_counter.pay_base(read_memory_base)?; self.gas_counter.pay_per_byte(read_memory_byte, len)?; self.try_fit_mem(offset, len)?; let mut buf = vec![0; len as usize]; self.memory.read_memory(offset, &mut buf); Ok(buf) } memory_get!(u128, memory_get_u128); memory_get!(u32, memory_get_u32); memory_get!(u16, memory_get_u16); memory_get!(u8, memory_get_u8); /// Reads an array of `u64` elements. fn memory_get_vec_u64(&mut self, offset: u64, num_elements: u64) -> Result<Vec<u64>> { let memory_len = num_elements .checked_mul(size_of::<u64>() as u64) .ok_or(HostError::MemoryAccessViolation)?; let data = self.memory_get_vec(offset, memory_len)?; let mut res = vec![0u64; num_elements as usize]; byteorder::LittleEndian::read_u64_into(&data, &mut res); Ok(res) } fn get_vec_from_memory_or_register(&mut self, offset: u64, len: u64) -> Result<Vec<u8>> { if len != std::u64::MAX { self.memory_get_vec(offset, len) } else { self.internal_read_register(offset) } } fn memory_set_slice(&mut self, offset: u64, buf: &[u8]) -> Result<()> { self.gas_counter.pay_base(write_memory_base)?; self.gas_counter.pay_per_byte(write_memory_byte, buf.len() as _)?; self.try_fit_mem(offset, buf.len() as _)?; self.memory.write_memory(offset, buf); Ok(()) } memory_set!(u128, memory_set_u128); // ################# // # Registers API # // ################# fn internal_read_register(&mut self, register_id: u64) -> Result<Vec<u8>> { if let Some(data) = self.registers.get(®ister_id) { self.gas_counter.pay_base(read_register_base)?; self.gas_counter.pay_per_byte(read_register_byte, data.len() as _)?; Ok(data.clone()) } else { Err(HostError::InvalidRegisterId { register_id }.into()) } } fn internal_write_register(&mut self, register_id: u64, data: Vec<u8>) -> Result<()> { self.gas_counter.pay_base(write_register_base)?; self.gas_counter.pay_per_byte(write_register_byte, data.len() as u64)?; if data.len() as u64 > self.config.limit_config.max_register_size || self.registers.len() as u64 >= self.config.limit_config.max_number_registers { return Err(HostError::MemoryAccessViolation.into()); } self.registers.insert(register_id, data); // Calculate the new memory usage. let usage: usize = self.registers.values().map(|v| size_of::<u64>() + v.len() * size_of::<u8>()).sum(); if usage as u64 > self.config.limit_config.registers_memory_limit { Err(HostError::MemoryAccessViolation.into()) } else { Ok(()) } } /// Convenience function for testing. pub fn wrapped_internal_write_register(&mut self, register_id: u64, data: &[u8]) -> Result<()> { self.internal_write_register(register_id, data.to_vec()) } /// Writes the entire content from the register `register_id` into the memory of the guest starting with `ptr`. /// /// # Arguments /// /// * `register_id` -- a register id from where to read the data; /// * `ptr` -- location on guest memory where to copy the data. /// /// # Errors /// /// * If the content extends outside the memory allocated to the guest. In Wasmer, it returns `MemoryAccessViolation` error message; /// * If `register_id` is pointing to unused register returns `InvalidRegisterId` error message. /// /// # Undefined Behavior /// /// If the content of register extends outside the preallocated memory on the host side, or the pointer points to a /// wrong location this function will overwrite memory that it is not supposed to overwrite causing an undefined behavior. /// /// # Cost /// /// `base + read_register_base + read_register_byte * num_bytes + write_memory_base + write_memory_byte * num_bytes` pub fn read_register(&mut self, register_id: u64, ptr: u64) -> Result<()> { self.gas_counter.pay_base(base)?; let data = self.internal_read_register(register_id)?; self.memory_set_slice(ptr, &data) } /// Returns the size of the blob stored in the given register. /// * If register is used, then returns the size, which can potentially be zero; /// * If register is not used, returns `u64::MAX` /// /// # Arguments /// /// * `register_id` -- a register id from where to read the data; /// /// # Cost /// /// `base` pub fn register_len(&mut self, register_id: u64) -> Result<u64> { self.gas_counter.pay_base(base)?; Ok(self.registers.get(®ister_id).map(|r| r.len() as _).unwrap_or(std::u64::MAX)) } /// Copies `data` from the guest memory into the register. If register is unused will initialize /// it. If register has larger capacity than needed for `data` will not re-allocate it. The /// register will lose the pre-existing data if any. /// /// # Arguments /// /// * `register_id` -- a register id where to write the data; /// * `data_len` -- length of the data in bytes; /// * `data_ptr` -- pointer in the guest memory where to read the data from. /// /// # Cost /// /// `base + read_memory_base + read_memory_bytes * num_bytes + write_register_base + write_register_bytes * num_bytes` pub fn write_register(&mut self, register_id: u64, data_len: u64, data_ptr: u64) -> Result<()> { self.gas_counter.pay_base(base)?; let data = self.memory_get_vec(data_ptr, data_len)?; self.internal_write_register(register_id, data) } // ################################### // # String reading helper functions # // ################################### /// Helper function to read and return utf8-encoding string. /// If `len == u64::MAX` then treats the string as null-terminated with character `'\0'`. /// /// # Errors /// /// * If string extends outside the memory of the guest with `MemoryAccessViolation`; /// * If string is not UTF-8 returns `BadUtf8`. /// * If number of bytes read + `total_log_length` exceeds the `max_total_log_length` returns /// `TotalLogLengthExceeded`. /// /// # Cost /// /// For not nul-terminated string: /// `read_memory_base + read_memory_byte * num_bytes + utf8_decoding_base + utf8_decoding_byte * num_bytes` /// /// For nul-terminated string: /// `(read_memory_base + read_memory_byte) * num_bytes + utf8_decoding_base + utf8_decoding_byte * num_bytes` fn get_utf8_string(&mut self, len: u64, ptr: u64) -> Result<String> { self.gas_counter.pay_base(utf8_decoding_base)?; let mut buf; let max_len = self.config.limit_config.max_total_log_length.saturating_sub(self.total_log_length); if len != std::u64::MAX { if len > max_len { return Err(HostError::TotalLogLengthExceeded { length: self.total_log_length.saturating_add(len), limit: self.config.limit_config.max_total_log_length, } .into()); } buf = self.memory_get_vec(ptr, len)?; } else { buf = vec![]; for i in 0..=max_len { // self.try_fit_mem will check for u64 overflow on the first iteration (i == 0) let el = self.memory_get_u8(ptr + i)?; if el == 0 { break; } if i == max_len { return Err(HostError::TotalLogLengthExceeded { length: self.total_log_length.saturating_add(max_len).saturating_add(1), limit: self.config.limit_config.max_total_log_length, } .into()); } buf.push(el); } } self.gas_counter.pay_per_byte(utf8_decoding_byte, buf.len() as _)?; String::from_utf8(buf).map_err(|_| HostError::BadUTF8.into()) } /// Helper function to read UTF-16 formatted string from guest memory. /// # Errors /// /// * If string extends outside the memory of the guest with `MemoryAccessViolation`; /// * If string is not UTF-16 returns `BadUtf16`. /// * If number of bytes read + `total_log_length` exceeds the `max_total_log_length` returns /// `TotalLogLengthExceeded`. /// /// # Cost /// /// For not nul-terminated string: /// `read_memory_base + read_memory_byte * num_bytes + utf16_decoding_base + utf16_decoding_byte * num_bytes` /// /// For nul-terminated string: /// `read_memory_base * num_bytes / 2 + read_memory_byte * num_bytes + utf16_decoding_base + utf16_decoding_byte * num_bytes` fn get_utf16_string(&mut self, len: u64, ptr: u64) -> Result<String> { self.gas_counter.pay_base(utf16_decoding_base)?; let mut u16_buffer; let max_len = self.config.limit_config.max_total_log_length.saturating_sub(self.total_log_length); if len != std::u64::MAX { let input = self.memory_get_vec(ptr, len)?; if len % 2 != 0 { return Err(HostError::BadUTF16.into()); } if len > max_len { return Err(HostError::TotalLogLengthExceeded { length: self.total_log_length.saturating_add(len), limit: self.config.limit_config.max_total_log_length, } .into()); } u16_buffer = vec![0u16; len as usize / 2]; byteorder::LittleEndian::read_u16_into(&input, &mut u16_buffer); } else { u16_buffer = vec![]; let limit = max_len / size_of::<u16>() as u64; // Takes 2 bytes each iter for i in 0..=limit { // self.try_fit_mem will check for u64 overflow on the first iteration (i == 0) let start = ptr + i * size_of::<u16>() as u64; let el = self.memory_get_u16(start)?; if el == 0 { break; } if i == limit { return Err(HostError::TotalLogLengthExceeded { length: self .total_log_length .saturating_add(i * size_of::<u16>() as u64) .saturating_add(size_of::<u16>() as u64), limit: self.config.limit_config.max_total_log_length, } .into()); } u16_buffer.push(el); } } self.gas_counter .pay_per_byte(utf16_decoding_byte, u16_buffer.len() as u64 * size_of::<u16>() as u64)?; String::from_utf16(&u16_buffer).map_err(|_| HostError::BadUTF16.into()) } // #################################################### // # Helper functions to prevent code duplication API # // #################################################### /// Checks that the current log number didn't reach the limit yet, so we can add a new message. fn check_can_add_a_log_message(&self) -> Result<()> { if self.logs.len() as u64 >= self.config.limit_config.max_number_logs { Err(HostError::NumberOfLogsExceeded { limit: self.config.limit_config.max_number_logs } .into()) } else { Ok(()) } } /// Adds a given promise to the vector of promises and returns a new promise index. /// Throws `NumberPromisesExceeded` if the total number of promises exceeded the limit. fn checked_push_promise(&mut self, promise: Promise) -> Result<PromiseIndex> { let new_promise_idx = self.promises.len() as PromiseIndex; self.promises.push(promise); if self.promises.len() as u64 > self.config.limit_config.max_promises_per_function_call_action { Err(HostError::NumberPromisesExceeded { number_of_promises: self.promises.len() as u64, limit: self.config.limit_config.max_promises_per_function_call_action, } .into()) } else { Ok(new_promise_idx) } } fn checked_push_log(&mut self, message: String) -> Result<()> { // The size of logged data can't be too large. No overflow. self.total_log_length += message.len() as u64; if self.total_log_length > self.config.limit_config.max_total_log_length { return Err(HostError::TotalLogLengthExceeded { length: self.total_log_length, limit: self.config.limit_config.max_total_log_length, } .into()); } self.logs.push(message); Ok(()) } // ############### // # Context API # // ############### /// Saves the account id of the current contract that we execute into the register. /// /// # Errors /// /// If the registers exceed the memory limit returns `MemoryAccessViolation`. /// /// # Cost /// /// `base + write_register_base + write_register_byte * num_bytes` pub fn current_account_id(&mut self, register_id: u64) -> Result<()> { self.gas_counter.pay_base(base)?; self.internal_write_register( register_id, self.context.current_account_id.as_bytes().to_vec(), ) } /// All contract calls are a result of some transaction that was signed by some account using /// some access key and submitted into a memory pool (either through the wallet using RPC or by /// a node itself). This function returns the id of that account. Saves the bytes of the signer /// account id into the register. /// /// # Errors /// /// * If the registers exceed the memory limit returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `base + write_register_base + write_register_byte * num_bytes` pub fn signer_account_id(&mut self, register_id: u64) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "signer_account_id".to_string(), } .into()); } self.internal_write_register( register_id, self.context.signer_account_id.as_bytes().to_vec(), ) } /// Saves the public key fo the access key that was used by the signer into the register. In /// rare situations smart contract might want to know the exact access key that was used to send /// the original transaction, e.g. to increase the allowance or manipulate with the public key. /// /// # Errors /// /// * If the registers exceed the memory limit returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `base + write_register_base + write_register_byte * num_bytes` pub fn signer_account_pk(&mut self, register_id: u64) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "signer_account_pk".to_string(), } .into()); } self.internal_write_register(register_id, self.context.signer_account_pk.clone()) } /// All contract calls are a result of a receipt, this receipt might be created by a transaction /// that does function invocation on the contract or another contract as a result of /// cross-contract call. Saves the bytes of the predecessor account id into the register. /// /// # Errors /// /// * If the registers exceed the memory limit returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `base + write_register_base + write_register_byte * num_bytes` pub fn predecessor_account_id(&mut self, register_id: u64) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "predecessor_account_id".to_string(), } .into()); } self.internal_write_register( register_id, self.context.predecessor_account_id.as_bytes().to_vec(), ) } /// Reads input to the contract call into the register. Input is expected to be in JSON-format. /// If input is provided saves the bytes (potentially zero) of input into register. If input is /// not provided writes 0 bytes into the register. /// /// # Cost /// /// `base + write_register_base + write_register_byte * num_bytes` pub fn input(&mut self, register_id: u64) -> Result<()> { self.gas_counter.pay_base(base)?; self.internal_write_register(register_id, self.context.input.clone()) } /// Returns the current block height. /// /// # Cost /// /// `base` // TODO #1903 rename to `block_height` pub fn block_index(&mut self) -> Result<u64> { self.gas_counter.pay_base(base)?; Ok(self.context.block_index) } /// Returns the current block timestamp (number of non-leap-nanoseconds since January 1, 1970 0:00:00 UTC). /// /// # Cost /// /// `base` pub fn block_timestamp(&mut self) -> Result<u64> { self.gas_counter.pay_base(base)?; Ok(self.context.block_timestamp) } /// Returns the current epoch height. /// /// # Cost /// /// `base` pub fn epoch_height(&mut self) -> Result<EpochHeight> { self.gas_counter.pay_base(base)?; Ok(self.context.epoch_height) } /// Get the stake of an account, if the account is currently a validator. Otherwise returns 0. /// writes the value into the` u128` variable pointed by `stake_ptr`. /// /// # Cost /// /// `base + memory_write_base + memory_write_size * 16 + utf8_decoding_base + utf8_decoding_byte * account_id_len + validator_stake_base`. pub fn validator_stake( &mut self, account_id_len: u64, account_id_ptr: u64, stake_ptr: u64, ) -> Result<()> { self.gas_counter.pay_base(base)?; let account_id = self.read_and_parse_account_id(account_id_ptr, account_id_len)?; self.gas_counter.pay_base(validator_stake_base)?; let balance = self.ext.validator_stake(&account_id)?.unwrap_or_default(); self.memory_set_u128(stake_ptr, balance) } /// Get the total validator stake of the current epoch. /// Write the u128 value into `stake_ptr`. /// writes the value into the` u128` variable pointed by `stake_ptr`. /// /// # Cost /// /// `base + memory_write_base + memory_write_size * 16 + validator_total_stake_base` pub fn validator_total_stake(&mut self, stake_ptr: u64) -> Result<()> { self.gas_counter.pay_base(base)?; self.gas_counter.pay_base(validator_total_stake_base)?; let total_stake = self.ext.validator_total_stake()?; self.memory_set_u128(stake_ptr, total_stake) } /// Returns the number of bytes used by the contract if it was saved to the trie as of the /// invocation. This includes: /// * The data written with storage_* functions during current and previous execution; /// * The bytes needed to store the access keys of the given account. /// * The contract code size /// * A small fixed overhead for account metadata. /// /// # Cost /// /// `base` pub fn storage_usage(&mut self) -> Result<StorageUsage> { self.gas_counter.pay_base(base)?; Ok(self.current_storage_usage) } // ################# // # Economics API # // ################# /// The current balance of the given account. This includes the attached_deposit that was /// attached to the transaction. /// /// # Cost /// /// `base + memory_write_base + memory_write_size * 16` pub fn account_balance(&mut self, balance_ptr: u64) -> Result<()> { self.gas_counter.pay_base(base)?; self.memory_set_u128(balance_ptr, self.current_account_balance) } /// The current amount of tokens locked due to staking. /// /// # Cost /// /// `base + memory_write_base + memory_write_size * 16` pub fn account_locked_balance(&mut self, balance_ptr: u64) -> Result<()> { self.gas_counter.pay_base(base)?; self.memory_set_u128(balance_ptr, self.current_account_locked_balance) } /// The balance that was attached to the call that will be immediately deposited before the /// contract execution starts. /// /// # Errors /// /// If called as view function returns `ProhibitedInView``. /// /// # Cost /// /// `base + memory_write_base + memory_write_size * 16` pub fn attached_deposit(&mut self, balance_ptr: u64) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "attached_deposit".to_string(), } .into()); } self.memory_set_u128(balance_ptr, self.context.attached_deposit) } /// The amount of gas attached to the call that can be used to pay for the gas fees. /// /// # Errors /// /// If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `base` pub fn prepaid_gas(&mut self) -> Result<Gas> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err( HostError::ProhibitedInView { method_name: "prepaid_gas".to_string() }.into() ); } Ok(self.context.prepaid_gas) } /// The gas that was already burnt during the contract execution (cannot exceed `prepaid_gas`) /// /// # Errors /// /// If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `base` pub fn used_gas(&mut self) -> Result<Gas> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "used_gas".to_string() }.into()); } Ok(self.gas_counter.used_gas()) } // ############ // # Math API # // ############ /// Writes random seed into the register. /// /// # Errors /// /// If the size of the registers exceed the set limit `MemoryAccessViolation`. /// /// # Cost /// /// `base + write_register_base + write_register_byte * num_bytes`. pub fn random_seed(&mut self, register_id: u64) -> Result<()> { self.gas_counter.pay_base(base)?; self.internal_write_register(register_id, self.context.random_seed.clone()) } /// Hashes the given value using sha256 and returns it into `register_id`. /// /// # Errors /// /// If `value_len + value_ptr` points outside the memory or the registers use more memory than /// the limit with `MemoryAccessViolation`. /// /// # Cost /// /// `base + write_register_base + write_register_byte * num_bytes + sha256_base + sha256_byte * num_bytes` pub fn sha256(&mut self, value_len: u64, value_ptr: u64, register_id: u64) -> Result<()> { self.gas_counter.pay_base(sha256_base)?; let value = self.get_vec_from_memory_or_register(value_ptr, value_len)?; self.gas_counter.pay_per_byte(sha256_byte, value.len() as u64)?; use sha2::Digest; let value_hash = sha2::Sha256::digest(&value); self.internal_write_register(register_id, value_hash.as_ref().to_vec()) } /// Hashes the given value using keccak256 and returns it into `register_id`. /// /// # Errors /// /// If `value_len + value_ptr` points outside the memory or the registers use more memory than /// the limit with `MemoryAccessViolation`. /// /// # Cost /// /// `base + write_register_base + write_register_byte * num_bytes + keccak256_base + keccak256_byte * num_bytes` pub fn keccak256(&mut self, value_len: u64, value_ptr: u64, register_id: u64) -> Result<()> { self.gas_counter.pay_base(keccak256_base)?; let value = self.get_vec_from_memory_or_register(value_ptr, value_len)?; self.gas_counter.pay_per_byte(keccak256_byte, value.len() as u64)?; use sha3::Digest; let value_hash = sha3::Keccak256::digest(&value); self.internal_write_register(register_id, value_hash.as_ref().to_vec()) } /// Hashes the given value using keccak512 and returns it into `register_id`. /// /// # Errors /// /// If `value_len + value_ptr` points outside the memory or the registers use more memory than /// the limit with `MemoryAccessViolation`. /// /// # Cost /// /// `base + write_register_base + write_register_byte * num_bytes + keccak512_base + keccak512_byte * num_bytes` pub fn keccak512(&mut self, value_len: u64, value_ptr: u64, register_id: u64) -> Result<()> { self.gas_counter.pay_base(keccak512_base)?; let value = self.get_vec_from_memory_or_register(value_ptr, value_len)?; self.gas_counter.pay_per_byte(keccak512_byte, value.len() as u64)?; use sha3::Digest; let value_hash = sha3::Keccak512::digest(&value); self.internal_write_register(register_id, value_hash.as_ref().to_vec()) } /// Called by gas metering injected into Wasm. Counts both towards `burnt_gas` and `used_gas`. /// /// # Errors /// /// * If passed gas amount somehow overflows internal gas counters returns `IntegerOverflow`; /// * If we exceed usage limit imposed on burnt gas returns `GasLimitExceeded`; /// * If we exceed the `prepaid_gas` then returns `GasExceeded`. pub fn gas(&mut self, gas_amount: u32) -> Result<()> { let value = Gas::from(gas_amount) * Gas::from(self.config.regular_op_cost); self.gas_counter.pay_wasm_gas(value) } // ################ // # Promises API # // ################ /// A helper function to pay gas fee for creating a new receipt without actions. /// # Args: /// * `sir`: whether contract call is addressed to itself; /// * `data_dependencies`: other contracts that this execution will be waiting on (or rather /// their data receipts), where bool indicates whether this is sender=receiver communication. /// /// # Cost /// /// This is a convenience function that encapsulates several costs: /// `burnt_gas := dispatch cost of the receipt + base dispatch cost cost of the data receipt` /// `used_gas := burnt_gas + exec cost of the receipt + base exec cost cost of the data receipt` /// Notice that we prepay all base cost upon the creation of the data dependency, we are going to /// pay for the content transmitted through the dependency upon the actual creation of the /// DataReceipt. fn pay_gas_for_new_receipt(&mut self, sir: bool, data_dependencies: &[bool]) -> Result<()> { let fees_config_cfg = &self.fees_config; let mut burn_gas = fees_config_cfg.action_receipt_creation_config.send_fee(sir); let mut use_gas = fees_config_cfg.action_receipt_creation_config.exec_fee(); for dep in data_dependencies { // Both creation and execution for data receipts are considered burnt gas. burn_gas = burn_gas .checked_add(fees_config_cfg.data_receipt_creation_config.base_cost.send_fee(*dep)) .ok_or(HostError::IntegerOverflow)? .checked_add(fees_config_cfg.data_receipt_creation_config.base_cost.exec_fee()) .ok_or(HostError::IntegerOverflow)?; } use_gas = use_gas.checked_add(burn_gas).ok_or(HostError::IntegerOverflow)?; self.gas_counter.pay_action_accumulated(burn_gas, use_gas, ActionCosts::new_receipt) } /// A helper function to subtract balance on transfer or attached deposit for promises. /// # Args: /// * `amount`: the amount to deduct from the current account balance. fn deduct_balance(&mut self, amount: Balance) -> Result<()> { self.current_account_balance = self.current_account_balance.checked_sub(amount).ok_or(HostError::BalanceExceeded)?; Ok(()) } /// Creates a promise that will execute a method on account with given arguments and attaches /// the given amount and gas. `amount_ptr` point to slices of bytes representing `u128`. /// /// # Errors /// /// * If `account_id_len + account_id_ptr` or `method_name_len + method_name_ptr` or /// `arguments_len + arguments_ptr` or `amount_ptr + 16` points outside the memory of the guest /// or host returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Returns /// /// Index of the new promise that uniquely identifies it within the current execution of the /// method. /// /// # Cost /// /// Since `promise_create` is a convenience wrapper around `promise_batch_create` and /// `promise_batch_action_function_call`. This also means it charges `base` cost twice. pub fn promise_create( &mut self, account_id_len: u64, account_id_ptr: u64, method_name_len: u64, method_name_ptr: u64, arguments_len: u64, arguments_ptr: u64, amount_ptr: u64, gas: Gas, ) -> Result<u64> { let new_promise_idx = self.promise_batch_create(account_id_len, account_id_ptr)?; self.promise_batch_action_function_call( new_promise_idx, method_name_len, method_name_ptr, arguments_len, arguments_ptr, amount_ptr, gas, )?; Ok(new_promise_idx) } /// Attaches the callback that is executed after promise pointed by `promise_idx` is complete. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`; /// * If `account_id_len + account_id_ptr` or `method_name_len + method_name_ptr` or /// `arguments_len + arguments_ptr` or `amount_ptr + 16` points outside the memory of the /// guest or host returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Returns /// /// Index of the new promise that uniquely identifies it within the current execution of the /// method. /// /// # Cost /// /// Since `promise_create` is a convenience wrapper around `promise_batch_then` and /// `promise_batch_action_function_call`. This also means it charges `base` cost twice. pub fn promise_then( &mut self, promise_idx: u64, account_id_len: u64, account_id_ptr: u64, method_name_len: u64, method_name_ptr: u64, arguments_len: u64, arguments_ptr: u64, amount_ptr: u64, gas: u64, ) -> Result<u64> { let new_promise_idx = self.promise_batch_then(promise_idx, account_id_len, account_id_ptr)?; self.promise_batch_action_function_call( new_promise_idx, method_name_len, method_name_ptr, arguments_len, arguments_ptr, amount_ptr, gas, )?; Ok(new_promise_idx) } /// Creates a new promise which completes when time all promises passed as arguments complete. /// Cannot be used with registers. `promise_idx_ptr` points to an array of `u64` elements, with /// `promise_idx_count` denoting the number of elements. The array contains indices of promises /// that need to be waited on jointly. /// /// # Errors /// /// * If `promise_ids_ptr + 8 * promise_idx_count` extend outside the guest memory returns /// `MemoryAccessViolation`; /// * If any of the promises in the array do not correspond to existing promises returns /// `InvalidPromiseIndex`. /// * If called as view function returns `ProhibitedInView`. /// * If the total number of receipt dependencies exceeds `max_number_input_data_dependencies` /// limit returns `NumInputDataDependenciesExceeded`. /// * If the total number of promises exceeds `max_promises_per_function_call_action` limit /// returns `NumPromisesExceeded`. /// /// # Returns /// /// Index of the new promise that uniquely identifies it within the current execution of the /// method. /// /// # Cost /// /// `base + promise_and_base + promise_and_per_promise * num_promises + cost of reading promise ids from memory`. pub fn promise_and( &mut self, promise_idx_ptr: u64, promise_idx_count: u64, ) -> Result<PromiseIndex> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err( HostError::ProhibitedInView { method_name: "promise_and".to_string() }.into() ); } self.gas_counter.pay_base(promise_and_base)?; self.gas_counter.pay_per_byte( promise_and_per_promise, promise_idx_count .checked_mul(size_of::<u64>() as u64) .ok_or(HostError::IntegerOverflow)?, )?; let promise_indices = self.memory_get_vec_u64(promise_idx_ptr, promise_idx_count)?; let mut receipt_dependencies = vec![]; for promise_idx in &promise_indices { let promise = self .promises .get(*promise_idx as usize) .ok_or(HostError::InvalidPromiseIndex { promise_idx: *promise_idx })?; match &promise { Promise::Receipt(receipt_idx) => { receipt_dependencies.push(*receipt_idx); } Promise::NotReceipt(receipt_indices) => { receipt_dependencies.extend(receipt_indices.clone()); } } // Checking this in the loop to prevent abuse of too many joined vectors. if receipt_dependencies.len() as u64 > self.config.limit_config.max_number_input_data_dependencies { return Err(HostError::NumberInputDataDependenciesExceeded { number_of_input_data_dependencies: receipt_dependencies.len() as u64, limit: self.config.limit_config.max_number_input_data_dependencies, } .into()); } } self.checked_push_promise(Promise::NotReceipt(receipt_dependencies)) } /// Creates a new promise towards given `account_id` without any actions attached to it. /// /// # Errors /// /// * If `account_id_len + account_id_ptr` points outside the memory of the guest or host /// returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// * If the total number of promises exceeds `max_promises_per_function_call_action` limit /// returns `NumPromisesExceeded`. /// /// # Returns /// /// Index of the new promise that uniquely identifies it within the current execution of the /// method. /// /// # Cost /// /// `burnt_gas := base + cost of reading and decoding the account id + dispatch cost of the receipt`. /// `used_gas := burnt_gas + exec cost of the receipt`. pub fn promise_batch_create( &mut self, account_id_len: u64, account_id_ptr: u64, ) -> Result<u64> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_batch_create".to_string(), } .into()); } let account_id = self.read_and_parse_account_id(account_id_ptr, account_id_len)?; let sir = account_id == self.context.current_account_id; self.pay_gas_for_new_receipt(sir, &[])?; let new_receipt_idx = self.ext.create_receipt(vec![], account_id.clone())?; self.receipt_to_account.insert(new_receipt_idx, account_id); self.checked_push_promise(Promise::Receipt(new_receipt_idx)) } /// Creates a new promise towards given `account_id` without any actions attached, that is /// executed after promise pointed by `promise_idx` is complete. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`; /// * If `account_id_len + account_id_ptr` points outside the memory of the guest or host /// returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// * If the total number of promises exceeds `max_promises_per_function_call_action` limit /// returns `NumPromisesExceeded`. /// /// # Returns /// /// Index of the new promise that uniquely identifies it within the current execution of the /// method. /// /// # Cost /// /// `base + cost of reading and decoding the account id + dispatch&execution cost of the receipt /// + dispatch&execution base cost for each data dependency` pub fn promise_batch_then( &mut self, promise_idx: u64, account_id_len: u64, account_id_ptr: u64, ) -> Result<u64> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_batch_then".to_string(), } .into()); } let account_id = self.read_and_parse_account_id(account_id_ptr, account_id_len)?; // Update the DAG and return new promise idx. let promise = self .promises .get(promise_idx as usize) .ok_or(HostError::InvalidPromiseIndex { promise_idx })?; let receipt_dependencies = match &promise { Promise::Receipt(receipt_idx) => vec![*receipt_idx], Promise::NotReceipt(receipt_indices) => receipt_indices.clone(), }; let sir = account_id == self.context.current_account_id; let deps: Vec<_> = receipt_dependencies .iter() .map(|receipt_idx| { self.receipt_to_account .get(receipt_idx) .expect("promises and receipt_to_account should be consistent.") == &account_id }) .collect(); self.pay_gas_for_new_receipt(sir, &deps)?; let new_receipt_idx = self.ext.create_receipt(receipt_dependencies, account_id.clone())?; self.receipt_to_account.insert(new_receipt_idx, account_id); self.checked_push_promise(Promise::Receipt(new_receipt_idx)) } /// Helper function to return the receipt index corresponding to the given promise index. /// It also pulls account ID for the given receipt and compares it with the current account ID /// to return whether the receipt's account ID is the same. fn promise_idx_to_receipt_idx_with_sir( &self, promise_idx: u64, ) -> Result<(ReceiptIndex, bool)> { let promise = self .promises .get(promise_idx as usize) .ok_or(HostError::InvalidPromiseIndex { promise_idx })?; let receipt_idx = match &promise { Promise::Receipt(receipt_idx) => Ok(*receipt_idx), Promise::NotReceipt(_) => Err(HostError::CannotAppendActionToJointPromise), }?; let account_id = self .receipt_to_account .get(&receipt_idx) .expect("promises and receipt_to_account should be consistent."); let sir = account_id == &self.context.current_account_id; Ok((receipt_idx, sir)) } /// Appends `CreateAccount` action to the batch of actions for the given promise pointed by /// `promise_idx`. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`. /// * If the promise pointed by the `promise_idx` is an ephemeral promise created by /// `promise_and` returns `CannotAppendActionToJointPromise`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `burnt_gas := base + dispatch action fee` /// `used_gas := burnt_gas + exec action fee` pub fn promise_batch_action_create_account(&mut self, promise_idx: u64) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_batch_action_create_account".to_string(), } .into()); } let (receipt_idx, sir) = self.promise_idx_to_receipt_idx_with_sir(promise_idx)?; self.gas_counter.pay_action_base( &self.fees_config.action_creation_config.create_account_cost, sir, ActionCosts::create_account, )?; self.ext.append_action_create_account(receipt_idx)?; Ok(()) } /// Appends `DeployContract` action to the batch of actions for the given promise pointed by /// `promise_idx`. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`. /// * If the promise pointed by the `promise_idx` is an ephemeral promise created by /// `promise_and` returns `CannotAppendActionToJointPromise`. /// * If `code_len + code_ptr` points outside the memory of the guest or host returns /// `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// * If the contract code length exceeds `max_contract_size` returns `ContractSizeExceeded`. /// /// # Cost /// /// `burnt_gas := base + dispatch action base fee + dispatch action per byte fee * num bytes + cost of reading vector from memory ` /// `used_gas := burnt_gas + exec action base fee + exec action per byte fee * num bytes` pub fn promise_batch_action_deploy_contract( &mut self, promise_idx: u64, code_len: u64, code_ptr: u64, ) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_batch_action_deploy_contract".to_string(), } .into()); } let code = self.get_vec_from_memory_or_register(code_ptr, code_len)?; if code.len() as u64 > self.config.limit_config.max_contract_size { return Err(HostError::ContractSizeExceeded { size: code.len() as u64, limit: self.config.limit_config.max_contract_size, } .into()); } let (receipt_idx, sir) = self.promise_idx_to_receipt_idx_with_sir(promise_idx)?; let num_bytes = code.len() as u64; self.gas_counter.pay_action_base( &self.fees_config.action_creation_config.deploy_contract_cost, sir, ActionCosts::deploy_contract, )?; self.gas_counter.pay_action_per_byte( &self.fees_config.action_creation_config.deploy_contract_cost_per_byte, num_bytes, sir, ActionCosts::deploy_contract, )?; self.ext.append_action_deploy_contract(receipt_idx, code)?; Ok(()) } /// Appends `FunctionCall` action to the batch of actions for the given promise pointed by /// `promise_idx`. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`. /// * If the promise pointed by the `promise_idx` is an ephemeral promise created by /// `promise_and` returns `CannotAppendActionToJointPromise`. /// * If `method_name_len + method_name_ptr` or `arguments_len + arguments_ptr` or /// `amount_ptr + 16` points outside the memory of the guest or host returns /// `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `burnt_gas := base + dispatch action base fee + dispatch action per byte fee * num bytes + cost of reading vector from memory /// + cost of reading u128, method_name and arguments from the memory` /// `used_gas := burnt_gas + exec action base fee + exec action per byte fee * num bytes` pub fn promise_batch_action_function_call( &mut self, promise_idx: u64, method_name_len: u64, method_name_ptr: u64, arguments_len: u64, arguments_ptr: u64, amount_ptr: u64, gas: Gas, ) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_batch_action_function_call".to_string(), } .into()); } let amount = self.memory_get_u128(amount_ptr)?; let method_name = self.get_vec_from_memory_or_register(method_name_ptr, method_name_len)?; if method_name.is_empty() { return Err(HostError::EmptyMethodName.into()); } let arguments = self.get_vec_from_memory_or_register(arguments_ptr, arguments_len)?; let (receipt_idx, sir) = self.promise_idx_to_receipt_idx_with_sir(promise_idx)?; // Input can't be large enough to overflow let num_bytes = method_name.len() as u64 + arguments.len() as u64; self.gas_counter.pay_action_base( &self.fees_config.action_creation_config.function_call_cost, sir, ActionCosts::function_call, )?; self.gas_counter.pay_action_per_byte( &self.fees_config.action_creation_config.function_call_cost_per_byte, num_bytes, sir, ActionCosts::function_call, )?; // Prepaid gas self.gas_counter.prepay_gas(gas)?; self.deduct_balance(amount)?; self.ext.append_action_function_call(receipt_idx, method_name, arguments, amount, gas)?; Ok(()) } /// Appends `Transfer` action to the batch of actions for the given promise pointed by /// `promise_idx`. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`. /// * If the promise pointed by the `promise_idx` is an ephemeral promise created by /// `promise_and` returns `CannotAppendActionToJointPromise`. /// * If `amount_ptr + 16` points outside the memory of the guest or host returns /// `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `burnt_gas := base + dispatch action base fee + dispatch action per byte fee * num bytes + cost of reading u128 from memory ` /// `used_gas := burnt_gas + exec action base fee + exec action per byte fee * num bytes` pub fn promise_batch_action_transfer( &mut self, promise_idx: u64, amount_ptr: u64, ) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_batch_action_transfer".to_string(), } .into()); } let amount = self.memory_get_u128(amount_ptr)?; let (receipt_idx, sir) = self.promise_idx_to_receipt_idx_with_sir(promise_idx)?; if self.current_protocol_version >= IMPLICIT_ACCOUNT_CREATION_PROTOCOL_VERSION { // Need to check if the receiver_id can be an implicit account. let account_id = self .receipt_to_account .get(&receipt_idx) .expect("promises and receipt_to_account should be consistent."); if is_account_id_64_len_hex(&account_id) { self.gas_counter.pay_action_base( &self.fees_config.action_creation_config.create_account_cost, sir, ActionCosts::transfer, )?; self.gas_counter.pay_action_base( &self.fees_config.action_creation_config.add_key_cost.full_access_cost, sir, ActionCosts::transfer, )?; } } self.gas_counter.pay_action_base( &self.fees_config.action_creation_config.transfer_cost, sir, ActionCosts::transfer, )?; self.deduct_balance(amount)?; self.ext.append_action_transfer(receipt_idx, amount)?; Ok(()) } /// Appends `Stake` action to the batch of actions for the given promise pointed by /// `promise_idx`. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`. /// * If the promise pointed by the `promise_idx` is an ephemeral promise created by /// `promise_and` returns `CannotAppendActionToJointPromise`. /// * If the given public key is not a valid (e.g. wrong length) returns `InvalidPublicKey`. /// * If `amount_ptr + 16` or `public_key_len + public_key_ptr` points outside the memory of the /// guest or host returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `burnt_gas := base + dispatch action base fee + dispatch action per byte fee * num bytes + cost of reading public key from memory ` /// `used_gas := burnt_gas + exec action base fee + exec action per byte fee * num bytes` pub fn promise_batch_action_stake( &mut self, promise_idx: u64, amount_ptr: u64, public_key_len: u64, public_key_ptr: u64, ) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_batch_action_stake".to_string(), } .into()); } let amount = self.memory_get_u128(amount_ptr)?; let public_key = self.get_vec_from_memory_or_register(public_key_ptr, public_key_len)?; let (receipt_idx, sir) = self.promise_idx_to_receipt_idx_with_sir(promise_idx)?; self.gas_counter.pay_action_base( &self.fees_config.action_creation_config.stake_cost, sir, ActionCosts::stake, )?; self.ext.append_action_stake(receipt_idx, amount, public_key)?; Ok(()) } /// Appends `AddKey` action to the batch of actions for the given promise pointed by /// `promise_idx`. The access key will have `FullAccess` permission. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`. /// * If the promise pointed by the `promise_idx` is an ephemeral promise created by /// `promise_and` returns `CannotAppendActionToJointPromise`. /// * If the given public key is not a valid (e.g. wrong length) returns `InvalidPublicKey`. /// * If `public_key_len + public_key_ptr` points outside the memory of the guest or host /// returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `burnt_gas := base + dispatch action base fee + dispatch action per byte fee * num bytes + cost of reading public key from memory ` /// `used_gas := burnt_gas + exec action base fee + exec action per byte fee * num bytes` pub fn promise_batch_action_add_key_with_full_access( &mut self, promise_idx: u64, public_key_len: u64, public_key_ptr: u64, nonce: u64, ) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_batch_action_add_key_with_full_access".to_string(), } .into()); } let public_key = self.get_vec_from_memory_or_register(public_key_ptr, public_key_len)?; let (receipt_idx, sir) = self.promise_idx_to_receipt_idx_with_sir(promise_idx)?; self.gas_counter.pay_action_base( &self.fees_config.action_creation_config.add_key_cost.full_access_cost, sir, ActionCosts::add_key, )?; self.ext.append_action_add_key_with_full_access(receipt_idx, public_key, nonce)?; Ok(()) } /// Appends `AddKey` action to the batch of actions for the given promise pointed by /// `promise_idx`. The access key will have `FunctionCall` permission. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`. /// * If the promise pointed by the `promise_idx` is an ephemeral promise created by /// `promise_and` returns `CannotAppendActionToJointPromise`. /// * If the given public key is not a valid (e.g. wrong length) returns `InvalidPublicKey`. /// * If `public_key_len + public_key_ptr`, `allowance_ptr + 16`, /// `receiver_id_len + receiver_id_ptr` or `method_names_len + method_names_ptr` points outside /// the memory of the guest or host returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `burnt_gas := base + dispatch action base fee + dispatch action per byte fee * num bytes + cost of reading vector from memory /// + cost of reading u128, method_names and public key from the memory + cost of reading and parsing account name` /// `used_gas := burnt_gas + exec action base fee + exec action per byte fee * num bytes` pub fn promise_batch_action_add_key_with_function_call( &mut self, promise_idx: u64, public_key_len: u64, public_key_ptr: u64, nonce: u64, allowance_ptr: u64, receiver_id_len: u64, receiver_id_ptr: u64, method_names_len: u64, method_names_ptr: u64, ) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_batch_action_add_key_with_function_call".to_string(), } .into()); } let public_key = self.get_vec_from_memory_or_register(public_key_ptr, public_key_len)?; let allowance = self.memory_get_u128(allowance_ptr)?; let allowance = if allowance > 0 { Some(allowance) } else { None }; let receiver_id = self.read_and_parse_account_id(receiver_id_ptr, receiver_id_len)?; let raw_method_names = self.get_vec_from_memory_or_register(method_names_ptr, method_names_len)?; let method_names = split_method_names(&raw_method_names)?; let (receipt_idx, sir) = self.promise_idx_to_receipt_idx_with_sir(promise_idx)?; // +1 is to account for null-terminating characters. let num_bytes = method_names.iter().map(|v| v.len() as u64 + 1).sum::<u64>(); self.gas_counter.pay_action_base( &self.fees_config.action_creation_config.add_key_cost.function_call_cost, sir, ActionCosts::function_call, )?; self.gas_counter.pay_action_per_byte( &self.fees_config.action_creation_config.add_key_cost.function_call_cost_per_byte, num_bytes, sir, ActionCosts::function_call, )?; self.ext.append_action_add_key_with_function_call( receipt_idx, public_key, nonce, allowance, receiver_id, method_names, )?; Ok(()) } /// Appends `DeleteKey` action to the batch of actions for the given promise pointed by /// `promise_idx`. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`. /// * If the promise pointed by the `promise_idx` is an ephemeral promise created by /// `promise_and` returns `CannotAppendActionToJointPromise`. /// * If the given public key is not a valid (e.g. wrong length) returns `InvalidPublicKey`. /// * If `public_key_len + public_key_ptr` points outside the memory of the guest or host /// returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `burnt_gas := base + dispatch action base fee + dispatch action per byte fee * num bytes + cost of reading public key from memory ` /// `used_gas := burnt_gas + exec action base fee + exec action per byte fee * num bytes` pub fn promise_batch_action_delete_key( &mut self, promise_idx: u64, public_key_len: u64, public_key_ptr: u64, ) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_batch_action_delete_key".to_string(), } .into()); } let public_key = self.get_vec_from_memory_or_register(public_key_ptr, public_key_len)?; let (receipt_idx, sir) = self.promise_idx_to_receipt_idx_with_sir(promise_idx)?; self.gas_counter.pay_action_base( &self.fees_config.action_creation_config.delete_key_cost, sir, ActionCosts::delete_key, )?; self.ext.append_action_delete_key(receipt_idx, public_key)?; Ok(()) } /// Appends `DeleteAccount` action to the batch of actions for the given promise pointed by /// `promise_idx`. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`. /// * If the promise pointed by the `promise_idx` is an ephemeral promise created by /// `promise_and` returns `CannotAppendActionToJointPromise`. /// * If `beneficiary_id_len + beneficiary_id_ptr` points outside the memory of the guest or /// host returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `burnt_gas := base + dispatch action base fee + dispatch action per byte fee * num bytes + cost of reading and parsing account id from memory ` /// `used_gas := burnt_gas + exec action base fee + exec action per byte fee * num bytes` pub fn promise_batch_action_delete_account( &mut self, promise_idx: u64, beneficiary_id_len: u64, beneficiary_id_ptr: u64, ) -> Result<()> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_batch_action_delete_account".to_string(), } .into()); } let beneficiary_id = self.read_and_parse_account_id(beneficiary_id_ptr, beneficiary_id_len)?; let (receipt_idx, sir) = self.promise_idx_to_receipt_idx_with_sir(promise_idx)?; self.gas_counter.pay_action_base( &self.fees_config.action_creation_config.delete_account_cost, sir, ActionCosts::delete_account, )?; self.ext.append_action_delete_account(receipt_idx, beneficiary_id)?; Ok(()) } /// If the current function is invoked by a callback we can access the execution results of the /// promises that caused the callback. This function returns the number of complete and /// incomplete callbacks. /// /// Note, we are only going to have incomplete callbacks once we have promise_or combinator. /// /// /// * If there is only one callback returns `1`; /// * If there are multiple callbacks (e.g. created through `promise_and`) returns their number; /// * If the function was called not through the callback returns `0`. /// /// # Cost /// /// `base` pub fn promise_results_count(&mut self) -> Result<u64> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err(HostError::ProhibitedInView { method_name: "promise_results_count".to_string(), } .into()); } Ok(self.promise_results.len() as _) } /// If the current function is invoked by a callback we can access the execution results of the /// promises that caused the callback. This function returns the result in blob format and /// places it into the register. /// /// * If promise result is complete and successful copies its blob into the register; /// * If promise result is complete and failed or incomplete keeps register unused; /// /// # Returns /// /// * If promise result is not complete returns `0`; /// * If promise result is complete and successful returns `1`; /// * If promise result is complete and failed returns `2`. /// /// # Errors /// /// * If `result_id` does not correspond to an existing result returns `InvalidPromiseResultIndex`; /// * If copying the blob exhausts the memory limit it returns `MemoryAccessViolation`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `base + cost of writing data into a register` pub fn promise_result(&mut self, result_idx: u64, register_id: u64) -> Result<u64> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err( HostError::ProhibitedInView { method_name: "promise_result".to_string() }.into() ); } match self .promise_results .get(result_idx as usize) .ok_or(HostError::InvalidPromiseResultIndex { result_idx })? { PromiseResult::NotReady => Ok(0), PromiseResult::Successful(data) => { self.internal_write_register(register_id, data.clone())?; Ok(1) } PromiseResult::Failed => Ok(2), } } /// When promise `promise_idx` finishes executing its result is considered to be the result of /// the current function. /// /// # Errors /// /// * If `promise_idx` does not correspond to an existing promise returns `InvalidPromiseIndex`. /// * If called as view function returns `ProhibitedInView`. /// /// # Cost /// /// `base + promise_return` pub fn promise_return(&mut self, promise_idx: u64) -> Result<()> { self.gas_counter.pay_base(base)?; self.gas_counter.pay_base(promise_return)?; if self.context.is_view { return Err( HostError::ProhibitedInView { method_name: "promise_return".to_string() }.into() ); } match self .promises .get(promise_idx as usize) .ok_or(HostError::InvalidPromiseIndex { promise_idx })? { Promise::Receipt(receipt_idx) => { self.return_data = ReturnData::ReceiptIndex(*receipt_idx); Ok(()) } Promise::NotReceipt(_) => Err(HostError::CannotReturnJointPromise.into()), } } // ##################### // # Miscellaneous API # // ##################### /// Sets the blob of data as the return value of the contract. /// /// # Errors /// /// * If `value_len + value_ptr` exceeds the memory container or points to an unused register it /// returns `MemoryAccessViolation`. /// * if the length of the returned data exceeds `max_length_returned_data` returns /// `ReturnedValueLengthExceeded`. /// /// # Cost /// `base + cost of reading return value from memory or register + dispatch&exec cost per byte of the data sent * num data receivers` pub fn value_return(&mut self, value_len: u64, value_ptr: u64) -> Result<()> { self.gas_counter.pay_base(base)?; let return_val = self.get_vec_from_memory_or_register(value_ptr, value_len)?; let mut burn_gas: Gas = 0; let num_bytes = return_val.len() as u64; if num_bytes > self.config.limit_config.max_length_returned_data { return Err(HostError::ReturnedValueLengthExceeded { length: num_bytes, limit: self.config.limit_config.max_length_returned_data, } .into()); } let data_cfg = &self.fees_config.data_receipt_creation_config; for data_receiver in &self.context.output_data_receivers { let sir = data_receiver == &self.context.current_account_id; // We deduct for execution here too, because if we later have an OR combinator // for promises then we might have some valid data receipts that arrive too late // to be picked up by the execution that waits on them (because it has started // after it receives the first data receipt) and then we need to issue a special // refund in this situation. Which we avoid by just paying for execution of // data receipt that might not be performed. // The gas here is considered burnt, cause we'll prepay for it upfront. burn_gas = burn_gas .checked_add( data_cfg .cost_per_byte .send_fee(sir) .checked_add(data_cfg.cost_per_byte.exec_fee()) .ok_or(HostError::IntegerOverflow)? .checked_mul(num_bytes) .ok_or(HostError::IntegerOverflow)?, ) .ok_or(HostError::IntegerOverflow)?; } self.gas_counter.pay_action_accumulated(burn_gas, burn_gas, ActionCosts::value_return)?; self.return_data = ReturnData::Value(return_val); Ok(()) } /// Terminates the execution of the program with panic `GuestPanic`. /// /// # Cost /// /// `base` pub fn panic(&mut self) -> Result<()> { self.gas_counter.pay_base(base)?; Err(HostError::GuestPanic { panic_msg: "explicit guest panic".to_string() }.into()) } /// Guest panics with the UTF-8 encoded string. /// If `len == u64::MAX` then treats the string as null-terminated with character `'\0'`. /// /// # Errors /// /// * If string extends outside the memory of the guest with `MemoryAccessViolation`; /// * If string is not UTF-8 returns `BadUtf8`. /// * If string is longer than `max_log_len` returns `TotalLogLengthExceeded`. /// /// # Cost /// `base + cost of reading and decoding a utf8 string` pub fn panic_utf8(&mut self, len: u64, ptr: u64) -> Result<()> { self.gas_counter.pay_base(base)?; Err(HostError::GuestPanic { panic_msg: self.get_utf8_string(len, ptr)? }.into()) } /// Logs the UTF-8 encoded string. /// If `len == u64::MAX` then treats the string as null-terminated with character `'\0'`. /// /// # Errors /// /// * If string extends outside the memory of the guest with `MemoryAccessViolation`; /// * If string is not UTF-8 returns `BadUtf8`. /// * If number of bytes read + `total_log_length` exceeds the `max_total_log_length` returns /// `TotalLogLengthExceeded`. /// * If the total number of logs will exceed the `max_number_logs` returns /// `NumberOfLogsExceeded`. /// /// # Cost /// /// `base + log_base + log_byte + num_bytes + utf8 decoding cost` pub fn log_utf8(&mut self, len: u64, ptr: u64) -> Result<()> { self.gas_counter.pay_base(base)?; self.check_can_add_a_log_message()?; let message = self.get_utf8_string(len, ptr)?; self.gas_counter.pay_base(log_base)?; self.gas_counter.pay_per_byte(log_byte, message.len() as u64)?; self.checked_push_log(message) } /// Logs the UTF-16 encoded string. If `len == u64::MAX` then treats the string as /// null-terminated with two-byte sequence of `0x00 0x00`. /// /// # Errors /// /// * If string extends outside the memory of the guest with `MemoryAccessViolation`; /// * If string is not UTF-16 returns `BadUtf16`. /// * If number of bytes read + `total_log_length` exceeds the `max_total_log_length` returns /// `TotalLogLengthExceeded`. /// * If the total number of logs will exceed the `max_number_logs` returns /// `NumberOfLogsExceeded`. /// /// # Cost /// /// `base + log_base + log_byte * num_bytes + utf16 decoding cost` pub fn log_utf16(&mut self, len: u64, ptr: u64) -> Result<()> { self.gas_counter.pay_base(base)?; self.check_can_add_a_log_message()?; let message = self.get_utf16_string(len, ptr)?; self.gas_counter.pay_base(log_base)?; // Let's not use `encode_utf16` for gas per byte here, since it's a lot of compute. self.gas_counter.pay_per_byte(log_byte, message.len() as u64)?; self.checked_push_log(message) } /// Special import kept for compatibility with AssemblyScript contracts. Not called by smart /// contracts directly, but instead called by the code generated by AssemblyScript. /// /// # Errors /// /// * If string extends outside the memory of the guest with `MemoryAccessViolation`; /// * If string is not UTF-8 returns `BadUtf8`. /// * If number of bytes read + `total_log_length` exceeds the `max_total_log_length` returns /// `TotalLogLengthExceeded`. /// * If the total number of logs will exceed the `max_number_logs` returns /// `NumberOfLogsExceeded`. /// /// # Cost /// /// `base + log_base + log_byte * num_bytes + utf16 decoding cost` pub fn abort(&mut self, msg_ptr: u32, filename_ptr: u32, line: u32, col: u32) -> Result<()> { self.gas_counter.pay_base(base)?; if msg_ptr < 4 || filename_ptr < 4 { return Err(HostError::BadUTF16.into()); } self.check_can_add_a_log_message()?; // Underflow checked above. let msg_len = self.memory_get_u32((msg_ptr - 4) as u64)?; let filename_len = self.memory_get_u32((filename_ptr - 4) as u64)?; let msg = self.get_utf16_string(msg_len as u64, msg_ptr as u64)?; let filename = self.get_utf16_string(filename_len as u64, filename_ptr as u64)?; let message = format!("{}, filename: \"{}\" line: {} col: {}", msg, filename, line, col); self.gas_counter.pay_base(log_base)?; self.gas_counter.pay_per_byte(log_byte, message.as_bytes().len() as u64)?; self.checked_push_log(format!("ABORT: {}", message))?; Err(HostError::GuestPanic { panic_msg: message }.into()) } // ############### // # Storage API # // ############### /// Reads account id from the given location in memory. /// /// # Errors /// /// * If account is not UTF-8 encoded then returns `BadUtf8`; /// /// # Cost /// /// This is a helper function that encapsulates the following costs: /// cost of reading buffer from register or memory, /// `utf8_decoding_base + utf8_decoding_byte * num_bytes`. fn read_and_parse_account_id(&mut self, ptr: u64, len: u64) -> Result<AccountId> { let buf = self.get_vec_from_memory_or_register(ptr, len)?; self.gas_counter.pay_base(utf8_decoding_base)?; self.gas_counter.pay_per_byte(utf8_decoding_byte, buf.len() as u64)?; let account_id = AccountId::from_utf8(buf).map_err(|_| HostError::BadUTF8)?; Ok(account_id) } /// Writes key-value into storage. /// * If key is not in use it inserts the key-value pair and does not modify the register. Returns `0`; /// * If key is in use it inserts the key-value and copies the old value into the `register_id`. Returns `1`. /// /// # Errors /// /// * If `key_len + key_ptr` or `value_len + value_ptr` exceeds the memory container or points /// to an unused register it returns `MemoryAccessViolation`; /// * If returning the preempted value into the registers exceed the memory container it returns /// `MemoryAccessViolation`. /// * If the length of the key exceeds `max_length_storage_key` returns `KeyLengthExceeded`. /// * If the length of the value exceeds `max_length_storage_value` returns /// `ValueLengthExceeded`. /// * If called as view function returns `ProhibitedInView``. /// /// # Cost /// /// `base + storage_write_base + storage_write_key_byte * num_key_bytes + storage_write_value_byte * num_value_bytes /// + get_vec_from_memory_or_register_cost x 2`. /// /// If a value was evicted it costs additional `storage_write_value_evicted_byte * num_evicted_bytes + internal_write_register_cost`. pub fn storage_write( &mut self, key_len: u64, key_ptr: u64, value_len: u64, value_ptr: u64, register_id: u64, ) -> Result<u64> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err( HostError::ProhibitedInView { method_name: "storage_write".to_string() }.into() ); } self.gas_counter.pay_base(storage_write_base)?; let key = self.get_vec_from_memory_or_register(key_ptr, key_len)?; if key.len() as u64 > self.config.limit_config.max_length_storage_key { return Err(HostError::KeyLengthExceeded { length: key.len() as u64, limit: self.config.limit_config.max_length_storage_key, } .into()); } let value = self.get_vec_from_memory_or_register(value_ptr, value_len)?; if value.len() as u64 > self.config.limit_config.max_length_storage_value { return Err(HostError::ValueLengthExceeded { length: value.len() as u64, limit: self.config.limit_config.max_length_storage_value, } .into()); } self.gas_counter.pay_per_byte(storage_write_key_byte, key.len() as u64)?; self.gas_counter.pay_per_byte(storage_write_value_byte, value.len() as u64)?; let nodes_before = self.ext.get_touched_nodes_count(); let evicted_ptr = self.ext.storage_get(&key)?; let evicted = Self::deref_value(&mut self.gas_counter, storage_write_evicted_byte, evicted_ptr)?; self.gas_counter .pay_per_byte(touching_trie_node, self.ext.get_touched_nodes_count() - nodes_before)?; self.ext.storage_set(&key, &value)?; let storage_config = &self.fees_config.storage_usage_config; match evicted { Some(old_value) => { // Inner value can't overflow, because the value length is limited. self.current_storage_usage = self .current_storage_usage .checked_sub(old_value.len() as u64) .ok_or(InconsistentStateError::IntegerOverflow)?; // Inner value can't overflow, because the value length is limited. self.current_storage_usage = self .current_storage_usage .checked_add(value.len() as u64) .ok_or(InconsistentStateError::IntegerOverflow)?; self.internal_write_register(register_id, old_value)?; Ok(1) } None => { // Inner value can't overflow, because the key/value length is limited. self.current_storage_usage = self .current_storage_usage .checked_add( value.len() as u64 + key.len() as u64 + storage_config.num_extra_bytes_record, ) .ok_or(InconsistentStateError::IntegerOverflow)?; Ok(0) } } } fn deref_value<'s>( gas_counter: &mut GasCounter, cost_per_byte: ExtCosts, value_ptr: Option<Box<dyn ValuePtr + 's>>, ) -> Result<Option<Vec<u8>>> { match value_ptr { Some(value_ptr) => { gas_counter.pay_per_byte(cost_per_byte, value_ptr.len() as u64)?; value_ptr.deref().map(Some) } None => Ok(None), } } /// Reads the value stored under the given key. /// * If key is used copies the content of the value into the `register_id`, even if the content /// is zero bytes. Returns `1`; /// * If key is not present then does not modify the register. Returns `0`; /// /// # Errors /// /// * If `key_len + key_ptr` exceeds the memory container or points to an unused register it /// returns `MemoryAccessViolation`; /// * If returning the preempted value into the registers exceed the memory container it returns /// `MemoryAccessViolation`. /// * If the length of the key exceeds `max_length_storage_key` returns `KeyLengthExceeded`. /// /// # Cost /// /// `base + storage_read_base + storage_read_key_byte * num_key_bytes + storage_read_value_byte + num_value_bytes /// cost to read key from register + cost to write value into register`. pub fn storage_read(&mut self, key_len: u64, key_ptr: u64, register_id: u64) -> Result<u64> { self.gas_counter.pay_base(base)?; self.gas_counter.pay_base(storage_read_base)?; let key = self.get_vec_from_memory_or_register(key_ptr, key_len)?; if key.len() as u64 > self.config.limit_config.max_length_storage_key { return Err(HostError::KeyLengthExceeded { length: key.len() as u64, limit: self.config.limit_config.max_length_storage_key, } .into()); } self.gas_counter.pay_per_byte(storage_read_key_byte, key.len() as u64)?; let nodes_before = self.ext.get_touched_nodes_count(); let read = self.ext.storage_get(&key); self.gas_counter .pay_per_byte(touching_trie_node, self.ext.get_touched_nodes_count() - nodes_before)?; let read = Self::deref_value(&mut self.gas_counter, storage_read_value_byte, read?)?; match read { Some(value) => { self.internal_write_register(register_id, value)?; Ok(1) } None => Ok(0), } } /// Removes the value stored under the given key. /// * If key is used, removes the key-value from the trie and copies the content of the value /// into the `register_id`, even if the content is zero bytes. Returns `1`; /// * If key is not present then does not modify the register. Returns `0`. /// /// # Errors /// /// * If `key_len + key_ptr` exceeds the memory container or points to an unused register it /// returns `MemoryAccessViolation`; /// * If the registers exceed the memory limit returns `MemoryAccessViolation`; /// * If returning the preempted value into the registers exceed the memory container it returns /// `MemoryAccessViolation`. /// * If the length of the key exceeds `max_length_storage_key` returns `KeyLengthExceeded`. /// * If called as view function returns `ProhibitedInView``. /// /// # Cost /// /// `base + storage_remove_base + storage_remove_key_byte * num_key_bytes + storage_remove_ret_value_byte * num_value_bytes /// + cost to read the key + cost to write the value`. pub fn storage_remove(&mut self, key_len: u64, key_ptr: u64, register_id: u64) -> Result<u64> { self.gas_counter.pay_base(base)?; if self.context.is_view { return Err( HostError::ProhibitedInView { method_name: "storage_remove".to_string() }.into() ); } self.gas_counter.pay_base(storage_remove_base)?; let key = self.get_vec_from_memory_or_register(key_ptr, key_len)?; if key.len() as u64 > self.config.limit_config.max_length_storage_key { return Err(HostError::KeyLengthExceeded { length: key.len() as u64, limit: self.config.limit_config.max_length_storage_key, } .into()); } self.gas_counter.pay_per_byte(storage_remove_key_byte, key.len() as u64)?; let nodes_before = self.ext.get_touched_nodes_count(); let removed_ptr = self.ext.storage_get(&key)?; let removed = Self::deref_value(&mut self.gas_counter, storage_remove_ret_value_byte, removed_ptr)?; self.ext.storage_remove(&key)?; self.gas_counter .pay_per_byte(touching_trie_node, self.ext.get_touched_nodes_count() - nodes_before)?; let storage_config = &self.fees_config.storage_usage_config; match removed { Some(value) => { // Inner value can't overflow, because the key/value length is limited. self.current_storage_usage = self .current_storage_usage .checked_sub( value.len() as u64 + key.len() as u64 + storage_config.num_extra_bytes_record, ) .ok_or(InconsistentStateError::IntegerOverflow)?; self.internal_write_register(register_id, value)?; Ok(1) } None => Ok(0), } } /// Checks if there is a key-value pair. /// * If key is used returns `1`, even if the value is zero bytes; /// * Otherwise returns `0`. /// /// # Errors /// /// * If `key_len + key_ptr` exceeds the memory container it returns `MemoryAccessViolation`. /// * If the length of the key exceeds `max_length_storage_key` returns `KeyLengthExceeded`. /// /// # Cost /// /// `base + storage_has_key_base + storage_has_key_byte * num_bytes + cost of reading key` pub fn storage_has_key(&mut self, key_len: u64, key_ptr: u64) -> Result<u64> { self.gas_counter.pay_base(base)?; self.gas_counter.pay_base(storage_has_key_base)?; let key = self.get_vec_from_memory_or_register(key_ptr, key_len)?; if key.len() as u64 > self.config.limit_config.max_length_storage_key { return Err(HostError::KeyLengthExceeded { length: key.len() as u64, limit: self.config.limit_config.max_length_storage_key, } .into()); } self.gas_counter.pay_per_byte(storage_has_key_byte, key.len() as u64)?; let nodes_before = self.ext.get_touched_nodes_count(); let res = self.ext.storage_has_key(&key); self.gas_counter .pay_per_byte(touching_trie_node, self.ext.get_touched_nodes_count() - nodes_before)?; Ok(res? as u64) } /// DEPRECATED /// Creates an iterator object inside the host. Returns the identifier that uniquely /// differentiates the given iterator from other iterators that can be simultaneously created. /// * It iterates over the keys that have the provided prefix. The order of iteration is defined /// by the lexicographic order of the bytes in the keys; /// * If there are no keys, it creates an empty iterator, see below on empty iterators. /// /// # Errors /// /// * If `prefix_len + prefix_ptr` exceeds the memory container it returns /// `MemoryAccessViolation`. /// * If the length of the prefix exceeds `max_length_storage_key` returns `KeyLengthExceeded`. /// /// # Cost /// /// `base + storage_iter_create_prefix_base + storage_iter_create_key_byte * num_prefix_bytes /// cost of reading the prefix`. pub fn storage_iter_prefix(&mut self, _prefix_len: u64, _prefix_ptr: u64) -> Result<u64> { Err(VMLogicError::HostError(HostError::Deprecated { method_name: "storage_iter_prefix".to_string(), })) } /// DEPRECATED /// Iterates over all key-values such that keys are between `start` and `end`, where `start` is /// inclusive and `end` is exclusive. Unless lexicographically `start < end`, it creates an /// empty iterator. Note, this definition allows for `start` or `end` keys to not actually exist /// on the given trie. /// /// # Errors /// /// * If `start_len + start_ptr` or `end_len + end_ptr` exceeds the memory container or points to /// an unused register it returns `MemoryAccessViolation`. /// * If the length of the `start` exceeds `max_length_storage_key` returns `KeyLengthExceeded`. /// * If the length of the `end` exceeds `max_length_storage_key` returns `KeyLengthExceeded`. /// /// # Cost /// /// `base + storage_iter_create_range_base + storage_iter_create_from_byte * num_from_bytes /// + storage_iter_create_to_byte * num_to_bytes + reading from prefix + reading to prefix`. pub fn storage_iter_range( &mut self, _start_len: u64, _start_ptr: u64, _end_len: u64, _end_ptr: u64, ) -> Result<u64> { Err(VMLogicError::HostError(HostError::Deprecated { method_name: "storage_iter_range".to_string(), })) } /// DEPRECATED /// Advances iterator and saves the next key and value in the register. /// * If iterator is not empty (after calling next it points to a key-value), copies the key /// into `key_register_id` and value into `value_register_id` and returns `1`; /// * If iterator is empty returns `0`; /// This allows us to iterate over the keys that have zero bytes stored in values. /// /// # Errors /// /// * If `key_register_id == value_register_id` returns `MemoryAccessViolation`; /// * If the registers exceed the memory limit returns `MemoryAccessViolation`; /// * If `iterator_id` does not correspond to an existing iterator returns `InvalidIteratorId`; /// * If between the creation of the iterator and calling `storage_iter_next` the range over /// which it iterates was modified returns `IteratorWasInvalidated`. Specifically, if /// `storage_write` or `storage_remove` was invoked on the key key such that: /// * in case of `storage_iter_prefix`. `key` has the given prefix and: /// * Iterator was not called next yet. /// * `next` was already called on the iterator and it is currently pointing at the `key` /// `curr` such that `curr <= key`. /// * in case of `storage_iter_range`. `start<=key<end` and: /// * Iterator was not called `next` yet. /// * `next` was already called on the iterator and it is currently pointing at the key /// `curr` such that `curr<=key<end`. /// /// # Cost /// /// `base + storage_iter_next_base + storage_iter_next_key_byte * num_key_bytes + storage_iter_next_value_byte * num_value_bytes /// + writing key to register + writing value to register`. pub fn storage_iter_next( &mut self, _iterator_id: u64, _key_register_id: u64, _value_register_id: u64, ) -> Result<u64> { Err(VMLogicError::HostError(HostError::Deprecated { method_name: "storage_iter_next".to_string(), })) } /// Computes the outcome of execution. pub fn outcome(self) -> VMOutcome { VMOutcome { balance: self.current_account_balance, storage_usage: self.current_storage_usage, return_data: self.return_data, burnt_gas: self.gas_counter.burnt_gas(), used_gas: self.gas_counter.used_gas(), logs: self.logs, } } /// clones the outcome of execution. pub fn clone_outcome(&self) -> VMOutcome { let logs = self.logs.clone(); let return_data = self.return_data.clone(); VMOutcome { balance: self.current_account_balance, storage_usage: self.current_storage_usage, return_data, burnt_gas: self.gas_counter.burnt_gas(), used_gas: self.gas_counter.used_gas(), logs, } } pub fn add_contract_compile_fee(&mut self, code_len: u64) -> Result<()> { self.gas_counter.pay_per_byte(contract_compile_bytes, code_len)?; self.gas_counter.pay_base(contract_compile_base) } } #[derive(Debug, PartialEq, Serialize, Deserialize, Clone)] pub struct VMOutcome { #[serde(with = "crate::serde_with::u128_dec_format")] pub balance: Balance, pub storage_usage: StorageUsage, pub return_data: ReturnData, pub burnt_gas: Gas, pub used_gas: Gas, pub logs: Vec<String>, }