Merge pull request #146 from jito-foundation/jm/actually-add-squads

Add basic Squads v3/v4 alerting

Author: aoikurokawa

Cargo.lock

@@ -1,5 +1,5 @@
 [workspace]
-members = ["examples/token-program", "jito-bell", "twitterust"]
+members = ["jito-bell", "twitterust"]
 resolver = "2"
 
 [workspace.dependencies]
@@ -21,7 +21,6 @@ log = "0.4.17"
 maplit = "1.0.2"
 num-derive = "0.4.2"
 num-traits = "0.2.19"
-openssl = { version = "0.10.72", features = ["vendored"] }
 percent-encoding = "2.3"
 rand = "0.8"
 reqwest = { version = "0.11.0", features = ["json"] }
@@ -41,12 +40,6 @@ thiserror = "2.0.12"
 tokio = { version = "1.0.1", features = ["full"] }
 toml = "0.8.22"
 tonic = { version = "0.13.1" }
-tracing = "0.1.41"
-tracing-appender = "0.2.3"
-tracing-subscriber = "0.3.19"
 twitterust = { path = "./twitterust" }
 yellowstone-grpc-client = "2.0.0"
 yellowstone-grpc-proto = { version = "2.0.0", default-features = false }
-yellowstone-vixen = "0.3.0"
-yellowstone-vixen-core = "0.3.0"
-yellowstone-vixen-parser = "0.3.0"

Cargo.toml

@@ -7,7 +7,7 @@ services:
     container_name: jito-bell
     environment:
       - RUST_LOG=${RUST_LOG:-debug}
-      - ENDPOINT=${ENDPOINT}
+      - YELLOWSTONE_URL=${YELLOWSTONE_URL}
       - X_TOKEN=${X_TOKEN}
       - ACCOUNT_INCLUDE=${ACCOUNT_INCLUDE}
       - CONFIG_FILE=${CONFIG_FILE}

docker-compose.yaml

@@ -26,7 +26,6 @@ jito-vault-client = { workspace = true }
 jito-vault-sdk = { workspace = true }
 log = { workspace = true }
 maplit = { workspace = true }
-openssl = { workspace = true }
 reqwest = { workspace = true }
 serde = { workspace = true }
 serde_json = { workspace = true }
@@ -42,9 +41,6 @@ spl-token-2022 = { workspace = true }
 thiserror = { workspace = true }
 tokio = { workspace = true }
 tonic = { workspace = true }
-tracing = { workspace = true }
-tracing-appender = { workspace = true }
-tracing-subscriber = { workspace = true }
 twitterust = { workspace = true }
 yellowstone-grpc-client = { workspace = true }
 yellowstone-grpc-proto = { workspace = true }

examples/token-program/Cargo.toml

@@ -13,6 +13,12 @@ use yellowstone_grpc_proto::geyser::CommitmentLevel;
 async fn main() -> anyhow::Result<()> {
     dotenvy::dotenv().ok();
 
+    if env::var("YELLOWSTONE_URL").is_err() {
+        if let Ok(endpoint) = env::var("ENDPOINT") {
+            env::set_var("YELLOWSTONE_URL", endpoint);
+        }
+    }
+
     let log_path =
         env::var("LOG_FILE_PATH").unwrap_or_else(|_| "/var/log/jito-bell/app.log".to_string());
 
@@ -43,7 +49,10 @@ async fn main() -> anyhow::Result<()> {
 
     let args = Args::parse();
 
-    info!("Starting Jito Bell with endpoint: {}", args.endpoint);
+    info!(
+        "Starting Jito Bell with yellowstone URL: {}",
+        args.yellowstone_url
+    );
 
     let hostname_cmd = Command::new("hostname")
         .output()
@@ -62,7 +71,7 @@ async fn main() -> anyhow::Result<()> {
 
     let commitment = CommitmentConfig::confirmed();
     let mut handler = JitoBellHandler::new(
-        args.endpoint.clone(),
+        args.yellowstone_url.clone(),
         commitment,
         args.config_file,
         subscribe_option,

examples/token-program/src/main.rs

@@ -6,9 +6,9 @@ use yellowstone_grpc_proto::geyser::CommitmentLevel;
 #[derive(Debug, Clone, Parser)]
 #[clap(author, version, about)]
 pub struct Args {
-    #[clap(short, long, env = "ENDPOINT")]
-    /// Service endpoint
-    pub endpoint: String,
+    #[clap(long, env = "YELLOWSTONE_URL")]
+    /// Yellowstone gRPC endpoint URL
+    pub yellowstone_url: String,
 
     #[clap(long, env = "X_TOKEN")]
     pub x_token: Option<String>,

jito-bell/Cargo.toml

@@ -2,20 +2,28 @@ use std::collections::HashMap;
 
 use serde::Deserialize;
 
-use crate::program::{EventConfig, Program, ProgramName};
+use crate::program::{EventConfig, ProgramConfig, ProgramName};
 
 #[derive(Deserialize)]
 pub struct JitoBellConfig {
     /// Programs Configuration
-    pub programs: HashMap<ProgramName, Program>,
+    pub programs: HashMap<ProgramName, ProgramConfig>,
 
     /// Block explorer url
     pub explorer_url: String,
 
+    /// Squads app URL template
+    #[serde(default = "default_squads_app_url_template")]
+    pub squads_app_url_template: String,
+
     /// Message Templates
     pub message_templates: HashMap<String, String>,
 }
 
+fn default_squads_app_url_template() -> String {
+    "https://app.squads.so/squads/{{multisig}}/transactions/{{transaction}}".to_string()
+}
+
 impl JitoBellConfig {
     /// Get a message template by name, falling back to default
     pub fn get_template(&self, name: &str) -> Option<&String> {
@@ -25,9 +33,30 @@ impl JitoBellConfig {
     }
 }
 
+#[cfg(test)]
+mod tests {
+    use super::JitoBellConfig;
+
+    #[test]
+    fn sample_config_parses() {
+        let path = std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
+            .parent()
+            .unwrap()
+            .join("jito_bell_config_sample.yaml");
+        let yaml = std::fs::read_to_string(path).expect("sample config file not found");
+        serde_yaml::from_str::<JitoBellConfig>(&yaml)
+            .expect("sample config should deserialize without error");
+    }
+}
+
 impl std::fmt::Display for JitoBellConfig {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         writeln!(f, "Explorer URL: {}", self.explorer_url)?;
+        writeln!(
+            f,
+            "Squads App URL Template: {}",
+            self.squads_app_url_template
+        )?;
 
         writeln!(f, "Message Templates:")?;
         for (name, template) in &self.message_templates {
@@ -41,6 +70,8 @@ impl std::fmt::Display for JitoBellConfig {
                 ProgramName::SplToken2022 => "spl_token2022",
                 ProgramName::SplStakePool => "spl_stake_pool",
                 ProgramName::JitoVault => "jito_vault",
+                ProgramName::SquadsV3 => "squads_v3",
+                ProgramName::SquadsV4 => "squads_v4",
             };
             writeln!(f, "  Program Name: {}", program_name)?;
             writeln!(f, "  Program ID: {}", program.program_id)?;

jito-bell/src/bin/main.rs

@@ -1,9 +1,7 @@
-use std::str::FromStr;
-
 use base64::{engine::general_purpose::STANDARD, Engine};
 use borsh::BorshDeserialize;
 use log::error;
-use solana_pubkey::Pubkey;
+use solana_pubkey::{pubkey, Pubkey};
 
 use crate::events::jito_steward::{
     AutoAddValidatorEvent, AutoRemoveValidatorEvent, DecreaseComponents, DirectedRebalanceEvent,
@@ -46,7 +44,7 @@ impl std::fmt::Display for JitoStewardEvent {
 impl JitoStewardEvent {
     /// Retrieve Program ID of Jito Steward Program
     pub fn program_id() -> Pubkey {
-        Pubkey::from_str("Stewardf95sJbmtcZsyagb2dg4Mo8eVQho8gpECvLx8").unwrap()
+        pubkey!("Stewardf95sJbmtcZsyagb2dg4Mo8eVQho8gpECvLx8")
     }
 
     /// Parse a log message and extract any events