//! Stable program log messages
//!
//! The format of these log messages should not be modified to avoid breaking downstream consumers
//! of program logging
use {
crate::{ic_logger_msg, log_collector::LogCollector},
itertools::Itertools,
solana_sdk::pubkey::Pubkey,
std::{cell::RefCell, rc::Rc},
};
/// Log a program invoke.
///
/// The general form is:
///
/// ```notrust
/// "Program
invoke []"
/// ```
pub fn program_invoke(
log_collector: &Option>>,
program_id: &Pubkey,
invoke_depth: usize,
) {
ic_logger_msg!(
log_collector,
"Program {} invoke [{}]",
program_id,
invoke_depth
);
}
/// Log a message from the program itself.
///
/// The general form is:
///
/// ```notrust
/// "Program log: "
/// ```
///
/// That is, any program-generated output is guaranteed to be prefixed by "Program log: "
pub fn program_log(log_collector: &Option>>, message: &str) {
ic_logger_msg!(log_collector, "Program log: {}", message);
}
/// Emit a program data.
///
/// The general form is:
///
/// ```notrust
/// "Program data: *"
/// ```
///
/// That is, any program-generated output is guaranteed to be prefixed by "Program data: "
pub fn program_data(log_collector: &Option>>, data: &[&[u8]]) {
ic_logger_msg!(
log_collector,
"Program data: {}",
data.iter().map(base64::encode).join(" ")
);
}
/// Log return data as from the program itself. This line will not be present if no return
/// data was set, or if the return data was set to zero length.
///
/// The general form is:
///
/// ```notrust
/// "Program return: "
/// ```
///
/// That is, any program-generated output is guaranteed to be prefixed by "Program return: "
pub fn program_return(
log_collector: &Option>>,
program_id: &Pubkey,
data: &[u8],
) {
ic_logger_msg!(
log_collector,
"Program return: {} {}",
program_id,
base64::encode(data)
);
}
/// Log successful program execution.
///
/// The general form is:
///
/// ```notrust
/// "Program success"
/// ```
pub fn program_success(log_collector: &Option>>, program_id: &Pubkey) {
ic_logger_msg!(log_collector, "Program {} success", program_id);
}
/// Log program execution failure
///
/// The general form is:
///
/// ```notrust
/// "Program failed: "
/// ```
pub fn program_failure(
log_collector: &Option>>,
program_id: &Pubkey,
err: &dyn std::error::Error,
) {
ic_logger_msg!(log_collector, "Program {} failed: {}", program_id, err);
}