Merge branch 'main' into cfg-file-watcher

Author: jclapis

.github/workflows/release.yml

@@ -37,7 +37,6 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          ref: "stable"
           fetch-depth: 0
           submodules: true
 
@@ -108,7 +107,6 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          ref: "stable"
           fetch-depth: 0
           submodules: true
 
@@ -168,7 +166,6 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          ref: "stable"
           fetch-depth: 0
           submodules: true
 
@@ -221,7 +218,6 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          ref: "stable"
           fetch-depth: 0
           submodules: true
 

Cargo.toml

@@ -33,7 +33,7 @@ cb-metrics = { path = "crates/metrics" }
 cb-pbs = { path = "crates/pbs" }
 cb-signer = { path = "crates/signer" }
 cipher = "0.4"
-clap = { version = "4.5.4", features = ["derive", "env"] }
+clap = { version = "4.5.48", features = ["derive", "env"] }
 color-eyre = "0.6.3"
 ctr = "0.9.2"
 derive_more = { version = "2.0.1", features = ["deref", "display", "from", "into"] }

bin/cli.rs

@@ -1,8 +1,20 @@
 use clap::Parser;
 
+/// Version string with a leading 'v'
+const VERSION: &str = concat!("v", env!("CARGO_PKG_VERSION"));
+
+/// Subcommands and global arguments for the module
+#[derive(Parser, Debug)]
+#[command(name = "Commit-Boost CLI", version = VERSION, about, long_about = None)]
+struct Cli {}
+
 /// Main entry point of the Commit-Boost CLI
 #[tokio::main]
 async fn main() -> eyre::Result<()> {
+    // Parse the CLI arguments (currently only used for version info, more can be
+    // added later)
+    let _cli = Cli::parse();
+
     color_eyre::install()?;
     // set default backtrace unless provided
 

bin/pbs.rs

@@ -7,8 +7,20 @@ use clap::Parser;
 use eyre::Result;
 use tracing::{error, info};
 
+/// Version string with a leading 'v'
+const VERSION: &str = concat!("v", env!("CARGO_PKG_VERSION"));
+
+/// Subcommands and global arguments for the module
+#[derive(Parser, Debug)]
+#[command(name = "Commit-Boost PBS Service", version = VERSION, about, long_about = None)]
+struct Cli {}
+
 #[tokio::main]
 async fn main() -> Result<()> {
+    // Parse the CLI arguments (currently only used for version info, more can be
+    // added later)
+    let _cli = Cli::parse();
+
     color_eyre::install()?;
 
     let _guard = initialize_tracing_log(PBS_MODULE_NAME, LogsSettings::from_env_config()?);

bin/signer.rs

@@ -7,8 +7,20 @@ use clap::Parser;
 use eyre::Result;
 use tracing::{error, info};
 
+/// Version string with a leading 'v'
+const VERSION: &str = concat!("v", env!("CARGO_PKG_VERSION"));
+
+/// Subcommands and global arguments for the module
+#[derive(Parser, Debug)]
+#[command(name = "Commit-Boost Signer Service", version = VERSION, about, long_about = None)]
+struct Cli {}
+
 #[tokio::main]
 async fn main() -> Result<()> {
+    // Parse the CLI arguments (currently only used for version info, more can be
+    // added later)
+    let _cli = Cli::parse();
+
     color_eyre::install()?;
 
     let _guard = initialize_tracing_log(SIGNER_MODULE_NAME, LogsSettings::from_env_config()?);

config.example.toml

@@ -89,6 +89,8 @@ headers = { X-MyCustomHeader = "MyCustomValue" }
 # OPTIONAL
 get_params = { param1 = "value1", param2 = "value2" }
 # Whether to enable timing games, as tuned by `target_first_request_ms` and `frequency_get_header_ms`.
+# NOTE: if neither `target_first_request_ms` nor `frequency_get_header_ms` is set, this flag has no effect.
+#
 # These values should be carefully chosen for each relay, as each relay has different latency and timing games setups.
 # They should only be used by advanced users, and if mis-configured can result in unforeseen effects, e.g. fetching a lower header value,
 # or getting a temporary IP ban.