scrypto_test/ledger_simulator/

ledger_simulator.rs

use crate::prelude::*;
use core::ops::AddAssign;
use radix_engine::blueprints::models::FieldPayload;
use radix_engine::blueprints::pool::v1::constants::*;
use radix_engine::define_composite_checker;
use radix_engine::object_modules::metadata::{MetadataCollection, MetadataEntryEntryPayload};
use radix_engine::system::checkers::*;
use radix_engine::system::system_db_reader::{
    ObjectCollectionKey, SystemDatabaseReader, SystemDatabaseWriter, SystemReaderError,
};
use radix_engine::system::system_substates::FieldSubstate;
use radix_engine::system::type_info::TypeInfoSubstate;
use radix_engine::transaction::*;
use radix_engine::updates::*;
use radix_engine::vm::wasm::DefaultWasmEngine;
use radix_engine::vm::{NativeVmExtension, NoExtension, ScryptoVm};
use radix_engine_interface::api::ModuleId;
use radix_engine_interface::blueprints::account::ACCOUNT_SECURIFY_IDENT;
use radix_engine_interface::blueprints::consensus_manager::*;
use radix_engine_interface::blueprints::pool::{
    OneResourcePoolInstantiateManifestInput, ONE_RESOURCE_POOL_INSTANTIATE_IDENT,
};
use radix_engine_interface::prelude::{dec, freeze_roles, rule};
use radix_substate_store_impls::memory_db::InMemorySubstateDatabase;
use radix_substate_store_impls::state_tree_support::StateTreeUpdatingDatabase;
use radix_substate_store_interface::interface::*;
use radix_substate_store_queries::query::{ResourceAccounter, StateTreeTraverser, VaultFinder};
use radix_substate_store_queries::typed_native_events::to_typed_native_event;
use radix_substate_store_queries::typed_substate_layout::*;
use radix_transactions::manifest::*;
use radix_transactions::validation::*;
use std::path::{Path, PathBuf};

use super::Compile;

pub trait TestDatabase:
    SubstateDatabase + CommittableSubstateDatabase + ListableSubstateDatabase
{
}
impl<T: SubstateDatabase + CommittableSubstateDatabase + ListableSubstateDatabase> TestDatabase
    for T
{
}

pub type DefaultLedgerSimulator = LedgerSimulator<NoExtension, InMemorySubstateDatabase>;

pub struct LedgerSimulatorBuilder<E, D> {
    custom_extension: E,
    custom_database: D,
    protocol_executor: ProtocolExecutor,

    // General options
    with_kernel_trace: Option<bool>,
    with_cost_breakdown: Option<bool>,
    with_receipt_substate_check: bool,
}

impl Default for LedgerSimulatorBuilder<NoExtension, InMemorySubstateDatabase> {
    fn default() -> Self {
        Self::new()
    }
}

impl LedgerSimulatorBuilder<NoExtension, InMemorySubstateDatabase> {
    pub fn new() -> Self {
        LedgerSimulatorBuilder {
            custom_extension: NoExtension,
            custom_database: InMemorySubstateDatabase::standard(),
            protocol_executor: ProtocolBuilder::for_network(&NetworkDefinition::simulator())
                .from_bootstrap_to_latest(),
            with_kernel_trace: None,
            with_cost_breakdown: None,
            with_receipt_substate_check: true,
        }
    }
}

impl<E: NativeVmExtension, D: TestDatabase> LedgerSimulatorBuilder<E, D> {
    pub fn network_definition() -> NetworkDefinition {
        NetworkDefinition::simulator()
    }

    pub fn with_state_hashing(self) -> LedgerSimulatorBuilder<E, StateTreeUpdatingDatabase<D>> {
        LedgerSimulatorBuilder {
            custom_extension: self.custom_extension,
            custom_database: StateTreeUpdatingDatabase::new(self.custom_database),
            protocol_executor: self.protocol_executor,
            with_kernel_trace: self.with_kernel_trace,
            with_cost_breakdown: self.with_cost_breakdown,
            with_receipt_substate_check: self.with_receipt_substate_check,
        }
    }

    /// Overrides the kernel trace setting to `true` for all executed transactions.
    pub fn with_kernel_trace(mut self) -> Self {
        self.with_kernel_trace = Some(true);
        self
    }

    /// Overrides the kernel trace setting to `false` for all executed transactions.
    pub fn without_kernel_trace(mut self) -> Self {
        self.with_kernel_trace = Some(false);
        self
    }

    /// Overrides the cost breakdown setting to `true` for all executed transactions.
    pub fn with_cost_breakdown(mut self) -> Self {
        self.with_cost_breakdown = Some(true);
        self
    }

    /// Overrides the cost breakdown setting to `false` for all executed transactions.
    pub fn without_cost_breakdown(mut self) -> Self {
        self.with_cost_breakdown = Some(false);
        self
    }

    pub fn with_receipt_substate_check(mut self) -> Self {
        self.with_receipt_substate_check = true;
        self
    }

    pub fn without_receipt_substate_check(mut self) -> Self {
        self.with_receipt_substate_check = false;
        self
    }

    pub fn with_custom_extension<NE: NativeVmExtension>(
        self,
        extension: NE,
    ) -> LedgerSimulatorBuilder<NE, D> {
        LedgerSimulatorBuilder::<NE, D> {
            custom_extension: extension,
            custom_database: self.custom_database,
            protocol_executor: self.protocol_executor,
            with_kernel_trace: self.with_kernel_trace,
            with_cost_breakdown: self.with_cost_breakdown,
            with_receipt_substate_check: self.with_receipt_substate_check,
        }
    }

    pub fn with_custom_database<ND: TestDatabase>(
        self,
        database: ND,
    ) -> LedgerSimulatorBuilder<E, ND> {
        LedgerSimulatorBuilder::<E, ND> {
            custom_extension: self.custom_extension,
            custom_database: database,
            protocol_executor: self.protocol_executor,
            with_kernel_trace: self.with_kernel_trace,
            with_cost_breakdown: self.with_cost_breakdown,
            with_receipt_substate_check: self.with_receipt_substate_check,
        }
    }

    /// Note - this overwrites / is overwritten by any other protocol overrides.
    /// Use [`Self::with_custom_protocol`] for full control.
    ///
    /// If you previously just used `CustomGenesis::test_default` in order to get round
    /// change tests to pass, this is no longer necessary.
    #[deprecated = "Use with_custom_protocol(|builder| builder.with_babylon(genesis).from_bootstrap_to_latest()) instead"]
    pub fn with_custom_genesis(self, genesis: BabylonSettings) -> Self {
        self.with_custom_protocol(|builder| {
            builder
                .configure_babylon(|_| genesis)
                .from_bootstrap_to_latest()
        })
    }

    pub fn with_custom_protocol(
        mut self,
        executor: impl FnOnce(ProtocolBuilder) -> ProtocolExecutor,
    ) -> Self {
        self.protocol_executor =
            executor(ProtocolBuilder::for_network(&Self::network_definition()));
        self
    }

    /// Note - this overwrites / is overwritten by any other protocol overrides.
    /// Use [`Self::with_custom_protocol`] for full control.
    #[deprecated = "Use with_custom_protocol(|builder| builder.from_bootstrap_to(protocol_version)) instead"]
    pub fn with_protocol_version(self, protocol_version: ProtocolVersion) -> Self {
        self.with_custom_protocol(|builder| builder.from_bootstrap_to(protocol_version))
    }

    pub fn build_from_snapshot(
        self,
        snapshot: LedgerSimulatorSnapshot,
    ) -> LedgerSimulator<E, InMemorySubstateDatabase> {
        LedgerSimulator {
            vm_modules: VmModules {
                scrypto_vm: ScryptoVm::default(),
                vm_extension: self.custom_extension,
            },
            transaction_validator: snapshot.transaction_validator,
            database: snapshot.database,
            next_private_key: snapshot.next_private_key,
            next_transaction_nonce: snapshot.next_transaction_nonce,
            collected_events: snapshot.collected_events,
            xrd_free_credits_used: snapshot.xrd_free_credits_used,
            with_kernel_trace: snapshot.with_kernel_trace,
            with_cost_breakdown: snapshot.with_cost_breakdown,
            with_receipt_substate_check: snapshot.with_receipt_substate_check,
        }
    }

    /// NOTE: The epoch change isn't available if the protocol builder does not run genesis.
    pub fn build_and_get_post_genesis_epoch_change(
        self,
    ) -> (LedgerSimulator<E, D>, Option<EpochChangeEvent>) {
        //---------- Override configs for resource tracker ---------------
        let bootstrap_trace = false;

        #[cfg(not(feature = "resource_tracker"))]
        let with_kernel_trace = self.with_kernel_trace;
        #[cfg(feature = "resource_tracker")]
        let with_kernel_trace = Some(false);

        #[cfg(not(feature = "resource_tracker"))]
        let with_cost_breakdown = self.with_cost_breakdown;
        #[cfg(feature = "resource_tracker")]
        let with_cost_breakdown = Some(false);

        //----------------------------------------------------------------
        struct ProtocolUpdateHooks {
            bootstrap_trace: bool,
            events: Vec<Vec<(EventTypeIdentifier, Vec<u8>)>>,
            genesis_next_epoch: Option<EpochChangeEvent>,
        }

        impl ProtocolUpdateExecutionHooks for ProtocolUpdateHooks {
            fn adapt_execution_config(&mut self, config: ExecutionConfig) -> ExecutionConfig {
                config.with_kernel_trace(self.bootstrap_trace)
            }

            fn on_transaction_executed(&mut self, event: OnProtocolTransactionExecuted) {
                let OnProtocolTransactionExecuted {
                    protocol_version,
                    receipt,
                    ..
                } = event;
                self.events
                    .push(receipt.expect_commit_success().application_events.clone());
                if protocol_version == ProtocolVersion::GENESIS {
                    if let Some(next_epoch) = receipt.expect_commit_success().next_epoch() {
                        self.genesis_next_epoch = Some(next_epoch);
                    }
                }
            }
        }

        let mut substate_db = self.custom_database;

        let mut hooks = ProtocolUpdateHooks {
            bootstrap_trace,
            events: vec![],
            genesis_next_epoch: None,
        };
        let vm_modules = VmModules::default_with_extension(self.custom_extension);

        // Protocol Updates
        self.protocol_executor.commit_each_protocol_update_advanced(
            &mut substate_db,
            &mut hooks,
            &vm_modules,
        );

        // Note that 0 is not a valid private key
        let next_private_key = 100;

        // Starting from non-zero considering that bootstrap might have used a few.
        let next_transaction_nonce = 100;

        let validator = TransactionValidator::new(&substate_db, &Self::network_definition());

        let runner = LedgerSimulator {
            vm_modules,
            database: substate_db,
            transaction_validator: validator,
            next_private_key,
            next_transaction_nonce,
            collected_events: hooks.events,
            xrd_free_credits_used: false,
            with_kernel_trace,
            with_cost_breakdown,
            with_receipt_substate_check: self.with_receipt_substate_check,
        };

        (runner, hooks.genesis_next_epoch)
    }

    pub fn build(self) -> LedgerSimulator<E, D> {
        self.build_and_get_post_genesis_epoch_change().0
    }
}

pub struct LedgerSimulator<E: NativeVmExtension, D: TestDatabase> {
    vm_modules: VmModules<DefaultWasmEngine, E>,
    database: D,

    next_private_key: u64,
    next_transaction_nonce: u32,
    transaction_validator: TransactionValidator,

    /// Events collected from all the committed transactions
    collected_events: Vec<Vec<(EventTypeIdentifier, Vec<u8>)>>,
    /// Track whether any of the committed transaction has used free credit
    xrd_free_credits_used: bool,

    /// Override whether to enable kernel tracing
    with_kernel_trace: Option<bool>,
    /// Override whether to enable the cost breakdown
    with_cost_breakdown: Option<bool>,
    /// Whether to enable receipt substate type checking
    with_receipt_substate_check: bool,
}

#[cfg(feature = "post_run_db_check")]
impl<E: NativeVmExtension, D: TestDatabase> Drop for LedgerSimulator<E, D> {
    fn drop(&mut self) {
        self.check_database()
    }
}

#[derive(Clone)]
pub struct LedgerSimulatorSnapshot {
    database: InMemorySubstateDatabase,
    transaction_validator: TransactionValidator,
    next_private_key: u64,
    next_transaction_nonce: u32,
    collected_events: Vec<Vec<(EventTypeIdentifier, Vec<u8>)>>,
    xrd_free_credits_used: bool,
    with_kernel_trace: Option<bool>,
    with_cost_breakdown: Option<bool>,
    with_receipt_substate_check: bool,
}

impl<E: NativeVmExtension> LedgerSimulator<E, InMemorySubstateDatabase> {
    pub fn create_snapshot(&self) -> LedgerSimulatorSnapshot {
        LedgerSimulatorSnapshot {
            database: self.database.clone(),
            transaction_validator: self.transaction_validator,
            next_private_key: self.next_private_key,
            next_transaction_nonce: self.next_transaction_nonce,
            collected_events: self.collected_events.clone(),
            xrd_free_credits_used: self.xrd_free_credits_used,
            with_kernel_trace: self.with_kernel_trace,
            with_cost_breakdown: self.with_cost_breakdown,
            with_receipt_substate_check: self.with_receipt_substate_check,
        }
    }

    pub fn restore_snapshot(&mut self, snapshot: LedgerSimulatorSnapshot) {
        let LedgerSimulatorSnapshot {
            database,
            transaction_validator,
            next_private_key,
            next_transaction_nonce,
            collected_events,
            xrd_free_credits_used,
            with_kernel_trace,
            with_cost_breakdown,
            with_receipt_substate_check,
        } = snapshot;
        self.database = database;
        self.transaction_validator = transaction_validator;
        self.next_private_key = next_private_key;
        self.next_transaction_nonce = next_transaction_nonce;
        self.collected_events = collected_events;
        self.xrd_free_credits_used = xrd_free_credits_used;
        self.with_kernel_trace = with_kernel_trace;
        self.with_cost_breakdown = with_cost_breakdown;
        self.with_receipt_substate_check = with_receipt_substate_check;
    }
}

impl<E: NativeVmExtension, D: TestDatabase> LedgerSimulator<E, D> {
    pub fn faucet_component(&self) -> GlobalAddress {
        FAUCET.into()
    }

    pub fn substate_db(&self) -> &D {
        &self.database
    }

    pub fn substate_db_mut(&mut self) -> &mut D {
        &mut self.database
    }

    pub fn transaction_validator(&self) -> &TransactionValidator {
        &self.transaction_validator
    }

    /// This should only be needed if you manually apply protocol
    /// updates to the underlying database after the LedgerSimulator
    /// has been built.
    pub fn update_transaction_validator_after_manual_protocol_update(&mut self) {
        self.transaction_validator =
            TransactionValidator::new(&self.database, &NetworkDefinition::simulator())
    }

    pub fn collected_events(&self) -> &Vec<Vec<(EventTypeIdentifier, Vec<u8>)>> {
        self.collected_events.as_ref()
    }

    pub fn next_private_key(&mut self) -> u64 {
        self.next_private_key += 1;
        self.next_private_key - 1
    }

    pub fn next_transaction_nonce(&mut self) -> u32 {
        self.next_transaction_nonce += 1;
        self.next_transaction_nonce - 1
    }

    pub fn new_key_pair(&mut self) -> (Secp256k1PublicKey, Secp256k1PrivateKey) {
        let private_key = Secp256k1PrivateKey::from_u64(self.next_private_key()).unwrap();
        let public_key = private_key.public_key();

        (public_key, private_key)
    }

    pub fn new_ed25519_key_pair(&mut self) -> (Ed25519PublicKey, Ed25519PrivateKey) {
        let private_key = Ed25519PrivateKey::from_u64(self.next_private_key()).unwrap();
        let public_key = private_key.public_key();

        (public_key, private_key)
    }

    pub fn new_key_pair_with_auth_address(
        &mut self,
    ) -> (Secp256k1PublicKey, Secp256k1PrivateKey, NonFungibleGlobalId) {
        let key_pair = self.new_allocated_account();
        (
            key_pair.0,
            key_pair.1,
            NonFungibleGlobalId::from_public_key(key_pair.0),
        )
    }

    pub fn set_metadata(
        &mut self,
        address: GlobalAddress,
        key: &str,
        value: &str,
        proof: NonFungibleGlobalId,
    ) {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .set_metadata(
                address,
                key.to_string(),
                MetadataValue::String(value.to_string()),
            )
            .build();

        let receipt = self.execute_manifest(manifest, vec![proof]);
        receipt.expect_commit_success();
    }

    pub fn get_metadata(&mut self, address: GlobalAddress, key: &str) -> Option<MetadataValue> {
        let reader = SystemDatabaseReader::new(self.substate_db());
        reader
            .read_object_collection_entry::<_, MetadataEntryEntryPayload>(
                address.as_node_id(),
                ModuleId::Metadata,
                ObjectCollectionKey::KeyValue(
                    MetadataCollection::EntryKeyValue.collection_index(),
                    &key.to_string(),
                ),
            )
            .unwrap()
            .map(|v| v.fully_update_and_into_latest_version())
    }

    pub fn inspect_component_royalty(
        &mut self,
        component_address: ComponentAddress,
    ) -> Result<Decimal, SystemReaderError> {
        let reader = SystemDatabaseReader::new(self.substate_db());
        let accumulator = reader
            .read_typed_object_field::<ComponentRoyaltyAccumulatorFieldPayload>(
                component_address.as_node_id(),
                ModuleId::Royalty,
                ComponentRoyaltyField::Accumulator.field_index(),
            )?
            .fully_update_and_into_latest_version();

        let balance = reader
            .read_typed_object_field::<FungibleVaultBalanceFieldPayload>(
                accumulator.royalty_vault.0.as_node_id(),
                ModuleId::Main,
                FungibleVaultField::Balance.field_index(),
            )?
            .fully_update_and_into_latest_version();

        Ok(balance.amount())
    }

    pub fn inspect_package_royalty(&mut self, package_address: PackageAddress) -> Option<Decimal> {
        let reader = SystemDatabaseReader::new(self.substate_db());
        let accumulator = reader
            .read_typed_object_field::<PackageRoyaltyAccumulatorFieldPayload>(
                package_address.as_node_id(),
                ModuleId::Main,
                PackageField::RoyaltyAccumulator.field_index(),
            )
            .ok()?
            .fully_update_and_into_latest_version();

        let balance = reader
            .read_typed_object_field::<FungibleVaultBalanceFieldPayload>(
                accumulator.royalty_vault.0.as_node_id(),
                ModuleId::Main,
                FungibleVaultField::Balance.field_index(),
            )
            .unwrap()
            .fully_update_and_into_latest_version();

        Some(balance.amount())
    }

    pub fn find_all_nodes(&self) -> IndexSet<NodeId> {
        self.database
            .read_partition_keys()
            .map(|(node_id, _)| node_id)
            .collect()
    }

    pub fn find_all_components(&self) -> Vec<ComponentAddress> {
        let mut addresses: Vec<ComponentAddress> = self
            .find_all_nodes()
            .iter()
            .filter_map(|node_id| ComponentAddress::try_from(node_id.as_bytes()).ok())
            .collect();
        addresses.sort();
        addresses
    }

    pub fn find_all_packages(&self) -> Vec<PackageAddress> {
        let mut addresses: Vec<PackageAddress> = self
            .find_all_nodes()
            .iter()
            .filter_map(|node_id| PackageAddress::try_from(node_id.as_bytes()).ok())
            .collect();
        addresses.sort();
        addresses
    }

    pub fn find_all_resources(&self) -> Vec<ResourceAddress> {
        let mut addresses: Vec<ResourceAddress> = self
            .find_all_nodes()
            .iter()
            .filter_map(|node_id| ResourceAddress::try_from(node_id.as_bytes()).ok())
            .collect();
        addresses.sort();
        addresses
    }

    pub fn get_package_radix_blueprint_schema_inits(
        &self,
        package_address: &PackageAddress,
    ) -> IndexMap<SchemaHash, VersionedScryptoSchema> {
        let reader = SystemDatabaseReader::new(self.substate_db());
        reader
            .collection_iter(
                package_address.as_node_id(),
                ModuleId::Main,
                PackageCollection::SchemaKeyValue.collection_index(),
            )
            .unwrap()
            .map(|(key, value)| {
                let key = key.into_map();
                let hash: SchemaHash = scrypto_decode(&key).unwrap();
                let schema: PackageSchemaEntryPayload = scrypto_decode(&value).unwrap();
                (hash, schema.into_content())
            })
            .collect()
    }

    pub fn get_package_blueprint_definitions(
        &self,
        package_address: &PackageAddress,
    ) -> IndexMap<BlueprintVersionKey, BlueprintDefinition> {
        let reader = SystemDatabaseReader::new(self.substate_db());
        reader
            .collection_iter(
                package_address.as_node_id(),
                ModuleId::Main,
                PackageCollection::BlueprintVersionDefinitionKeyValue.collection_index(),
            )
            .unwrap()
            .map(|(key, value)| {
                let map_key = key.into_map();
                let key: BlueprintVersionKey = scrypto_decode(&map_key).unwrap();
                let definition: PackageBlueprintVersionDefinitionEntryPayload =
                    scrypto_decode(&value).unwrap();
                (key, definition.fully_update_and_into_latest_version())
            })
            .collect()
    }

    pub fn sum_descendant_balance_changes(
        &mut self,
        commit: &CommitResult,
        node_id: &NodeId,
    ) -> IndexMap<ResourceAddress, BalanceChange> {
        SubtreeVaults::new(&self.database)
            .sum_balance_changes(node_id, commit.vault_balance_changes())
    }

    pub fn get_component_vaults(
        &mut self,
        component_address: ComponentAddress,
        resource_address: ResourceAddress,
    ) -> Vec<NodeId> {
        SubtreeVaults::new(&self.database)
            .get_all(component_address.as_node_id())
            .swap_remove(&resource_address)
            .unwrap_or_default()
    }

    pub fn get_component_balance(
        &mut self,
        account_address: ComponentAddress,
        resource_address: ResourceAddress,
    ) -> Decimal {
        let vaults = self.get_component_vaults(account_address, resource_address);
        let mut sum = Decimal::ZERO;
        for vault in vaults {
            sum = sum
                .checked_add(self.inspect_vault_balance(vault).unwrap())
                .unwrap();
        }
        sum
    }

    pub fn inspect_vault_balance(&mut self, vault_id: NodeId) -> Option<Decimal> {
        if vault_id.is_internal_fungible_vault() {
            self.inspect_fungible_vault(vault_id)
        } else {
            self.inspect_non_fungible_vault(vault_id)
                .map(|(amount, ..)| amount)
        }
    }

    pub fn inspect_fungible_vault(&mut self, vault_id: NodeId) -> Option<Decimal> {
        let reader = SystemDatabaseReader::new(self.substate_db());
        let vault: Option<FungibleVaultBalanceFieldPayload> = reader
            .read_typed_object_field(
                &vault_id,
                ModuleId::Main,
                FungibleVaultField::Balance.into(),
            )
            .ok();

        vault.map(|v| v.fully_update_and_into_latest_version().amount())
    }

    pub fn inspect_non_fungible_vault(
        &mut self,
        vault_id: NodeId,
    ) -> Option<(Decimal, Box<dyn Iterator<Item = NonFungibleLocalId> + '_>)> {
        let reader = SystemDatabaseReader::new(self.substate_db());
        let vault_balance: NonFungibleVaultBalanceFieldPayload = reader
            .read_typed_object_field(
                &vault_id,
                ModuleId::Main,
                NonFungibleVaultField::Balance.into(),
            )
            .ok()?;
        let amount = vault_balance.fully_update_and_into_latest_version().amount;

        // TODO: Remove .collect() by using SystemDatabaseReader in ledger
        let iter: Vec<NonFungibleLocalId> = reader
            .collection_iter(
                &vault_id,
                ModuleId::Main,
                NonFungibleVaultCollection::NonFungibleIndex.collection_index(),
            )
            .unwrap()
            .map(|(key, _)| {
                let map_key = key.into_map();
                let id: NonFungibleLocalId = scrypto_decode(&map_key).unwrap();
                id
            })
            .collect();

        Some((amount, Box::new(iter.into_iter())))
    }

    pub fn get_component_resources(
        &mut self,
        component_address: ComponentAddress,
    ) -> HashMap<ResourceAddress, Decimal> {
        let node_id = component_address.as_node_id();
        let mut accounter = ResourceAccounter::new(&self.database);
        accounter.traverse(*node_id);
        accounter.close().balances
    }

    pub fn component_state<T: ScryptoDecode>(&self, component_address: ComponentAddress) -> T {
        let node_id: &NodeId = component_address.as_node_id();
        let component_state = self.substate_db().get_substate::<FieldSubstate<T>>(
            node_id,
            MAIN_BASE_PARTITION,
            ComponentField::State0,
        );
        component_state.unwrap().into_payload()
    }

    pub fn get_non_fungible_data<T: NonFungibleData>(
        &self,
        resource: ResourceAddress,
        non_fungible_id: NonFungibleLocalId,
    ) -> T {
        let reader = SystemDatabaseReader::new(self.substate_db());
        let payload = reader
            .read_object_collection_entry::<_, NonFungibleResourceManagerDataEntryPayload>(
                resource.as_node_id(),
                ModuleId::Main,
                ObjectCollectionKey::KeyValue(
                    NonFungibleResourceManagerCollection::DataKeyValue.collection_index(),
                    &non_fungible_id,
                ),
            )
            .unwrap()
            .unwrap();

        scrypto_decode(&scrypto_encode(&payload).unwrap()).unwrap()
    }

    pub fn get_kv_store_entry<K: ScryptoEncode, V: ScryptoEncode + ScryptoDecode>(
        &self,
        kv_store_id: Own,
        key: &K,
    ) -> Option<V> {
        let reader = SystemDatabaseReader::new(self.substate_db());
        reader.read_typed_kv_entry(kv_store_id.as_node_id(), key)
    }

    pub fn get_fungible_resource_total_supply(&self, resource: ResourceAddress) -> Decimal {
        let total_supply = self
            .substate_db()
            .get_substate::<FungibleResourceManagerTotalSupplyFieldSubstate>(
                resource,
                MAIN_BASE_PARTITION,
                FungibleResourceManagerField::TotalSupply,
            )
            .unwrap()
            .into_payload()
            .fully_update_and_into_latest_version();
        total_supply
    }

    pub fn load_account_from_faucet(&mut self, account_address: ComponentAddress) {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .get_free_xrd_from_faucet()
            .take_all_from_worktop(XRD, "free_xrd")
            .try_deposit_or_abort(account_address, None, "free_xrd")
            .build();

        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit_success();
    }

    pub fn new_account_advanced(&mut self, owner_role: OwnerRole) -> ComponentAddress {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .new_account_advanced(owner_role, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit_success();

        let account = receipt.expect_commit(true).new_component_addresses()[0];

        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .get_free_xrd_from_faucet()
            .try_deposit_entire_worktop_or_abort(account, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit_success();

        account
    }

    pub fn new_preallocated_account(
        &mut self,
    ) -> (Secp256k1PublicKey, Secp256k1PrivateKey, ComponentAddress) {
        let (pub_key, priv_key) = self.new_key_pair();
        let account =
            ComponentAddress::preallocated_account_from_public_key(&PublicKey::Secp256k1(pub_key));
        self.load_account_from_faucet(account);
        (pub_key, priv_key, account)
    }

    pub fn new_ed25519_preallocated_account(
        &mut self,
    ) -> (Ed25519PublicKey, Ed25519PrivateKey, ComponentAddress) {
        let (pub_key, priv_key) = self.new_ed25519_key_pair();
        let account =
            ComponentAddress::preallocated_account_from_public_key(&PublicKey::Ed25519(pub_key));
        self.load_account_from_faucet(account);
        (pub_key, priv_key, account)
    }

    pub fn get_active_validator_info_by_key(&self, key: &Secp256k1PublicKey) -> ValidatorSubstate {
        let address = self.get_active_validator_with_key(key);
        self.get_validator_info(address)
    }

    pub fn get_validator_info(&self, address: ComponentAddress) -> ValidatorSubstate {
        let reader = SystemDatabaseReader::new(&self.database);
        let substate = reader
            .read_typed_object_field::<ValidatorStateFieldPayload>(
                address.as_node_id(),
                ModuleId::Main,
                ValidatorField::State.field_index(),
            )
            .unwrap()
            .fully_update_and_into_latest_version();

        substate
    }

    pub fn get_active_validator_with_key(&self, key: &Secp256k1PublicKey) -> ComponentAddress {
        let reader = SystemDatabaseReader::new(&self.database);
        let substate = reader
            .read_typed_object_field::<ConsensusManagerCurrentValidatorSetFieldPayload>(
                CONSENSUS_MANAGER.as_node_id(),
                ModuleId::Main,
                ConsensusManagerField::CurrentValidatorSet.field_index(),
            )
            .unwrap()
            .fully_update_and_into_latest_version();
        *substate.validator_set.get_by_public_key(key).unwrap().0
    }

    pub fn new_allocated_account(
        &mut self,
    ) -> (Secp256k1PublicKey, Secp256k1PrivateKey, ComponentAddress) {
        let key_pair = self.new_key_pair();
        let withdraw_auth = rule!(require(signature(key_pair.0)));
        let account = self.new_account_advanced(OwnerRole::Fixed(withdraw_auth));
        (key_pair.0, key_pair.1, account)
    }

    pub fn new_ed25519_preallocated_account_with_access_controller(
        &mut self,
        n_out_of_4: u8,
    ) -> (
        Ed25519PublicKey,
        Ed25519PrivateKey,
        Ed25519PublicKey,
        Ed25519PrivateKey,
        Ed25519PublicKey,
        Ed25519PrivateKey,
        Ed25519PublicKey,
        Ed25519PrivateKey,
        ComponentAddress,
        ComponentAddress,
    ) {
        let (pk1, sk1, account) = self.new_ed25519_preallocated_account();
        let (pk2, sk2) = self.new_ed25519_key_pair();
        let (pk3, sk3) = self.new_ed25519_key_pair();
        let (pk4, sk4) = self.new_ed25519_key_pair();

        let access_rule = AccessRule::Protected(CompositeRequirement::BasicRequirement(
            BasicRequirement::CountOf(
                n_out_of_4,
                vec![
                    ResourceOrNonFungible::NonFungible(NonFungibleGlobalId::from_public_key(pk1)),
                    ResourceOrNonFungible::NonFungible(NonFungibleGlobalId::from_public_key(pk2)),
                    ResourceOrNonFungible::NonFungible(NonFungibleGlobalId::from_public_key(pk3)),
                    ResourceOrNonFungible::NonFungible(NonFungibleGlobalId::from_public_key(pk4)),
                ],
            ),
        ));

        let access_controller = self
            .execute_manifest(
                ManifestBuilder::new()
                    .lock_fee_from_faucet()
                    .call_method(account, ACCOUNT_SECURIFY_IDENT, manifest_args!())
                    .take_all_from_worktop(ACCOUNT_OWNER_BADGE, "owner_badge")
                    .call_function_with_name_lookup(
                        ACCESS_CONTROLLER_PACKAGE,
                        ACCESS_CONTROLLER_BLUEPRINT,
                        ACCESS_CONTROLLER_CREATE_IDENT,
                        |lookup| {
                            (
                                lookup.bucket("owner_badge"),
                                ManifestRuleSet {
                                    primary_role: access_rule.clone().into(),
                                    recovery_role: access_rule.clone().into(),
                                    confirmation_role: access_rule.clone().into(),
                                },
                                Some(1000u32),
                                None::<()>,
                            )
                        },
                    )
                    .build(),
                vec![NonFungibleGlobalId::from_public_key(pk1)],
            )
            .expect_commit_success()
            .new_component_addresses()[0];

        (
            pk1,
            sk1,
            pk2,
            sk2,
            pk3,
            sk3,
            pk4,
            sk4,
            account,
            access_controller,
        )
    }

    pub fn new_account(
        &mut self,
        is_preallocated: bool,
    ) -> (Secp256k1PublicKey, Secp256k1PrivateKey, ComponentAddress) {
        if is_preallocated {
            self.new_preallocated_account()
        } else {
            self.new_allocated_account()
        }
    }

    pub fn new_identity<P: Into<PublicKey> + Clone + HasPublicKeyHash>(
        &mut self,
        pk: P,
        is_virtual: bool,
    ) -> ComponentAddress {
        if is_virtual {
            ComponentAddress::preallocated_identity_from_public_key(&pk)
        } else {
            let owner_id = NonFungibleGlobalId::from_public_key(&pk);
            let manifest = ManifestBuilder::new()
                .lock_fee_from_faucet()
                .create_identity_advanced(OwnerRole::Fixed(rule!(require(owner_id))))
                .build();
            let receipt = self.execute_manifest(manifest, vec![]);
            receipt.expect_commit_success();
            let component_address = receipt.expect_commit(true).new_component_addresses()[0];

            component_address
        }
    }

    pub fn new_securified_identity(&mut self, account: ComponentAddress) -> ComponentAddress {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .create_identity()
            .try_deposit_entire_worktop_or_abort(account, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit_success();
        let component_address = receipt.expect_commit(true).new_component_addresses()[0];

        component_address
    }

    pub fn new_validator_with_pub_key(
        &mut self,
        pub_key: Secp256k1PublicKey,
        account: ComponentAddress,
    ) -> ComponentAddress {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .get_free_xrd_from_faucet()
            .take_from_worktop(XRD, *DEFAULT_VALIDATOR_XRD_COST, "xrd_creation_fee")
            .create_validator(pub_key, Decimal::ONE, "xrd_creation_fee")
            .try_deposit_entire_worktop_or_abort(account, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        let address = receipt.expect_commit(true).new_component_addresses()[0];
        address
    }

    pub fn new_staked_validator_with_pub_key(
        &mut self,
        pub_key: Secp256k1PublicKey,
        account: ComponentAddress,
    ) -> ComponentAddress {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .get_free_xrd_from_faucet()
            .take_from_worktop(XRD, *DEFAULT_VALIDATOR_XRD_COST, "xrd_creation_fee")
            .create_validator(pub_key, Decimal::ONE, "xrd_creation_fee")
            .try_deposit_entire_worktop_or_abort(account, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        let validator_address = receipt.expect_commit(true).new_component_addresses()[0];

        let receipt = self.execute_manifest(
            ManifestBuilder::new()
                .lock_fee_from_faucet()
                .get_free_xrd_from_faucet()
                .create_proof_from_account_of_non_fungibles(
                    account,
                    VALIDATOR_OWNER_BADGE,
                    [NonFungibleLocalId::bytes(validator_address.as_node_id().0).unwrap()],
                )
                .take_all_from_worktop(XRD, "bucket")
                .with_bucket("bucket", |builder, bucket| {
                    builder.call_method(
                        validator_address,
                        VALIDATOR_STAKE_AS_OWNER_IDENT,
                        manifest_args!(bucket),
                    )
                })
                .deposit_entire_worktop(account)
                .build(),
            vec![NonFungibleGlobalId::from_public_key(pub_key)],
        );
        receipt.expect_commit_success();

        validator_address
    }

    pub fn publish_native_package(
        &mut self,
        native_package_code_id: u64,
        definition: PackageDefinition,
    ) -> PackageAddress {
        let receipt = self.execute_system_transaction(
            ManifestBuilder::new_system_v1()
                .call_function(
                    PACKAGE_PACKAGE,
                    PACKAGE_BLUEPRINT,
                    PACKAGE_PUBLISH_NATIVE_IDENT,
                    PackagePublishNativeManifestInput {
                        definition: definition.into(),
                        native_package_code_id,
                        metadata: MetadataInit::default().into(),
                        package_address: None,
                    },
                )
                .build(),
            btreeset!(system_execution(SystemExecution::Protocol)),
        );
        let package_address: PackageAddress = receipt.expect_commit(true).output(0);
        package_address
    }

    /// Publishes a package at a specified address.
    ///
    /// This is for testing only. On real networks, this operation is not allowed to users.
    pub fn publish_package_at_address<P: Into<PackagePublishingSource>>(
        &mut self,
        source: P,
        address: PackageAddress,
    ) {
        let (code, definition) = source.into().code_and_definition();
        let mut manifest_builder = ManifestBuilder::new_system_v1();
        let reservation =
            manifest_builder.use_preallocated_address(address, PACKAGE_PACKAGE, PACKAGE_BLUEPRINT);
        let manifest = manifest_builder
            .publish_package_advanced(
                reservation,
                code,
                definition,
                metadata_init!(),
                OwnerRole::Fixed(AccessRule::AllowAll),
            )
            .build();

        let receipt =
            self.execute_system_transaction(manifest, [SystemExecution::Protocol.proof()]);

        receipt.expect_commit_success();
    }

    pub fn publish_package<P: Into<PackagePublishingSource>>(
        &mut self,
        source: P,
        metadata: BTreeMap<String, MetadataValue>,
        owner_role: OwnerRole,
    ) -> PackageAddress {
        let (code, definition) = source.into().code_and_definition();
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .publish_package_advanced(
                None,
                code,
                definition,
                MetadataInit::from(metadata),
                owner_role,
            )
            .build();

        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit(true).new_package_addresses()[0]
    }

    pub fn try_publish_package<P: Into<PackagePublishingSource>>(
        &mut self,
        source: P,
    ) -> TransactionReceipt {
        let (code, definition) = source.into().code_and_definition();
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .publish_package_advanced(
                None,
                code,
                definition,
                MetadataInit::from(BTreeMap::new()),
                OwnerRole::None,
            )
            .build();

        self.execute_manifest(manifest, vec![])
    }

    pub fn publish_package_simple<P: Into<PackagePublishingSource>>(
        &mut self,
        source: P,
    ) -> PackageAddress {
        self.publish_package(source, Default::default(), OwnerRole::None)
    }

    pub fn publish_package_with_owner<P: Into<PackagePublishingSource>>(
        &mut self,
        source: P,
        owner_badge: NonFungibleGlobalId,
    ) -> PackageAddress {
        let (code, definition) = source.into().code_and_definition();
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .publish_package_with_owner(code, definition, owner_badge)
            .build();

        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit(true).new_package_addresses()[0]
    }

    pub fn compile<P: AsRef<Path>>(&mut self, package_dir: P) -> (Vec<u8>, PackageDefinition) {
        self.compile_with_option(package_dir, CompileProfile::FastWithTraceLogs)
    }

    pub fn compile_with_option<P: AsRef<Path>>(
        &mut self,
        package_dir: P,
        compile_profile: CompileProfile,
    ) -> (Vec<u8>, PackageDefinition) {
        Compile::compile(package_dir, compile_profile)
    }

    // Doesn't need to be here - kept for backward compatibility
    pub fn compile_and_publish<P: AsRef<Path>>(&mut self, package_dir: P) -> PackageAddress {
        self.publish_package(package_dir.as_ref(), BTreeMap::new(), OwnerRole::None)
    }

    // Doesn't need to be here - kept for backward compatibility
    pub fn compile_and_publish_at_address<P: AsRef<Path>>(
        &mut self,
        package_dir: P,
        address: PackageAddress,
    ) {
        self.publish_package_at_address(package_dir.as_ref(), address);
    }

    pub fn publish_retain_blueprints<
        P: Into<PackagePublishingSource>,
        F: FnMut(&String, &mut BlueprintDefinitionInit) -> bool,
    >(
        &mut self,
        source: P,
        retain: F,
    ) -> PackageAddress {
        let (code, mut definition) =
            Into::<PackagePublishingSource>::into(source).code_and_definition();
        definition.blueprints.retain(retain);
        self.publish_package((code, definition), BTreeMap::new(), OwnerRole::None)
    }

    // Doesn't need to be here - kept for backward compatibility
    pub fn compile_and_publish_with_owner<P: AsRef<Path>>(
        &mut self,
        package_dir: P,
        owner_badge: NonFungibleGlobalId,
    ) -> PackageAddress {
        self.publish_package_with_owner(package_dir.as_ref(), owner_badge)
    }

    fn resolve_suggested_config(&self, manifest: &impl BuildableManifest) -> ExecutionConfig {
        let config = match manifest.default_test_execution_config_type() {
            DefaultTestExecutionConfigType::Notarized => {
                ExecutionConfig::for_notarized_transaction(NetworkDefinition::simulator())
            }
            DefaultTestExecutionConfigType::System => {
                ExecutionConfig::for_system_transaction(NetworkDefinition::simulator())
            }
            DefaultTestExecutionConfigType::Test => ExecutionConfig::for_test_transaction(),
        };
        self.override_configured_execution_config_properties(config)
    }

    fn override_configured_execution_config_properties(
        &self,
        mut config: ExecutionConfig,
    ) -> ExecutionConfig {
        if let Some(override_kernel_trace) = self.with_kernel_trace {
            config = config.with_kernel_trace(override_kernel_trace);
        }
        if let Some(override_cost_breakdown) = self.with_cost_breakdown {
            config = config.with_cost_breakdown(override_cost_breakdown);
        }
        config
    }

    pub fn execute_manifest(
        &mut self,
        manifest: impl BuildableManifest,
        initial_proofs: impl IntoIterator<Item = NonFungibleGlobalId>,
    ) -> TransactionReceipt {
        let config = self.resolve_suggested_config(&manifest);
        self.execute_manifest_with_execution_config(manifest, initial_proofs, config)
    }

    pub fn execute_manifest_with_execution_config(
        &mut self,
        manifest: impl BuildableManifest,
        initial_proofs: impl IntoIterator<Item = NonFungibleGlobalId>,
        execution_config: ExecutionConfig,
    ) -> TransactionReceipt {
        let executable = manifest
            .into_executable_with_proofs(
                self.next_transaction_nonce(),
                initial_proofs.into_iter().collect(),
                &self.transaction_validator,
            )
            .unwrap_or_else(|err| {
                panic!(
                    "Could not convert manifest into executable transaction: {}",
                    err
                )
            });
        self.execute_transaction(executable, execution_config)
    }

    pub fn execute_manifest_with_costing_params(
        &mut self,
        manifest: impl BuildableManifest,
        initial_proofs: impl IntoIterator<Item = NonFungibleGlobalId>,
        costing_parameters: CostingParameters,
    ) -> TransactionReceipt {
        let mut config = self.resolve_suggested_config(&manifest);
        config.system_overrides = Some(SystemOverrides {
            costing_parameters: Some(costing_parameters),
            ..config.system_overrides.unwrap_or_default()
        });
        self.execute_manifest_with_execution_config(manifest, initial_proofs, config)
    }

    pub fn execute_manifest_with_injected_error(
        &mut self,
        manifest: impl BuildableManifest,
        initial_proofs: impl IntoIterator<Item = NonFungibleGlobalId>,
        error_after_count: u64,
    ) -> TransactionReceipt {
        let execution_config = self.resolve_suggested_config(&manifest);

        let executable = manifest
            .into_executable_with_proofs(
                self.next_transaction_nonce(),
                initial_proofs.into_iter().collect(),
                &self.transaction_validator,
            )
            .unwrap_or_else(|err| {
                panic!(
                    "Could not convert manifest into executable transaction: {}",
                    err
                )
            });

        let vm_init = VmInit::load(&self.database, &self.vm_modules);
        let system_init = InjectCostingErrorInit {
            system_input: SystemInit::load(&self.database, execution_config, vm_init),
            error_after_count,
        };
        let kernel_init = KernelInit::load(&self.database, system_init);

        let transaction_receipt = kernel_init.execute(&executable);

        if let TransactionResult::Commit(commit) = &transaction_receipt.result {
            let database_updates = commit.state_updates.create_database_updates();
            self.database.commit(&database_updates);
            self.collected_events
                .push(commit.application_events.clone());

            if self.with_receipt_substate_check {
                assert_receipt_substate_changes_can_be_typed(commit);
            }
        }
        transaction_receipt
    }

    pub fn construct_unsigned_notarized_transaction_v1(
        &mut self,
        manifest: TransactionManifestV1,
    ) -> NotarizedTransactionV1 {
        let notary = Ed25519PrivateKey::from_u64(1337).unwrap();
        let current_epoch = self.get_current_epoch();
        let nonce = self.next_transaction_nonce();
        TransactionV1Builder::new()
            .header(TransactionHeaderV1 {
                network_id: NetworkDefinition::simulator().id,
                start_epoch_inclusive: current_epoch,
                end_epoch_exclusive: current_epoch.next().unwrap(),
                nonce,
                notary_public_key: notary.public_key().into(),
                notary_is_signatory: false,
                tip_percentage: 0,
            })
            .manifest(manifest)
            .notarize(&notary)
            .build()
    }

    pub fn default_notary(&self) -> Ed25519PrivateKey {
        Ed25519PrivateKey::from_u64(1337).unwrap()
    }

    /// Includes default headers
    pub fn v2_transaction_builder(&mut self) -> TransactionV2Builder {
        let current_epoch = self.get_current_epoch();
        let nonce = self.next_transaction_nonce();
        TransactionV2Builder::new()
            .intent_header(IntentHeaderV2 {
                network_id: NetworkDefinition::simulator().id,
                start_epoch_inclusive: current_epoch,
                end_epoch_exclusive: current_epoch.next().unwrap(),
                min_proposer_timestamp_inclusive: None,
                max_proposer_timestamp_exclusive: None,
                intent_discriminator: nonce as u64,
            })
            .transaction_header(TransactionHeaderV2 {
                notary_public_key: self.default_notary().public_key().into(),
                notary_is_signatory: false,
                tip_basis_points: 0,
            })
    }

    /// Includes default headers
    pub fn v2_partial_transaction_builder(&mut self) -> PartialTransactionV2Builder {
        let current_epoch = self.get_current_epoch();
        let nonce = self.next_transaction_nonce();
        PartialTransactionV2Builder::new().intent_header(IntentHeaderV2 {
            network_id: NetworkDefinition::simulator().id,
            start_epoch_inclusive: current_epoch,
            end_epoch_exclusive: current_epoch.next().unwrap(),
            min_proposer_timestamp_inclusive: None,
            max_proposer_timestamp_exclusive: None,
            intent_discriminator: nonce as u64,
        })
    }

    pub fn execute_notarized_transaction(
        &mut self,
        transaction_source: impl ResolveAsRawNotarizedTransaction,
    ) -> TransactionReceipt {
        let raw_transaction = transaction_source.resolve_raw_notarized_transaction();
        let executable = raw_transaction
            .as_ref()
            .validate(&self.transaction_validator)
            .expect("Expected raw transaction to be valid")
            .create_executable();
        self.execute_transaction(
            executable,
            ExecutionConfig::for_notarized_transaction(NetworkDefinition::simulator()),
        )
    }

    /// The system manifest can be created with `ManifestBuilder::new_system_v1()`.
    /// Preallocated addresses can be created with manifest_builder.preallocate_address()
    pub fn execute_system_transaction(
        &mut self,
        manifest: SystemTransactionManifestV1,
        initial_proofs: impl IntoIterator<Item = NonFungibleGlobalId>,
    ) -> TransactionReceipt {
        self.execute_manifest(manifest, initial_proofs)
    }

    pub fn execute_test_transaction(
        &mut self,
        test_transaction: TestTransaction,
    ) -> TransactionReceipt {
        self.execute_transaction(test_transaction, ExecutionConfig::for_test_transaction())
    }

    pub fn execute_transaction_no_commit(
        &mut self,
        executable_source: impl IntoExecutable,
        execution_config: ExecutionConfig,
    ) -> TransactionReceipt {
        let executable = executable_source
            .into_executable(&self.transaction_validator)
            .expect("Transaction should be convertible to executable");

        let execution_config =
            self.override_configured_execution_config_properties(execution_config);

        execute_transaction(
            &self.database,
            &self.vm_modules,
            &execution_config,
            executable,
        )
    }

    pub fn execute_transaction(
        &mut self,
        executable_source: impl IntoExecutable,
        execution_config: ExecutionConfig,
    ) -> TransactionReceipt {
        let executable = executable_source
            .into_executable(&self.transaction_validator)
            .expect("Transaction should be convertible to executable");

        let execution_config =
            self.override_configured_execution_config_properties(execution_config);

        if executable
            .costing_parameters()
            .free_credit_in_xrd
            .is_positive()
        {
            self.xrd_free_credits_used = true;
        }

        let transaction_receipt = execute_transaction(
            &self.database,
            &self.vm_modules,
            &execution_config,
            executable,
        );

        if let TransactionResult::Commit(commit) = &transaction_receipt.result {
            let database_updates = commit.state_updates.create_database_updates();
            self.database.commit(&database_updates);
            self.collected_events
                .push(commit.application_events.clone());

            if self.with_receipt_substate_check {
                assert_receipt_substate_changes_can_be_typed(commit);
            }
        }
        transaction_receipt
    }

    pub fn preview(
        &mut self,
        preview_intent: PreviewIntentV1,
        network: &NetworkDefinition,
    ) -> Result<TransactionReceipt, PreviewError> {
        execute_preview(
            &self.database,
            &self.vm_modules,
            network,
            preview_intent,
            self.with_kernel_trace.unwrap_or(false),
        )
    }

    pub fn preview_manifest(
        &mut self,
        manifest: TransactionManifestV1,
        signer_public_keys: Vec<PublicKey>,
        tip_percentage: u16,
        flags: PreviewFlags,
    ) -> TransactionReceipt {
        let epoch = self.get_current_epoch();
        execute_preview(
            &self.database,
            &self.vm_modules,
            &NetworkDefinition::simulator(),
            PreviewIntentV1 {
                intent: IntentV1 {
                    header: TransactionHeaderV1 {
                        network_id: NetworkDefinition::simulator().id,
                        start_epoch_inclusive: epoch,
                        end_epoch_exclusive: epoch.after(10).unwrap(),
                        nonce: 0,
                        notary_public_key: PublicKey::Secp256k1(Secp256k1PublicKey([0u8; 33])),
                        notary_is_signatory: false,
                        tip_percentage,
                    },
                    instructions: InstructionsV1::from(manifest.instructions),
                    blobs: BlobsV1 {
                        blobs: manifest.blobs.values().map(|x| BlobV1(x.clone())).collect(),
                    },
                    message: MessageV1::default(),
                },
                signer_public_keys,
                flags,
            },
            self.with_kernel_trace.unwrap_or(false),
        )
        .unwrap()
    }

    pub fn preview_v2(
        &mut self,
        preview_transaction: PreviewTransactionV2,
        flags: PreviewFlags,
    ) -> TransactionReceipt {
        let validated = preview_transaction
            .prepare_and_validate(&self.transaction_validator)
            .expect("Preview transaction should be valid");
        let execution_config = if flags.disable_auth {
            ExecutionConfig::for_preview_no_auth(NetworkDefinition::simulator())
        } else {
            ExecutionConfig::for_preview(NetworkDefinition::simulator())
        };
        let execution_config =
            self.override_configured_execution_config_properties(execution_config);
        let executable = validated.create_executable(flags);
        self.execute_transaction_no_commit(executable, execution_config)
    }

    /// Calls a package blueprint function with the given arguments, paying the fee from the faucet.
    ///
    /// The arguments should be one of:
    /// * A tuple, such as `()`, `(x,)` or `(x, y, z)`
    ///   * IMPORTANT: If calling with a single argument, you must include a trailing comma
    ///     in the tuple declaration. This ensures that the rust compiler knows it's a singleton tuple,
    ///     rather than just some brackets around the inner value.
    /// * A struct which implements `ManifestEncode` representing the arguments
    /// * `manifest_args!(x, y, z)`
    ///
    /// Notes:
    /// * Buckets and signatures are not supported - instead use `execute_manifest_ignoring_fee` and `ManifestBuilder` directly.
    /// * Call `.expect_commit_success()` on the receipt to get access to receipt details.
    pub fn call_function(
        &mut self,
        package_address: impl Resolve<ManifestPackageAddress>,
        blueprint_name: impl Into<String>,
        function_name: impl Into<String>,
        arguments: impl ResolvableArguments,
    ) -> TransactionReceipt {
        self.execute_manifest(
            ManifestBuilder::new()
                .lock_fee_from_faucet()
                .call_function(package_address, blueprint_name, function_name, arguments)
                .build(),
            vec![],
        )
    }

    /// Calls a package blueprint function with the given arguments, and assumes it constructs a single component successfully.
    /// It returns the address of the first created component.
    ///
    /// The arguments should be one of:
    /// * A tuple, such as `()`, `(x,)` or `(x, y, z)`
    ///   * IMPORTANT: If calling with a single argument, you must include a trailing comma
    ///     in the tuple declaration. This ensures that the rust compiler knows it's a singleton tuple,
    ///     rather than just some brackets around the inner value.
    /// * A struct which implements `ManifestEncode` representing the arguments
    /// * `manifest_args!(x, y, z)`
    ///
    /// Notes:
    /// * Buckets and signatures are not supported - instead use `execute_manifest_ignoring_fee` and `ManifestBuilder` directly.
    pub fn construct_new(
        &mut self,
        package_address: impl Resolve<ManifestPackageAddress>,
        blueprint_name: impl Into<String>,
        function_name: impl Into<String>,
        arguments: impl ResolvableArguments,
    ) -> ComponentAddress {
        self.call_function(package_address, blueprint_name, function_name, arguments)
            .expect_commit_success()
            .new_component_addresses()[0]
    }

    /// Calls a component method with the given arguments, paying the fee from the faucet.
    ///
    /// The arguments should be one of:
    /// * A tuple, such as `()`, `(x,)` or `(x, y, z)`
    ///   * IMPORTANT: If calling with a single argument, you must include a trailing comma
    ///     in the tuple declaration. This ensures that the rust compiler knows it's a singleton tuple,
    ///     rather than just some brackets around the inner value.
    /// * A struct which implements `ManifestEncode` representing the arguments
    /// * `manifest_args!(x, y, z)`
    ///
    /// Notes:
    /// * Buckets and signatures are not supported - instead use `execute_manifest_ignoring_fee` and `ManifestBuilder` directly.
    /// * Call `.expect_commit_success()` on the receipt to get access to receipt details.
    pub fn call_method(
        &mut self,
        address: impl Resolve<ManifestGlobalAddress>,
        method_name: impl Into<String>,
        args: impl ResolvableArguments,
    ) -> TransactionReceipt {
        self.execute_manifest(
            ManifestBuilder::new()
                .lock_fee_from_faucet()
                .call_method(address, method_name, args)
                .build(),
            vec![],
        )
    }

    fn create_fungible_resource_and_deposit(
        &mut self,
        owner_role: OwnerRole,
        resource_roles: FungibleResourceRoles,
        to: ComponentAddress,
    ) -> ResourceAddress {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .create_fungible_resource(
                owner_role,
                true,
                0,
                resource_roles,
                metadata!(),
                Some(5.into()),
            )
            .try_deposit_entire_worktop_or_abort(to, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit(true).new_resource_addresses()[0]
    }

    pub fn create_restricted_token(
        &mut self,
        account: ComponentAddress,
    ) -> (
        ResourceAddress,
        ResourceAddress,
        ResourceAddress,
        ResourceAddress,
        ResourceAddress,
        ResourceAddress,
        ResourceAddress,
        ResourceAddress,
    ) {
        let mint_auth = self.create_fungible_resource(dec!(1), 0, account);
        let burn_auth = self.create_fungible_resource(dec!(1), 0, account);
        let withdraw_auth = self.create_fungible_resource(dec!(1), 0, account);
        let recall_auth = self.create_fungible_resource(dec!(1), 0, account);
        let update_metadata_auth = self.create_fungible_resource(dec!(1), 0, account);
        let freeze_auth = self.create_fungible_resource(dec!(1), 0, account);
        let admin_auth = self.create_fungible_resource(dec!(1), 0, account);

        let token_address = self.create_fungible_resource_and_deposit(
            OwnerRole::None,
            FungibleResourceRoles {
                mint_roles: mint_roles! {
                    minter => rule!(require(mint_auth));
                    minter_updater => rule!(require(admin_auth));
                },
                burn_roles: burn_roles! {
                    burner => rule!(require(burn_auth));
                    burner_updater => rule!(require(admin_auth));
                },
                freeze_roles: freeze_roles! {
                    freezer => rule!(require(freeze_auth));
                    freezer_updater => rule!(require(admin_auth));
                },
                recall_roles: recall_roles! {
                    recaller => rule!(require(recall_auth));
                    recaller_updater => rule!(require(admin_auth));
                },
                withdraw_roles: withdraw_roles! {
                    withdrawer => rule!(require(withdraw_auth));
                    withdrawer_updater => rule!(require(admin_auth));
                },
                deposit_roles: deposit_roles! {
                    depositor => rule!(allow_all);
                    depositor_updater => rule!(require(admin_auth));
                },
            },
            account,
        );

        (
            token_address,
            mint_auth,
            burn_auth,
            withdraw_auth,
            recall_auth,
            update_metadata_auth,
            freeze_auth,
            admin_auth,
        )
    }

    pub fn create_everything_allowed_non_fungible_resource(
        &mut self,
        owner_role: OwnerRole,
    ) -> ResourceAddress {
        let receipt = self.execute_manifest(
            ManifestBuilder::new()
                .lock_fee_from_faucet()
                .create_non_fungible_resource::<Vec<_>, ()>(
                    owner_role,
                    NonFungibleIdType::Integer,
                    false,
                    NonFungibleResourceRoles {
                        mint_roles: mint_roles! {
                            minter => rule!(allow_all);
                            minter_updater => rule!(allow_all);
                        },
                        burn_roles: burn_roles! {
                            burner => rule!(allow_all);
                            burner_updater => rule!(allow_all);
                        },
                        freeze_roles: freeze_roles! {
                            freezer => rule!(allow_all);
                            freezer_updater => rule!(allow_all);
                        },
                        recall_roles: recall_roles! {
                            recaller => rule!(allow_all);
                            recaller_updater => rule!(allow_all);
                        },
                        withdraw_roles: withdraw_roles! {
                            withdrawer => rule!(allow_all);
                            withdrawer_updater => rule!(allow_all);
                        },
                        deposit_roles: deposit_roles! {
                            depositor => rule!(allow_all);
                            depositor_updater => rule!(allow_all);
                        },
                        non_fungible_data_update_roles: non_fungible_data_update_roles! {
                            non_fungible_data_updater => rule!(allow_all);
                            non_fungible_data_updater_updater => rule!(allow_all);
                        },
                    },
                    metadata!(),
                    None,
                )
                .build(),
            vec![],
        );
        receipt.expect_commit(true).new_resource_addresses()[0]
    }

    pub fn create_freezeable_token(&mut self, account: ComponentAddress) -> ResourceAddress {
        self.create_fungible_resource_and_deposit(
            OwnerRole::None,
            FungibleResourceRoles {
                burn_roles: burn_roles! {
                    burner => rule!(allow_all);
                    burner_updater => rule!(deny_all);
                },
                recall_roles: recall_roles! {
                    recaller => rule!(allow_all);
                    recaller_updater => rule!(deny_all);
                },
                freeze_roles: freeze_roles! {
                    freezer => rule!(allow_all);
                    freezer_updater => rule!(deny_all);
                },
                ..Default::default()
            },
            account,
        )
    }

    pub fn create_freezeable_non_fungible(&mut self, account: ComponentAddress) -> ResourceAddress {
        self.create_non_fungible_resource_with_roles(
            NonFungibleResourceRoles {
                burn_roles: burn_roles! {
                    burner => rule!(allow_all);
                    burner_updater => rule!(deny_all);
                },
                recall_roles: recall_roles! {
                    recaller => rule!(allow_all);
                    recaller_updater => rule!(deny_all);
                },
                freeze_roles: freeze_roles! {
                    freezer => rule!(allow_all);
                    freezer_updater => rule!(deny_all);
                },
                ..Default::default()
            },
            account,
        )
    }

    pub fn create_recallable_token(&mut self, account: ComponentAddress) -> ResourceAddress {
        self.create_fungible_resource_and_deposit(
            OwnerRole::None,
            FungibleResourceRoles {
                recall_roles: recall_roles! {
                    recaller => rule!(allow_all);
                    recaller_updater => rule!(deny_all);
                },
                ..Default::default()
            },
            account,
        )
    }

    pub fn create_restricted_burn_token(
        &mut self,
        account: ComponentAddress,
    ) -> (ResourceAddress, ResourceAddress) {
        let auth_resource_address = self.create_fungible_resource(dec!(1), 0, account);

        let resource_address = self.create_fungible_resource_and_deposit(
            OwnerRole::None,
            FungibleResourceRoles {
                burn_roles: burn_roles! {
                    burner => rule!(require(auth_resource_address));
                    burner_updater => rule!(deny_all);
                },
                ..Default::default()
            },
            account,
        );

        (auth_resource_address, resource_address)
    }

    pub fn create_restricted_transfer_token(
        &mut self,
        account: ComponentAddress,
    ) -> (ResourceAddress, ResourceAddress) {
        let auth_resource_address = self.create_non_fungible_resource(account);

        let resource_address = self.create_fungible_resource_and_deposit(
            OwnerRole::None,
            FungibleResourceRoles {
                withdraw_roles: withdraw_roles! {
                    withdrawer => rule!(require(auth_resource_address));
                    withdrawer_updater => rule!(deny_all);
                },
                ..Default::default()
            },
            account,
        );

        (auth_resource_address, resource_address)
    }

    pub fn create_non_fungible_resource(&mut self, account: ComponentAddress) -> ResourceAddress {
        self.create_non_fungible_resource_advanced(NonFungibleResourceRoles::default(), account, 3)
    }
    pub fn create_non_fungible_resource_with_roles(
        &mut self,
        resource_roles: NonFungibleResourceRoles,
        account: ComponentAddress,
    ) -> ResourceAddress {
        self.create_non_fungible_resource_advanced(resource_roles, account, 3)
    }

    pub fn create_non_fungible_resource_advanced(
        &mut self,
        resource_roles: NonFungibleResourceRoles,
        account: ComponentAddress,
        n: usize,
    ) -> ResourceAddress {
        let mut entries = BTreeMap::new();
        for i in 1..n + 1 {
            entries.insert(
                NonFungibleLocalId::integer(i as u64),
                EmptyNonFungibleData {},
            );
        }

        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .create_non_fungible_resource(
                OwnerRole::None,
                NonFungibleIdType::Integer,
                false,
                resource_roles,
                metadata!(),
                Some(entries),
            )
            .try_deposit_entire_worktop_or_abort(account, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit(true).new_resource_addresses()[0]
    }

    pub fn create_fungible_resource(
        &mut self,
        amount: Decimal,
        divisibility: u8,
        account: ComponentAddress,
    ) -> ResourceAddress {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .create_fungible_resource(
                OwnerRole::None,
                true,
                divisibility,
                FungibleResourceRoles::default(),
                metadata!(),
                Some(amount),
            )
            .try_deposit_entire_worktop_or_abort(account, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit(true).new_resource_addresses()[0]
    }

    pub fn create_mintable_burnable_fungible_resource(
        &mut self,
        account: ComponentAddress,
    ) -> (ResourceAddress, ResourceAddress) {
        let admin_auth = self.create_non_fungible_resource(account);

        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .create_fungible_resource(
                OwnerRole::None,
                true,
                1u8,
                FungibleResourceRoles {
                    mint_roles: mint_roles! {
                        minter => rule!(require(admin_auth));
                        minter_updater => rule!(deny_all);
                    },
                    burn_roles: burn_roles! {
                        burner => rule!(require(admin_auth));
                        burner_updater => rule!(deny_all);
                    },
                    ..Default::default()
                },
                metadata!(),
                None,
            )
            .try_deposit_entire_worktop_or_abort(account, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        let resource_address = receipt.expect_commit(true).new_resource_addresses()[0];
        (admin_auth, resource_address)
    }

    pub fn create_freely_mintable_fungible_resource(
        &mut self,
        owner_role: OwnerRole,
        amount: Option<Decimal>,
        divisibility: u8,
        account: ComponentAddress,
    ) -> ResourceAddress {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .create_fungible_resource(
                owner_role,
                true,
                divisibility,
                FungibleResourceRoles {
                    mint_roles: mint_roles! {
                        minter => rule!(allow_all);
                        minter_updater => rule!(deny_all);
                    },
                    ..Default::default()
                },
                metadata!(),
                amount,
            )
            .try_deposit_entire_worktop_or_abort(account, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit(true).new_resource_addresses()[0]
    }

    pub fn create_freely_mintable_and_burnable_fungible_resource(
        &mut self,
        owner_role: OwnerRole,
        amount: Option<Decimal>,
        divisibility: u8,
        account: ComponentAddress,
    ) -> ResourceAddress {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .create_fungible_resource(
                owner_role,
                true,
                divisibility,
                FungibleResourceRoles {
                    mint_roles: mint_roles! {
                        minter => rule!(allow_all);
                        minter_updater => rule!(deny_all);
                    },
                    burn_roles: burn_roles! {
                        burner => rule!(allow_all);
                        burner_updater => rule!(deny_all);
                    },
                    ..Default::default()
                },
                metadata!(),
                amount,
            )
            .try_deposit_entire_worktop_or_abort(account, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit(true).new_resource_addresses()[0]
    }

    pub fn create_freely_mintable_and_burnable_non_fungible_resource<T, V>(
        &mut self,
        owner_role: OwnerRole,
        id_type: NonFungibleIdType,
        initial_supply: Option<T>,
        account: ComponentAddress,
    ) -> ResourceAddress
    where
        T: IntoIterator<Item = (NonFungibleLocalId, V)>,
        V: ManifestEncode + NonFungibleData,
    {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .create_non_fungible_resource(
                owner_role,
                id_type,
                true,
                NonFungibleResourceRoles {
                    mint_roles: mint_roles! {
                        minter => rule!(allow_all);
                        minter_updater => rule!(deny_all);
                    },
                    burn_roles: burn_roles! {
                        burner => rule!(allow_all);
                        burner_updater => rule!(deny_all);
                    },
                    ..Default::default()
                },
                metadata!(),
                initial_supply,
            )
            .try_deposit_entire_worktop_or_abort(account, None)
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        receipt.expect_commit(true).new_resource_addresses()[0]
    }

    pub fn create_one_resource_pool(
        &mut self,
        resource_address: ResourceAddress,
        pool_manager_rule: AccessRule,
    ) -> (ComponentAddress, ResourceAddress) {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .call_function(
                POOL_PACKAGE,
                ONE_RESOURCE_POOL_BLUEPRINT_IDENT,
                ONE_RESOURCE_POOL_INSTANTIATE_IDENT,
                OneResourcePoolInstantiateManifestInput {
                    resource_address: resource_address.into(),
                    pool_manager_rule: pool_manager_rule.into(),
                    owner_role: OwnerRole::None.into(),
                    address_reservation: None,
                },
            )
            .build();
        let receipt = self.execute_manifest(manifest, vec![]);
        let commit_result = receipt.expect_commit_success();

        (
            commit_result.new_component_addresses()[0],
            commit_result.new_resource_addresses()[0],
        )
    }

    pub fn new_component<F>(
        &mut self,
        initial_proofs: BTreeSet<NonFungibleGlobalId>,
        handler: F,
    ) -> ComponentAddress
    where
        F: FnOnce(ManifestBuilder) -> ManifestBuilder,
    {
        let manifest = ManifestBuilder::new()
            .lock_fee_from_faucet()
            .then(handler)
            .build();

        let receipt = self.execute_manifest(manifest, initial_proofs);
        receipt.expect_commit(true).new_component_addresses()[0]
    }

    pub fn set_current_epoch(&mut self, epoch: Epoch) {
        let reader = SystemDatabaseReader::new(&self.database);
        let mut substate = reader
            .read_typed_object_field::<ConsensusManagerStateFieldPayload>(
                CONSENSUS_MANAGER.as_node_id(),
                ModuleId::Main,
                ConsensusManagerField::State.field_index(),
            )
            .unwrap()
            .fully_update_and_into_latest_version();

        substate.epoch = epoch;

        let mut writer = SystemDatabaseWriter::new(&mut self.database);
        writer
            .write_typed_object_field(
                CONSENSUS_MANAGER.as_node_id(),
                ModuleId::Main,
                ConsensusManagerField::State.field_index(),
                ConsensusManagerStateFieldPayload::from_content_source(substate),
            )
            .unwrap();
    }

    pub fn get_current_epoch(&mut self) -> Epoch {
        let receipt = self.execute_system_transaction(
            ManifestBuilder::new_system_v1()
                .call_method(
                    CONSENSUS_MANAGER,
                    CONSENSUS_MANAGER_GET_CURRENT_EPOCH_IDENT,
                    ConsensusManagerGetCurrentEpochInput,
                )
                .build(),
            btreeset![system_execution(SystemExecution::Validator)],
        );
        receipt.expect_commit(true).output(0)
    }

    /// Executes a "start round number `round` at timestamp `timestamp_ms`" system transaction, as
    /// if it was proposed by the first validator from the validator set, after `round - 1` missed
    /// rounds by that validator.
    pub fn advance_to_round_at_timestamp(
        &mut self,
        round: Round,
        proposer_timestamp_ms: i64,
    ) -> TransactionReceipt {
        let expected_round_number = self.get_consensus_manager_state().round.number() + 1;
        self.execute_system_transaction(
            ManifestBuilder::new_system_v1()
                .call_method(
                    CONSENSUS_MANAGER,
                    CONSENSUS_MANAGER_NEXT_ROUND_IDENT,
                    ConsensusManagerNextRoundInput {
                        round,
                        proposer_timestamp_ms,
                        leader_proposal_history: LeaderProposalHistory {
                            gap_round_leaders: (expected_round_number..round.number())
                                .map(|_| 0)
                                .collect(),
                            current_leader: 0,
                            is_fallback: false,
                        },
                    },
                )
                .build(),
            btreeset![system_execution(SystemExecution::Validator)],
        )
    }

    /// Performs an [`advance_to_round_at_timestamp()`] with an unchanged timestamp.
    pub fn advance_to_round(&mut self, round: Round) -> TransactionReceipt {
        let current_timestamp_ms = self.get_current_proposer_timestamp_ms();
        self.advance_to_round_at_timestamp(round, current_timestamp_ms)
    }

    /// Reads out the substate holding the "epoch milli" timestamp reported by the proposer on the
    /// most recent round change.
    pub fn get_current_proposer_timestamp_ms(&mut self) -> i64 {
        let reader = SystemDatabaseReader::new(self.substate_db());
        reader
            .read_typed_object_field::<ConsensusManagerProposerMilliTimestampFieldPayload>(
                CONSENSUS_MANAGER.as_node_id(),
                ModuleId::Main,
                ConsensusManagerField::ProposerMilliTimestamp.field_index(),
            )
            .unwrap()
            .fully_update_and_into_latest_version()
            .epoch_milli
    }

    pub fn get_consensus_manager_state(&mut self) -> ConsensusManagerSubstate {
        let reader = SystemDatabaseReader::new(self.substate_db());
        reader
            .read_typed_object_field::<ConsensusManagerStateFieldPayload>(
                CONSENSUS_MANAGER.as_node_id(),
                ModuleId::Main,
                ConsensusManagerField::State.field_index(),
            )
            .unwrap()
            .fully_update_and_into_latest_version()
    }

    pub fn get_current_time(&mut self, precision: TimePrecision) -> Instant {
        let receipt = self.execute_system_transaction(
            ManifestBuilder::new_system_v1()
                .call_method(
                    CONSENSUS_MANAGER,
                    CONSENSUS_MANAGER_GET_CURRENT_TIME_IDENT,
                    ConsensusManagerGetCurrentTimeInputV2 { precision },
                )
                .build(),
            btreeset![system_execution(SystemExecution::Validator)],
        );
        receipt.expect_commit(true).output(0)
    }

    pub fn event_schema(
        &self,
        event_type_identifier: &EventTypeIdentifier,
    ) -> (LocalTypeId, VersionedScryptoSchema) {
        let (blueprint_id, name) = match event_type_identifier {
            EventTypeIdentifier(Emitter::Method(node_id, node_module), event_name) => {
                let blueprint_id = match node_module {
                    ModuleId::Main => {
                        let reader = SystemDatabaseReader::new(self.substate_db());
                        let type_info = reader.get_type_info(node_id).unwrap();
                        match type_info {
                            TypeInfoSubstate::Object(ObjectInfo {
                                blueprint_info: BlueprintInfo { blueprint_id, .. },
                                ..
                            }) => blueprint_id,
                            _ => {
                                panic!("No event schema.")
                            }
                        }
                    }
                    module => module.static_blueprint().unwrap(),
                };
                (blueprint_id, event_name.clone())
            }
            EventTypeIdentifier(Emitter::Function(blueprint_id), event_name) => {
                (blueprint_id.clone(), event_name.clone())
            }
        };

        let system_reader = SystemDatabaseReader::new(self.substate_db());
        let definition = system_reader
            .get_blueprint_definition(&blueprint_id)
            .unwrap();
        let schema_pointer = definition
            .interface
            .get_event_payload_def(name.as_str())
            .unwrap();

        match schema_pointer {
            BlueprintPayloadDef::Static(type_identifier) => {
                let reader = SystemDatabaseReader::new(self.substate_db());
                let schema = reader
                    .get_schema(
                        blueprint_id.package_address.as_node_id(),
                        &type_identifier.0,
                    )
                    .unwrap();
                (type_identifier.1, schema.as_ref().clone())
            }
            BlueprintPayloadDef::Generic(_instance_index) => {
                todo!()
            }
        }
    }

    pub fn event_name(&self, event_type_identifier: &EventTypeIdentifier) -> String {
        let (local_type_id, schema) = self.event_schema(event_type_identifier);
        schema
            .v1()
            .resolve_type_metadata(local_type_id)
            .unwrap()
            .get_name_string()
            .unwrap()
    }

    pub fn is_event_name_equal<T: ScryptoDescribe>(
        &self,
        event_type_identifier: &EventTypeIdentifier,
    ) -> bool {
        let expected_type_name = {
            let (local_type_id, schema) =
                sbor::generate_full_schema_from_single_type::<T, ScryptoCustomSchema>();
            schema
                .v1()
                .resolve_type_metadata(local_type_id)
                .unwrap()
                .get_name_string()
                .unwrap()
        };
        let actual_type_name = self.event_name(event_type_identifier);
        expected_type_name == actual_type_name
    }

    pub fn extract_events_of_type<T: ScryptoEvent>(&self, result: &CommitResult) -> Vec<T> {
        result
            .application_events
            .iter()
            .filter(|(id, _data)| self.is_event_name_equal::<T>(id))
            .map(|(_id, data)| scrypto_decode::<T>(data).unwrap())
            .collect::<Vec<_>>()
    }

    pub fn check_db<A: ApplicationChecker + Default>(
        &self,
    ) -> Result<
        (SystemDatabaseCheckerResults, A::ApplicationCheckerResults),
        SystemDatabaseCheckError,
    > {
        let mut checker = SystemDatabaseChecker::<A>::default();
        checker.check_db(&self.database)
    }

    pub fn check_events<A: ApplicationEventChecker>(
        &self,
    ) -> Result<A::ApplicationEventCheckerResults, SystemEventCheckerError> {
        let mut event_checker = SystemEventChecker::<A>::new();
        event_checker.check_all_events(&self.database, self.collected_events())
    }

    pub fn check_database(&self) {
        let mut kernel_checker = KernelDatabaseChecker::new();
        kernel_checker
            .check_db(&self.database)
            .expect("Database should be consistent");

        // Defining a composite checker of all of the application db checkers we have.
        define_composite_checker! {
            CompositeApplicationDatabaseChecker,
            [
                ResourceDatabaseChecker,
                RoleAssignmentDatabaseChecker,
                PackageRoyaltyDatabaseChecker<F: Fn(&BlueprintId, &str) -> bool>,
                ComponentRoyaltyDatabaseChecker,
            ]
        }
        let db_results = {
            let reader = SystemDatabaseReader::new(&self.database);
            let mut checker = SystemDatabaseChecker::new(CompositeApplicationDatabaseChecker::new(
                Default::default(),
                Default::default(),
                PackageRoyaltyDatabaseChecker::new(|blueprint_id, func_name| {
                    reader
                        .get_blueprint_definition(blueprint_id)
                        .map(|bp_def| bp_def.interface.functions.contains_key(func_name))
                        .unwrap_or(false)
                }),
                Default::default(),
            ));
            checker
                .check_db(&self.database)
                .expect("Database should be consistent after running test")
        };
        println!("{:#?}", db_results);

        if !db_results.1 .1.is_empty() {
            panic!("Role assignment violations: {:?}", db_results.1 .1);
        }

        let event_results = SystemEventChecker::<ResourceEventChecker>::new()
            .check_all_events(&self.database, &self.collected_events)
            .expect("Events should be consistent");
        println!("{:#?}", event_results);

        // If free credits (xrd from thin air) have been used then reconciliation will fail
        // due to missing mint events
        if !self.xrd_free_credits_used {
            ResourceReconciler::reconcile(&db_results.1 .0, &event_results)
                .expect("Resource reconciliation failed");
        }
    }
}

impl<E: NativeVmExtension, D: TestDatabase> LedgerSimulator<E, StateTreeUpdatingDatabase<D>> {
    pub fn get_state_hash(&self) -> Hash {
        self.database.get_current_root_hash()
    }

    pub fn assert_state_tree_matches_substate_store(&mut self) {
        self.database
            .validate_state_tree_matches_substate_store()
            .unwrap()
    }
}

pub struct SubtreeVaults<'d, D> {
    database: &'d D,
}

impl<'d, D: SubstateDatabase> SubtreeVaults<'d, D> {
    pub fn new(database: &'d D) -> Self {
        Self { database }
    }

    pub fn get_all(&self, node_id: &NodeId) -> IndexMap<ResourceAddress, Vec<NodeId>> {
        let mut vault_finder = VaultFinder::new();
        let mut traverser = StateTreeTraverser::new(self.database, &mut vault_finder, 100);
        traverser.traverse_subtree(None, *node_id);
        vault_finder.to_vaults()
    }

    pub fn sum_balance_changes(
        &self,
        node_id: &NodeId,
        vault_balance_changes: &IndexMap<NodeId, (ResourceAddress, BalanceChange)>,
    ) -> IndexMap<ResourceAddress, BalanceChange> {
        self.get_all(node_id)
            .into_iter()
            .filter_map(|(traversed_resource, vault_ids)| {
                vault_ids
                    .into_iter()
                    .filter_map(|vault_id| vault_balance_changes.get(&vault_id).cloned())
                    .map(|(reported_resource, change)| {
                        assert_eq!(reported_resource, traversed_resource);
                        change
                    })
                    .reduce(|mut left, right| {
                        left.add_assign(right);
                        left
                    })
                    .map(|change| (traversed_resource, change))
            })
            .collect()
    }
}

pub fn is_auth_error(e: &RuntimeError) -> bool {
    matches!(
        e,
        RuntimeError::SystemModuleError(SystemModuleError::AuthError(_))
    )
}

pub fn is_costing_error(e: &RuntimeError) -> bool {
    matches!(
        e,
        RuntimeError::SystemModuleError(SystemModuleError::CostingError(_))
    )
}

pub fn is_wasm_error(e: &RuntimeError) -> bool {
    matches!(e, RuntimeError::VmError(VmError::Wasm(..)))
}
pub fn wat2wasm(wat: &str) -> Vec<u8> {
    let wat = wat
        .replace("${memcpy}", include_str!("snippets/memcpy.wat"))
        .replace("${memmove}", include_str!("snippets/memmove.wat"))
        .replace("${memset}", include_str!("snippets/memset.wat"));

    wat::parse_str(wat).expect("Failed to compiled WAT into WASM")
}

pub fn single_function_package_definition(
    blueprint_name: &str,
    function_name: &str,
) -> PackageDefinition {
    PackageDefinition::new_single_function_test_definition(blueprint_name, function_name)
}

#[derive(ScryptoSbor, ManifestSbor)]
pub struct EmptyNonFungibleData {}

impl NonFungibleData for EmptyNonFungibleData {
    const MUTABLE_FIELDS: &'static [&'static str] = &[];
}

pub struct TransactionParams {
    pub start_epoch_inclusive: Epoch,
    pub end_epoch_exclusive: Epoch,
}

pub fn create_notarized_transaction(
    params: TransactionParams,
    manifest: TransactionManifestV1,
) -> NotarizedTransactionV1 {
    // create key pairs
    let sk1 = Secp256k1PrivateKey::from_u64(1).unwrap();
    let sk2 = Secp256k1PrivateKey::from_u64(2).unwrap();
    let sk_notary = Secp256k1PrivateKey::from_u64(3).unwrap();

    TransactionBuilder::new()
        .header(TransactionHeaderV1 {
            network_id: NetworkDefinition::simulator().id,
            start_epoch_inclusive: params.start_epoch_inclusive,
            end_epoch_exclusive: params.end_epoch_exclusive,
            nonce: 5,
            notary_public_key: sk_notary.public_key().into(),
            notary_is_signatory: false,
            tip_percentage: 5,
        })
        .manifest(manifest)
        .sign(&sk1)
        .sign(&sk2)
        .notarize(&sk_notary)
        .build()
}

pub fn create_notarized_transaction_advanced<S: Signer>(
    ledger: &mut DefaultLedgerSimulator,
    network: &NetworkDefinition,
    manifest: TransactionManifestV1,
    signers: Vec<&S>,
    notary: &S,
    notary_is_signatory: bool,
) -> NotarizedTransactionV1 {
    TransactionBuilder::new()
        .header(TransactionHeaderV1 {
            network_id: network.id,
            start_epoch_inclusive: Epoch::zero(),
            end_epoch_exclusive: Epoch::of(99),
            nonce: ledger.next_transaction_nonce(),
            notary_public_key: notary.public_key(),
            notary_is_signatory,
            tip_percentage: 0,
        })
        .manifest(manifest)
        .multi_sign(&signers)
        .notarize(notary)
        .build()
}

pub fn assert_receipt_substate_changes_can_be_typed(commit_result: &CommitResult) {
    let substate_updates = commit_result
        .state_updates
        .clone()
        .into_flattened_substate_updates();
    for ((node_id, partition_num, substate_key), database_update) in substate_updates.into_iter() {
        let typed_substate_key =
            to_typed_substate_key(node_id.entity_type().unwrap(), partition_num, &substate_key)
                .expect("Substate key should be typeable");
        if !typed_substate_key.value_is_mappable() {
            continue;
        }
        match database_update {
            DatabaseUpdate::Set(raw_value) => {
                // Check that typed value mapping works
                to_typed_substate_value(&typed_substate_key, &raw_value)
                    .expect("Substate value should be typeable");
            }
            DatabaseUpdate::Delete => {}
        }
    }
}

pub fn assert_receipt_events_can_be_typed(commit_result: &CommitResult) {
    for (event_type_identifier, event_data) in &commit_result.application_events {
        match event_type_identifier.0 {
            Emitter::Function(BlueprintId {
                package_address, ..
            }) if ![
                PACKAGE_PACKAGE,
                RESOURCE_PACKAGE,
                ACCOUNT_PACKAGE,
                IDENTITY_PACKAGE,
                CONSENSUS_MANAGER_PACKAGE,
                ACCESS_CONTROLLER_PACKAGE,
                POOL_PACKAGE,
                TRANSACTION_PROCESSOR_PACKAGE,
                METADATA_MODULE_PACKAGE,
                ROYALTY_MODULE_PACKAGE,
                ROLE_ASSIGNMENT_MODULE_PACKAGE,
                TEST_UTILS_PACKAGE,
                GENESIS_HELPER_PACKAGE,
                FAUCET_PACKAGE,
                TRANSACTION_TRACKER_PACKAGE,
            ]
            .contains(&package_address) =>
            {
                continue
            }
            Emitter::Method(node_id, ..)
                if node_id.entity_type().is_some_and(|item| {
                    matches!(
                        item,
                        EntityType::GlobalGenericComponent | EntityType::InternalGenericComponent
                    )
                }) =>
            {
                continue
            }
            _ => {}
        };
        let _ = to_typed_native_event(event_type_identifier, event_data).unwrap();
    }
}

pub enum PackagePublishingSource {
    CompileAndPublishFromSource(PathBuf, CompileProfile),
    PublishExisting(Vec<u8>, PackageDefinition),
}

impl From<String> for PackagePublishingSource {
    fn from(value: String) -> Self {
        Self::CompileAndPublishFromSource(value.into(), CompileProfile::FastWithTraceLogs)
    }
}

impl<'g> From<&'g str> for PackagePublishingSource {
    fn from(value: &'g str) -> Self {
        Self::CompileAndPublishFromSource(value.into(), CompileProfile::FastWithTraceLogs)
    }
}

impl From<PathBuf> for PackagePublishingSource {
    fn from(value: PathBuf) -> Self {
        Self::CompileAndPublishFromSource(value, CompileProfile::FastWithTraceLogs)
    }
}

impl<'g> From<&'g Path> for PackagePublishingSource {
    fn from(value: &'g Path) -> Self {
        Self::CompileAndPublishFromSource(value.into(), CompileProfile::FastWithTraceLogs)
    }
}

impl From<(Vec<u8>, PackageDefinition)> for PackagePublishingSource {
    fn from(value: (Vec<u8>, PackageDefinition)) -> Self {
        Self::PublishExisting(value.0, value.1)
    }
}

impl PackagePublishingSource {
    pub fn code_and_definition(self) -> (Vec<u8>, PackageDefinition) {
        match self {
            Self::CompileAndPublishFromSource(path, profile) => Compile::compile(path, profile),
            Self::PublishExisting(code, definition) => (code, definition),
        }
    }
}