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
/* automatically generated by rust-bindgen */
pub type uint128_t = [u64; 2];
pub type int128_t = [u64; 2];
pub type capi_name = u64;
/// @brief 256-bit hash
/// @details 256-bit hash
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, Hash, PartialOrd, Ord, PartialEq, Eq)]
pub struct capi_checksum256 {
pub hash: [u8; 32usize],
}
/// @brief 160-bit hash
/// @details 160-bit hash
#[repr(C)]
#[derive(Debug, Default, Copy, Clone, Hash, PartialOrd, Ord, PartialEq, Eq)]
pub struct capi_checksum160 {
pub hash: [u8; 20usize],
pub __bindgen_padding_0: [u32; 3usize],
}
/// @brief 512-bit hash
/// @details 512-bit hash
#[repr(C)]
#[derive(Copy, Clone)]
pub struct capi_checksum512 {
pub hash: [u8; 64usize],
}
impl Default for capi_checksum512 {
fn default() -> Self {
unsafe { ::std::mem::zeroed() }
}
}
extern "C" {
/// Aborts processing of this action and unwinds all pending changes if the test condition is true
/// @brief Aborts processing of this action and unwinds all pending changes
/// @param test - 0 to abort, 1 to ignore
///
/// Example:
///
/// @code
/// eosio_assert(1 == 2, "One is not equal to two.");
/// eosio_assert(1 == 1, "One is not equal to one.");
/// @endcode
///
/// @param msg - a null terminated string explaining the reason for failure
pub fn eosio_assert(test: u32, msg: *const crate::ctypes::c_char);
}
extern "C" {
/// Aborts processing of this action and unwinds all pending changes if the test condition is true
/// @brief Aborts processing of this action and unwinds all pending changes
/// @param test - 0 to abort, 1 to ignore
/// @param msg - a pointer to the start of string explaining the reason for failure
/// @param msg_len - length of the string
pub fn eosio_assert_message(test: u32, msg: *const crate::ctypes::c_char, msg_len: u32);
}
extern "C" {
/// Aborts processing of this action and unwinds all pending changes if the test condition is true
/// @brief Aborts processing of this action and unwinds all pending changes
/// @param test - 0 to abort, 1 to ignore
/// @param code - the error code
pub fn eosio_assert_code(test: u32, code: u64);
}
extern "C" {
/// This method will abort execution of wasm without failing the contract. This is used to bypass all cleanup / destructors that would normally be called.
/// @brief Aborts execution of wasm without failing the contract
/// @param code - the exit code
/// Example:
///
/// @code
/// eosio_exit(0);
/// eosio_exit(1);
/// eosio_exit(2);
/// eosio_exit(3);
/// @endcode
pub fn eosio_exit(code: i32);
}
extern "C" {
/// Returns the time in microseconds from 1970 of the current block
/// @brief Get time of the current block (i.e. the block including this action)
/// @return time in microseconds from 1970 of the current block
pub fn current_time() -> u64;
}
extern "C" {
/// Copy up to @ref len bytes of current action data to the specified location
///
/// @brief Copy current action data to the specified location
/// @param msg - a pointer where up to @ref len bytes of the current action data will be copied
/// @param len - len of the current action data to be copied, 0 to report required size
/// @return the number of bytes copied to msg, or number of bytes that can be copied if len==0 passed
/// @pre `msg` is a valid pointer to a range of memory at least `len` bytes long
/// @post `msg` is filled with packed action data
pub fn read_action_data(msg: *mut crate::ctypes::c_void, len: u32) -> u32;
}
extern "C" {
/// Get the length of the current action's data field. This method is useful for dynamically sized actions
///
/// @brief Get the length of current action's data field
/// @return the length of the current action's data field
pub fn action_data_size() -> u32;
}
extern "C" {
/// Add the specified account to set of accounts to be notified
///
/// @brief Add the specified account to set of accounts to be notified
/// @param name - name of the account to be verified
pub fn require_recipient(name: capi_name);
}
extern "C" {
/// Verifies that @ref name exists in the set of provided auths on a action. Throws if not found.
///
/// @brief Verify specified account exists in the set of provided auths
/// @param name - name of the account to be verified
pub fn require_auth(name: capi_name);
}
extern "C" {
/// Verifies that @ref name has auth.
///
/// @brief Verifies that @ref name has auth.
/// @param name - name of the account to be verified
pub fn has_auth(name: capi_name) -> bool;
}
extern "C" {
/// Verifies that @ref name exists in the set of provided auths on a action. Throws if not found.
///
/// @brief Verify specified account exists in the set of provided auths
/// @param name - name of the account to be verified
/// @param permission - permission level to be verified
pub fn require_auth2(name: capi_name, permission: capi_name);
}
extern "C" {
pub fn is_account(name: capi_name) -> bool;
}
extern "C" {
/// Send an inline action in the context of this action's parent transaction
///
/// @param serialized_action - serialized action
/// @param size - size of serialized action in bytes
/// @pre `serialized_action` is a valid pointer to an array at least `size` bytes long
pub fn send_inline(serialized_action: *mut crate::ctypes::c_char, size: usize);
}
extern "C" {
/// Send an inline context free action in the context of this action's parent transaction
///
/// @param serialized_action - serialized action
/// @param size - size of serialized action in bytes
/// @pre `serialized_action` is a valid pointer to an array at least `size` bytes long
pub fn send_context_free_inline(serialized_action: *mut crate::ctypes::c_char, size: usize);
}
extern "C" {
/// Returns the time in microseconds from 1970 of the publication_time
/// @brief Get the publication time
/// @return the time in microseconds from 1970 of the publication_time
pub fn publication_time() -> u64;
}
extern "C" {
/// Get the current receiver of the action
/// @brief Get the current receiver of the action
/// @return the account which specifies the current receiver of the action
pub fn current_receiver() -> capi_name;
}
extern "C" {
/// Gets the set of active producers.
/// @brief Gets the set of active producers.
///
/// @param producers - Pointer to a buffer of account names
/// @param datalen - Byte length of buffer, when passed 0 will return the size required to store full output.
///
/// @return uint32_t - Number of bytes actually populated
/// @pre `producers` is a pointer to a range of memory at least `datalen` bytes long
/// @post the passed in `producers` pointer gets the array of active producers.
///
/// Example:
///
/// @code
/// capi_name producers[21];
/// uint32_t bytes_populated = get_active_producers(producers, sizeof(capi_name)*21);
/// @endcode
pub fn get_active_producers(producers: *mut capi_name, datalen: u32) -> u32;
}
extern "C" {
/// Tests if the sha256 hash generated from data matches the provided checksum.
/// This method is optimized to a NO-OP when in fast evaluation mode.
/// @brief Tests if the sha256 hash generated from data matches the provided checksum.
///
/// @param data - Data you want to hash
/// @param length - Data length
/// @param hash - `capi_checksum256*` hash to compare to
///
/// @pre **assert256 hash** of `data` equals provided `hash` parameter.
/// @post Executes next statement. If was not `true`, hard return.
///
/// Example:
///
/// @code
/// checksum hash;
/// char data;
/// uint32_t length;
/// assert_sha256( data, length, hash )
/// //If the sha256 hash generated from data does not equal provided hash, anything below will never fire.
/// eosio::print("sha256 hash generated from data equals provided hash");
/// @endcode
pub fn assert_sha256(
data: *const crate::ctypes::c_char,
length: u32,
hash: *const capi_checksum256,
);
}
extern "C" {
/// Tests if the sha1 hash generated from data matches the provided checksum.
/// This method is optimized to a NO-OP when in fast evaluation mode.
/// @brief Tests if the sha1 hash generated from data matches the provided checksum.
///
/// @param data - Data you want to hash
/// @param length - Data length
/// @param hash - `capi_checksum160*` hash to compare to
///
/// @pre **sha1 hash** of `data` equals provided `hash` parameter.
/// @post Executes next statement. If was not `true`, hard return.
///
/// Example:
///
/// @code
/// checksum hash;
/// char data;
/// uint32_t length;
/// assert_sha1( data, length, hash )
/// //If the sha1 hash generated from data does not equal provided hash, anything below will never fire.
/// eosio::print("sha1 hash generated from data equals provided hash");
/// @endcode
pub fn assert_sha1(
data: *const crate::ctypes::c_char,
length: u32,
hash: *const capi_checksum160,
);
}
extern "C" {
/// Tests if the sha512 hash generated from data matches the provided checksum.
/// This method is optimized to a NO-OP when in fast evaluation mode.
/// @brief Tests if the sha512 hash generated from data matches the provided checksum.
///
/// @param data - Data you want to hash
/// @param length - Data length
/// @param hash - `capi_checksum512*` hash to compare to
///
/// @pre **assert512 hash** of `data` equals provided `hash` parameter.
/// @post Executes next statement. If was not `true`, hard return.
///
/// Example:
///
/// @code
/// checksum hash;
/// char data;
/// uint32_t length;
/// assert_sha512( data, length, hash )
/// //If the sha512 hash generated from data does not equal provided hash, anything below will never fire.
/// eosio::print("sha512 hash generated from data equals provided hash");
/// @endcode
pub fn assert_sha512(
data: *const crate::ctypes::c_char,
length: u32,
hash: *const capi_checksum512,
);
}
extern "C" {
/// Tests if the ripemod160 hash generated from data matches the provided checksum.
/// @brief Tests if the ripemod160 hash generated from data matches the provided checksum.
///
/// @param data - Data you want to hash
/// @param length - Data length
/// @param hash - `capi_checksum160*` hash to compare to
///
/// @pre **assert160 hash** of `data` equals provided `hash` parameter.
/// @post Executes next statement. If was not `true`, hard return.
///
/// Example:
///
/// @code
/// checksum hash;
/// char data;
/// uint32_t length;
/// assert_ripemod160( data, length, hash )
/// //If the ripemod160 hash generated from data does not equal provided hash, anything below will never fire.
/// eosio::print("ripemod160 hash generated from data equals provided hash");
/// @endcode
pub fn assert_ripemd160(
data: *const crate::ctypes::c_char,
length: u32,
hash: *const capi_checksum160,
);
}
extern "C" {
/// Hashes `data` using `sha256` and stores result in memory pointed to by hash.
/// @brief Hashes `data` using `sha256` and stores result in memory pointed to by hash.
///
/// @param data - Data you want to hash
/// @param length - Data length
/// @param hash - Hash pointer
///
/// Example:
///
/// @code
/// checksum calc_hash;
/// sha256( data, length, &calc_hash );
/// eos_assert( calc_hash == hash, "invalid hash" );
/// @endcode
pub fn sha256(data: *const crate::ctypes::c_char, length: u32, hash: *mut capi_checksum256);
}
extern "C" {
/// Hashes `data` using `sha1` and stores result in memory pointed to by hash.
/// @brief Hashes `data` using `sha1` and stores result in memory pointed to by hash.
///
/// @param data - Data you want to hash
/// @param length - Data length
/// @param hash - Hash pointer
///
/// Example:
///
/// @code
/// checksum calc_hash;
/// sha1( data, length, &calc_hash );
/// eos_assert( calc_hash == hash, "invalid hash" );
/// @endcode
pub fn sha1(data: *const crate::ctypes::c_char, length: u32, hash: *mut capi_checksum160);
}
extern "C" {
/// Hashes `data` using `sha512` and stores result in memory pointed to by hash.
/// @brief Hashes `data` using `sha512` and stores result in memory pointed to by hash.
///
/// @param data - Data you want to hash
/// @param length - Data length
/// @param hash - Hash pointer
///
/// Example:
///
/// @code
/// checksum calc_hash;
/// sha512( data, length, &calc_hash );
/// eos_assert( calc_hash == hash, "invalid hash" );
/// @endcode
pub fn sha512(data: *const crate::ctypes::c_char, length: u32, hash: *mut capi_checksum512);
}
extern "C" {
/// Hashes `data` using `ripemod160` and stores result in memory pointed to by hash.
/// @brief Hashes `data` using `ripemod160` and stores result in memory pointed to by hash.
///
/// @param data - Data you want to hash
/// @param length - Data length
/// @param hash - Hash pointer
///
/// Example:
///
/// @code
/// checksum calc_hash;
/// ripemod160( data, length, &calc_hash );
/// eos_assert( calc_hash == hash, "invalid hash" );
/// @endcode
pub fn ripemd160(data: *const crate::ctypes::c_char, length: u32, hash: *mut capi_checksum160);
}
extern "C" {
/// Calculates the public key used for a given signature and hash used to create a message.
/// @brief Calculates the public key used for a given signature and hash used to create a message.
///
/// @param digest - Hash used to create a message
/// @param sig - Signature
/// @param siglen - Signature length
/// @param pub - Public key
/// @param publen - Public key length
///
/// Example:
///
/// @code
/// @endcode
pub fn recover_key(
digest: *const capi_checksum256,
sig: *const crate::ctypes::c_char,
siglen: usize,
pub_: *mut crate::ctypes::c_char,
publen: usize,
) -> crate::ctypes::c_int;
}
extern "C" {
/// Tests a given public key with the generated key from digest and the signature.
/// @brief Tests a given public key with the generated key from digest and the signature.
///
/// @param digest - What the key will be generated from
/// @param sig - Signature
/// @param siglen - Signature length
/// @param pub - Public key
/// @param publen - Public key length
///
/// @pre **assert recovery key** of `pub` equals the key generated from the `digest` parameter
/// @post Executes next statement. If was not `true`, hard return.
///
/// Example:
///
/// @code
/// checksum digest;
/// char sig;
/// size_t siglen;
/// char pub;
/// size_t publen;
/// assert_recover_key( digest, sig, siglen, pub, publen )
/// // If the given public key does not match with the generated key from digest and the signature, anything below will never fire.
/// eosio::print("pub key matches the pub key generated from digest");
/// @endcode
pub fn assert_recover_key(
digest: *const capi_checksum256,
sig: *const crate::ctypes::c_char,
siglen: usize,
pub_: *const crate::ctypes::c_char,
publen: usize,
);
}
extern "C" {
/// Store a record in a primary 64-bit integer index table
///
/// @brief Store a record in a primary 64-bit integer index table
/// @param scope - The scope where the table resides (implied to be within the code of the current receiver)
/// @param table - The table name
/// @param payer - The account that pays for the storage costs
/// @param id - ID of the entry
/// @param data - Record to store
/// @param len - Size of data
/// @pre `data` is a valid pointer to a range of memory at least `len` bytes long
/// @pre `*((uint64_t*)data)` stores the primary key
/// @return iterator to the newly created table row
/// @post a new entry is created in the table
pub fn db_store_i64(
scope: u64,
table: capi_name,
payer: capi_name,
id: u64,
data: *const crate::ctypes::c_void,
len: u32,
) -> i32;
}
extern "C" {
/// Update a record in a primary 64-bit integer index table
///
/// @brief Update a record in a primary 64-bit integer index table
/// @param iterator - Iterator to the table row containing the record to update
/// @param payer - The account that pays for the storage costs (use 0 to continue using current payer)
/// @param data - New updated record
/// @param len - Size of data
/// @pre `data` is a valid pointer to a range of memory at least `len` bytes long
/// @pre `*((uint64_t*)data)` stores the primary key
/// @pre `iterator` points to an existing table row in the table
/// @post the record contained in the table row pointed to by `iterator` is replaced with the new updated record
pub fn db_update_i64(
iterator: i32,
payer: capi_name,
data: *const crate::ctypes::c_void,
len: u32,
);
}
extern "C" {
/// Remove a record from a primary 64-bit integer index table
///
/// @brief Remove a record from a primary 64-bit integer index table
/// @param iterator - Iterator to the table row to remove
/// @pre `iterator` points to an existing table row in the table
/// @post the table row pointed to by `iterator` is removed and the associated storage costs are refunded to the payer
///
/// Example:
///
/// @code
/// int32_t itr = db_find_i64(receiver, receiver, table1, N(alice));
/// eosio_assert(itr >= 0, "Alice cannot be removed since she was already not found in the table");
/// db_remove_i64(itr);
/// @endcode
pub fn db_remove_i64(iterator: i32);
}
extern "C" {
/// Get a record in a primary 64-bit integer index table
///
/// @brief Get a record in a primary 64-bit integer index table
/// @param iterator - The iterator to the table row containing the record to retrieve
/// @param data - Pointer to the buffer which will be filled with the retrieved record
/// @param len - Size of the buffer
/// @return size of the data copied into the buffer if `len > 0`, or size of the retrieved record if `len == 0`.
/// @pre `iterator` points to an existing table row in the table
/// @pre `data` is a valid pointer to a range of memory at least `len` bytes long
/// @post `data` will be filled with the retrieved record (truncated to the first `len` bytes if necessary)
///
/// Example:
///
/// @code
/// char value[50];
/// auto len = db_get_i64(itr, value, 0);
/// eosio_assert(len <= 50, "buffer to small to store retrieved record");
/// db_get_i64(itr, value, len);
/// @endcode
pub fn db_get_i64(iterator: i32, data: *const crate::ctypes::c_void, len: u32) -> i32;
}
extern "C" {
/// Find the table row following the referenced table row in a primary 64-bit integer index table
///
/// @brief Find the table row following the referenced table row in a primary 64-bit integer index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the next table row
/// @return iterator to the table row following the referenced table row (or the end iterator of the table if the referenced table row is the last one in the table)
/// @pre `iterator` points to an existing table row in the table
/// @post `*primary` will be replaced with the primary key of the table row following the referenced table row if it exists, otherwise `*primary` will be left untouched
///
/// Example:
///
/// @code
/// int32_t charlie_itr = db_find_i64(receiver, receiver, table1, N(charlie));
/// // expect nothing after charlie
/// uint64_t prim = 0
/// int32_t end_itr = db_next_i64(charlie_itr, &prim);
/// eosio_assert(end_itr < -1, "Charlie was not the last entry in the table");
/// @endcode
pub fn db_next_i64(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find the table row preceding the referenced table row in a primary 64-bit integer index table
///
/// @brief Find the table row preceding the referenced table row in a primary 64-bit integer index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the previous table row
/// @return iterator to the table row preceding the referenced table row assuming one exists (it will return -1 if the referenced table row is the first one in the table)
/// @pre `iterator` points to an existing table row in the table or it is the end iterator of the table
/// @post `*primary` will be replaced with the primary key of the table row preceding the referenced table row if it exists, otherwise `*primary` will be left untouched
///
/// Example:
///
/// @code
/// uint64_t prim = 0;
/// int32_t itr_prev = db_previous_i64(itr, &prim);
/// @endcode
pub fn db_previous_i64(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find a table row in a primary 64-bit integer index table by primary key
///
/// @brief Find a table row in a primary 64-bit integer index table by primary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param id - The primary key of the table row to look up
/// @return iterator to the table row with a primary key equal to `id` or the end iterator of the table if the table row could not be found
///
/// Example:
///
/// @code
/// int itr = db_find_i64(receiver, receiver, table1, N(charlie));
/// @endcode
pub fn db_find_i64(code: capi_name, scope: u64, table: capi_name, id: u64) -> i32;
}
extern "C" {
/// Find the table row in a primary 64-bit integer index table that matches the lowerbound condition for a given primary key
/// The table row that matches the lowerbound condition is the first table row in the table with the lowest primary key that is >= the given key
///
/// @brief Find the table row in a primary 64-bit integer index table that matches the lowerbound condition for a given primary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param id - The primary key used to determine the lowerbound
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_lowerbound_i64(code: capi_name, scope: u64, table: capi_name, id: u64) -> i32;
}
extern "C" {
/// Find the table row in a primary 64-bit integer index table that matches the upperbound condition for a given primary key
/// The table row that matches the upperbound condition is the first table row in the table with the lowest primary key that is > the given key
///
/// @brief Find the table row in a primary 64-bit integer index table that matches the upperbound condition for a given primary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param id - The primary key used to determine the upperbound
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_upperbound_i64(code: capi_name, scope: u64, table: capi_name, id: u64) -> i32;
}
extern "C" {
/// Get an iterator representing just-past-the-end of the last table row of a primary 64-bit integer index table
///
/// @brief Get an iterator representing just-past-the-end of the last table row of a primary 64-bit integer index table
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @return end iterator of the table
pub fn db_end_i64(code: capi_name, scope: u64, table: capi_name) -> i32;
}
extern "C" {
/// Store an association of a 64-bit integer secondary key to a primary key in a secondary 64-bit integer index table
///
/// @brief Store an association of a 64-bit integer secondary key to a primary key in a secondary 64-bit integer index table
/// @param scope - The scope where the table resides (implied to be within the code of the current receiver)
/// @param table - The table name
/// @param payer - The account that pays for the storage costs
/// @param id - The primary key to which to associate the secondary key
/// @param secondary - Pointer to the secondary key
/// @return iterator to the newly created table row
/// @post new secondary key association between primary key `id` and secondary key `*secondary` is created in the secondary 64-bit integer index table
pub fn db_idx64_store(
scope: u64,
table: capi_name,
payer: capi_name,
id: u64,
secondary: *const u64,
) -> i32;
}
extern "C" {
/// Update an association for a 64-bit integer secondary key to a primary key in a secondary 64-bit integer index table
///
/// @brief Update an association for a 64-bit integer secondary key to a primary key in a secondary 64-bit integer index table
/// @param iterator - The iterator to the table row containing the secondary key association to update
/// @param payer - The account that pays for the storage costs (use 0 to continue using current payer)
/// @param secondary - Pointer to the **new** secondary key that will replace the existing one of the association
/// @pre `iterator` points to an existing table row in the table
/// @post the secondary key of the table row pointed to by `iterator` is replaced by `*secondary`
pub fn db_idx64_update(iterator: i32, payer: capi_name, secondary: *const u64);
}
extern "C" {
/// Remove a table row from a secondary 64-bit integer index table
///
/// @brief Remove a table row from a secondary 64-bit integer index table
/// @param iterator - Iterator to the table row to remove
/// @pre `iterator` points to an existing table row in the table
/// @post the table row pointed to by `iterator` is removed and the associated storage costs are refunded to the payer
pub fn db_idx64_remove(iterator: i32);
}
extern "C" {
/// Find the table row following the referenced table row in a secondary 64-bit integer index table
///
/// @brief Find the table row following the referenced table row in a secondary 64-bit integer index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the next table row
/// @return iterator to the table row following the referenced table row (or the end iterator of the table if the referenced table row is the last one in the table)
/// @pre `iterator` points to an existing table row in the table
/// @post `*primary` will be replaced with the primary key of the table row following the referenced table row if it exists, otherwise `*primary` will be left untouched
pub fn db_idx64_next(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find the table row preceding the referenced table row in a secondary 64-bit integer index table
///
/// @brief Find the table row preceding the referenced table row in a secondary 64-bit integer index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the previous table row
/// @return iterator to the table row preceding the referenced table row assuming one exists (it will return -1 if the referenced table row is the first one in the table)
/// @pre `iterator` points to an existing table row in the table or it is the end iterator of the table
/// @post `*primary` will be replaced with the primary key of the table row preceding the referenced table row if it exists, otherwise `*primary` will be left untouched
pub fn db_idx64_previous(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find a table row in a secondary 64-bit integer index table by primary key
///
/// @brief Find a table row in a secondary 64-bit integer index table by primary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to a `uint64_t` variable which will have its value set to the secondary key of the found table row
/// @param primary - The primary key of the table row to look up
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @return iterator to the table row with a primary key equal to `id` or the end iterator of the table if the table row could not be found
pub fn db_idx64_find_primary(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut u64,
primary: u64,
) -> i32;
}
extern "C" {
/// Find a table row in a secondary 64-bit integer index table by secondary key
///
/// @brief Find a table row in a secondary 64-bit integer index table by secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key used to lookup the table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the first table row with a secondary key equal to `*secondary` or the end iterator of the table if the table row could not be found
pub fn db_idx64_find_secondary(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *const u64,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Find the table row in a secondary 64-bit integer index table that matches the lowerbound condition for a given secondary key
/// The table row that matches the lowerbound condition is the first table row in the table with the lowest secondary key that is >= the given key
///
/// @brief Find the table row in a secondary 64-bit integer index table that matches the lowerbound condition for a given secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key first used to determine the lowerbound and which is then replaced with the secondary key of the found table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_idx64_lowerbound(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut u64,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Find the table row in a secondary 64-bit integer index table that matches the upperbound condition for a given secondary key
/// The table row that matches the upperbound condition is the first table row in the table with the lowest secondary key that is > the given key
///
/// @brief Find the table row in a secondary 64-bit integer index table that matches the upperbound condition for a given secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key first used to determine the upperbound and which is then replaced with the secondary key of the found table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_idx64_upperbound(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut u64,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Get an end iterator representing just-past-the-end of the last table row of a secondary 64-bit integer index table
///
/// @brief Get an end iterator representing just-past-the-end of the last table row of a secondary 64-bit integer index table
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @return end iterator of the table
pub fn db_idx64_end(code: capi_name, scope: u64, table: capi_name) -> i32;
}
extern "C" {
/// Store an association of a 128-bit integer secondary key to a primary key in a secondary 128-bit integer index table
///
/// @brief Store an association of a 128-bit integer secondary key to a primary key in a secondary 128-bit integer index table
/// @param scope - The scope where the table resides (implied to be within the code of the current receiver)
/// @param table - The table name
/// @param payer - The account that pays for the storage costs
/// @param id - The primary key to which to associate the secondary key
/// @param secondary - Pointer to the secondary key
/// @return iterator to the newly created table row
/// @post new secondary key association between primary key `id` and secondary key `*secondary` is created in the secondary 128-bit integer index table
pub fn db_idx128_store(
scope: u64,
table: capi_name,
payer: capi_name,
id: u64,
secondary: *const uint128_t,
) -> i32;
}
extern "C" {
/// Update an association for a 128-bit integer secondary key to a primary key in a secondary 128-bit integer index table
///
/// @brief Update an association for a 128-bit integer secondary key to a primary key in a secondary 128-bit integer index table
/// @param iterator - The iterator to the table row containing the secondary key association to update
/// @param payer - The account that pays for the storage costs (use 0 to continue using current payer)
/// @param secondary - Pointer to the **new** secondary key that will replace the existing one of the association
/// @pre `iterator` points to an existing table row in the table
/// @post the secondary key of the table row pointed to by `iterator` is replaced by `*secondary`
pub fn db_idx128_update(iterator: i32, payer: capi_name, secondary: *const uint128_t);
}
extern "C" {
/// Remove a table row from a secondary 128-bit integer index table
///
/// @brief Remove a table row from a secondary 128-bit integer index table
/// @param iterator - Iterator to the table row to remove
/// @pre `iterator` points to an existing table row in the table
/// @post the table row pointed to by `iterator` is removed and the associated storage costs are refunded to the payer
pub fn db_idx128_remove(iterator: i32);
}
extern "C" {
/// Find the table row following the referenced table row in a secondary 128-bit integer index table
///
/// @brief Find the table row following the referenced table row in a secondary 128-bit integer index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the next table row
/// @return iterator to the table row following the referenced table row (or the end iterator of the table if the referenced table row is the last one in the table)
/// @pre `iterator` points to an existing table row in the table
/// @post `*primary` will be replaced with the primary key of the table row following the referenced table row if it exists, otherwise `*primary` will be left untouched
pub fn db_idx128_next(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find the table row preceding the referenced table row in a secondary 128-bit integer index table
///
/// @brief Find the table row preceding the referenced table row in a secondary 128-bit integer index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the previous table row
/// @return iterator to the table row preceding the referenced table row assuming one exists (it will return -1 if the referenced table row is the first one in the table)
/// @pre `iterator` points to an existing table row in the table or it is the end iterator of the table
/// @post `*primary` will be replaced with the primary key of the table row preceding the referenced table row if it exists, otherwise `*primary` will be left untouched
pub fn db_idx128_previous(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find a table row in a secondary 128-bit integer index table by primary key
///
/// @brief Find a table row in a secondary 128-bit integer index table by primary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to a `uint128_t` variable which will have its value set to the secondary key of the found table row
/// @param primary - The primary key of the table row to look up
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @return iterator to the table row with a primary key equal to `id` or the end iterator of the table if the table row could not be found
pub fn db_idx128_find_primary(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut uint128_t,
primary: u64,
) -> i32;
}
extern "C" {
/// Find a table row in a secondary 128-bit integer index table by secondary key
///
/// @brief Find a table row in a secondary 128-bit integer index table by secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key used to lookup the table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the first table row with a secondary key equal to `*secondary` or the end iterator of the table if the table row could not be found
pub fn db_idx128_find_secondary(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *const uint128_t,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Find the table row in a secondary 128-bit integer index table that matches the lowerbound condition for a given secondary key
/// The table row that matches the lowerbound condition is the first table row in the table with the lowest secondary key that is >= the given key
///
/// @brief Find the table row in a secondary 128-bit integer index table that matches the lowerbound condition for a given secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key first used to determine the lowerbound and which is then replaced with the secondary key of the found table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_idx128_lowerbound(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut uint128_t,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Find the table row in a secondary 128-bit integer index table that matches the upperbound condition for a given secondary key
/// The table row that matches the upperbound condition is the first table row in the table with the lowest secondary key that is > the given key
///
/// @brief Find the table row in a secondary 128-bit integer index table that matches the upperbound condition for a given secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key first used to determine the upperbound and which is then replaced with the secondary key of the found table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_idx128_upperbound(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut uint128_t,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Get an end iterator representing just-past-the-end of the last table row of a secondary 128-bit integer index table
///
/// @brief Get an end iterator representing just-past-the-end of the last table row of a secondary 128-bit integer index table
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @return end iterator of the table
pub fn db_idx128_end(code: capi_name, scope: u64, table: capi_name) -> i32;
}
extern "C" {
/// Store an association of a 256-bit secondary key to a primary key in a secondary 256-bit index table
///
/// @brief Store an association of a 256-bit secondary key to a primary key in a secondary 256-bit index table
/// @param scope - The scope where the table resides (implied to be within the code of the current receiver)
/// @param table - The table name
/// @param payer - The account that pays for the storage costs
/// @param id - The primary key to which to associate the secondary key
/// @param data - Pointer to the secondary key data stored as an array of 2 `uint128_t` integers
/// @param data_len - Must be set to 2
/// @return iterator to the newly created table row
/// @post new secondary key association between primary key `id` and the specified secondary key is created in the secondary 256-bit index table
pub fn db_idx256_store(
scope: u64,
table: capi_name,
payer: capi_name,
id: u64,
data: *const uint128_t,
data_len: u32,
) -> i32;
}
extern "C" {
/// Update an association for a 256-bit secondary key to a primary key in a secondary 256-bit index table
///
/// @brief Update an association for a 256-bit secondary key to a primary key in a secondary 256-bit index table
/// @param iterator - The iterator to the table row containing the secondary key association to update
/// @param payer - The account that pays for the storage costs (use 0 to continue using current payer)
/// @param data - Pointer to the **new** secondary key data (which is stored as an array of 2 `uint128_t` integers) that will replace the existing one of the association
/// @param data_len - Must be set to 2
/// @pre `iterator` points to an existing table row in the table
/// @post the secondary key of the table row pointed to by `iterator` is replaced by the specified secondary key
pub fn db_idx256_update(iterator: i32, payer: capi_name, data: *const uint128_t, data_len: u32);
}
extern "C" {
/// Remove a table row from a secondary 256-bit index table
///
/// @brief Remove a table row from a secondary 256-bit index table
/// @param iterator - Iterator to the table row to remove
/// @pre `iterator` points to an existing table row in the table
/// @post the table row pointed to by `iterator` is removed and the associated storage costs are refunded to the payer
pub fn db_idx256_remove(iterator: i32);
}
extern "C" {
/// Find the table row following the referenced table row in a secondary 256-bit index table
///
/// @brief Find the table row following the referenced table row in a secondary 256-bit index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the next table row
/// @return iterator to the table row following the referenced table row (or the end iterator of the table if the referenced table row is the last one in the table)
/// @pre `iterator` points to an existing table row in the table
/// @post `*primary` will be replaced with the primary key of the table row following the referenced table row if it exists, otherwise `*primary` will be left untouched
pub fn db_idx256_next(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find the table row preceding the referenced table row in a secondary 256-bit index table
///
/// @brief Find the table row preceding the referenced table row in a secondary 256-bit index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the previous table row
/// @return iterator to the table row preceding the referenced table row assuming one exists (it will return -1 if the referenced table row is the first one in the table)
/// @pre `iterator` points to an existing table row in the table or it is the end iterator of the table
/// @post `*primary` will be replaced with the primary key of the table row preceding the referenced table row if it exists, otherwise `*primary` will be left untouched
pub fn db_idx256_previous(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find a table row in a secondary 256-bit index table by primary key
///
/// @brief Find a table row in a secondary 128-bit integer index table by primary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param data - Pointer to the an array of 2 `uint128_t` integers which will act as the buffer to hold the retrieved secondary key of the found table row
/// @param data_len - Must be set to 2
/// @param primary - The primary key of the table row to look up
/// @post If and only if the table row is found, the buffer pointed to by `data` will be filled with the secondary key of the found table row
/// @return iterator to the table row with a primary key equal to `id` or the end iterator of the table if the table row could not be found
pub fn db_idx256_find_primary(
code: capi_name,
scope: u64,
table: capi_name,
data: *mut uint128_t,
data_len: u32,
primary: u64,
) -> i32;
}
extern "C" {
/// Find a table row in a secondary 256-bit index table by secondary key
///
/// @brief Find a table row in a secondary 256-bit index table by secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param data - Pointer to the secondary key data (which is stored as an array of 2 `uint128_t` integers) used to lookup the table row
/// @param data_len - Must be set to 2
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the first table row with a secondary key equal to the specified secondary key or the end iterator of the table if the table row could not be found
pub fn db_idx256_find_secondary(
code: capi_name,
scope: u64,
table: capi_name,
data: *const uint128_t,
data_len: u32,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Find the table row in a secondary 256-bit index table that matches the lowerbound condition for a given secondary key
/// The table row that matches the lowerbound condition is the first table row in the table with the lowest secondary key that is >= the given key (uses lexicographical ordering on the 256-bit keys)
///
/// @brief Find the table row in a secondary 256-bit index table that matches the lowerbound condition for a given secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param data - Pointer to the secondary key data (which is stored as an array of 2 `uint128_t` integers) first used to determine the lowerbound and which is then replaced with the secondary key of the found table row
/// @param data_len - Must be set to 2
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, the buffer pointed to by `data` will be filled with the secondary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_idx256_lowerbound(
code: capi_name,
scope: u64,
table: capi_name,
data: *mut uint128_t,
data_len: u32,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Find the table row in a secondary 256-bit index table that matches the upperbound condition for a given secondary key
/// The table row that matches the upperbound condition is the first table row in the table with the lowest secondary key that is > the given key (uses lexicographical ordering on the 256-bit keys)
///
/// @brief Find the table row in a secondary 256-bit index table that matches the upperbound condition for a given secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param data - Pointer to the secondary key data (which is stored as an array of 2 `uint128_t` integers) first used to determine the upperbound and which is then replaced with the secondary key of the found table row
/// @param data_len - Must be set to 2
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, the buffer pointed to by `data` will be filled with the secondary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_idx256_upperbound(
code: capi_name,
scope: u64,
table: capi_name,
data: *mut uint128_t,
data_len: u32,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Get an end iterator representing just-past-the-end of the last table row of a secondary 256-bit index table
///
/// @brief Get an end iterator representing just-past-the-end of the last table row of a secondary 256-bit index table
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @return end iterator of the table
pub fn db_idx256_end(code: capi_name, scope: u64, table: capi_name) -> i32;
}
extern "C" {
/// Store an association of a double-precision floating-point secondary key to a primary key in a secondary double-precision floating-point index table
///
/// @brief Store an association of a double-precision floating-point secondary key to a primary key in a secondary double-precision floating-point index table
/// @param scope - The scope where the table resides (implied to be within the code of the current receiver)
/// @param table - The table name
/// @param payer - The account that pays for the storage costs
/// @param id - The primary key to which to associate the secondary key
/// @param secondary - Pointer to the secondary key
/// @return iterator to the newly created table row
/// @post new secondary key association between primary key `id` and secondary key `*secondary` is created in the secondary double-precision floating-point index table
pub fn db_idx_double_store(
scope: u64,
table: capi_name,
payer: capi_name,
id: u64,
secondary: *const f64,
) -> i32;
}
extern "C" {
/// Update an association for a double-precision floating-point secondary key to a primary key in a secondary double-precision floating-point index table
///
/// @brief Update an association for a double-precision floating-point secondary key to a primary key in a secondary double-precision floating-point index table
/// @param iterator - The iterator to the table row containing the secondary key association to update
/// @param payer - The account that pays for the storage costs (use 0 to continue using current payer)
/// @param secondary - Pointer to the **new** secondary key that will replace the existing one of the association
/// @pre `iterator` points to an existing table row in the table
/// @post the secondary key of the table row pointed to by `iterator` is replaced by `*secondary`
pub fn db_idx_double_update(iterator: i32, payer: capi_name, secondary: *const f64);
}
extern "C" {
/// Remove a table row from a secondary double-precision floating-point index table
///
/// @brief Remove a table row from a secondary double-precision floating-point index table
/// @param iterator - Iterator to the table row to remove
/// @pre `iterator` points to an existing table row in the table
/// @post the table row pointed to by `iterator` is removed and the associated storage costs are refunded to the payer
pub fn db_idx_double_remove(iterator: i32);
}
extern "C" {
/// Find the table row following the referenced table row in a secondary double-precision floating-point index table
///
/// @brief Find the table row following the referenced table row in a secondary double-precision floating-point index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the next table row
/// @return iterator to the table row following the referenced table row (or the end iterator of the table if the referenced table row is the last one in the table)
/// @pre `iterator` points to an existing table row in the table
/// @post `*primary` will be replaced with the primary key of the table row following the referenced table row if it exists, otherwise `*primary` will be left untouched
pub fn db_idx_double_next(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find the table row preceding the referenced table row in a secondary double-precision floating-point index table
///
/// @brief Find the table row preceding the referenced table row in a secondary double-precision floating-point index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the previous table row
/// @return iterator to the table row preceding the referenced table row assuming one exists (it will return -1 if the referenced table row is the first one in the table)
/// @pre `iterator` points to an existing table row in the table or it is the end iterator of the table
/// @post `*primary` will be replaced with the primary key of the table row preceding the referenced table row if it exists, otherwise `*primary` will be left untouched
pub fn db_idx_double_previous(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find a table row in a secondary double-precision floating-point index table by primary key
///
/// @brief Find a table row in a secondary double-precision floating-point index table by primary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to a `double` variable which will have its value set to the secondary key of the found table row
/// @param primary - The primary key of the table row to look up
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @return iterator to the table row with a primary key equal to `id` or the end iterator of the table if the table row could not be found
pub fn db_idx_double_find_primary(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut f64,
primary: u64,
) -> i32;
}
extern "C" {
/// Find a table row in a secondary double-precision floating-point index table by secondary key
///
/// @brief Find a table row in a secondary double-precision floating-point index table by secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key used to lookup the table row
/// @param primary - Pointer to a `double` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the first table row with a secondary key equal to `*secondary` or the end iterator of the table if the table row could not be found
pub fn db_idx_double_find_secondary(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *const f64,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Find the table row in a secondary double-precision floating-point index table that matches the lowerbound condition for a given secondary key
/// The table row that matches the lowerbound condition is the first table row in the table with the lowest secondary key that is >= the given key
///
/// @brief Find the table row in a secondary double-precision floating-point index table that matches the lowerbound condition for a given secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key first used to determine the lowerbound and which is then replaced with the secondary key of the found table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_idx_double_lowerbound(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut f64,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Find the table row in a secondary double-precision floating-point index table that matches the upperbound condition for a given secondary key
/// The table row that matches the upperbound condition is the first table row in the table with the lowest secondary key that is > the given key
///
/// @brief Find the table row in a secondary double-precision floating-point index table that matches the upperbound condition for a given secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key first used to determine the upperbound and which is then replaced with the secondary key of the found table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_idx_double_upperbound(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut f64,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Get an end iterator representing just-past-the-end of the last table row of a secondary double-precision floating-point index table
///
/// @brief Get an end iterator representing just-past-the-end of the last table row of a secondary double-precision floating-point index table
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @return end iterator of the table
pub fn db_idx_double_end(code: capi_name, scope: u64, table: capi_name) -> i32;
}
extern "C" {
/// Store an association of a quadruple-precision floating-point secondary key to a primary key in a secondary quadruple-precision floating-point index table
///
/// @brief Store an association of a quadruple-precision floating-point secondary key to a primary key in a secondary quadruple-precision floating-point index table
/// @param scope - The scope where the table resides (implied to be within the code of the current receiver)
/// @param table - The table name
/// @param payer - The account that pays for the storage costs
/// @param id - The primary key to which to associate the secondary key
/// @param secondary - Pointer to the secondary key
/// @return iterator to the newly created table row
/// @post new secondary key association between primary key `id` and secondary key `*secondary` is created in the secondary quadruple-precision floating-point index table
pub fn db_idx_long_double_store(
scope: u64,
table: capi_name,
payer: capi_name,
id: u64,
secondary: *const f64,
) -> i32;
}
extern "C" {
/// Update an association for a quadruple-precision floating-point secondary key to a primary key in a secondary quadruple-precision floating-point index table
///
/// @brief Update an association for a quadruple-precision floating-point secondary key to a primary key in a secondary quadruple-precision floating-point index table
/// @param iterator - The iterator to the table row containing the secondary key association to update
/// @param payer - The account that pays for the storage costs (use 0 to continue using current payer)
/// @param secondary - Pointer to the **new** secondary key that will replace the existing one of the association
/// @pre `iterator` points to an existing table row in the table
/// @post the secondary key of the table row pointed to by `iterator` is replaced by `*secondary`
pub fn db_idx_long_double_update(iterator: i32, payer: capi_name, secondary: *const f64);
}
extern "C" {
/// Remove a table row from a secondary quadruple-precision floating-point index table
///
/// @brief Remove a table row from a secondary quadruple-precision floating-point index table
/// @param iterator - Iterator to the table row to remove
/// @pre `iterator` points to an existing table row in the table
/// @post the table row pointed to by `iterator` is removed and the associated storage costs are refunded to the payer
pub fn db_idx_long_double_remove(iterator: i32);
}
extern "C" {
/// Find the table row following the referenced table row in a secondary quadruple-precision floating-point index table
///
/// @brief Find the table row following the referenced table row in a secondary quadruple-precision floating-point index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the next table row
/// @return iterator to the table row following the referenced table row (or the end iterator of the table if the referenced table row is the last one in the table)
/// @pre `iterator` points to an existing table row in the table
/// @post `*primary` will be replaced with the primary key of the table row following the referenced table row if it exists, otherwise `*primary` will be left untouched
pub fn db_idx_long_double_next(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find the table row preceding the referenced table row in a secondary quadruple-precision floating-point index table
///
/// @brief Find the table row preceding the referenced table row in a secondary quadruple-precision floating-point index table
/// @param iterator - The iterator to the referenced table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the previous table row
/// @return iterator to the table row preceding the referenced table row assuming one exists (it will return -1 if the referenced table row is the first one in the table)
/// @pre `iterator` points to an existing table row in the table or it is the end iterator of the table
/// @post `*primary` will be replaced with the primary key of the table row preceding the referenced table row if it exists, otherwise `*primary` will be left untouched
pub fn db_idx_long_double_previous(iterator: i32, primary: *mut u64) -> i32;
}
extern "C" {
/// Find a table row in a secondary quadruple-precision floating-point index table by primary key
///
/// @brief Find a table row in a secondary quadruple-precision floating-point index table by primary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to a `long double` variable which will have its value set to the secondary key of the found table row
/// @param primary - The primary key of the table row to look up
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @return iterator to the table row with a primary key equal to `id` or the end iterator of the table if the table row could not be found
pub fn db_idx_long_double_find_primary(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut f64,
primary: u64,
) -> i32;
}
extern "C" {
/// Find a table row in a secondary quadruple-precision floating-point index table by secondary key
///
/// @brief Find a table row in a secondary quadruple-precision floating-point index table by secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key used to lookup the table row
/// @param primary - Pointer to a `long double` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the first table row with a secondary key equal to `*secondary` or the end iterator of the table if the table row could not be found
pub fn db_idx_long_double_find_secondary(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *const f64,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Find the table row in a secondary quadruple-precision floating-point index table that matches the lowerbound condition for a given secondary key
/// The table row that matches the lowerbound condition is the first table row in the table with the lowest secondary key that is >= the given key
///
/// @brief Find the table row in a secondary quadruple-precision floating-point index table that matches the lowerbound condition for a given secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key first used to determine the lowerbound and which is then replaced with the secondary key of the found table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_idx_long_double_lowerbound(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut f64,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Find the table row in a secondary quadruple-precision floating-point index table that matches the upperbound condition for a given secondary key
/// The table row that matches the upperbound condition is the first table row in the table with the lowest secondary key that is > the given key
///
/// @brief Find the table row in a secondary quadruple-precision floating-point index table that matches the upperbound condition for a given secondary key
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @param secondary - Pointer to secondary key first used to determine the upperbound and which is then replaced with the secondary key of the found table row
/// @param primary - Pointer to a `uint64_t` variable which will have its value set to the primary key of the found table row
/// @post If and only if the table row is found, `*secondary` will be replaced with the secondary key of the found table row
/// @post If and only if the table row is found, `*primary` will be replaced with the primary key of the found table row
/// @return iterator to the found table row or the end iterator of the table if the table row could not be found
pub fn db_idx_long_double_upperbound(
code: capi_name,
scope: u64,
table: capi_name,
secondary: *mut f64,
primary: *mut u64,
) -> i32;
}
extern "C" {
/// Get an end iterator representing just-past-the-end of the last table row of a secondary quadruple-precision floating-point index table
///
/// @brief Get an end iterator representing just-past-the-end of the last table row of a secondary quadruple-precision floating-point index table
/// @param code - The name of the owner of the table
/// @param scope - The scope where the table resides
/// @param table - The table name
/// @return end iterator of the table
pub fn db_idx_long_double_end(code: capi_name, scope: u64, table: capi_name) -> i32;
}
extern "C" {
/// @brief Checks if a transaction is authorized by a provided set of keys and permissions
///
/// @param trx_data - pointer to the start of the serialized transaction
/// @param trx_size - size (in bytes) of the serialized transaction
/// @param pubkeys_data - pointer to the start of the serialized vector of provided public keys
/// @param pubkeys_size - size (in bytes) of serialized vector of provided public keys (can be 0 if no public keys are to be provided)
/// @param perms_data - pointer to the start of the serialized vector of provided permissions (empty permission name acts as wildcard)
/// @param perms_size - size (in bytes) of the serialized vector of provided permissions
///
/// @return 1 if the transaction is authorized, 0 otherwise
pub fn check_transaction_authorization(
trx_data: *const crate::ctypes::c_char,
trx_size: u32,
pubkeys_data: *const crate::ctypes::c_char,
pubkeys_size: u32,
perms_data: *const crate::ctypes::c_char,
perms_size: u32,
) -> i32;
}
extern "C" {
/// @brief Checks if a permission is authorized by a provided delay and a provided set of keys and permissions
///
/// @param account - the account owner of the permission
/// @param permission - the name of the permission to check for authorization
/// @param pubkeys_data - pointer to the start of the serialized vector of provided public keys
/// @param pubkeys_size - size (in bytes) of serialized vector of provided public keys (can be 0 if no public keys are to be provided)
/// @param perms_data - pointer to the start of the serialized vector of provided permissions (empty permission name acts as wildcard)
/// @param perms_size - size (in bytes) of the serialized vector of provided permissions
/// @param delay_us - the provided delay in microseconds (cannot exceed INT64_MAX)
///
/// @return 1 if the permission is authorized, 0 otherwise
pub fn check_permission_authorization(
account: capi_name,
permission: capi_name,
pubkeys_data: *const crate::ctypes::c_char,
pubkeys_size: u32,
perms_data: *const crate::ctypes::c_char,
perms_size: u32,
delay_us: u64,
) -> i32;
}
extern "C" {
/// @brief Returns the last used time of a permission
///
/// @param account - the account owner of the permission
/// @param permission - the name of the permission
///
/// @return the last used time (in microseconds since Unix epoch) of the permission
pub fn get_permission_last_used(account: capi_name, permission: capi_name) -> i64;
}
extern "C" {
/// @brief Returns the creation time of an account
///
/// @param account - the account
///
/// @return the creation time (in microseconds since Unix epoch) of the account
pub fn get_account_creation_time(account: capi_name) -> i64;
}
extern "C" {
/// Prints string
/// @brief Prints string
/// @param cstr - a null terminated string
///
/// Example:
///
/// @code
/// prints("Hello World!"); // Output: Hello World!
/// @endcode
pub fn prints(cstr: *const crate::ctypes::c_char);
}
extern "C" {
/// Prints string up to given length
/// @brief Prints string
/// @param cstr - pointer to string
/// @param len - len of string to be printed
///
/// Example:
///
/// @code
/// prints_l("Hello World!", 5); // Output: Hello
/// @endcode
pub fn prints_l(cstr: *const crate::ctypes::c_char, len: u32);
}
extern "C" {
/// Prints value as a 64 bit signed integer
/// @brief Prints value as a 64 bit signed integer
/// @param value of 64 bit signed integer to be printed
///
/// Example:
///
/// @code
/// printi(-1e+18); // Output: -1000000000000000000
/// @endcode
pub fn printi(value: i64);
}
extern "C" {
/// Prints value as a 64 bit unsigned integer
/// @brief Prints value as a 64 bit unsigned integer
/// @param value of 64 bit unsigned integer to be printed
///
/// Example:
///
/// @code
/// printui(1e+18); // Output: 1000000000000000000
/// @endcode
pub fn printui(value: u64);
}
extern "C" {
/// Prints value as a 128 bit signed integer
/// @brief Prints value as a 128 bit signed integer
/// @param value is a pointer to the 128 bit signed integer to be printed
///
/// Example:
///
/// @code
/// int128_t large_int(-87654323456);
/// printi128(&large_int); // Output: -87654323456
/// @endcode
pub fn printi128(value: *const int128_t);
}
extern "C" {
/// Prints value as a 128 bit unsigned integer
/// @brief Prints value as a 128 bit unsigned integer
/// @param value is a pointer to the 128 bit unsigned integer to be printed
///
/// Example:
///
/// @code
/// uint128_t large_int(87654323456);
/// printui128(&large_int); // Output: 87654323456
/// @endcode
pub fn printui128(value: *const uint128_t);
}
extern "C" {
/// Prints value as single-precision floating point number
/// @brief Prints value as single-precision floating point number (i.e. float)
/// @param value of float to be printed
///
/// Example:
///
/// @code
/// float value = 5.0 / 10.0;
/// printsf(value); // Output: 0.5
/// @endcode
pub fn printsf(value: f32);
}
extern "C" {
/// Prints value as double-precision floating point number
/// @brief Prints value as double-precision floating point number (i.e. double)
/// @param value of double to be printed
///
/// Example:
///
/// @code
/// double value = 5.0 / 10.0;
/// printdf(value); // Output: 0.5
/// @endcode
pub fn printdf(value: f64);
}
extern "C" {
/// Prints value as quadruple-precision floating point number
/// @brief Prints value as quadruple-precision floating point number (i.e. long double)
/// @param value is a pointer to the long double to be printed
///
/// Example:
///
/// @code
/// long double value = 5.0 / 10.0;
/// printqf(value); // Output: 0.5
/// @endcode
pub fn printqf(value: *const f64);
}
extern "C" {
/// Prints a 64 bit names as base32 encoded string
/// @brief Prints a 64 bit names as base32 encoded string
/// @param name - 64 bit name to be printed
///
/// Example:
/// @code
/// printn(N(abcde)); // Output: abcde
/// @endcode
pub fn printn(name: u64);
}
extern "C" {
pub fn printhex(data: *const crate::ctypes::c_void, datalen: u32);
}
extern "C" {
/// @brief Get the resource limits of an account
/// Get the resource limits of an account
/// @param account - name of the account whose resource limit to get
/// @param ram_bytes - pointer to `int64_t` to hold retrieved ram limit in absolute bytes
/// @param net_weight - pointer to `int64_t` to hold net limit
/// @param cpu_weight - pointer to `int64_t` to hold cpu limit
pub fn get_resource_limits(
account: capi_name,
ram_bytes: *mut i64,
net_weight: *mut i64,
cpu_weight: *mut i64,
);
}
extern "C" {
/// @brief Set the resource limits of an account
/// Set the resource limits of an account
/// @param account - name of the account whose resource limit to be set
/// @param ram_bytes - ram limit in absolute bytes
/// @param net_weight - fractionally proportionate net limit of available resources based on (weight / total_weight_of_all_accounts)
/// @param cpu_weight - fractionally proportionate cpu limit of available resources based on (weight / total_weight_of_all_accounts)
pub fn set_resource_limits(
account: capi_name,
ram_bytes: i64,
net_weight: i64,
cpu_weight: i64,
);
}
extern "C" {
/// Proposes a schedule change, once the block that contains the proposal becomes irreversible, the schedule is promoted to "pending" automatically. Once the block that promotes the schedule is irreversible, the schedule will become "active"
/// @param producer_data - packed data of produce_keys in the appropriate producer schedule order
/// @param producer_data_size - size of the data buffer
///
/// @return -1 if proposing a new producer schedule was unsuccessful, otherwise returns the version of the new proposed schedule
pub fn set_proposed_producers(
producer_data: *mut crate::ctypes::c_char,
producer_data_size: u32,
) -> i64;
}
extern "C" {
/// @brief Set new active producers
/// Set new active producers. Producers will only be activated once the block which starts the next round is irrreversible
/// @param producer_data - pointer to producer schedule packed as bytes
/// @param producer_data_size - size of the packed producer schedule
/// @pre `producer_data` is a valid pointer to a range of memory at least `producer_data_size` bytes long that contains serialized produced schedule data
pub fn set_active_producers(producer_data: *mut crate::ctypes::c_char, producer_data_size: u32);
}
extern "C" {
/// @brief Check if an account is privileged
/// Check if an account is privileged
/// @param account - name of the account to be checked
/// @return true if the account is privileged
/// @return false if the account is not privileged
pub fn is_privileged(account: capi_name) -> bool;
}
extern "C" {
/// @brief Set the privileged status of an account
/// Set the privileged status of an account
/// @param account - name of the account whose privileged account to be set
/// @param is_priv - privileged status
pub fn set_privileged(account: capi_name, is_priv: bool);
}
extern "C" {
/// @brief Set the blockchain parameters
/// Set the blockchain parameters
/// @param data - pointer to blockchain parameters packed as bytes
/// @param datalen - size of the packed blockchain parameters
/// @pre `data` is a valid pointer to a range of memory at least `datalen` bytes long that contains packed blockchain params data
pub fn set_blockchain_parameters_packed(data: *mut crate::ctypes::c_char, datalen: u32);
}
extern "C" {
/// @brief Retrieve the blolckchain parameters
/// Retrieve the blolckchain parameters
/// @param data - output buffer of the blockchain parameters, only retrieved if sufficent size to hold packed data.
/// @param datalen - size of the data buffer, 0 to report required size.
/// @return size of the blockchain parameters
/// @pre `data` is a valid pointer to a range of memory at least `datalen` bytes long
/// @post `data` is filled with packed blockchain parameters
pub fn get_blockchain_parameters_packed(data: *mut crate::ctypes::c_char, datalen: u32) -> u32;
}
extern "C" {
/// @brief Activate new feature
/// Activate new feature
/// @param f - name (identifier) of the feature to be activated
pub fn activate_feature(f: i64);
}
extern "C" {
/// Sends a deferred transaction.
///
/// @brief Sends a deferred transaction.
/// @param sender_id - ID of sender
/// @param payer - Account paying for RAM
/// @param serialized_transaction - Pointer of serialized transaction to be deferred
/// @param size - Size to reserve
/// @param replace_existing - f this is `0` then if the provided sender_id is already in use by an in-flight transaction from this contract, which will be a failing assert. If `1` then transaction will atomically cancel/replace the inflight transaction
pub fn send_deferred(
sender_id: *const uint128_t,
payer: capi_name,
serialized_transaction: *const crate::ctypes::c_char,
size: usize,
replace_existing: u32,
);
}
extern "C" {
/// Cancels a deferred transaction.
///
/// @brief Cancels a deferred transaction.
/// @param sender_id - The id of the sender
///
/// @pre The deferred transaction ID exists.
/// @pre The deferred transaction ID has not yet been published.
/// @post Deferred transaction canceled.
///
/// @return 1 if transaction was canceled, 0 if transaction was not found
///
/// Example:
///
/// @code
/// id = 0xffffffffffffffff
/// cancel_deferred( id );
/// @endcode
pub fn cancel_deferred(sender_id: *const uint128_t) -> crate::ctypes::c_int;
}
extern "C" {
/// Access a copy of the currently executing transaction.
///
/// @brief Access a copy of the currently executing transaction.
/// @param buffer - a buffer to write the current transaction to
/// @param size - the size of the buffer, 0 to return required size
/// @return the size of the transaction written to the buffer, or number of bytes that can be copied if size==0 passed
pub fn read_transaction(buffer: *mut crate::ctypes::c_char, size: usize) -> usize;
}
extern "C" {
/// Gets the size of the currently executing transaction.
///
/// @brief Gets the size of the currently executing transaction.
/// @return size of the currently executing transaction
pub fn transaction_size() -> usize;
}
extern "C" {
/// Gets the block number used for TAPOS on the currently executing transaction.
///
/// @brief Gets the block number used for TAPOS on the currently executing transaction.
/// @return block number used for TAPOS on the currently executing transaction
/// Example:
/// @code
/// int tbn = tapos_block_num();
/// @endcode
pub fn tapos_block_num() -> crate::ctypes::c_int;
}
extern "C" {
/// Gets the block prefix used for TAPOS on the currently executing transaction.
///
/// @brief Gets the block prefix used for TAPOS on the currently executing transaction.
/// @return block prefix used for TAPOS on the currently executing transaction
/// Example:
/// @code
/// int tbp = tapos_block_prefix();
/// @endcode
pub fn tapos_block_prefix() -> crate::ctypes::c_int;
}
extern "C" {
/// Gets the expiration of the currently executing transaction.
///
/// @brief Gets the expiration of the currently executing transaction.
/// @return expiration of the currently executing transaction in seconds since Unix epoch
/// Example:
/// @code
/// uint32_t tm = expiration();
/// eosio_print(tm);
/// @endcode
pub fn expiration() -> u32;
}
extern "C" {
/// Retrieves the indicated action from the active transaction.
///
/// @brief Retrieves the indicated action from the active transaction.
/// @param type - 0 for context free action, 1 for action
/// @param index - the index of the requested action
/// @param buff - output packed buff of the action
/// @param size - amount of buff read, pass 0 to have size returned
/// @return the size of the action, -1 on failure
pub fn get_action(
type_: u32,
index: u32,
buff: *mut crate::ctypes::c_char,
size: usize,
) -> crate::ctypes::c_int;
}
extern "C" {
/// Retrieve the signed_transaction.context_free_data[index].
///
/// @brief Retrieve the signed_transaction.context_free_data[index].
/// @param index - the index of the context_free_data entry to retrieve
/// @param buff - output buff of the context_free_data entry
/// @param size - amount of context_free_data[index] to retrieve into buff, 0 to report required size
/// @return size copied, or context_free_data[index].size() if 0 passed for size, or -1 if index not valid
pub fn get_context_free_data(
index: u32,
buff: *mut crate::ctypes::c_char,
size: usize,
) -> crate::ctypes::c_int;
}