patch 1.1.1 (#103)

* update version to 1.1.1
* refactor `CLI`
* make --save-path and --meta-merkle-tree-dir optional arguments, where
one must be present
    * Brings back ENV var support for META_MERKLE_TREE_DIR
    * marked --meta-merkle-tree-dir as deprecated

Author: tomjohn1028

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "tip-router-operator-cli"
-version = "0.1.0"
+version = "1.1.1"
 edition = "2021"
 description = "CLI for Jito Tip Router"
 

tip-router-operator-cli/Cargo.toml

@@ -78,7 +78,7 @@ pub async fn claim_mev_tips_with_emit(
     let keypair = read_keypair_file(cli.keypair_path.clone())
         .map_err(|e| anyhow::anyhow!("Failed to read keypair file: {:?}", e))?;
     let keypair = Arc::new(keypair);
-    let meta_merkle_tree_dir = cli.save_path.clone();
+    let meta_merkle_tree_dir = cli.get_save_path().clone();
     let rpc_url = cli.rpc_url.clone();
     let merkle_tree_coll_path = meta_merkle_tree_dir.join(merkle_tree_collection_file_name(epoch));
     let mut merkle_tree_coll = GeneratedMerkleTreeCollection::new_from_file(&merkle_tree_coll_path)

tip-router-operator-cli/src/claim.rs

@@ -37,26 +37,41 @@ pub struct Cli {
     #[arg(long, env, default_value_t = 1)]
     pub micro_lamports: u64,
 
-    #[arg(
-        long,
-        env,
-        alias = "meta-merkle-tree-dir",
-        help = "Path to save data (formerly meta-merkle-tree-dir)"
-    )]
-    pub save_path: PathBuf,
+    #[arg(long, env, help = "Path to save data (formerly meta-merkle-tree-dir)")]
+    pub save_path: Option<PathBuf>,
+
+    #[arg(short, long, env, help = "Path to save data (deprecated)")]
+    #[deprecated(since = "1.1.0", note = "use --save-path instead")]
+    pub meta_merkle_tree_dir: Option<PathBuf>,
 
     #[command(subcommand)]
     pub command: Commands,
 }
 
 impl Cli {
+    #[allow(deprecated)]
+    pub fn get_save_path(&self) -> PathBuf {
+        self.save_path.to_owned().map_or_else(
+            || {
+                self.meta_merkle_tree_dir.to_owned().map_or_else(
+                    || {
+                        panic!("--save-path argument must be set");
+                    },
+                    |save_path| save_path,
+                )
+            },
+            |save_path| save_path,
+        )
+    }
+
     pub fn create_save_path(&self) {
-        if !self.save_path.exists() {
+        let save_path = self.get_save_path();
+        if !save_path.exists() {
             info!(
                 "Creating Tip Router save directory at {}",
-                self.save_path.display()
+                save_path.display()
             );
-            std::fs::create_dir_all(&self.save_path).unwrap();
+            std::fs::create_dir_all(&save_path).unwrap();
         }
     }
 

tip-router-operator-cli/src/cli.rs

@@ -40,6 +40,9 @@ async fn main() -> Result<()> {
 
     set_host_id(cli.operator_address.to_string());
 
+    // Will panic if the user did not set --save-path or the deprecated --meta-merkle-tree-dir
+    let save_path = cli.get_save_path();
+
     info!(
         "CLI Arguments:
         keypair_path: {}
@@ -48,14 +51,16 @@ async fn main() -> Result<()> {
         ledger_path: {}
         full_snapshots_path: {:?}
         snapshot_output_dir: {}
-        backup_snapshots_dir: {}",
+        backup_snapshots_dir: {}
+        save_path: {}",
         cli.keypair_path,
         cli.operator_address,
         cli.rpc_url,
         cli.ledger_path.display(),
         cli.full_snapshots_path,
         cli.snapshot_output_dir.display(),
-        cli.backup_snapshots_dir.display()
+        cli.backup_snapshots_dir.display(),
+        save_path.display(),
     );
 
     cli.create_save_path();
@@ -132,7 +137,7 @@ async fn main() -> Result<()> {
             let cli_clone: Cli = cli.clone();
             // Track incremental snapshots and backup to `backup_snapshots_dir`
             tokio::spawn(async move {
-                let save_path = cli_clone.save_path;
+                let save_path = cli_clone.get_save_path();
                 loop {
                     if let Err(e) = BackupSnapshotMonitor::new(
                         &rpc_url,
@@ -206,7 +211,7 @@ async fn main() -> Result<()> {
             epoch,
             set_merkle_roots,
         } => {
-            let meta_merkle_tree_path = cli.save_path.join(meta_merkle_tree_file_name(epoch));
+            let meta_merkle_tree_path = cli.get_save_path().join(meta_merkle_tree_file_name(epoch));
             info!(
                 "Submitting epoch {} from {}...",
                 epoch,
@@ -277,7 +282,7 @@ async fn main() -> Result<()> {
                 &Arc::new(bank),
                 &tip_distribution_program_id,
                 &tip_payment_program_id,
-                &cli.save_path,
+                &save_path,
                 save,
             );
         }
@@ -289,7 +294,7 @@ async fn main() -> Result<()> {
         } => {
             // Load the stake_meta_collection from disk
             let stake_meta_collection = match StakeMetaCollection::new_from_file(
-                &cli.save_path.join(stake_meta_file_name(epoch)),
+                &cli.get_save_path().join(stake_meta_file_name(epoch)),
             ) {
                 Ok(stake_meta_collection) => stake_meta_collection,
                 Err(e) => panic!("{}", e),
@@ -309,14 +314,14 @@ async fn main() -> Result<()> {
                 epoch,
                 &ncn_address,
                 protocol_fee_bps,
-                &cli.save_path,
+                &save_path,
                 save,
             );
         }
         Commands::CreateMetaMerkleTree { epoch, save } => {
             // Load the stake_meta_collection from disk
             let merkle_tree_collection = match GeneratedMerkleTreeCollection::new_from_file(
-                &cli.save_path.join(merkle_tree_collection_file_name(epoch)),
+                &save_path.join(merkle_tree_collection_file_name(epoch)),
             ) {
                 Ok(merkle_tree_collection) => merkle_tree_collection,
                 Err(e) => panic!("{}", e),
@@ -326,7 +331,7 @@ async fn main() -> Result<()> {
                 cli.operator_address,
                 merkle_tree_collection,
                 epoch,
-                &cli.save_path,
+                &save_path,
                 save,
             );
         }

tip-router-operator-cli/src/main.rs

@@ -185,7 +185,7 @@ pub async fn loop_stages(
                     bank.as_ref().expect("Bank was not set"),
                     tip_distribution_program_id,
                     tip_payment_program_id,
-                    &cli.save_path,
+                    &cli.get_save_path(),
                     save_stages,
                 ));
                 // we should be able to safely drop the bank in this loop
@@ -197,7 +197,9 @@ pub async fn loop_stages(
                 let some_stake_meta_collection = match stake_meta_collection.to_owned() {
                     Some(collection) => collection,
                     None => {
-                        let file = cli.save_path.join(stake_meta_file_name(epoch_to_process));
+                        let file = cli
+                            .get_save_path()
+                            .join(stake_meta_file_name(epoch_to_process));
                         StakeMetaCollection::new_from_file(&file)?
                     }
                 };
@@ -217,7 +219,7 @@ pub async fn loop_stages(
                     epoch_to_process,
                     ncn_address,
                     protocol_fee_bps,
-                    &cli.save_path,
+                    &cli.get_save_path(),
                     save_stages,
                 ));
 
@@ -230,7 +232,7 @@ pub async fn loop_stages(
                     Some(collection) => collection,
                     None => {
                         let file = cli
-                            .save_path
+                            .get_save_path()
                             .join(merkle_tree_collection_file_name(epoch_to_process));
                         GeneratedMerkleTreeCollection::new_from_file(&file)?
                     }
@@ -240,7 +242,7 @@ pub async fn loop_stages(
                     cli.operator_address.clone(),
                     some_merkle_tree_collection,
                     epoch_to_process,
-                    &cli.save_path,
+                    &cli.get_save_path(),
                     // This is defaulted to true because the output file is required by the
                     //  task that sets TipDistributionAccounts' merkle roots
                     true,
@@ -250,7 +252,7 @@ pub async fn loop_stages(
             OperatorState::CastVote => {
                 let meta_merkle_tree_path = PathBuf::from(format!(
                     "{}/{}",
-                    cli.save_path.display(),
+                    cli.get_save_path().display(),
                     meta_merkle_tree_file_name(epoch_to_process)
                 ));
                 let operator_address = Pubkey::from_str(&cli.operator_address)?;

tip-router-operator-cli/src/process_epoch.rs

@@ -41,7 +41,7 @@ pub async fn submit_recent_epochs_to_ncn(
     for i in 0..num_monitored_epochs {
         let process_epoch = epoch.epoch.checked_sub(i).unwrap();
 
-        let meta_merkle_tree_dir = cli_args.save_path.clone();
+        let meta_merkle_tree_dir = cli_args.get_save_path();
         let target_meta_merkle_tree_file = meta_merkle_tree_file_name(process_epoch);
         let target_meta_merkle_tree_path = meta_merkle_tree_dir.join(target_meta_merkle_tree_file);
         if !target_meta_merkle_tree_path.exists() {