chore: wrap-up 0.10 (#268)

Co-authored-by: MicaiahReid <[email protected]>

Author: lgalabru

Cargo.lock

@@ -1,5 +1,5 @@
 [workspace.package]
-version = "0.9.6"
+version = "0.10.0"
 edition = "2024"
 description = "Surfpool is the best place to train before surfing Solana."
 license = "Apache-2.0"

Cargo.toml

@@ -183,9 +183,9 @@ pub struct StartSimnet {
     /// Path to subgraph's sqlite database (default: :memory:)
     #[arg(long = "subgraph-database-path", short = 'd')]
     pub subgraph_database_path: Option<String>,
-    /// Disable Studio (default: false)
-    #[clap(long = "studio", action=ArgAction::SetFalse)]
-    pub studio: bool,
+    /// Disable Studio (default: true)
+    #[clap(long = "no-studio")]
+    pub no_studio: bool,
     /// Set the Studio port
     #[arg(long = "studio-port", short = 's', default_value_t = CHANGE_TO_DEFAULT_STUDIO_PORT_ONCE_SUPERVISOR_MERGED)]
     pub studio_port: u16,

crates/cli/src/cli/mod.rs

@@ -175,7 +175,7 @@ pub async fn handle_start_local_surfnet_command(
         }
     }
 
-    let displayed_url = if cmd.studio {
+    let displayed_url = if cmd.no_studio {
         DisplayedUrl::Datasource(sanitized_config)
     } else {
         DisplayedUrl::Studio(sanitized_config)

crates/cli/src/cli/simnet/mod.rs

@@ -13,11 +13,13 @@ use txtx_addon_network_svm::templates::{
 use txtx_core::{
     kit::{helpers::fs::FileLocation, indexmap::indexmap},
     manifest::{RunbookMetadata, WorkspaceManifest},
-    templates::{TXTX_MANIFEST_TEMPLATE, TXTX_README_TEMPLATE, build_manifest_data},
+    templates::{TXTX_MANIFEST_TEMPLATE, build_manifest_data},
 };
 
 use crate::{cli::DEFAULT_SOLANA_KEYPAIR_PATH, types::Framework};
 
+pub const SURFPOOL_README_TEMPLATE: &str = include_str!("./templates/readme.md.mst");
+
 mod anchor;
 mod native;
 mod pinocchio;
@@ -283,7 +285,7 @@ pub fn scaffold_iac_layout(
                 format!("Failed to create Runbook README {}: {e}", readme_file_path)
             })?;
             let readme_file_data = build_manifest_data(&manifest);
-            let template = mustache::compile_str(TXTX_README_TEMPLATE)
+            let template = mustache::compile_str(SURFPOOL_README_TEMPLATE)
                 .map_err(|e| format!("Failed to generate Runbook README: {e}"))?;
             template
                 .render_data(&mut readme_file, &readme_file_data)

crates/cli/src/scaffold/mod.rs

@@ -0,0 +1,87 @@
+# {{ workspace_name }} Runbooks
+
+[![Surfpool](https://img.shields.io/badge/Operated%20with-Surfpool-gree?labelColor=gray)](https://surfpool.run)
+
+## Available Runbooks
+
+{{# runbooks }}
+### {{ name }}
+{{ description }}
+{{/ runbooks }}
+
+## Getting Started
+
+This repository is using [Surfpool](https://surfpool.run) as a part of its development workflow.
+
+Surfpool provides three major upgrades to the Solana development experience:
+- **Surfnet**: A local validator that runs on your machine, allowing you fork mainnet on the fly so that you always use the latest chain data when testing your programs.
+- **Runbooks**: Bringing the devops best practice of `infrastructure as code` to Solana, Runbooks allow you to have secure, reproducible, and composable scripts for managing on-chain operations & deployments.
+- **Surfpool Studio**: An all-local Web UI that gives new levels of introspection into your transactions.
+
+### Installation
+
+Install pre-built binaries:
+
+```console
+# macOS (Homebrew)
+brew install txtx/taps/surfpool
+
+# Updating surfpool for Homebrew users
+brew tap txtx/taps
+brew reinstall surfpool
+
+# Linux (Snap Store)
+snap install surfpool
+```
+
+Install from source:
+
+```console
+# Clone repo
+git clone https://github.com/txtx/surfpool.git
+
+# Set repo as current directory
+cd surfpool
+
+# Build
+cargo surfpool-install
+```
+
+### Start a Surfnet
+
+```console
+$ surfpool start
+```
+
+## Resources
+
+Access tutorials and documentation at [docs.surfpool.run](https://docs.surfpool.run) to understand Surfnets and the Runbook syntax, and to discover the powerful features of surfpool.
+
+Additionally, the [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=txtx.txtx) will make writing runbooks easier.
+
+Our [Surfpool 101 Series](https://www.youtube.com/playlist?list=PL0FMgRjJMRzO1FdunpMS-aUS4GNkgyr3T) is also a great place to start learning about Surfpool and its features:
+<a href="https://www.youtube.com/playlist?list=PL0FMgRjJMRzO1FdunpMS-aUS4GNkgyr3T">
+  <picture>
+    <source srcset="https://raw.githubusercontent.com/txtx/surfpool/main/doc/assets/youtube.png">
+    <img alt="Surfpool 101 series" style="max-width: 100%;">
+  </picture>
+</a>
+
+## Quickstart
+
+### List runbooks available in this repository
+```console
+$ surfpool ls
+Name                                    Description
+deployment                              Deploy programs
+```
+
+### Start a Surfnet, automatically executing the `deployment` runbook on program recompile:
+```console
+$ surfpool start --watch
+```
+
+### Execute an existing runbook
+```console
+$ surfpool run deployment
+```

crates/cli/src/scaffold/templates/readme.md.mst

@@ -1,4 +1,3 @@
-use core::panic;
 use std::{
     collections::{BTreeMap, HashMap, HashSet},
     sync::Arc,
@@ -1141,6 +1140,7 @@ impl SurfnetSvmLocker {
     fn handle_execution_failure(
         &self,
         failed_transaction_metadata: FailedTransactionMetadata,
+        simulated_slot: Slot,
         pre_execution_capture: ExecutionCapture,
         status_tx: Sender<TransactionStatusEvent>,
         do_propagate: bool,
@@ -1150,6 +1150,7 @@ impl SurfnetSvmLocker {
         let cus = meta.compute_units_consumed;
         let log_messages = meta.logs.clone();
         let err_string = err.to_string();
+        let signature = meta.signature;
 
         if do_propagate {
             let meta = convert_transaction_metadata_from_canonical(&meta);
@@ -1159,7 +1160,24 @@ impl SurfnetSvmLocker {
                 err
             )));
 
-            let _ = status_tx.try_send(TransactionStatusEvent::ExecutionFailure((err, meta)));
+            let _ = status_tx.try_send(TransactionStatusEvent::ExecutionFailure((
+                err.clone(),
+                meta,
+            )));
+            self.with_svm_writer(|svm_writer| {
+                svm_writer.notify_signature_subscribers(
+                    SignatureSubscriptionType::processed(),
+                    &signature,
+                    simulated_slot,
+                    Some(err.clone()),
+                );
+                svm_writer.notify_logs_subscribers(
+                    &signature,
+                    Some(err.clone()),
+                    log_messages.clone(),
+                    CommitmentLevel::Processed,
+                );
+            })
         }
 
         ProfileResult::new(
@@ -1175,6 +1193,7 @@ impl SurfnetSvmLocker {
         &self,
         transaction_metadata: TransactionMetadata,
         transaction: VersionedTransaction,
+        simulated_slot: Slot,
         pubkeys_from_message: &[Pubkey],
         loaded_addresses: &Option<LoadedAddresses>,
         accounts_before: &[Option<Account>],
@@ -1186,6 +1205,7 @@ impl SurfnetSvmLocker {
     ) -> SurfpoolResult<ProfileResult> {
         let cus = transaction_metadata.compute_units_consumed;
         let logs = transaction_metadata.logs.clone();
+        let signature = transaction.signatures[0];
 
         let post_execution_capture = self.with_svm_writer(|svm_writer| {
             let accounts_after = pubkeys_from_message
@@ -1301,6 +1321,19 @@ impl SurfnetSvmLocker {
                 svm_writer
                     .transactions_queued_for_confirmation
                     .push_back((transaction.clone(), status_tx.clone()));
+
+                svm_writer.notify_signature_subscribers(
+                    SignatureSubscriptionType::processed(),
+                    &signature,
+                    simulated_slot,
+                    None,
+                );
+                svm_writer.notify_logs_subscribers(
+                    &signature,
+                    None,
+                    logs.clone(),
+                    CommitmentLevel::Processed,
+                );
             }
 
             Ok::<ExecutionCapture, SurfpoolError>(post_execution_capture)
@@ -1337,6 +1370,7 @@ impl SurfnetSvmLocker {
                 .handle_execution_success(
                     transaction_metadata,
                     transaction,
+                    self.get_latest_absolute_slot(),
                     transaction_accounts,
                     &loaded_addresses,
                     accounts_before,
@@ -1358,6 +1392,7 @@ impl SurfnetSvmLocker {
             ProcessTransactionResult::ExecutionFailure(failed_transaction_metadata) => self
                 .handle_execution_failure(
                     failed_transaction_metadata,
+                    self.get_latest_absolute_slot(),
                     pre_execution_capture,
                     status_tx.clone(),
                     do_propagate,
@@ -1995,7 +2030,7 @@ impl SurfnetSvmLocker {
         }
 
         if remapped_instructions.is_empty() {
-            panic!("No valid instructions after remapping, skipping partial transaction creation.");
+            // panic!("No valid instructions after remapping, skipping partial transaction creation.");
             return None;
         }
 
@@ -2513,11 +2548,19 @@ impl SurfnetSvmLocker {
             calculate_time_travel_clock(&config, updated_at, slot_time, &epoch_info)
                 .map_err(|e| SurfpoolError::internal(e.to_string()))?;
 
+        let formated_time = chrono::DateTime::from_timestamp(clock_update.unix_timestamp / 1000, 0)
+            .unwrap_or_else(|| chrono::DateTime::from_timestamp(0, 0).unwrap())
+            .format("%Y-%m-%d %H:%M:%S")
+            .to_string();
         epoch_info.slot_index = clock_update.slot;
         epoch_info.epoch = clock_update.epoch;
         epoch_info.absolute_slot =
             clock_update.slot + clock_update.epoch * epoch_info.slots_in_epoch;
         let _ = simnet_command_tx.send(SimnetCommand::UpdateInternalClock(clock_update));
+        let _ = self.simnet_events_tx().send(SimnetEvent::info(format!(
+            "Time travel to {} successful (epoch {} / slot {})",
+            formated_time, epoch_info.epoch, epoch_info.absolute_slot
+        )));
 
         Ok(epoch_info)
     }