Add instructions to run (#18)

Author: ChewingGlass

Cargo.lock

@@ -12,6 +12,41 @@ Tuktuk's architecture allows for crankers to run a simple rust util that require
 
 Creators of Task Queues set their payment per-crank turn in SOL. Crankers that run the tasks are paid out in SOL for each crank they complete. There is a minimum deposit of 1 SOL to create a task queue to discourage spam. This deposit is refunded when the task queue is closed. The intent is to minimize the number of task queues that crank turners need to watch. You should try to reuse task queues as much as possible. It is an antipattern to create a new task queue for each user, for example.
 
+## Running a Crank Turner
+
+Install the crank turner:
+
+```
+cargo install tuktuk-crank-turner
+```
+
+If you want to run a crank turner, create a config.toml file with the following:
+
+```
+rpc_url = "https://api.mainnet-beta.solana.com"
+key_path = "/path/to/your/keypair.json"
+min_crank_fee = 10000
+```
+
+Then run the crank turner:
+
+```
+tuktuk-crank-turner -c config.toml
+```
+
+You can also provider configuration via environment variables
+
+```
+export TUKTUK__RPC_URL="https://api.mainnet-beta.solana.com"
+export TUKTUK__KEY_PATH="/path/to/your/keypair.json"
+export TUKTUK__MIN_CRANK_FEE=10000
+tuktuk-crank-turner
+```
+
+### Requirements
+
+You will need a good Solana RPC that doesn't have heavy rate limits (for when there are a lot of tasks queued). You should also handle restarting the process if it crashes, as this can happen if your RPC disconnects the websocket without a proper handshake.
+
 ## Usage
 
 Install the tuktuk cli by running `cargo install tuktuk-cli`.

README.md

@@ -76,49 +76,60 @@ pub enum Cmd {
 
 async fn simulate_task(client: &CliClient, task_key: Pubkey) -> Result<Option<SimulationResult>> {
     // Get the run instruction
-    let run_ix = tuktuk_sdk::compiled_transaction::run_ix(
+    let run_ix_res = tuktuk_sdk::compiled_transaction::run_ix(
         client.as_ref(),
         task_key,
         client.payer.pubkey(),
         &HashSet::new(),
     )
-    .await?;
+    .await;
 
-    // Create and simulate the transaction
-    let mut updated_instructions =
-        vec![solana_sdk::compute_budget::ComputeBudgetInstruction::set_compute_unit_limit(1900000)];
-    updated_instructions.extend(run_ix.instructions.clone());
-    let recent_blockhash = client.rpc_client.get_latest_blockhash().await?;
-    let message = VersionedMessage::V0(v0::Message::try_compile(
-        &client.payer.pubkey(),
-        &updated_instructions,
-        &run_ix.lookup_tables,
-        recent_blockhash,
-    )?);
-    let tx = VersionedTransaction::try_new(message, &[&client.payer])?;
-    let sim_result = client
-        .rpc_client
-        .simulate_transaction_with_config(
-            &tx,
-            RpcSimulateTransactionConfig {
-                commitment: Some(solana_sdk::commitment_config::CommitmentConfig::confirmed()),
-                sig_verify: true,
-                ..Default::default()
-            },
-        )
-        .await;
+    match run_ix_res {
+        Ok(run_ix) => {
+            // Create and simulate the transaction
+            let mut updated_instructions = vec![
+                solana_sdk::compute_budget::ComputeBudgetInstruction::set_compute_unit_limit(
+                    1900000,
+                ),
+            ];
+            updated_instructions.extend(run_ix.instructions.clone());
+            let recent_blockhash = client.rpc_client.get_latest_blockhash().await?;
+            let message = VersionedMessage::V0(v0::Message::try_compile(
+                &client.payer.pubkey(),
+                &updated_instructions,
+                &run_ix.lookup_tables,
+                recent_blockhash,
+            )?);
+            let tx = VersionedTransaction::try_new(message, &[&client.payer])?;
+            let sim_result = client
+                .rpc_client
+                .simulate_transaction_with_config(
+                    &tx,
+                    RpcSimulateTransactionConfig {
+                        commitment: Some(
+                            solana_sdk::commitment_config::CommitmentConfig::confirmed(),
+                        ),
+                        sig_verify: true,
+                        ..Default::default()
+                    },
+                )
+                .await;
 
-    match sim_result {
-        Ok(simulated) => Ok(Some(SimulationResult {
-            error: simulated.value.err.map(|e| e.to_string()),
-            logs: Some(simulated.value.logs.unwrap_or_default()),
-            compute_units: simulated.value.units_consumed,
-        })),
-        Err(err) => Ok(Some(SimulationResult {
-            error: Some(err.to_string()),
-            logs: None,
-            compute_units: None,
-        })),
+            match sim_result {
+                Ok(simulated) => Ok(Some(SimulationResult {
+                    error: simulated.value.err.map(|e| e.to_string()),
+                    logs: Some(simulated.value.logs.unwrap_or_default()),
+                    compute_units: simulated.value.units_consumed,
+                })),
+                Err(err) => Ok(Some(SimulationResult {
+                    error: Some(err.to_string()),
+                    logs: None,
+                    compute_units: None,
+                })),
+            }
+        }
+        Err(tuktuk_sdk::error::Error::AccountNotFound) => Ok(None),
+        Err(e) => Err(e.into()),
     }
 }
 

tuktuk-cli/src/cmd/task.rs

@@ -1,6 +1,6 @@
 [package]
 name = "tuktuk-crank-turner"
-version = "0.2.10"
+version = "0.2.11"
 authors.workspace = true
 edition.workspace = true
 license.workspace = true

tuktuk-crank-turner/Cargo.toml

@@ -10,6 +10,7 @@ pub struct Settings {
     #[serde(default = "default_log")]
     pub log: String,
 
+    #[serde(default = "default_max_retries")]
     pub max_retries: u8,
     pub rpc_url: String,
     pub key_path: String,
@@ -26,6 +27,10 @@ pub struct Settings {
     pub recent_attempts_window: usize,
 }
 
+fn default_max_retries() -> u8 {
+    5
+}
+
 fn default_recent_attempts_window() -> usize {
     5
 }
@@ -47,7 +52,7 @@ fn default_max_sol_fee() -> u64 {
 }
 
 fn default_log() -> String {
-    "queue_node=debug".to_string()
+    "info".to_string()
 }
 
 impl Settings {