Rust logging 2 (#198)

* changed c return value of update price to indicate aggregation (#190)

* changed c return value of update price to indicate aggregation

* forgot to add bindings

* removed the need for casting

* fixed update_no_fail

* removed unnecessary docker packages

* timeless coments

* added comment clarifying that 0 is success

* a convinient way to derive traits

* silenced unused bindings warnings

* removed dead code

* added a comment explaining the structure

* changed importing style

* called fmt on bindings output

* added register_traits method

* removed unnecessary  match

* fixed formatting

* made it easier to add borsch to more types by not using vectors

* changed c return value of update price to indicate aggregation (#190)

* changed c return value of update price to indicate aggregation

* forgot to add bindings

* removed the need for casting

* fixed update_no_fail

* removed unnecessary docker packages

* Switch from vector to slice to allow adding traits to multiple structs

* Logging 2

* Prelog and postlog instructions

* Fix CI

* Remove accidental commits

* Remove line

* Clippy

* Format and reorder

* Add comment about accessing account 1

* Remove old offset file

* Remove duplicate comment

Co-authored-by: majabbour <[email protected]>
Co-authored-by: Mark Jabbour <[email protected]>
Co-authored-by: Guillermo Bescos <guibescos>

Author: guibescos

program/rust/Cargo.toml

@@ -13,6 +13,7 @@ bindgen = "0.60.1"
 [dependencies]
 solana-program = "=1.10.29"
 borsh = "0.9"
+thiserror = "1.0"
 
 
 [lib]

program/rust/build.rs

@@ -1,6 +1,5 @@
 mod build_utils;
 use bindgen::Builder;
-use std::vec::Vec;
 
 fn main() {
     println!("cargo:rustc-link-search=../c/target");
@@ -11,6 +10,9 @@ fn main() {
     let mut parser = build_utils::DeriveAdderParserCallback::new();
     parser.register_traits("cmd_hdr", borsh_derives.to_vec());
     parser.register_traits("pc_acc", borsh_derives.to_vec());
+    parser.register_traits("pc_price_info", borsh_derives.to_vec());
+    parser.register_traits("cmd_upd_price", borsh_derives.to_vec());
+
 
 
     //generate and write bindings

program/rust/src/bindings.h

@@ -12,4 +12,4 @@ typedef signed long int int64_t;
 typedef unsigned long int uint64_t;
 
 #include "../../c/src/oracle/oracle.h"
-#include "price_t_offsets.h"
+#include "price_t_offsets.h"

program/rust/src/error.rs

@@ -0,0 +1,18 @@
+//! Error types
+
+use solana_program::program_error::ProgramError;
+use thiserror::Error;
+
+/// Errors that may be returned by the oracle program
+#[derive(Clone, Debug, Eq, Error, PartialEq)]
+pub enum OracleError {
+    /// Generic catch all error
+    #[error("Generic")]
+    Generic = 600,
+}
+
+impl From<OracleError> for ProgramError {
+    fn from(e: OracleError) -> Self {
+        ProgramError::Custom(e as u32)
+    }
+}

program/rust/src/lib.rs

@@ -1,5 +1,10 @@
 mod c_oracle_header;
 mod time_machine_types;
+mod error;
+mod log;
+
+use crate::log::{post_log, pre_log};
+use solana_program::entrypoint::deserialize;
 
 //Below is a high lever description of the rust/c setup.
 
@@ -33,11 +38,27 @@ pub extern "C" fn c_entrypoint(input: *mut u8) -> u64 {
 
 #[no_mangle]
 pub extern "C" fn entrypoint(input: *mut u8) -> u64 {
+    let (_program_id, accounts, instruction_data) = unsafe { deserialize(input) };
+
+    match pre_log(instruction_data) {
+        Err(error) => return error.into(),
+        _ => {}
+    }
+
     let c_ret_val = unsafe { c_entrypoint(input) };
+
+    match post_log(c_ret_val, &accounts) {
+        Err(error) => return error.into(),
+        _ => {}
+    }
+
     if c_ret_val == c_oracle_header::SUCCESSFULLY_UPDATED_AGGREGATE {
         //0 is the SUCCESS value for solana
         return 0;
     } else {
         return c_ret_val;
     }
 }
+
+solana_program::custom_heap_default!();
+solana_program::custom_panic_default!();

program/rust/src/log.rs

@@ -0,0 +1,102 @@
+use crate::c_oracle_header::*;
+use crate::error::OracleError;
+use borsh::BorshDeserialize;
+use solana_program::account_info::AccountInfo;
+use solana_program::entrypoint::ProgramResult;
+use solana_program::msg;
+use std::mem::size_of;
+
+pub fn pre_log(instruction_data: &[u8]) -> ProgramResult {
+    msg!("Pyth oracle contract");
+
+    let instruction_header: cmd_hdr = cmd_hdr::try_from_slice(&instruction_data[..8])?;
+    let instruction_id: u32 = instruction_header
+        .cmd_
+        .try_into()
+        .map_err(|_| OracleError::Generic)?;
+    match instruction_id {
+        command_t_e_cmd_upd_price => {
+            let instruction: cmd_upd_price = cmd_upd_price::try_from_slice(instruction_data)?;
+            msg!(
+                "Update price: price={:}, conf={:}, status={:}",
+                instruction.price_,
+                instruction.conf_,
+                instruction.status_
+            );
+        }
+        command_t_e_cmd_agg_price => {
+            let instruction: cmd_upd_price = cmd_upd_price::try_from_slice(instruction_data)?;
+            msg!(
+                "Update price: price={:}, conf={:}, status={:}",
+                instruction.price_,
+                instruction.conf_,
+                instruction.status_
+            );
+        }
+        command_t_e_cmd_upd_price_no_fail_on_error => {
+            let instruction: cmd_upd_price = cmd_upd_price::try_from_slice(instruction_data)?;
+            msg!(
+                "Update price no fail on error: price={:}, conf={:}, status={:}",
+                instruction.price_,
+                instruction.conf_,
+                instruction.status_
+            );
+        }
+
+        command_t_e_cmd_add_mapping => {
+            msg!("Add mapping");
+        }
+        command_t_e_cmd_add_price => {
+            msg!("Add price");
+        }
+        command_t_e_cmd_add_product => {
+            msg!("Add product")
+        }
+        command_t_e_cmd_add_publisher => {
+            msg!("Add publisher")
+        }
+        command_t_e_cmd_del_publisher => {
+            msg!("Delete publisher")
+        }
+        command_t_e_cmd_init_price => {
+            msg!("Initialize price")
+        }
+        command_t_e_cmd_init_mapping => {
+            msg!("Initialize mapping account");
+        }
+
+        command_t_e_cmd_set_min_pub => {
+            msg!("Set minimum number of publishers");
+        }
+        command_t_e_cmd_upd_product => {
+            msg!("Update product");
+        }
+        _ => {
+            msg!("Unrecognized instruction");
+            return Err(OracleError::Generic.into());
+        }
+    }
+    Ok(())
+}
+
+pub fn post_log(c_ret_val: u64, accounts: &[AccountInfo]) -> ProgramResult {
+    if c_ret_val == SUCCESSFULLY_UPDATED_AGGREGATE {
+        let start: usize = PRICE_T_AGGREGATE_OFFSET
+            .try_into()
+            .map_err(|_| OracleError::Generic)?;
+        // We trust that the C oracle has properly checked this account
+        let aggregate_price_info: pc_price_info = pc_price_info::try_from_slice(
+            &accounts
+                .get(1)
+                .ok_or(OracleError::Generic)?
+                .try_borrow_data()?[start..(start + size_of::<pc_price_info>())],
+        )?;
+        msg!(
+            "Aggregate updated : price={:}, conf={:}, status={:}",
+            aggregate_price_info.price_,
+            aggregate_price_info.conf_,
+            aggregate_price_info.status_
+        );
+    }
+    Ok(())
+}