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
// Copyright (c) 2022 MASSA LABS <info@massa.net>
//! This module represents the context in which the VM executes bytecode.
//! It provides information such as the current call stack.
//! It also maintains a "speculative" ledger state which is a virtual ledger
//! as seen after applying everything that happened so far in the context.
//! More generally, the context acts only on its own state
//! and does not write anything persistent to the consensus state.
use crate::active_history::HistorySearchResult;
use crate::speculative_async_pool::SpeculativeAsyncPool;
use crate::speculative_deferred_calls::SpeculativeDeferredCallRegistry;
use crate::speculative_executed_denunciations::SpeculativeExecutedDenunciations;
use crate::speculative_executed_ops::SpeculativeExecutedOps;
use crate::speculative_ledger::SpeculativeLedger;
use crate::{active_history::ActiveHistory, speculative_roll_state::SpeculativeRollState};
use massa_async_pool::{AsyncMessage, AsyncPoolChanges};
use massa_async_pool::{AsyncMessageId, AsyncMessageInfo};
use massa_deferred_calls::registry_changes::DeferredCallRegistryChanges;
use massa_deferred_calls::{DeferredCall, DeferredSlotCalls};
use massa_executed_ops::{ExecutedDenunciationsChanges, ExecutedOpsChanges};
use massa_execution_exports::{
EventStore, ExecutedBlockInfo, ExecutionConfig, ExecutionError, ExecutionOutput,
ExecutionStackElement,
};
use massa_final_state::{FinalStateController, StateChanges};
use massa_hash::Hash;
use massa_ledger_exports::LedgerChanges;
use massa_models::address::ExecutionAddressCycleInfo;
use massa_models::block_id::BlockIdSerializer;
use massa_models::bytecode::Bytecode;
use massa_models::deferred_calls::DeferredCallId;
use massa_models::denunciation::DenunciationIndex;
use massa_models::timeslots::get_block_slot_timestamp;
use massa_models::types::SetOrKeep;
use massa_models::{
address::Address,
amount::Amount,
block_id::BlockId,
operation::OperationId,
output_event::{EventExecutionContext, SCOutputEvent},
slot::Slot,
};
use massa_module_cache::controller::ModuleCache;
use massa_pos_exports::PoSChanges;
use massa_sc_runtime::CondomLimits;
use massa_serialization::Serializer;
use massa_versioning::address_factory::{AddressArgs, AddressFactory};
use massa_versioning::versioning::{MipComponent, MipStore};
use massa_versioning::versioning_factory::{FactoryStrategy, VersioningFactory};
use parking_lot::RwLock;
use rand::SeedableRng;
use rand_xoshiro::Xoshiro256PlusPlus;
use std::collections::{BTreeMap, BTreeSet};
use std::sync::Arc;
use tracing::{debug, warn};
/// A snapshot taken from an `ExecutionContext` and that represents its current state.
/// The `ExecutionContext` state can then be restored later from this snapshot.
pub struct ExecutionContextSnapshot {
/// speculative ledger changes caused so far in the context
pub ledger_changes: LedgerChanges,
/// speculative asynchronous pool messages emitted so far in the context
pub async_pool_changes: AsyncPoolChanges,
/// speculative deferred calls changes
pub deferred_calls_changes: DeferredCallRegistryChanges,
/// the associated message infos for the speculative async pool
pub message_infos: BTreeMap<AsyncMessageId, AsyncMessageInfo>,
/// speculative list of operations executed
pub executed_ops: ExecutedOpsChanges,
/// speculative list of executed denunciations
pub executed_denunciations: ExecutedDenunciationsChanges,
/// speculative roll state changes caused so far in the context
pub pos_changes: PoSChanges,
/// counter of newly created addresses so far for this slot (does not reset after each execution)
pub created_addr_index: u64,
/// counter of newly created events so far for this slot (does not reset after each execution)
pub created_event_index: u64,
/// counter of async messages emitted so far for this slot (does not reset after each execution)
pub created_message_index: u64,
/// address call stack, most recent is at the back
pub stack: Vec<ExecutionStackElement>,
/// keep the count of event emitted in the context
pub event_count: usize,
/// Unsafe random state
pub unsafe_rng: Xoshiro256PlusPlus,
/// The gas remaining before the last subexecution.
/// so *excluding* the gas used by the last sc call.
pub gas_remaining_before_subexecution: Option<u64>,
/// recursion counter, incremented for each new nested call
/// This is used to avoid stack overflow issues in the VM (that would crash the node instead of failing the call),
/// by limiting the depth of recursion contracts can have with the max_recursive_calls_depth value.
pub recursion_counter: u16,
/// Counts the number of event (apart from system events) in the current execution_context
/// Should be reset to 0 when executing a new op / readonly request / asc / deferred call
pub user_event_count_in_current_exec: u16,
}
/// An execution context that needs to be initialized before executing bytecode,
/// passed to the VM to interact with during bytecode execution (through ABIs),
/// and read after execution to gather results.
pub struct ExecutionContext {
/// configuration
config: ExecutionConfig,
/// speculative ledger state,
/// as seen after everything that happened so far in the context
#[cfg(all(
not(feature = "gas_calibration"),
not(feature = "benchmarking"),
not(feature = "test-exports"),
not(test)
))]
speculative_ledger: SpeculativeLedger,
#[cfg(any(
feature = "gas_calibration",
feature = "benchmarking",
feature = "test-exports",
test
))]
pub(crate) speculative_ledger: SpeculativeLedger,
/// speculative asynchronous pool state,
/// as seen after everything that happened so far in the context
speculative_async_pool: SpeculativeAsyncPool,
/// speculative deferred calls state,
speculative_deferred_calls: SpeculativeDeferredCallRegistry,
/// speculative roll state,
/// as seen after everything that happened so far in the context
speculative_roll_state: SpeculativeRollState,
/// speculative list of executed operations
speculative_executed_ops: SpeculativeExecutedOps,
/// speculative list of executed denunciations
speculative_executed_denunciations: SpeculativeExecutedDenunciations,
/// minimal balance allowed for the creator of the operation after its execution
pub creator_min_balance: Option<Amount>,
/// slot at which the execution happens
pub slot: Slot,
/// counter of newly created addresses so far during this execution
pub created_addr_index: u64,
/// counter of newly created events so far during this execution
pub created_event_index: u64,
/// counter of newly created messages so far during this execution
pub created_message_index: u64,
/// block Id, if one is present at the execution slot
pub opt_block_id: Option<BlockId>,
/// address call stack, most recent is at the back
pub stack: Vec<ExecutionStackElement>,
/// True if it's a read-only context
pub read_only: bool,
/// generated events during this execution, with multiple indexes
pub events: EventStore,
/// Unsafe random state (can be predicted and manipulated)
pub unsafe_rng: Xoshiro256PlusPlus,
/// Creator address. The bytecode of this address can't be modified
pub creator_address: Option<Address>,
/// operation id that originally caused this execution (if any)
pub origin_operation_id: Option<OperationId>,
/// Execution trail hash
pub execution_trail_hash: Hash,
/// cache of compiled runtime modules
pub module_cache: Arc<RwLock<ModuleCache>>,
/// Address factory
pub address_factory: AddressFactory,
/// The gas remaining before the last subexecution.
/// so *excluding* the gas used by the last sc call.
pub gas_remaining_before_subexecution: Option<u64>,
/// The version of the execution component
pub execution_component_version: u32,
/// recursion counter, incremented for each new nested call
pub recursion_counter: u16,
/// Counts the number of event (apart from system events) in the current execution_context
/// Should be reset to 0 when executing a new op / readonly request / asc / deferred call
pub user_event_count_in_current_exec: u16,
}
impl ExecutionContext {
/// Create a new empty `ExecutionContext`
/// This should only be used as a placeholder.
/// Further initialization is required before running bytecode
/// (see read-only and `active_slot` methods).
///
/// # arguments
/// * `final_state`: thread-safe access to the final state.
///
/// Note that this will be used only for reading, never for writing
///
/// # returns
/// A new (empty) `ExecutionContext` instance
pub(crate) fn new(
config: ExecutionConfig,
final_state: Arc<RwLock<dyn FinalStateController>>,
active_history: Arc<RwLock<ActiveHistory>>,
module_cache: Arc<RwLock<ModuleCache>>,
mip_store: MipStore,
execution_trail_hash: massa_hash::Hash,
) -> Self {
let slot = Slot::new(0, 0);
let ts = get_block_slot_timestamp(
config.thread_count,
config.t0,
config.genesis_timestamp,
slot,
)
.expect("Time overflow when getting block slot timestamp for MIP");
ExecutionContext {
speculative_ledger: SpeculativeLedger::new(
final_state.clone(),
active_history.clone(),
config.max_datastore_key_length,
config.max_bytecode_size,
config.max_datastore_value_size,
config.storage_costs_constants,
),
speculative_async_pool: SpeculativeAsyncPool::new(
final_state.clone(),
active_history.clone(),
),
speculative_deferred_calls: SpeculativeDeferredCallRegistry::new(
final_state.clone(),
active_history.clone(),
config.deferred_calls_config,
),
speculative_roll_state: SpeculativeRollState::new(
final_state.clone(),
active_history.clone(),
),
speculative_executed_ops: SpeculativeExecutedOps::new(
final_state.clone(),
active_history.clone(),
),
speculative_executed_denunciations: SpeculativeExecutedDenunciations::new(
final_state,
active_history,
),
creator_min_balance: Default::default(),
slot,
created_addr_index: Default::default(),
created_event_index: Default::default(),
created_message_index: Default::default(),
opt_block_id: Default::default(),
stack: Default::default(),
read_only: Default::default(),
events: Default::default(),
unsafe_rng: init_prng(&execution_trail_hash),
creator_address: Default::default(),
origin_operation_id: Default::default(),
module_cache,
config,
address_factory: AddressFactory {
mip_store: mip_store.clone(),
},
execution_trail_hash,
gas_remaining_before_subexecution: None,
execution_component_version: mip_store
.get_latest_component_version_at(&MipComponent::Execution, ts),
recursion_counter: 0,
user_event_count_in_current_exec: 0,
}
}
/// Returns a snapshot containing the clone of the current execution state.
/// Note that the snapshot does not include slot-level information such as the slot number or block ID.
pub(crate) fn get_snapshot(&self) -> ExecutionContextSnapshot {
let (async_pool_changes, message_infos) = self.speculative_async_pool.get_snapshot();
ExecutionContextSnapshot {
ledger_changes: self.speculative_ledger.get_snapshot(),
async_pool_changes,
deferred_calls_changes: self.speculative_deferred_calls.get_snapshot(),
message_infos,
pos_changes: self.speculative_roll_state.get_snapshot(),
executed_ops: self.speculative_executed_ops.get_snapshot(),
executed_denunciations: self.speculative_executed_denunciations.get_snapshot(),
created_addr_index: self.created_addr_index,
created_event_index: self.created_event_index,
created_message_index: self.created_message_index,
stack: self.stack.clone(),
event_count: self.events.0.len(),
unsafe_rng: self.unsafe_rng.clone(),
gas_remaining_before_subexecution: self.gas_remaining_before_subexecution,
recursion_counter: self.recursion_counter,
user_event_count_in_current_exec: self.user_event_count_in_current_exec,
}
}
/// Resets context to an existing snapshot.
/// Optionally emits an error as an event after restoring the snapshot.
/// Note that the snapshot does not include slot-level information such as the slot number or block ID.
///
/// # Arguments
/// * `snapshot`: a saved snapshot to be restored
/// * `error`: an execution error to emit as an event conserved after snapshot reset.
pub fn reset_to_snapshot(&mut self, snapshot: ExecutionContextSnapshot, error: ExecutionError) {
// Emit the error event.
// Note that the context event counter is properly handled by event_emit (see doc).
let mut event = self.event_create(
serde_json::json!({ "massa_execution_error": format!("{}", error) }).to_string(),
true,
);
let max_event_size = match self.execution_component_version {
0 => self.config.max_event_size_v0,
_ => self.config.max_event_size_v1,
};
if event.data.len() > max_event_size {
event.data.truncate(max_event_size);
}
self.event_emit(event);
// Reset context to snapshot.
self.speculative_ledger
.reset_to_snapshot(snapshot.ledger_changes);
self.speculative_async_pool
.reset_to_snapshot((snapshot.async_pool_changes, snapshot.message_infos));
self.speculative_deferred_calls
.reset_to_snapshot(snapshot.deferred_calls_changes);
self.speculative_roll_state
.reset_to_snapshot(snapshot.pos_changes);
self.speculative_executed_ops
.reset_to_snapshot(snapshot.executed_ops);
self.speculative_executed_denunciations
.reset_to_snapshot(snapshot.executed_denunciations);
self.created_addr_index = snapshot.created_addr_index;
self.created_event_index = snapshot.created_event_index;
self.created_message_index = snapshot.created_message_index;
self.stack = snapshot.stack;
self.unsafe_rng = snapshot.unsafe_rng;
self.gas_remaining_before_subexecution = snapshot.gas_remaining_before_subexecution;
self.recursion_counter = snapshot.recursion_counter;
self.user_event_count_in_current_exec = snapshot.user_event_count_in_current_exec;
// For events, set snapshot delta to error events.
for event in self.events.0.range_mut(snapshot.event_count..) {
event.context.is_error = true;
}
}
/// Create a new `ExecutionContext` for read-only execution
/// This should be used before performing a read-only execution.
///
/// # arguments
/// * `slot`: slot at which the execution will happen
/// * `req`: parameters of the read only execution
/// * `final_state`: thread-safe access to the final state. Note that this will be used only for reading, never for writing
///
/// # returns
/// A `ExecutionContext` instance ready for a read-only execution
#[allow(clippy::too_many_arguments)]
pub(crate) fn readonly(
config: ExecutionConfig,
slot: Slot,
call_stack: Vec<ExecutionStackElement>,
final_state: Arc<RwLock<dyn FinalStateController>>,
active_history: Arc<RwLock<ActiveHistory>>,
module_cache: Arc<RwLock<ModuleCache>>,
mip_store: MipStore,
) -> Self {
// Get the execution hash trail
let prev_execution_trail_hash = active_history.read().get_execution_trail_hash();
let prev_execution_trail_hash = match prev_execution_trail_hash {
HistorySearchResult::Present(h) => h,
_ => final_state.read().get_execution_trail_hash(),
};
let execution_trail_hash =
generate_execution_trail_hash(&prev_execution_trail_hash, &slot, None, true);
let ts = get_block_slot_timestamp(
config.thread_count,
config.t0,
config.genesis_timestamp,
slot,
)
.expect("Time overflow when getting block slot timestamp for MIP");
// return readonly context
ExecutionContext {
slot,
stack: call_stack,
read_only: true,
execution_component_version: mip_store
.get_latest_component_version_at(&MipComponent::Execution, ts),
..ExecutionContext::new(
config,
final_state,
active_history,
module_cache,
mip_store,
execution_trail_hash,
)
}
}
/// This function takes a batch of asynchronous operations to execute, removing them from the speculative pool.
///
/// # Arguments
/// * `max_gas`: maximal amount of asynchronous gas available
///
/// # Returns
/// A vector of `(Option<Bytecode>, AsyncMessage)` pairs where:
/// * `Option<Bytecode>` is the bytecode to execute (or `None` if not found)
/// * `AsyncMessage` is the asynchronous message to execute
pub(crate) fn take_async_batch_v0(
&mut self,
max_gas: u64,
async_msg_cst_gas_cost: u64,
) -> Vec<(Option<Bytecode>, AsyncMessage)> {
self.speculative_async_pool
.take_batch_to_execute(self.slot, max_gas, async_msg_cst_gas_cost)
.into_iter()
.map(|(_id, msg)| (self.get_bytecode(&msg.destination), msg))
.collect()
}
pub(crate) fn take_async_batch_v1(
&mut self,
max_gas: u64,
async_msg_cst_gas_cost: u64,
) -> Vec<(AsyncMessageId, AsyncMessage)> {
self.speculative_async_pool.take_batch_to_execute(
self.slot,
max_gas,
async_msg_cst_gas_cost,
)
}
/// Create a new `ExecutionContext` for executing an active slot.
/// This should be used before performing any executions at that slot.
///
/// # arguments
/// * `slot`: slot at which the execution will happen
/// * `opt_block_id`: optional ID of the block at that slot
/// * `final_state`: thread-safe access to the final state. Note that this will be used only for reading, never for writing
///
/// # returns
/// A `ExecutionContext` instance
#[allow(clippy::too_many_arguments)]
pub(crate) fn active_slot(
config: ExecutionConfig,
slot: Slot,
opt_block_id: Option<BlockId>,
final_state: Arc<RwLock<dyn FinalStateController>>,
active_history: Arc<RwLock<ActiveHistory>>,
module_cache: Arc<RwLock<ModuleCache>>,
mip_store: MipStore,
) -> Self {
// Get the execution hash trail
let prev_execution_trail_hash = active_history.read().get_execution_trail_hash();
let prev_execution_trail_hash = match prev_execution_trail_hash {
HistorySearchResult::Present(h) => h,
_ => final_state.read().get_execution_trail_hash(),
};
let execution_trail_hash = generate_execution_trail_hash(
&prev_execution_trail_hash,
&slot,
opt_block_id.as_ref(),
false,
);
let ts = get_block_slot_timestamp(
config.thread_count,
config.t0,
config.genesis_timestamp,
slot,
)
.expect("Time overflow when getting block slot timestamp for MIP");
// return active slot execution context
ExecutionContext {
slot,
opt_block_id,
execution_component_version: mip_store
.get_latest_component_version_at(&MipComponent::Execution, ts),
..ExecutionContext::new(
config,
final_state,
active_history,
module_cache,
mip_store,
execution_trail_hash,
)
}
}
/// Gets the address at the top of the call stack, if any
pub fn get_current_address(&self) -> Result<Address, ExecutionError> {
match self.stack.last() {
Some(addr) => Ok(addr.address),
_ => Err(ExecutionError::RuntimeError(
"failed to read current address: call stack empty".into(),
)),
}
}
/// Gets the current list of owned addresses (top of the stack)
/// Ordering is conserved for determinism
pub fn get_current_owned_addresses(&self) -> Result<Vec<Address>, ExecutionError> {
match self.stack.last() {
Some(v) => Ok(v.owned_addresses.clone()),
None => Err(ExecutionError::RuntimeError(
"failed to read current owned addresses list: call stack empty".into(),
)),
}
}
/// Gets the current call coins
pub fn get_current_call_coins(&self) -> Result<Amount, ExecutionError> {
match self.stack.last() {
Some(v) => Ok(v.coins),
None => Err(ExecutionError::RuntimeError(
"failed to read current call coins: call stack empty".into(),
)),
}
}
/// Gets the addresses from the call stack (last = top of the stack)
pub fn get_call_stack(&self) -> Vec<Address> {
self.stack.iter().map(|v| v.address).collect()
}
/// Checks whether the context currently grants write access to a given address
pub fn has_write_rights_on(&self, addr: &Address) -> bool {
self.stack
.last()
.map_or(false, |v| v.owned_addresses.contains(addr))
}
/// Creates a new smart contract address with initial bytecode, and returns this address
pub fn create_new_sc_address(&mut self, bytecode: Bytecode) -> Result<Address, ExecutionError> {
// deterministically generate a new unique smart contract address
let slot_timestamp = get_block_slot_timestamp(
self.config.thread_count,
self.config.t0,
self.config.genesis_timestamp,
self.slot,
)
.expect("could not compute current slot timestamp");
// Loop over nonces until we find an address that doesn't exist in the speculative ledger.
// Note that this loop is here for robustness, and should not be looping because
// even through the SC addresses are predictable, nobody can create them beforehand because:
// - their category is "SC" and not "USER" so they can't be derived from a public key
// - sending tokens to the target SC address to create it by funding is not allowed because transactions towards SC addresses are not allowed
let mut nonce = 0u64;
let address = loop {
// get a deterministic seed hash
let hash = massa_hash::Hash::compute_from_tuple(&[
"SC_ADDRESS".as_bytes(),
self.execution_trail_hash.to_bytes(),
&self.created_addr_index.to_be_bytes(),
&nonce.to_be_bytes(),
]);
// deduce the address
let addr = self.address_factory.create(
&AddressArgs::SC { hash },
FactoryStrategy::At(slot_timestamp),
)?;
// check if this address already exists in the speculative ledger
if !self.speculative_ledger.entry_exists(&addr) {
// if not, we can use it
break addr;
}
// otherwise, increment the nonce to get a new hash and try again
nonce = nonce.checked_add(1).ok_or_else(|| {
ExecutionError::RuntimeError("nonce overflow when creating SC address".into())
})?;
};
// add this address with its bytecode to the speculative ledger
self.speculative_ledger.create_new_sc_address(
self.get_current_address()?,
address,
bytecode,
self.execution_component_version,
)?;
// add the address to owned addresses
// so that the current call has write access to it
// from now and for its whole duration,
// in order to allow initializing newly created ledger entries.
match self.stack.last_mut() {
Some(v) => {
v.owned_addresses.push(address);
}
None => {
return Err(ExecutionError::RuntimeError(
"owned addresses not found in context stack".into(),
));
}
};
// increment the address creation counter at this slot
self.created_addr_index += 1;
Ok(address)
}
/// gets the bytecode of an address if it exists in the speculative ledger, or returns None
pub fn get_bytecode(&self, address: &Address) -> Option<Bytecode> {
self.speculative_ledger.get_bytecode(address)
}
/// gets the datastore keys of an address if it exists in the speculative ledger, or returns None
pub fn get_keys(&self, address: &Address, prefix: &[u8]) -> Option<BTreeSet<Vec<u8>>> {
self.speculative_ledger.get_keys(address, prefix)
}
/// gets the data from a datastore entry of an address if it exists in the speculative ledger, or returns None
pub fn get_data_entry(&self, address: &Address, key: &[u8]) -> Option<Vec<u8>> {
self.speculative_ledger.get_data_entry(address, key)
}
/// checks if a datastore entry exists in the speculative ledger
pub fn has_data_entry(&self, address: &Address, key: &[u8]) -> bool {
self.speculative_ledger.has_data_entry(address, key)
}
/// gets the effective balance of an address
pub fn get_balance(&self, address: &Address) -> Option<Amount> {
self.speculative_ledger.get_balance(address)
}
/// Sets a datastore entry for an address in the speculative ledger.
/// Fail if the address is absent from the ledger.
/// The datastore entry is created if it is absent for that address.
///
/// # Arguments
/// * address: the address of the ledger entry
/// * key: the datastore key
/// * data: the data to insert
pub fn set_data_entry(
&mut self,
address: &Address,
key: Vec<u8>,
data: Vec<u8>,
) -> Result<(), ExecutionError> {
// check access right
if !self.has_write_rights_on(address) {
return Err(ExecutionError::RuntimeError(format!(
"writing in the datastore of address {} is not allowed in this context",
address
)));
}
// set data entry
self.speculative_ledger.set_data_entry(
&self.get_current_address()?,
address,
key,
data,
self.execution_component_version,
)
}
/// Appends data to a datastore entry for an address in the speculative ledger.
/// Fail if the address is absent from the ledger.
/// Fails if the datastore entry is absent for that address.
///
/// # Arguments
/// * address: the address of the ledger entry
/// * key: the datastore key
/// * data: the data to append
pub fn append_data_entry(
&mut self,
address: &Address,
key: Vec<u8>,
data: Vec<u8>,
) -> Result<(), ExecutionError> {
// check access right
if !self.has_write_rights_on(address) {
return Err(ExecutionError::RuntimeError(format!(
"appending to the datastore of address {} is not allowed in this context",
address
)));
}
// get current data entry
let mut res_data = self
.speculative_ledger
.get_data_entry(address, &key)
.ok_or_else(|| {
ExecutionError::RuntimeError(format!(
"appending to the datastore of address {} failed: entry {:?} not found",
address, key
))
})?;
// append data
res_data.extend(data);
// set data entry
self.speculative_ledger.set_data_entry(
&self.get_current_address()?,
address,
key,
res_data,
self.execution_component_version,
)
}
/// Deletes a datastore entry for an address.
/// Fails if the address or the entry does not exist or if write access rights are missing.
///
/// # Arguments
/// * address: the address of the ledger entry
/// * key: the datastore key
pub fn delete_data_entry(
&mut self,
address: &Address,
key: &[u8],
) -> Result<(), ExecutionError> {
// check access right
if !self.has_write_rights_on(address) {
return Err(ExecutionError::RuntimeError(format!(
"deleting from the datastore of address {} is not allowed in this context",
address
)));
}
// delete entry
self.speculative_ledger.delete_data_entry(
&self.get_current_address()?,
address,
key,
self.execution_component_version,
)
}
/// Transfers coins from one address to another.
/// No changes are retained in case of failure.
/// Spending is only allowed from existing addresses we have write access on
///
/// # Arguments
/// * `from_addr`: optional spending address (use None for pure coin creation)
/// * `to_addr`: optional crediting address (use None for pure coin destruction)
/// * `amount`: amount of coins to transfer
/// * `check_rights`: check that the sender has the right to spend the coins according to the call stack
pub fn transfer_coins(
&mut self,
from_addr: Option<Address>,
to_addr: Option<Address>,
amount: Amount,
check_rights: bool,
) -> Result<(), ExecutionError> {
let execution_component_version = self.execution_component_version;
if let Some(from_addr) = &from_addr {
// check access rights
// ensure we can't spend from an address on which we have no write access
// If execution component version is 0, we need to disallow sending to SC addresses
match execution_component_version {
0 => {
if check_rights {
if !self.has_write_rights_on(from_addr) {
return Err(ExecutionError::RuntimeError(format!(
"spending from address {} is not allowed in this context",
from_addr
)));
}
// ensure we can't transfer towards SC addresses on which we have no write access
if let Some(to_addr) = &to_addr {
if matches!(to_addr, Address::SC(..))
&& !self.has_write_rights_on(to_addr)
{
return Err(ExecutionError::RuntimeError(format!(
"crediting SC address {} is not allowed without write access to it",
to_addr
)));
}
}
}
}
_ => {
if check_rights && !self.has_write_rights_on(from_addr) {
return Err(ExecutionError::RuntimeError(format!(
"spending from address {} is not allowed in this context",
from_addr
)));
}
}
}
}
// do the transfer
self.speculative_ledger.transfer_coins(
from_addr,
to_addr,
amount,
execution_component_version,
)
}
/// Add a new asynchronous message to speculative pool
///
/// # Arguments
/// * `msg`: asynchronous message to add
pub fn push_new_message(&mut self, msg: AsyncMessage) {
self.speculative_async_pool.push_new_message(msg);
}
/// Cancels an asynchronous message, reimbursing `msg.coins` to the sender
///
/// # Arguments
/// * `msg`: the asynchronous message to cancel
pub fn cancel_async_message(
&mut self,
msg: &AsyncMessage,
) -> Option<(Address, Result<Amount, String>)> {
#[allow(unused_assignments, unused_mut)]
let mut result = None;
let transfer_result = self.transfer_coins(None, Some(msg.sender), msg.coins, false);
if let Err(e) = transfer_result.as_ref() {
debug!(
"async message cancel: reimbursement of {} failed: {}",
msg.sender, e
);
}
#[cfg(feature = "execution-info")]
if let Err(e) = transfer_result {
result = Some((msg.sender, Err(e.to_string())))
} else {
result = Some((msg.sender, Ok(msg.coins)));
}
result
}
/// Add `roll_count` rolls to the buyer address.
/// Validity checks must be performed _outside_ of this function.
///
/// # Arguments
/// * `buyer_addr`: address that will receive the rolls
/// * `roll_count`: number of rolls it will receive
pub fn add_rolls(&mut self, buyer_addr: &Address, roll_count: u64) {
self.speculative_roll_state
.add_rolls(buyer_addr, roll_count);
}
/// Try to sell `roll_count` rolls from the seller address.
///
/// # Arguments
/// * `seller_addr`: address to sell the rolls from
/// * `roll_count`: number of rolls to sell
pub fn try_sell_rolls(
&mut self,
seller_addr: &Address,
roll_count: u64,
) -> Result<(), ExecutionError> {
self.speculative_roll_state.try_sell_rolls(
seller_addr,
self.slot,
roll_count,
self.config.periods_per_cycle,
self.config.thread_count,
self.config.roll_price,
)
}
/// Try to slash `roll_count` rolls from the denounced address. If not enough rolls,
/// slash the available amount and return the result
///
/// # Arguments
/// * `denounced_addr`: address to sell the rolls from
/// * `roll_count`: number of rolls to slash
pub fn try_slash_rolls(
&mut self,
denounced_addr: &Address,
roll_count: u64,
) -> Result<Amount, ExecutionError> {
let execution_component_version = self.execution_component_version;
match execution_component_version {
0 => self.try_slash_rolls_v0(denounced_addr, roll_count),
_ => self.try_slash_rolls_v1(denounced_addr, roll_count),
}
}
pub fn try_slash_rolls_v0(
&mut self,
denounced_addr: &Address,
roll_count: u64,
) -> Result<Amount, ExecutionError> {
// try to slash as many roll as available
let slashed_rolls = self
.speculative_roll_state
.try_slash_rolls(denounced_addr, roll_count);
// convert slashed rolls to coins (as deferred credits => coins)
let mut slashed_coins = self
.config
.roll_price
.checked_mul_u64(slashed_rolls.unwrap_or_default())
.ok_or_else(|| {
ExecutionError::RuntimeError(format!(
"Cannot multiply roll price by {}",
roll_count
))
})?;
// what remains to slash (then will try to slash as many deferred credits as avail/what remains to be slashed)
let amount_remaining_to_slash = self
.config
.roll_price
.checked_mul_u64(roll_count)
.ok_or_else(|| {
ExecutionError::RuntimeError(format!(
"Cannot multiply roll price by {}",
roll_count
))
})?
.saturating_sub(slashed_coins);
if amount_remaining_to_slash > Amount::zero() {
// There is still an amount to slash for this denunciation so we need to slash
// in deferred credits
let slashed_coins_in_deferred_credits = self
.speculative_roll_state
.try_slash_deferred_credits(&self.slot, denounced_addr, &amount_remaining_to_slash);
slashed_coins = slashed_coins.saturating_add(slashed_coins_in_deferred_credits);
let amount_remaining_to_slash_2 =
slashed_coins.saturating_sub(slashed_coins_in_deferred_credits);
if amount_remaining_to_slash_2 > Amount::zero() {
// Use saturating_mul_u64 to avoid an error (for just a warn!(..))
warn!("Slashed {} coins (by selling rolls) and {} coins from deferred credits of address: {} but cumulative amount is lower than expected: {} coins",
slashed_coins, slashed_coins_in_deferred_credits, denounced_addr,
self.config.roll_price.saturating_mul_u64(roll_count)
);
}
}
Ok(slashed_coins)
}
pub fn try_slash_rolls_v1(
&mut self,
denounced_addr: &Address,
roll_count: u64,
) -> Result<Amount, ExecutionError> {
// try to slash as many roll as available
let slashed_rolls = self
.speculative_roll_state
.try_slash_rolls(denounced_addr, roll_count);
// convert slashed rolls to coins (as deferred credits => coins)
let slashed_coins_from_rolls = self
.config
.roll_price
.checked_mul_u64(slashed_rolls.unwrap_or_default())
.ok_or_else(|| {
ExecutionError::RuntimeError(format!(
"Cannot multiply roll price by {}",
roll_count
))
})?;
// what remains to slash (then will try to slash as many deferred credits as avail/what remains to be slashed)
let amount_remaining_to_slash = self
.config
.roll_price
.checked_mul_u64(roll_count)
.ok_or_else(|| {
ExecutionError::RuntimeError(format!(
"Cannot multiply roll price by {}",
roll_count
))
})?
.saturating_sub(slashed_coins_from_rolls);
let mut total_slashed_coins = slashed_coins_from_rolls;
if amount_remaining_to_slash > Amount::zero() {
// There is still an amount to slash for this denunciation so we need to slash
// in deferred credits
let slashed_coins_in_deferred_credits = self
.speculative_roll_state
.try_slash_deferred_credits(&self.slot, denounced_addr, &amount_remaining_to_slash);
total_slashed_coins =
total_slashed_coins.saturating_add(slashed_coins_in_deferred_credits);
let amount_remaining_to_slash_2 =
amount_remaining_to_slash.saturating_sub(slashed_coins_in_deferred_credits);
if amount_remaining_to_slash_2 > Amount::zero() {
// Use saturating_mul_u64 to avoid an error (for just a warn!(..))
warn!("Slashed {} coins (by selling rolls) and {} coins from deferred credits of address: {} but cumulative amount is lower than expected: {} coins",
slashed_coins_from_rolls, slashed_coins_in_deferred_credits, denounced_addr,
self.config.roll_price.saturating_mul_u64(roll_count)
);
}
}
Ok(total_slashed_coins)
}
/// Update production statistics of an address.
///
/// # Arguments
/// * `creator`: the supposed creator
/// * `slot`: current slot
/// * `block_id`: id of the block (if some)
pub fn update_production_stats(
&mut self,
creator: &Address,
slot: Slot,
block_id: Option<BlockId>,
) {
self.speculative_roll_state
.update_production_stats(creator, slot, block_id);
}
/// Execute the deferred credits of `slot`.
///
/// # Arguments
/// * `slot`: associated slot of the deferred credits to be executed
pub fn execute_deferred_credits(
&mut self,
slot: &Slot,
) -> Vec<(Address, Result<Amount, String>)> {
#[allow(unused_mut)]
let mut result = vec![];
for (_slot, map) in self
.speculative_roll_state
.take_unexecuted_deferred_credits(slot)
.credits
{
for (address, amount) in map {
let transfer_result = self.transfer_coins(None, Some(address), amount, false);
if let Err(e) = transfer_result.as_ref() {
debug!(
"could not credit {} deferred coins to {} at slot {}: {}",
amount, address, slot, e
);
}
#[cfg(feature = "execution-info")]
if let Err(e) = transfer_result {
result.push((address, Err(e.to_string())));
} else {
result.push((address, Ok(amount)));
}
}
}
result
}
fn settle_slot_v0(&mut self, block_info: Option<ExecutedBlockInfo>) -> ExecutionOutput {
let slot = self.slot;
// execute the deferred credits coming from roll sells
let deferred_credits_transfers = self.execute_deferred_credits(&slot);
// take the ledger changes first as they are needed for async messages and cache
let ledger_changes = self.speculative_ledger.take();
// settle emitted async messages and reimburse the senders of deleted messages
let deleted_messages =
self.speculative_async_pool
.settle_slot(&slot, &ledger_changes, false);
let mut cancel_async_message_transfers = vec![];
for (_msg_id, msg) in deleted_messages {
if let Some(t) = self.cancel_async_message(&msg) {
cancel_async_message_transfers.push(t)
}
}
// update module cache
let bc_updates = ledger_changes.get_bytecode_updates();
{
let mut cache_write_lock = self.module_cache.write();
for bytecode in bc_updates {
cache_write_lock.save_module(&bytecode.0, CondomLimits::default());
}
}
// if the current slot is last in cycle check the production stats and act accordingly
let auto_sell_rolls = if self
.slot
.is_last_of_cycle(self.config.periods_per_cycle, self.config.thread_count)
{
self.speculative_roll_state.settle_production_stats(
&slot,
self.config.periods_per_cycle,
self.config.thread_count,
self.config.roll_price,
self.config.max_miss_ratio,
)
} else {
vec![]
};
// generate the execution output
let state_changes = StateChanges {
ledger_changes,
async_pool_changes: self.speculative_async_pool.take(),
pos_changes: self.speculative_roll_state.take(),
executed_ops_changes: self.speculative_executed_ops.take(),
executed_denunciations_changes: self.speculative_executed_denunciations.take(),
execution_trail_hash_change: SetOrKeep::Set(self.execution_trail_hash),
deferred_call_changes: self.speculative_deferred_calls.take(),
};
std::mem::take(&mut self.opt_block_id);
ExecutionOutput {
slot,
block_info,
state_changes,
events: std::mem::take(&mut self.events),
#[cfg(feature = "execution-trace")]
slot_trace: None,
#[cfg(feature = "dump-block")]
storage: None,
deferred_credits_execution: deferred_credits_transfers,
cancel_async_message_execution: cancel_async_message_transfers,
auto_sell_execution: auto_sell_rolls,
}
}
fn settle_slot_with_fixed_ledger_change_handling(
&mut self,
block_info: Option<ExecutedBlockInfo>,
) -> ExecutionOutput {
let slot = self.slot;
// execute the deferred credits coming from roll sells
let deferred_credits_transfers = self.execute_deferred_credits(&slot);
// settle emitted async messages and reimburse the senders of deleted messages
let deleted_messages = self.speculative_async_pool.settle_slot(
&slot,
&self.speculative_ledger.added_changes,
true,
);
let mut cancel_async_message_transfers = vec![];
for (_msg_id, msg) in deleted_messages {
if let Some(t) = self.cancel_async_message(&msg) {
cancel_async_message_transfers.push(t)
}
}
// update module cache
let bc_updates = self.speculative_ledger.added_changes.get_bytecode_updates();
{
let mut cache_write_lock = self.module_cache.write();
for bytecode in bc_updates {
cache_write_lock.save_module(&bytecode.0, self.config.condom_limits.clone());
}
}
// if the current slot is last in cycle check the production stats and act accordingly
let auto_sell_rolls = if self
.slot
.is_last_of_cycle(self.config.periods_per_cycle, self.config.thread_count)
{
self.speculative_roll_state.settle_production_stats(
&slot,
self.config.periods_per_cycle,
self.config.thread_count,
self.config.roll_price,
self.config.max_miss_ratio,
)
} else {
vec![]
};
// generate the execution output
let state_changes = StateChanges {
ledger_changes: self.speculative_ledger.take(),
async_pool_changes: self.speculative_async_pool.take(),
deferred_call_changes: self.speculative_deferred_calls.take(),
pos_changes: self.speculative_roll_state.take(),
executed_ops_changes: self.speculative_executed_ops.take(),
executed_denunciations_changes: self.speculative_executed_denunciations.take(),
execution_trail_hash_change: SetOrKeep::Set(self.execution_trail_hash),
};
std::mem::take(&mut self.opt_block_id);
ExecutionOutput {
slot,
block_info,
state_changes,
events: std::mem::take(&mut self.events),
#[cfg(feature = "execution-trace")]
slot_trace: None,
#[cfg(feature = "dump-block")]
storage: None,
deferred_credits_execution: deferred_credits_transfers,
cancel_async_message_execution: cancel_async_message_transfers,
auto_sell_execution: auto_sell_rolls,
}
}
/// Finishes a slot and generates the execution output.
/// Settles emitted asynchronous messages, reimburse the senders of deleted messages.
/// Moves the output of the execution out of the context,
/// resetting some context fields in the process.
///
/// This is used to get the output of an execution before discarding the context.
/// Note that we are not taking self by value to consume it because the context is shared.
pub fn settle_slot(&mut self, block_info: Option<ExecutedBlockInfo>) -> ExecutionOutput {
match self.execution_component_version {
0 => self.settle_slot_v0(block_info),
_ => self.settle_slot_with_fixed_ledger_change_handling(block_info),
}
}
/// Sets a bytecode for an address in the speculative ledger.
/// Fail if the address is absent from the ledger.
///
/// # Arguments
/// * address: the address of the ledger entry
/// * data: the bytecode to set
pub fn set_bytecode(
&mut self,
address: &Address,
bytecode: Bytecode,
) -> Result<(), ExecutionError> {
// check access right
if !self.has_write_rights_on(address) {
return Err(ExecutionError::RuntimeError(format!(
"setting the bytecode of address {} is not allowed in this context",
address
)));
}
// Do not allow user addresses to store bytecode.
// See: https://github.com/massalabs/massa/discussions/2952
if let Address::User(_) = address {
return Err(ExecutionError::RuntimeError(format!(
"can't set the bytecode of address {} because this is not a smart contract address",
address
)));
}
// set data entry
self.speculative_ledger.set_bytecode(
&self.get_current_address()?,
address,
bytecode,
self.execution_component_version,
)
}
/// Creates a new event but does not emit it.
/// Note that this does not increment the context event counter.
///
/// # Arguments:
/// data: the string data that is the payload of the event
pub fn event_create(&self, data: String, is_error: bool) -> SCOutputEvent {
// Gather contextual information from the execution context
let context = EventExecutionContext {
slot: self.slot,
block: self.opt_block_id,
call_stack: self.stack.iter().map(|e| e.address).collect(),
read_only: self.read_only,
index_in_slot: self.created_event_index,
origin_operation_id: self.origin_operation_id,
is_final: false,
is_error,
};
// Return the event
SCOutputEvent { context, data }
}
/// Emits a previously created event.
/// Overrides the event's index with the current event counter value, and increments the event counter.
pub fn event_emit(&mut self, mut event: SCOutputEvent) {
// Set the event index
event.context.index_in_slot = self.created_event_index;
// Increment the event counter for this slot
self.created_event_index += 1;
// Add the event to the context store
self.events.push(event);
}
/// Check if an operation was previously executed (to prevent reuse)
pub fn is_op_executed(&self, op_id: &OperationId) -> bool {
self.speculative_executed_ops.is_op_executed(op_id)
}
/// Check if a denunciation was previously executed (to prevent reuse)
pub fn is_denunciation_executed(&self, de_idx: &DenunciationIndex) -> bool {
self.speculative_executed_denunciations
.is_denunciation_executed(de_idx)
}
/// Insert an executed operation.
/// Does not check for reuse, please use `is_op_executed` before.
///
/// # Arguments
/// * `op_id`: operation ID
/// * `op_exec_status` : the status of the execution of the operation (true: success, false: failed).
/// * `op_valid_until_slot`: slot until which the operation remains valid (included)
pub fn insert_executed_op(
&mut self,
op_id: OperationId,
op_exec_status: bool,
op_valid_until_slot: Slot,
) {
self.speculative_executed_ops
.insert_executed_op(op_id, op_exec_status, op_valid_until_slot)
}
/// Insert a executed denunciation.
///
pub fn insert_executed_denunciation(&mut self, denunciation_idx: &DenunciationIndex) {
self.speculative_executed_denunciations
.insert_executed_denunciation(*denunciation_idx);
}
/// gets the cycle information for an address
pub fn get_address_cycle_infos(
&self,
address: &Address,
periods_per_cycle: u64,
) -> Vec<ExecutionAddressCycleInfo> {
self.speculative_roll_state
.get_address_cycle_infos(address, periods_per_cycle, self.slot)
}
/// Get future deferred credits of an address
/// With optionally a limit slot (excluded)
pub fn get_address_future_deferred_credits(
&self,
address: &Address,
thread_count: u8,
max_slot: std::ops::Bound<Slot>,
) -> BTreeMap<Slot, Amount> {
let min_slot = self
.slot
.get_next_slot(thread_count)
.expect("unexpected slot overflow in context.get_addresses_deferred_credits");
self.speculative_roll_state
.get_address_deferred_credits(address, (std::ops::Bound::Included(min_slot), max_slot))
}
/// in case of
///
/// async_msg, call OP, call SC to SC, read only call
///
/// check if the given address is a smart contract address and if it exists
/// returns an error instead
pub fn check_target_sc_address(
&self,
target_sc_address: Address,
) -> Result<(), ExecutionError> {
match target_sc_address {
Address::SC(..) => {
// if the target address does not exist: fail
if !self.speculative_ledger.entry_exists(&target_sc_address) {
return Err(ExecutionError::RuntimeError(format!(
"The called smart contract address {} does not exist",
target_sc_address
)));
}
Ok(())
}
// if the target address is not SC: fail
_ => Err(ExecutionError::RuntimeError(format!(
"The called address {} is not a smart contract address",
target_sc_address
))),
}
}
pub fn deferred_calls_advance_slot(&mut self, current_slot: Slot) -> DeferredSlotCalls {
self.speculative_deferred_calls.advance_slot(current_slot)
}
/// Get the price it would cost to reserve "gas" with params at target slot "slot".
pub fn deferred_calls_compute_call_fee(
&self,
target_slot: Slot,
max_gas_request: u64,
current_slot: Slot,
params_size: u64,
) -> Result<Amount, ExecutionError> {
self.speculative_deferred_calls.compute_call_fee(
target_slot,
max_gas_request,
current_slot,
params_size,
)
}
pub fn deferred_call_register(
&mut self,
call: DeferredCall,
) -> Result<DeferredCallId, ExecutionError> {
self.speculative_deferred_calls
.register_call(call, self.execution_trail_hash)
}
/// Check if a deferred call exists
/// If it exists, check if it has been cancelled
/// If it has been cancelled, return false
pub fn deferred_call_exists(&self, call_id: &DeferredCallId) -> bool {
if let Some(call) = self.speculative_deferred_calls.get_call(call_id) {
return !call.cancelled;
}
false
}
/// Get a deferred call by its id
pub fn get_deferred_call(&self, call_id: &DeferredCallId) -> Option<DeferredCall> {
self.speculative_deferred_calls.get_call(call_id)
}
/// when a deferred call execution fails we need to refund the coins to the caller
pub fn deferred_call_fail_exec(
&mut self,
id: &DeferredCallId,
call: &DeferredCall,
) -> Option<(Address, Result<Amount, String>)> {
#[allow(unused_assignments, unused_mut)]
let mut result = None;
let transfer_result =
self.transfer_coins(None, Some(call.sender_address), call.coins, false);
if let Err(e) = transfer_result.as_ref() {
debug!(
"deferred call cancel: reimbursement of {} failed: {}",
call.sender_address, e
);
}
let mut event =
self.event_create(format!("DeferredCall execution fail call_id:{}", id), true);
let max_event_size = match self.execution_component_version {
0 => self.config.max_event_size_v0,
_ => self.config.max_event_size_v1,
};
if event.data.len() > max_event_size {
event.data.truncate(max_event_size);
}
self.event_emit(event);
#[cfg(feature = "execution-info")]
if let Err(e) = transfer_result {
result = Some((call.sender_address, Err(e.to_string())))
} else {
result = Some((call.sender_address, Ok(call.coins)));
}
result
}
/// when a deferred call is cancelled we need to refund the coins to the caller
pub fn deferred_call_cancel(
&mut self,
call_id: &DeferredCallId,
caller_address: Address,
) -> Result<(), ExecutionError> {
match self.speculative_deferred_calls.get_call(call_id) {
Some(call) => {
// check that the caller is the one who registered the deferred call
if call.sender_address != caller_address {
return Err(ExecutionError::DeferredCallsError(format!(
"only the caller {} can cancel the deferred call",
call.sender_address
)));
}
let (address, amount) = self.speculative_deferred_calls.cancel_call(call_id)?;
// refund the coins to the caller
let transfer_result = self.transfer_coins(None, Some(address), amount, false);
if let Err(e) = transfer_result.as_ref() {
debug!(
"deferred call cancel: reimbursement of {} failed: {}",
address, e
);
}
Ok(())
}
_ => Err(ExecutionError::DeferredCallsError(format!(
"deferred call {} does not exist",
call_id
)))?,
}
}
/// find the deferred calls for a given slot
pub fn get_deferred_calls_by_slot(&self, slot: Slot) -> BTreeMap<DeferredCallId, DeferredCall> {
self.speculative_deferred_calls
.get_calls_by_slot(slot)
.slot_calls
}
/// Get the condom limits to pass to the VM depending on the current execution component version
pub fn get_condom_limits(&self) -> CondomLimits {
match self.execution_component_version {
0 => Default::default(),
_ => self.config.condom_limits.clone(),
}
}
}
/// Generate the execution trail hash
fn generate_execution_trail_hash(
previous_execution_trail_hash: &massa_hash::Hash,
slot: &Slot,
opt_block_id: Option<&BlockId>,
read_only: bool,
) -> massa_hash::Hash {
match opt_block_id {
None => massa_hash::Hash::compute_from_tuple(&[
previous_execution_trail_hash.to_bytes(),
&slot.to_bytes_key(),
&[if read_only { 1u8 } else { 0u8 }, 0u8],
]),
Some(block_id) => {
let mut bytes = Vec::new();
let block_id_serializer = BlockIdSerializer::new();
block_id_serializer.serialize(block_id, &mut bytes).unwrap();
massa_hash::Hash::compute_from_tuple(&[
previous_execution_trail_hash.to_bytes(),
&slot.to_bytes_key(),
&[if read_only { 1u8 } else { 0u8 }, 1u8],
&bytes,
])
}
}
}
/// Initializes and seeds the PRNG with the given execution trail hash.
fn init_prng(execution_trail_hash: &massa_hash::Hash) -> Xoshiro256PlusPlus {
// Deterministically seed the unsafe RNG to allow the bytecode to use it.
// Note that consecutive read-only calls for the same slot will get the same random seed.
let seed = massa_hash::Hash::compute_from_tuple(&[
"PRNG_SEED".as_bytes(),
execution_trail_hash.to_bytes(),
])
.into_bytes();
// We use Xoshiro256PlusPlus because it is very fast,
// has a period long enough to ensure no repetitions will ever happen,
// of decent quality (given the unsafe constraints)
// but not cryptographically secure (and that's ok because the internal state is exposed anyway)
Xoshiro256PlusPlus::from_seed(seed)
}