chore: logo.svg

Author: dpc

README.md

@@ -14,10 +14,10 @@ Head to [BFTE's Radicle site][bfte-radicle] for an up to date version.
 ## Introduction
 
 BFTE in its current form is a research project on alternative
-design/implementation of a Fedimint-like system. While th *very-long*
+design/implementation of a Fedimint-like system. While the *very-long*
 term goals and supported use-cases could be similar to [Fedimint][fedimint],
 it has a luxury of not worrying about immediate practical application,
-and enabling focus on parts and goals that the author (dpc)
+enabling focus on parts and goals that the author (dpc)
 finds most promising and interesting.
 
 [fedimint]:  http://github.com/fedimint/fedimint
@@ -27,7 +27,7 @@ where it seems to make sense.
 
 Fedimint started as a Bitcoin Ecash Mint solution, with a side-goal/need
 of building a general purpose consensus engine. BFTE stars with
-a goal of researching a good general purpose consensus engine first, with
+a goal of building as good as possible general purpose consensus engine first, with
 an ability to support Bitcoin/cryptography applications like Ecash Mints "maybe one
 day".
 
@@ -36,15 +36,15 @@ in itself, with large and complex integrations and ever evolving ecosystem, with
 expectations on stability and robustness.
 
 BFTE can just let Fedimint chart these difficult waters, while only
-worrying about the general architecture eventually be able to support
+worrying about the general architecture, which could eventually be able to support
 what Fedimint can already do, while focusing on less mission-critical applications,
 like:
 
 * CI system coordination,
 * review systems,
 * etc.
 
-Basically - things that could benefit from a BFT Consensus.
+basically - things that could benefit from a BFT Consensus.
 
 Similarly, Fedimint's ambition was always reaching broad end user appeal.
 This requires a lot of effort: building end user clients including web and
@@ -53,16 +53,20 @@ compatibility etc.
 
 By ignoring all these ambitions, BFTE can focus first on honing the primary
 goal: becoming good general purpose modular consensus engine, and be ambitious
-about other aspects of the design places and implementation.
+about other aspects of the design space and implementation.
 
 ## Status
 
-As of last update the project has most of the core pieces in a working state:
+As of last update the project has most of the core pieces in a working state.
 
-* Simplex Consensu algorithm is implemented,
-* has a usable web UI,
-* Consensus Control Mode allows adding and removing peers from the consensus,
-* Metadata Module is a first simple showcase module.
+Implemented:
+
+* Simplex BFT consensu algorithm,
+* web UI,
+* consensus membership changes,
+* core consensus and module consensus versioning and upgrades,
+* consensus control module,
+* metadata module (first simple example module),
 
 ## Running
 
@@ -72,8 +76,25 @@ and run it. Using the provided Nix Flake Dev Shell is recommend.
 If you're a Nix user (which you should be), you can easily give it a try:
 
 ```
-nix run git+https://radicle.dpc.pw/zii8qFzZhN3vigh8BuxGCuEEp6z4.git
+nix run git+https://radicle.dpc.pw/zii8qFzZhN3vigh8BuxGCuEEp6z4.git -- --help
+```
+
+eg.
+
 ```
+> nix run git+https://radicle.dpc.pw/zii8qFzZhN3vigh8BuxGCuEEp6z4.git -- gen-secret > /tmp/secret
+PeerId: nk2tb7xtkw5uqyxj65w0fhd3nqdhm7ztbs2uysxrgv3yfc5dbbn1
+
+
+This mnemonic is irrecoverable if lost. Please make a back up before using it!
+
+> nix run git+https://radicle.dpc.pw/zii8qFzZhN3vigh8BuxGCuEEp6z4.git -- run --secret-path /tmp/secret --data-dir /tmp/
+2025-06-13T05:03:19.622758Z  INFO bfte::node: Opening redb database… path=/tmp/bfte.redb
+2025-06-13T05:03:19.626664Z  INFO bfte::node: Iroh endpoint initialized endpoint=a182558e0be2a4c145ad60a5e92fd11356c2d441b43e7925e27b3964ca72ca43 bound_ipv4=0.0.0.0:35687 bound_ipv6=[::]:35688
+2025-06-13T05:03:19.626707Z  WARN bfte::node: Temporary UI password pass=GYBJQPbFhk
+2025-06-13T05:03:19.626858Z  INFO bfte::node: Waiting for consensus initialization via web UI
+2025-06-13T05:03:19.626905Z  INFO bfte::node::ui: Starting web UI server... addr=[::1]:6910
+`
 
 ## Links
 

crates/node-ui-axum/assets/logo.svg

@@ -13,7 +13,7 @@ pub const ROUTE_ALPINEJS_JS: &str = "/assets/alpine/alpinejs-3.18.8.js";
 pub const ROUTE_ALPINEAJAX_JS: &str = "/assets/alpine/alpine-ajax-0.12.2.js";
 pub const ROUTE_PICO_CSS: &str = "/assets/pico@2.indigo.min.css";
 pub const ROUTE_STYLE_CSS: &str = "/assets/style.css";
-pub const ROUTE_LOGO_PNG: &str = "/assets/logo.png";
+pub const ROUTE_LOGO_SVG: &str = "/assets/logo.svg";
 
 pub(crate) fn get_static_asset(content_type: &'static str, body: &'static [u8]) -> Response {
     (
@@ -39,6 +39,9 @@ pub(crate) fn get_static_js(body: &'static str) -> Response {
 pub(crate) fn get_static_json(body: &'static str) -> Response {
     get_static_asset("application/json", body.as_bytes())
 }
+pub(crate) fn get_static_svg(body: &'static [u8]) -> Response {
+    get_static_asset("image/svg+xml", body)
+}
 
 pub(crate) trait WithStaticRoutesExt {
     fn with_static_routes(self) -> Self;
@@ -87,10 +90,9 @@ where
             ROUTE_PICO_CSS,
             get(|| async move { get_static_css(include_str!("../assets/pico@2.indigo.min.css")) }),
         )
-        // TODO: add some logo
-        // .route(
-        //     ROUTE_LOGO_PNG,
-        //     get(|| async move {
-        // get_static_png(include_bytes!("../assets/logo.png")) }),
+        .route(
+            ROUTE_LOGO_SVG,
+            get(|| async move { get_static_svg(include_bytes!("../assets/logo.svg")) }),
+        )
     }
 }

crates/node-ui-axum/src/assets.rs

@@ -2,7 +2,7 @@ use bfte_consensus_core::module::ModuleId;
 use maud::{DOCTYPE, Markup, html};
 
 use crate::assets::{
-    ROUTE_ALPINEAJAX_JS, ROUTE_ALPINEJS_JS, ROUTE_DATASTAR_JS, ROUTE_LOGO_PNG, ROUTE_PICO_CSS,
+    ROUTE_ALPINEAJAX_JS, ROUTE_ALPINEJS_JS, ROUTE_DATASTAR_JS, ROUTE_LOGO_SVG, ROUTE_PICO_CSS,
     ROUTE_STYLE_CSS,
 };
 use crate::{ROUTE_EXPLORER, ROUTE_INVITE, ROUTE_UI, UiState};
@@ -17,7 +17,7 @@ impl UiState {
                 title { (page_title) }
                 link rel="stylesheet" type="text/css" href=(ROUTE_PICO_CSS);
                 link rel="stylesheet" type="text/css" href=(ROUTE_STYLE_CSS);
-                link rel="icon" type="image/png" href=(ROUTE_LOGO_PNG);
+                link rel="icon" type="image/svg+xml" href=(ROUTE_LOGO_SVG);
                 script defer type="module" src=(ROUTE_DATASTAR_JS) {}
                 script defer src=(ROUTE_ALPINEAJAX_JS) {}
                 script defer src=(ROUTE_ALPINEJS_JS) {}

crates/node-ui-axum/src/page.rs

@@ -68,7 +68,7 @@ impl UiState {
                                 "x-target.error"="error-response-form-create:error-response"
                             {
                                 p { "Start a new consensus network as the first node." }
-                                button type="submit" disabled[(!can_create_consensus)] { "Create" }
+                                button type="submit" disabled[!can_create_consensus] { "Create" }
                                 @if !has_secret {
                                     p { "Must have a root secret set with" code { "--secret-path" } "." }
                                 }