chore: some progress

Author: dpc

Cargo.lock

@@ -1,8 +1,12 @@
 [workspace]
 members = [
+  "crates/bfte",
+  "crates/bfte-node",
   "crates/consensus",
   "crates/consensus-core",
   "crates/util-array-type",
+  "crates/util-db",
+  "crates/util-error",
 ]
 resolver = "2"
 
@@ -11,8 +15,8 @@ name = "bfte"
 version = "0.1.0"
 edition = "2024"
 
-authors = ["Your Name <[email protected]>"]
-description = "Rust project to test BFT consensus protocol properties"
+authors = ["Dawid Ciężarkiewicz <[email protected]>"]
+description = "BFTE is a federated consesus engine"
 license = "MIT"
 repository = "https://github.com/username/consensus-test"
 
@@ -21,24 +25,38 @@ collapsible_if = "allow"
 collapsible_else_if = "allow"
 
 [workspace.dependencies]
-bfte-util-array-type = { path = "./crates/util-array-type" }
-bfte-consensus = { path = "./crates/consensus" }
+bfte = { path = "./crates/bfte" }
 bfte-consensus-core = { path = "./crates/consensus-core" }
+bfte-consensus = { path = "./crates/consensus" }
+bfte-node = { path = "./crates/bfte-node" }
+bfte-util-array-type = { path = "./crates/util-array-type" }
+bfte-util-db = { path = "./crates/util-db" }
+bfte-util-error = { path = "./crates/util-error" }
 
 anyhow = "1.0"
 assert_matches = "1.5.0"
 bincode = { version = "2.0.0", features = ["derive"] }
+bit-set = { version = "0.8" }
+bon = "3.6.1"
+blake3 = "1.8.2"
 bytes = "1.0"
+convi = { version = "0.1.1", features = ["min_target_pointer_width_32"] }
 data-encoding = "2.7"
-derive_more = { version = "2.0.1", features = ["from"] }
+derive_more = { version = "2.0.1", features = ["from", "deref", "deref_mut"] }
 ed25519-dalek = "2.1.1"
 futures = "0.3"
 log = "0.4"
 rand = "0.8"
+redb-bincode = "0.4.0"
+nutype = "0.6.1"
+num-bigint = "0.4.6"
 serde_bytes = "0.11.17"
 serde = { version = "1.0", features = ["derive"] }
+snafu = { version = "0.8.5", features = ["rust_1_81"] }
 tokio-test = "0.4.4"
 tokio = { version = "1.0", features = ["full"] }
+tracing = "0.1.41"
+tracing-subscriber = { version = "0.3.19", features = ["env-filter"] }
 
 
 [profile]
@@ -48,3 +66,6 @@ inherits = "dev"
 incremental = false
 debug = "line-tables-only"
 lto = "off"
+
+[patch.crates-io]
+redb-bincode = { git = "https://github.com/rustshop/redb-bincode", rev = "e8f2d2783b2972f8e6b097bf1e18d90f1cf570b1" }

Cargo.toml

@@ -0,0 +1,108 @@
+# BTF Engine
+
+BTFE is a BFT consensus solution.
+
+A group of peers maintains a ledger.
+
+### BFTE vs Fedimint
+
+This project aims at the very similar very-long term goals as [fedimint][fedimint],
+but having benefit of years of extra experience, and allowing focus
+on parts and goals that the author (dpc) finds most promising and interesting.
+
+[fedimint]:  http://github.com/fedimint/fedimint
+
+
+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 being a good general purpose consensus engine most, with ability
+to support Bitcoin/cryptography applications like Ecash Mints "maybe one
+day".
+
+Things like Bitcoin and Lightning Network support are a huge time sinks,
+largely still in development applications and ecosystems, with a huge
+expectations on stability and robustness, and other barriers to becoming
+widely deployed.
+
+So, no dealing with 3 versions of LN nodes, each with it's own stupid
+problems.
+
+BFTE can just let Fedimint chart these difficult waters, while only
+ensuring the general architecture can be eventually supported, while
+building less mission-critical things, like:
+
+* CI system coordination,
+* review systems,
+* etc.
+
+Similarly, Fedimint's ambition was reaching broad Bitcoin end user appeal.
+This requires a lot of effort: building end user clients including web and
+mobile apps. While years of working in Bitcoin space thought me: There is
+no market for self-custodial Bitcoin solutions. The UX is clunky, userbase
+interested in it small, and amount of money they are willing to pay small.
+
+By ignoring all these ambitions, BFTE can focus first on honing the primary
+goal: becoming good general purpose modular consensus engine.
+
+So (at least in near to medium term future):
+
+No support for anything that isn't Linux. If you can't install Linux
+you don't deserve good stuff, and you probably don't value your freedom
+much anyway, so you have no use for censorship resistant software.
+Go pay someone for dealing with your stupid Windows or MacOS, Android, MacOS,
+and especially your stupid fucking XCode development ecosystem.
+
+No WASM support. Fuck WASM, that shit is just yet another, even more difficult
+to run platform that is ultimately hostile to distribted, censorship
+resistant applications.
+
+You'll get a Linux daemon that you can run on a server, or a desktop,
+with a built-in web interface, and you'll be happy.
+
+Other than this "focus", BFTE tries to steal and borrow as much as it can
+from Fedimint.
+
+### Design (Ideas):
+
+In BFTE *everything* is part of the consensus.
+
+A BFTE node stars either by becoming non-voting follower of existing
+consensus, or starts a fresh consensus with itself a single-peer consensus.
+
+Adding and removing peers, changes to configuration like adding new modules,
+software upgrades, etc. are all implemented by consensus items agreed on
+and published on a shared ledger.
+
+A simple consensus algorithm (Simplex) is used to perfectly match
+the needs of BFTE.
+
+
+Simplicity is achieved through interactions between very few well
+thought general purpose pritmivites:
+
+* consensus
+* module
+
+
+
+
+No client APIs, all nodes follow consensus, even if they don't participate in it.
+Maintaining APIs, and client side state machines is just duplicating effort.
+The mutable part of the consensus state is typically small anyway and
+"clients" might maybe throw away the bulk data that they don't need anyway,
+as they not validate anything
+
+DKGs can just happen as a part of consensus. Mint module should support
+multiple keysets , and generating new ones on demand.
+
+Consensus items should be just module specific inputs/outputs, signed by the
+node itself. This allows creating transactions
+
+Effect system as the only means of inter-module interactions. Modules can process
+effects published by other modules. Process input/output.
+
+
+
+### License
+
+MPLE is licensed under MIT.

README.md

@@ -0,0 +1,20 @@
+[package]
+name = "bfte-node"
+
+description.workspace = true
+license.workspace = true
+edition.workspace = true
+version.workspace = true
+
+[dependencies]
+bfte-util-array-type = { workspace = true }
+bfte-consensus-core = { workspace = true }
+bincode = { workspace = true }
+blake3 = { workspace = true }
+convi = { workspace = true }
+data-encoding = { workspace = true }
+derive_more = { workspace = true }
+ed25519-dalek = { workspace = true }
+nutype = { workspace = true }
+serde_bytes = { workspace = true }
+serde = { workspace = true, features = ["derive"] }

crates/bfte-node/Cargo.toml

@@ -0,0 +1 @@
+pub struct Node {}

crates/bfte-node/src/lib.rs

@@ -0,0 +1,24 @@
+[package]
+name = "bfte"
+
+description.workspace = true
+license.workspace = true
+edition.workspace = true
+version.workspace = true
+
+[dependencies]
+bon = { workspace = true }
+bfte-util-array-type = { workspace = true }
+bfte-consensus-core = { workspace = true }
+bincode = { workspace = true }
+blake3 = { workspace = true }
+convi = { workspace = true }
+data-encoding = { workspace = true }
+derive_more = { workspace = true }
+ed25519-dalek = { workspace = true }
+nutype = { workspace = true }
+serde_bytes = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
+
+[dev-dependencies]
+tokio-test = { workspace = true }

crates/bfte/Cargo.toml

@@ -0,0 +1,7 @@
+pub struct Bfte {}
+
+#[bon::bon]
+impl Bfte {
+    #[builder(finish_fn = run)]
+    pub fn build() {}
+}

crates/bfte/src/lib.rs

@@ -0,0 +1,5 @@
+use bfte::Bfte;
+
+fn main() {
+    Bfte::build().run();
+}

crates/bfte/src/main.rs

@@ -7,8 +7,11 @@ version.workspace = true
 [dependencies]
 bfte-util-array-type = { workspace = true }
 bincode = { workspace = true }
+blake3 = { workspace = true }
+convi = { workspace = true }
 data-encoding = { workspace = true }
 derive_more = { workspace = true }
 ed25519-dalek = { workspace = true }
+num-bigint = { workspace = true }
 serde_bytes = { workspace = true }
 serde = { workspace = true, features = ["derive"] }

crates/consensus-core/Cargo.toml

@@ -0,0 +1,11 @@
+use bincode::config;
+
+pub const STANDARD_LIMIT_16M: usize = 0x1_0000_0000;
+pub const STD_BINCODE_CONFIG: config::Configuration<
+    config::BigEndian,
+    config::Varint,
+    config::Limit<STANDARD_LIMIT_16M>,
+> = config::standard()
+    .with_limit::<STANDARD_LIMIT_16M>()
+    .with_big_endian()
+    .with_variable_int_encoding();