[LST-343] StartRebalance and EndRebalance instructions

Cargo.toml

@@ -68,6 +68,7 @@ mollusk-svm-programs-token = { version = "^0.5", default-features = false }
 solana-account = { version = "^2.2.1", default-features = false } # vers constraint based on solana-sdk subdep
 solana-account-decoder-client-types = { version = "^2", default-features = false }
 solana-instruction = { version = "^2.3.0", default-features = false } # vers constraint based on solana-sdk subdep
+solana-instructions-sysvar = { version = "^2.2.1", default-features = false }
 solana-logger = { version = "^2.3", default-features = false }
 solana-program-error = { version = "^2.2", default-features = false }
 solana-pubkey = { version = "^2.2.1", default-features = false } # vers constraint based on solana-sdk subdep
@@ -87,6 +88,7 @@ jiminy-log = { git = "https://github.com/igneous-labs/jiminy.git", branch = "mas
 jiminy-pda = { git = "https://github.com/igneous-labs/jiminy.git", branch = "master", default-features = false }
 jiminy-program-error = { git = "https://github.com/igneous-labs/jiminy.git", branch = "master", default-features = false }
 jiminy-return-data = { git = "https://github.com/igneous-labs/jiminy.git", branch = "master", default-features = false }
+jiminy-sysvar-instructions = { git = "https://github.com/igneous-labs/jiminy.git", branch = "master", default-features = false }
 jiminy-sysvar-rent = { git = "https://github.com/igneous-labs/jiminy.git", branch = "master", default-features = false }
 sanctum-ata-jiminy = { git = "https://github.com/igneous-labs/sanctum-ata-sdk.git", branch = "master", default-features = false }
 sanctum-spl-token-core = { git = "https://github.com/igneous-labs/sanctum-spl-token-sdk.git", branch = "master", default-features = false }

controller/core/src/accounts/mod.rs

@@ -2,3 +2,4 @@ pub mod disable_pool_authority_list;
 pub mod lst_state_list;
 pub mod packed_list;
 pub mod pool_state;
+pub mod rebalance_record;

controller/core/src/accounts/rebalance_record.rs

@@ -0,0 +1,58 @@
+use core::mem::size_of;
+
+use crate::internal_utils::{impl_cast_from_acc_data, impl_cast_to_acc_data};
+
+#[repr(C)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
+pub struct RebalanceRecord {
+    pub old_total_sol_value: u64,
+    pub inp_lst_index: u32,
+    pub padding: [u8; 4],
+}
+impl_cast_from_acc_data!(RebalanceRecord);
+impl_cast_to_acc_data!(RebalanceRecord);
+
+#[repr(C)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
+pub struct RebalanceRecordPacked {
+    old_total_sol_value: [u8; 8],
+    inp_lst_index: [u8; 4],
+    padding: [u8; 4],
+}
+impl_cast_from_acc_data!(RebalanceRecordPacked, packed);
+impl_cast_to_acc_data!(RebalanceRecordPacked, packed);
+
+impl RebalanceRecordPacked {
+    #[inline]
+    pub const fn into_rebalance_record(self) -> RebalanceRecord {
+        let Self {
+            old_total_sol_value,
+            inp_lst_index,
+            padding,
+        } = self;
+        RebalanceRecord {
+            old_total_sol_value: u64::from_le_bytes(old_total_sol_value),
+            inp_lst_index: u32::from_le_bytes(inp_lst_index),
+            padding,
+        }
+    }
+
+    /// # Safety
+    /// - `self` must be pointing to mem that has same align as `RebalanceRecord`.
+    ///   This is true onchain for a RebalanceRecord account since account data
+    ///   is always 8-byte aligned onchain.
+    #[inline]
+    pub const unsafe fn as_rebalance_record(&self) -> &RebalanceRecord {
+        &*(self as *const Self).cast()
+    }
+}
+
+impl From<RebalanceRecordPacked> for RebalanceRecord {
+    #[inline]
+    fn from(value: RebalanceRecordPacked) -> Self {
+        value.into_rebalance_record()
+    }
+}
+
+const _ASSERT_PACKED_UNPACKED_SIZES_EQ: () =
+    assert!(size_of::<RebalanceRecord>() == size_of::<RebalanceRecordPacked>());

controller/core/src/instructions/rebalance/start.rs

@@ -1,6 +1,6 @@
 use generic_array_struct::generic_array_struct;
 
-use crate::instructions::internal_utils::caba;
+use crate::instructions::internal_utils::{caba, csba};
 
 // Accounts
 
@@ -104,4 +104,25 @@ impl StartRebalanceIxData {
     pub const fn as_buf(&self) -> &[u8; START_REBALANCE_IX_DATA_LEN] {
         &self.0
     }
+
+    #[inline]
+    pub const fn parse_no_discm(
+        data: &[u8; START_REBALANCE_IX_DATA_LEN - 1],
+    ) -> StartRebalanceIxArgs {
+        let (out_lst_value_calc_accs, rest) = csba::<33, 1, 32>(data);
+        let (out_lst_index, rest) = csba::<32, 4, 28>(rest);
+        let (inp_lst_index, rest) = csba::<28, 4, 24>(rest);
+        let (amount, rest) = csba::<24, 8, 16>(rest);
+        let (min_starting_out_lst, rest) = csba::<16, 8, 8>(rest);
+        let (max_starting_inp_lst, _) = csba::<8, 8, 0>(rest);
+
+        StartRebalanceIxArgs {
+            out_lst_value_calc_accs: out_lst_value_calc_accs[0],
+            out_lst_index: u32::from_le_bytes(*out_lst_index),
+            inp_lst_index: u32::from_le_bytes(*inp_lst_index),
+            amount: u64::from_le_bytes(*amount),
+            min_starting_out_lst: u64::from_le_bytes(*min_starting_out_lst),
+            max_starting_inp_lst: u64::from_le_bytes(*max_starting_inp_lst),
+        }
+    }
 }

controller/jiminy/src/account_utils.rs

@@ -4,6 +4,7 @@ use inf1_ctl_core::{
         lst_state_list::{LstStateList, LstStateListMut},
         packed_list::{PackedList, PackedListMut},
         pool_state::PoolState,
+        rebalance_record::RebalanceRecord,
     },
     err::Inf1CtlErr,
     typedefs::lst_state::LstState,
@@ -14,8 +15,6 @@ use crate::program_err::Inf1CtlCustomProgErr;
 
 const _ACC_DATA_ALIGN: usize = 8;
 
-const _POOL_STATE_ALIGN_CHECK: () = assert!(core::mem::align_of::<PoolState>() <= _ACC_DATA_ALIGN);
-
 #[inline]
 pub fn pool_state_checked(acc: &Account) -> Result<&PoolState, Inf1CtlCustomProgErr> {
     // safety: account data is 8-byte aligned
@@ -105,6 +104,25 @@ pub fn disable_pool_auth_list_checked_mut(
     }
 }
 
+const _REBALANCE_RECORD_ALIGN_CHECK: () =
+    assert!(core::mem::align_of::<RebalanceRecord>() <= _ACC_DATA_ALIGN);
+
+#[inline]
+pub fn rebalance_record_checked(acc: &Account) -> Result<&RebalanceRecord, Inf1CtlCustomProgErr> {
+    // safety: account data is 8-byte aligned
+    unsafe { RebalanceRecord::of_acc_data(acc.data()) }
+        .ok_or(Inf1CtlCustomProgErr(Inf1CtlErr::InvalidRebalanceRecordData))
+}
+
+#[inline]
+pub fn rebalance_record_checked_mut(
+    acc: &mut Account,
+) -> Result<&mut RebalanceRecord, Inf1CtlCustomProgErr> {
+    // safety: account data is 8-byte aligned
+    unsafe { RebalanceRecord::of_acc_data_mut(acc.data_mut()) }
+        .ok_or(Inf1CtlCustomProgErr(Inf1CtlErr::InvalidRebalanceRecordData))
+}
+
 // TODO: refactor to use this fn everywhere
 #[inline]
 pub fn lst_state_list_get(

controller/jiminy/src/cpi.rs

@@ -2,6 +2,7 @@ use core::ops::RangeInclusive;
 use inf1_ctl_core::instructions::{
     admin::set_sol_value_calculator::SetSolValueCalculatorIxPreAccs,
     liquidity::{add::AddLiquidityIxPreAccs, remove::RemoveLiquidityIxPreAccs},
+    rebalance::{end::EndRebalanceIxPreAccs, start::StartRebalanceIxPreAccs},
     swap::IxPreAccs as SwapIxPreAccs,
     sync_sol_value::SyncSolValueIxPreAccs,
 };
@@ -31,6 +32,15 @@ pub type RemoveLiquidityPreAccountHandles<'account> =
 pub type SetSolValueCalculatorIxPreAccountHandles<'account> =
     SetSolValueCalculatorIxPreAccs<AccountHandle<'account>>;
 
+/// `S: AsRef<[AccountHandle]>`
+/// -> use [`IxAccountHandles::seq`] with [`jiminy_cpi::Cpi::invoke_fwd`]
+pub type StartRebalanceIxPreAccountHandles<'account> =
+    StartRebalanceIxPreAccs<AccountHandle<'account>>;
+
+/// `S: AsRef<[AccountHandle]>`
+/// -> use [`IxAccountHandles::seq`] with [`jiminy_cpi::Cpi::invoke_fwd`]
+pub type EndRebalanceIxPreAccountHandles<'account> = EndRebalanceIxPreAccs<AccountHandle<'account>>;
+
 pub type SwapIxPreAccountHandles<'account> = SwapIxPreAccs<AccountHandle<'account>>;
 
 // TODO: make invoke() helpers for client programs

controller/jiminy/src/pda_onchain.rs

@@ -1,11 +1,12 @@
 use inf1_ctl_core::{
     keys::{
         ATOKEN_ID, DISABLE_POOL_AUTHORITY_LIST_BUMP, LST_STATE_LIST_BUMP, POOL_STATE_BUMP,
-        PROTOCOL_FEE_BUMP,
+        PROTOCOL_FEE_BUMP, REBALANCE_RECORD_BUMP,
     },
     pda::{
         pool_reserves_ata_seeds, protocol_fee_accumulator_ata_seeds,
         DISABLE_POOL_AUTHORITY_LIST_SEED, LST_STATE_LIST_SEED, POOL_STATE_SEED, PROTOCOL_FEE_SEED,
+        REBALANCE_RECORD_SEED,
     },
 };
 use jiminy_pda::{
@@ -31,6 +32,11 @@ const_1seed_signer!(
     DISABLE_POOL_AUTHORITY_LIST_SEED,
     DISABLE_POOL_AUTHORITY_LIST_BUMP
 );
+const_1seed_signer!(
+    REBALANCE_RECORD_SIGNER,
+    REBALANCE_RECORD_SEED,
+    REBALANCE_RECORD_BUMP
+);
 
 #[inline]
 pub fn create_raw_pool_reserves_addr(

controller/program/Cargo.toml

@@ -22,6 +22,7 @@ jiminy-cpi = { workspace = true }
 jiminy-entrypoint = { workspace = true, features = ["allocator", "panic"] }
 jiminy-log = { workspace = true }
 jiminy-pda = { workspace = true }
+jiminy-sysvar-instructions = { workspace = true }
 jiminy-sysvar-rent = { workspace = true }
 sanctum-ata-jiminy = { workspace = true }
 sanctum-spl-token-jiminy = { workspace = true }
@@ -40,4 +41,5 @@ mollusk-svm = { workspace = true }
 proptest = { workspace = true, features = ["std"] }
 solana-account = { workspace = true }
 solana-instruction = { workspace = true }
+solana-instructions-sysvar = { workspace = true }
 solana-pubkey = { workspace = true }

controller/program/src/instructions/mod.rs

@@ -2,5 +2,6 @@ pub mod admin;
 pub mod disable_pool;
 pub mod liquidity;
 pub mod protocol_fee;
+pub mod rebalance;
 pub mod swap;
 pub mod sync_sol_value;