sui_core/

transaction_input_loader.rs

// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

use crate::{
    authority::{
        authority_per_epoch_store::CertLockGuard, shared_object_version_manager::AssignedVersions,
    },
    execution_cache::ObjectCacheRead,
};
use itertools::izip;
use std::collections::BTreeMap;
use std::sync::Arc;
use sui_types::{
    base_types::{EpochId, FullObjectID, ObjectRef, TransactionDigest},
    error::{SuiError, SuiResult, UserInputError},
    storage::{FullObjectKey, ObjectKey},
    transaction::{
        InputObjectKind, InputObjects, ObjectReadResult, ObjectReadResultKind,
        ReceivingObjectReadResult, ReceivingObjectReadResultKind, ReceivingObjects, TransactionKey,
    },
};
use tracing::instrument;

pub(crate) struct TransactionInputLoader {
    cache: Arc<dyn ObjectCacheRead>,
}

impl TransactionInputLoader {
    pub fn new(cache: Arc<dyn ObjectCacheRead>) -> Self {
        Self { cache }
    }
}

impl TransactionInputLoader {
    /// Read the inputs for a transaction that the validator was asked to sign.
    ///
    /// tx_digest is provided so that the inputs can be cached with the tx_digest and returned with
    /// a single hash map lookup when notify_read_objects_for_execution is called later.
    /// TODO: implement this caching
    #[instrument(level = "trace", skip_all)]
    pub fn read_objects_for_signing(
        &self,
        _tx_digest_for_caching: Option<&TransactionDigest>,
        input_object_kinds: &[InputObjectKind],
        receiving_objects: &[ObjectRef],
        epoch_id: EpochId,
    ) -> SuiResult<(InputObjects, ReceivingObjects)> {
        // Length of input_object_kinds have been checked via validity_check() for ProgrammableTransaction.
        let mut input_results = vec![None; input_object_kinds.len()];
        let mut object_refs = Vec::with_capacity(input_object_kinds.len());
        let mut fetch_indices = Vec::with_capacity(input_object_kinds.len());

        for (i, kind) in input_object_kinds.iter().enumerate() {
            match kind {
                // Packages are loaded one at a time via the cache
                InputObjectKind::MovePackage(id) => {
                    let Some(package) = self.cache.get_package_object(id)?.map(|o| o.into()) else {
                        return Err(SuiError::from(kind.object_not_found_error()));
                    };
                    input_results[i] = Some(ObjectReadResult {
                        input_object_kind: *kind,
                        object: ObjectReadResultKind::Object(package),
                    });
                }
                InputObjectKind::SharedMoveObject { .. } => {
                    let input_full_id = kind.full_object_id();

                    // Load the most current version from the cache.
                    match self.cache.get_object(&kind.object_id()) {
                        // If full ID matches, we're done.
                        // (Full ID may not match if object was transferred in or out of
                        // consensus. We have to double-check this because cache is keyed
                        // on ObjectID and not FullObjectID.)
                        Some(object) if object.full_id() == input_full_id => {
                            input_results[i] = Some(ObjectReadResult::new(*kind, object.into()))
                        }
                        _ => {
                            // If the full ID doesn't match, check if the object's consensus
                            // stream was ended.
                            if let Some((version, digest)) = self
                                .cache
                                .get_last_consensus_stream_end_info(input_full_id, epoch_id)
                            {
                                input_results[i] = Some(ObjectReadResult {
                                    input_object_kind: *kind,
                                    object: ObjectReadResultKind::ObjectConsensusStreamEnded(
                                        version, digest,
                                    ),
                                });
                            } else {
                                return Err(SuiError::from(kind.object_not_found_error()));
                            }
                        }
                    }
                }
                InputObjectKind::ImmOrOwnedMoveObject(objref) => {
                    object_refs.push(*objref);
                    fetch_indices.push(i);
                }
            }
        }

        let objects = self
            .cache
            .multi_get_objects_with_more_accurate_error_return(&object_refs)?;
        assert_eq!(objects.len(), object_refs.len());
        for (index, object) in fetch_indices.into_iter().zip(objects.into_iter()) {
            input_results[index] = Some(ObjectReadResult {
                input_object_kind: input_object_kinds[index],
                object: ObjectReadResultKind::Object(object),
            });
        }

        let receiving_results =
            self.read_receiving_objects_for_signing(receiving_objects, epoch_id)?;

        Ok((
            input_results
                .into_iter()
                .map(Option::unwrap)
                .collect::<Vec<_>>()
                .into(),
            receiving_results,
        ))
    }

    /// Read the inputs for a transaction that is ready to be executed.
    ///
    /// epoch_store is used to resolve the versions of any shared input objects.
    ///
    /// This function panics if any inputs are not available, as ExecutionScheduler should already
    /// have verified that the transaction is ready to be executed.
    ///
    /// The tx_digest is provided here to support the following optimization (not yet implemented):
    /// All the owned input objects will likely have been loaded during transaction signing, and
    /// can be stored as a group with the transaction_digest as the key, allowing the lookup to
    /// proceed with only a single hash map lookup. (additional lookups may be necessary for shared
    /// inputs, since the versions are not known at signing time). Receiving objects could be
    /// cached, but only with appropriate invalidation logic for when an object is received by a
    /// different tx first.
    #[instrument(level = "trace", skip_all)]
    pub fn read_objects_for_execution(
        &self,
        tx_key: &TransactionKey,
        _tx_lock: &CertLockGuard, // see below for why this is needed
        input_object_kinds: &[InputObjectKind],
        assigned_shared_object_versions: &AssignedVersions,
        epoch_id: EpochId,
    ) -> SuiResult<InputObjects> {
        let assigned_shared_versions: BTreeMap<_, _> = assigned_shared_object_versions
            .iter()
            .map(|((id, initial_shared_version), version)| {
                ((*id, *initial_shared_version), *version)
            })
            .collect();

        let mut results = vec![None; input_object_kinds.len()];
        let mut object_keys = Vec::with_capacity(input_object_kinds.len());
        let mut fetches = Vec::with_capacity(input_object_kinds.len());

        for (i, input) in input_object_kinds.iter().enumerate() {
            match input {
                InputObjectKind::MovePackage(id) => {
                    let package = self.cache.get_package_object(id)?.unwrap_or_else(|| {
                        panic!("Executable transaction {tx_key:?} depends on non-existent package {id:?}")
                    });

                    results[i] = Some(ObjectReadResult {
                        input_object_kind: *input,
                        object: ObjectReadResultKind::Object(package.into()),
                    });
                    continue;
                }
                InputObjectKind::ImmOrOwnedMoveObject(objref) => {
                    object_keys.push(objref.into());
                    fetches.push((i, input));
                }
                InputObjectKind::SharedMoveObject {
                    id,
                    initial_shared_version,
                    ..
                } => {
                    // If we find a set of assigned versions but one object's version assignments
                    // are missing from the set, it indicates a serious inconsistency:
                    let version = assigned_shared_versions.get(&(*id, *initial_shared_version)).unwrap_or_else(|| {
                        panic!("Shared object version should have been assigned. key: {tx_key:?}, obj id: {id:?}")
                    });
                    if version.is_cancelled() {
                        // Do not need to fetch shared object for cancelled transaction.
                        results[i] = Some(ObjectReadResult {
                            input_object_kind: *input,
                            object: ObjectReadResultKind::CancelledTransactionSharedObject(
                                *version,
                            ),
                        })
                    } else {
                        object_keys.push(ObjectKey(*id, *version));
                        fetches.push((i, input));
                    }
                }
            }
        }

        let objects = self.cache.multi_get_objects_by_key(&object_keys);

        assert!(objects.len() == object_keys.len() && objects.len() == fetches.len());

        for (object, key, (index, input)) in izip!(
            objects.into_iter(),
            object_keys.into_iter(),
            fetches.into_iter()
        ) {
            results[index] = Some(match (object, input) {
                (Some(obj), InputObjectKind::SharedMoveObject { .. })
                    if obj.full_id() == input.full_object_id() =>
                {
                    ObjectReadResult {
                        input_object_kind: *input,
                        object: obj.into(),
                    }
                }
                (_, InputObjectKind::SharedMoveObject { .. }) => {
                    assert!(key.1.is_valid());
                    // If the full ID on a shared input doesn't match, check if the object
                    // was removed from consensus by a concurrently certified tx.
                    let version = key.1;
                    if let Some(dependency) = self.cache.get_consensus_stream_end_tx_digest(
                        FullObjectKey::new(input.full_object_id(), version),
                        epoch_id,
                    ) {
                        ObjectReadResult {
                            input_object_kind: *input,
                            object: ObjectReadResultKind::ObjectConsensusStreamEnded(
                                version, dependency,
                            ),
                        }
                    } else {
                        panic!(
                            "All dependencies of tx {tx_key:?} should have been executed now, but Shared Object id: {:?}, version: {version} is absent in epoch {epoch_id}",
                            input.full_object_id()
                        );
                    }
                }
                (Some(obj), input_object_kind) => ObjectReadResult {
                    input_object_kind: *input_object_kind,
                    object: obj.into(),
                },
                _ => panic!(
                    "All dependencies of tx {tx_key:?} should have been executed now, but obj {key:?} is absent"
                ),
            });
        }

        Ok(results
            .into_iter()
            .map(Option::unwrap)
            .collect::<Vec<_>>()
            .into())
    }
}

// private methods
impl TransactionInputLoader {
    fn read_receiving_objects_for_signing(
        &self,
        receiving_objects: &[ObjectRef],
        epoch_id: EpochId,
    ) -> SuiResult<ReceivingObjects> {
        let mut receiving_results = Vec::with_capacity(receiving_objects.len());
        for objref in receiving_objects {
            // Note: the digest is checked later in check_transaction_input
            let (object_id, version, _) = objref;

            // TODO: Add support for receiving consensus objects. For now this assumes fastpath.
            if self.cache.have_received_object_at_version(
                FullObjectKey::new(FullObjectID::new(*object_id, None), *version),
                epoch_id,
            ) {
                receiving_results.push(ReceivingObjectReadResult::new(
                    *objref,
                    ReceivingObjectReadResultKind::PreviouslyReceivedObject,
                ));
                continue;
            }

            let Some(object) = self.cache.get_object(object_id) else {
                return Err(UserInputError::ObjectNotFound {
                    object_id: *object_id,
                    version: Some(*version),
                }
                .into());
            };

            receiving_results.push(ReceivingObjectReadResult::new(*objref, object.into()));
        }
        Ok(receiving_results.into())
    }
}