Adding also reward views into the CLI

Author: vanitymnm

token-lending/cli/src/liquidity_mining.rs

@@ -1,14 +1,19 @@
 //! CLI commands related to liquidity mining.
 
 mod add_pool_reward;
-mod claim_pool_reward;
 mod close_pool_reward;
 mod crank_pool_rewards;
 mod edit_pool_reward;
 mod find_obligations_to_fund;
 mod migrate_all_reserves;
+mod view_obligation_rewards;
+mod view_reserve_rewards;
 
 pub(crate) use add_pool_reward::command as command_add_pool_reward;
+pub(crate) use close_pool_reward::command as command_close_pool_reward;
 pub(crate) use crank_pool_rewards::command as command_crank_pool_rewards;
+pub(crate) use edit_pool_reward::command as command_edit_pool_reward;
 pub(crate) use find_obligations_to_fund::command as command_find_obligations_to_fund_for_liquidity_mining;
 pub(crate) use migrate_all_reserves::command as command_migrate_all_reserves_for_liquidity_mining;
+pub(crate) use view_obligation_rewards::command as command_view_obligation_rewards;
+pub(crate) use view_reserve_rewards::command as command_view_reserve_rewards;

token-lending/cli/src/liquidity_mining/add_pool_reward.rs

@@ -42,10 +42,9 @@ pub(crate) fn command(
         .any(|pr| matches!(pr, PoolRewardEntry::Vacant { .. }));
 
     if !has_free_slot {
-        return Err(format!(
-            "There are no vacant slots to add the pool reward. Please crank it first"
-        )
-        .into());
+        return Err(
+            "There are no vacant slots to add the pool reward. Please crank it first".into(),
+        );
     }
 
     let Some(source_reward_token_account) = config
@@ -55,7 +54,8 @@ pub(crate) fn command(
         return Err(format!(
             "Failed to fetch source token account '{}'",
             source_reward_token_account_pubkey
-        ))?;
+        )
+        .into());
     };
 
     let reward_mint = Pubkey::from_str(&source_reward_token_account.mint)?;

token-lending/cli/src/liquidity_mining/claim_pool_reward.rs

@@ -0,0 +1,104 @@
+//! A pool reward can only be closed if it has no more active user reward managers.
+
+use std::{borrow::Borrow, str::FromStr};
+
+use solana_program::program_pack::Pack;
+use solana_sdk::pubkey::Pubkey;
+use solend_sdk::{
+    instruction::{close_pool_reward, find_reward_vault_authority},
+    state::{LendingMarket, PoolRewardEntry, PositionKind, Reserve},
+};
+
+use crate::{send_transaction, CommandResult, Config};
+
+pub(crate) fn command(
+    config: &mut Config,
+    reserve_pubkey: Pubkey,
+    position_kind: PositionKind,
+    pool_reward_index: usize,
+    destination_reward_token_account_pubkey: Pubkey,
+) -> CommandResult {
+    let reserve_info = config.rpc_client.get_account(&reserve_pubkey)?;
+    let reserve = Reserve::unpack_from_slice(reserve_info.data.borrow())?;
+    let lending_market_info = config.rpc_client.get_account(&reserve.lending_market)?;
+    let lending_market = LendingMarket::unpack(lending_market_info.data.borrow())?;
+
+    if config.fee_payer.pubkey() != lending_market.owner {
+        return Err(format!(
+            "The fee payer must be the owner of the lending market '{}'",
+            reserve.lending_market
+        )
+        .into());
+    }
+
+    let PoolRewardEntry::Occupied(pool_reward) = reserve
+        .pool_reward_manager(position_kind)
+        .pool_rewards
+        .get(pool_reward_index)
+        .ok_or_else(|| {
+            format!(
+                "Pool reward index {} does not exist for position kind {:?}",
+                pool_reward_index, position_kind
+            )
+        })?
+    else {
+        return Err("Pool reward index is not occupied".into());
+    };
+
+    if pool_reward.num_user_reward_managers > 0 {
+        return Err(format!(
+            "Pool reward still has {} user reward managers. Crank it first.",
+            pool_reward.num_user_reward_managers
+        )
+        .into());
+    }
+
+    let Some(reward_vault_token_account) =
+        config.rpc_client.get_token_account(&pool_reward.vault)?
+    else {
+        return Err(format!(
+            "Failed to fetch pool reward vault '{}'",
+            pool_reward.vault
+        ))?;
+    };
+
+    let reward_mint = Pubkey::from_str(&reward_vault_token_account.mint)?;
+
+    let (reward_vault_authority, reward_authority_bump) = find_reward_vault_authority(
+        &config.lending_program_id,
+        &reserve.lending_market,
+        &pool_reward.vault,
+    );
+
+    let close_reward_ix = close_pool_reward(
+        config.lending_program_id,
+        reward_authority_bump,
+        position_kind,
+        pool_reward_index as _,
+        reserve_pubkey,
+        reward_mint,
+        destination_reward_token_account_pubkey,
+        reward_vault_authority,
+        pool_reward.vault,
+        reserve.lending_market,
+        lending_market.owner,
+    );
+
+    let recent_blockhash = config.rpc_client.get_latest_blockhash()?;
+
+    let message = solana_sdk::message::Message::new_with_blockhash(
+        &[close_reward_ix],
+        Some(&config.fee_payer.pubkey()),
+        &recent_blockhash,
+    );
+
+    let transaction = solana_sdk::transaction::Transaction::new(
+        &vec![config.fee_payer.as_ref()],
+        message,
+        recent_blockhash,
+    );
+
+    send_transaction(config, transaction)?;
+
+    Ok(())
+}

token-lending/cli/src/liquidity_mining/close_pool_reward.rs

@@ -1,5 +1,5 @@
-//! Each reserve has a limited number of slots that are used to declare pool rewards.
-//! When all slots are occupied, the admin can no longer start new pool rewards.
+//! Each reserve has a limited number of entries that are used to declare pool rewards.
+//! When all entries are occupied, the admin can no longer start new pool rewards.
 //!
 //! This is where cranking comes in.
 //! Given a reserve, this command estimates the cheapest pool reward to crank out.
@@ -130,7 +130,7 @@ pub(crate) fn command(
                 })
         })
         .map(|(obligation_pubkey, obligation)| (obligation_pubkey, obligation.owner))
-        .map(|(obligation_pubkey, obligation_owner)| {
+        .flat_map(|(obligation_pubkey, obligation_owner)| {
             let ata = get_associated_token_address(&obligation_owner, &reward_mint);
 
             let create_ata_ix = create_associated_token_account_idempotent(
@@ -155,7 +155,6 @@ pub(crate) fn command(
 
             std::iter::once(create_ata_ix).chain(std::iter::once(claim_ix))
         })
-        .flatten()
         .collect();
 
     for ixs in ixs.chunks(CLAIM_IXS_BATCH_SIZE).progress() {

token-lending/cli/src/liquidity_mining/crank_pool_rewards.rs

@@ -0,0 +1,96 @@
+use std::{borrow::Borrow, str::FromStr};
+
+use solana_program::program_pack::Pack;
+use solana_sdk::pubkey::Pubkey;
+use solend_sdk::{
+    instruction::{edit_pool_reward, find_reward_vault_authority},
+    state::{LendingMarket, PoolRewardEntry, PositionKind, Reserve},
+};
+
+use crate::{send_transaction, CommandResult, Config};
+
+pub(crate) fn command(
+    config: &mut Config,
+    reserve_pubkey: Pubkey,
+    position_kind: PositionKind,
+    pool_reward_index: usize,
+    new_end_time_secs: u64,
+    reward_token_account_pubkey: Pubkey,
+) -> CommandResult {
+    let reserve_info = config.rpc_client.get_account(&reserve_pubkey)?;
+    let reserve = Reserve::unpack_from_slice(reserve_info.data.borrow())?;
+    let lending_market_info = config.rpc_client.get_account(&reserve.lending_market)?;
+    let lending_market = LendingMarket::unpack(lending_market_info.data.borrow())?;
+
+    if config.fee_payer.pubkey() != lending_market.owner {
+        return Err(format!(
+            "The fee payer must be the owner of the lending market '{}'",
+            reserve.lending_market
+        )
+        .into());
+    }
+
+    let PoolRewardEntry::Occupied(pool_reward) = reserve
+        .pool_reward_manager(position_kind)
+        .pool_rewards
+        .get(pool_reward_index)
+        .ok_or_else(|| {
+            format!(
+                "Pool reward index {} does not exist for position kind {:?}",
+                pool_reward_index, position_kind
+            )
+        })?
+    else {
+        return Err("Pool reward index is not occupied".into());
+    };
+
+    let Some(reward_vault_token_account) =
+        config.rpc_client.get_token_account(&pool_reward.vault)?
+    else {
+        return Err(format!(
+            "Failed to fetch pool reward vault '{}'",
+            pool_reward.vault
+        ))?;
+    };
+
+    let reward_mint = Pubkey::from_str(&reward_vault_token_account.mint)?;
+
+    let (reward_vault_authority, reward_authority_bump) = find_reward_vault_authority(
+        &config.lending_program_id,
+        &reserve.lending_market,
+        &pool_reward.vault,
+    );
+
+    let edit_reward_ix = edit_pool_reward(
+        config.lending_program_id,
+        reward_authority_bump,
+        position_kind,
+        pool_reward_index as _,
+        new_end_time_secs,
+        reserve_pubkey,
+        reward_mint,
+        reward_token_account_pubkey,
+        reward_vault_authority,
+        pool_reward.vault,
+        reserve.lending_market,
+        lending_market.owner,
+    );
+
+    let recent_blockhash = config.rpc_client.get_latest_blockhash()?;
+
+    let message = solana_sdk::message::Message::new_with_blockhash(
+        &[edit_reward_ix],
+        Some(&config.fee_payer.pubkey()),
+        &recent_blockhash,
+    );
+
+    let transaction = solana_sdk::transaction::Transaction::new(
+        &vec![config.fee_payer.as_ref()],
+        message,
+        recent_blockhash,
+    );
+
+    send_transaction(config, transaction)?;
+
+    Ok(())
+}

token-lending/cli/src/liquidity_mining/edit_pool_reward.rs

@@ -37,7 +37,6 @@ pub(crate) fn command(config: &mut Config, output_csv: impl AsRef<Path>) -> Comm
             encoding: Some(UiAccountEncoding::Base64),
             ..Default::default()
         },
-        ..Default::default()
     };
     let all_obligations = config
         .rpc_client

token-lending/cli/src/liquidity_mining/find_obligations_to_fund.rs

@@ -0,0 +1,38 @@
+use std::{borrow::Borrow, time::SystemTime};
+
+use solana_program::program_pack::Pack;
+use solana_sdk::pubkey::Pubkey;
+use solend_sdk::state::{Obligation, Reserve};
+
+use crate::{CommandResult, Config};
+
+pub(crate) fn command(config: &mut Config, obligation_pubkey: Pubkey) -> CommandResult {
+    let obligation_info = config.rpc_client.get_account(&obligation_pubkey)?;
+    let obligation = Obligation::unpack_from_slice(obligation_info.data.borrow())?;
+
+    let now_secs = SystemTime::now()
+        .duration_since(SystemTime::UNIX_EPOCH)?
+        .as_secs();
+
+    for user_manager in obligation.user_reward_managers.iter() {
+        let reserve_info = config.rpc_client.get_account(&user_manager.reserve)?;
+        let reserve = Reserve::unpack_from_slice(reserve_info.data.borrow())?;
+        println!(
+            "Rewards for reserve {} {:?} last updated {}s ago",
+            user_manager.reserve,
+            user_manager.position_kind,
+            now_secs.saturating_sub(user_manager.last_update_time_secs)
+        );
+
+        let pool_reward_manager = reserve.pool_reward_manager(user_manager.position_kind);
+
+        let share = user_manager.share as f64 / pool_reward_manager.total_shares as f64;
+        println!(
+            "  Mines {}% in {} rewards",
+            share * 100.0,
+            user_manager.rewards.len()
+        );
+    }
+
+    Ok(())
+}