Minor readme edit

.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/side.iml" filepath="$PROJECT_DIR$/.idea/side.iml" />
-    </modules>
-  </component>
-</project>

.idea/side-crdt.iml

@@ -6,9 +6,9 @@
       <sourceFolder url="file://$MODULE_DIR$/crates/bft-json-crdt/bft-crdt-derive/src" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/crates/bft-json-crdt/src" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/crates/bft-json-crdt/tests" isTestSource="true" />
-      <sourceFolder url="file://$MODULE_DIR$/side-node/src" isTestSource="false" />
-      <sourceFolder url="file://$MODULE_DIR$/side-node/tests" isTestSource="true" />
-      <sourceFolder url="file://$MODULE_DIR$/side-watcher/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/crdt-node/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/crdt-node/tests" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/crdt-relayer/src" isTestSource="false" />
       <excludeFolder url="file://$MODULE_DIR$/target" />
     </content>
     <orderEntry type="inheritedJdk" />

.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="" vcs="Git" />
-  </component>
-</project>

Cargo.lock

@@ -951,6 +951,47 @@ dependencies = [
  "cfg-if",
 ]
 
+[[package]]
+name = "crdt-node"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "async-trait",
+ "bdk",
+ "bdk_esplora",
+ "bdk_sqlite",
+ "bdk_wallet",
+ "bft-crdt-derive",
+ "bft-json-crdt",
+ "bitcoin 0.32.2",
+ "clap 4.5.7",
+ "dirs",
+ "electrum-client 0.20.0",
+ "ezsockets",
+ "fastcrypto",
+ "indexmap 2.2.6",
+ "reqwest",
+ "serde",
+ "serde_json",
+ "sha256",
+ "tokio",
+ "toml",
+ "tracing",
+ "uuid",
+]
+
+[[package]]
+name = "crdt-relayer"
+version = "0.1.0"
+dependencies = [
+ "async-trait",
+ "ezsockets",
+ "sha256",
+ "tokio",
+ "tracing",
+ "tracing-subscriber",
+]
+
 [[package]]
 name = "criterion"
 version = "0.4.0"
@@ -3333,47 +3374,6 @@ version = "1.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
-[[package]]
-name = "side-node"
-version = "0.1.0"
-dependencies = [
- "anyhow",
- "async-trait",
- "bdk",
- "bdk_esplora",
- "bdk_sqlite",
- "bdk_wallet",
- "bft-crdt-derive",
- "bft-json-crdt",
- "bitcoin 0.32.2",
- "clap 4.5.7",
- "dirs",
- "electrum-client 0.20.0",
- "ezsockets",
- "fastcrypto",
- "indexmap 2.2.6",
- "reqwest",
- "serde",
- "serde_json",
- "sha256",
- "tokio",
- "toml",
- "tracing",
- "uuid",
-]
-
-[[package]]
-name = "side-watcher"
-version = "0.1.0"
-dependencies = [
- "async-trait",
- "ezsockets",
- "sha256",
- "tokio",
- "tracing",
- "tracing-subscriber",
-]
-
 [[package]]
 name = "signal-hook-registry"
 version = "1.4.2"

Cargo.toml

@@ -1,4 +1,4 @@
 [workspace]
 
-members = ["side-node", "side-watcher"]
+members = ["crdt-node", "crdt-relayer"]
 resolver = "2"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Side Protocol
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,27 +1,37 @@
-# Side BFT-CRDT PoC
+# BFT-CRDT PoC
 
-This is a proof of concept implementation of a BFT-CRDT blockchain system.
+This is a proof of concept implementation of a [BFT-CRDT](https://jzhao.xyz/posts/bft-json-crdt) blockchain-like system. It is willfully, wildly insecure as a blockchain right now. Think of it as an experiment which is strictly for fun and poking at ideas.
+
+This code is based on the ideas of [Martin Kleppmann](https://martin.kleppmann.com/papers/bft-crdt-papoc22.pdf) and the ideas and code of [Jacky Zhao](https://jzhao.xyz/). Have a read, they are both excellent writers and have some of the most interesting computing ideas I've run across in quite a while.
+
+It is not clear what this thing is for, yet. It's not a blockchain. It makes a kind of secure DAG. It uses BFT-CRDTs to make a Sybil-proof and secure information transmission system for messages, with eventual consistency guarantees.
+
+The idea that it could be possible to set up a secure Sybil-proof system, negating the energy burn required for proof of work, the financially exclusionary proof of stake, or the meat space hassle of a proof of personhood ceremony, is too attractive to ignore. At least, if you're interested in cool P2P systems.
+
+## Prerequisites
+
+Install a recent version of Rust.
 
 ## Running in development
 
 Run the watcher first:
 
 ```bash
-cd side-watcher
+cd crdt-relayer
 cargo watch -x run
 ```
 
 To init a Side node:
 
 ```bash
-cd side-node
+cd crdt-node
 cargo run -- init node1
 cargo run -- init node2
 cargo run -- init node3
 cargo run -- init node4
 ```
 
-To start a node with a cargo watch for development purposes (from the side-node dir), open up a few terminals and run:
+To start a node with a cargo watch for development purposes (from the `crdt-node` dir), open up a few terminals and run:
 
 ```bash
 cargo watch -x "run -- run -- node1"
@@ -29,34 +39,23 @@ cargo watch -x "run -- run -- node2"
 cargo watch -x "run -- run -- node3"
 cargo watch -x "run -- run -- node4"
 ```
+You can then type directly into each of the Crdt Node consoles. Messages will be relayed to each Crdt Node, and the transaction history will end up being the same on all nodes.
 
 ## Discussion
 
-What we have here is a very simple system comprised of two key parts: the Side Node, and the Side Watcher.
+What we have here is a very simple system comprised of two parts: the Crdt Node, and the Crdt Relayer.
 
-### Side Node(s)
+### Crdt Node(s)
 
-The Side Nodes make up a system of BFT-CRDT-producing nodes that can make a blockchain. Currently they can reliably send transactions to each other in a secure way, such that all nodes they communicate with can tell whether received transactions are obeying the rules of the system.
+The Crdt Nodes make up a system of BFT-CRDT-producing nodes that can make a sort of wildly insecure blockchain. Currently, they can reliably send transactions to each other in a secure way, such that all nodes they communicate with can tell whether received transactions are obeying the rules of the system.
 
-Next dev tasks:
+The Crdt Node does not download any chain state, and if one goes off-line it will miss transactions. This is expected at the moment and fairly easy to fix, with a bit of work.
 
-[ ] enable Side Nodes to download current P2P chain state so that they start out with a consistent copy of transaction data
-[ ] add smart contract execution engine (CosmWasm would be a good first choice)
-[ ] enable Side Nodes to download contract code for a given contract
-[ ] enable Side Nodes to download current contract state for a given contract
-[ ] switch to full P2P messaging instead of websockets
-[ ] take the Side Watcher out of the system by electing a Side Node as a leader, so that agreement about transaction inclusion can be reached for a given block.
+### Crdt Relayer
 
-### Side Watcher
+The Crdt Relayer replicates transactions between nodes using a websocket. We aim to eliminate this component from the architecture, but for the moment it simplifies networking and consensus agreement while we experiment with higher-value concepts.
 
-The Side Watcher is a simple relayer node that sits between the Side Chain (Cosmos) and the decentralized Side Nodes. At the moment, it simply relays transactions between nodes via a websocket. We aim to eliminate this component from the architecture, but for the moment it simplifies networking and consensus agreement while we experiment with higher-value concepts.
-
-To fulfill the promises in the Lite Paper, the Side Watcher needs to:
-
-[ ] make a block for the P2P when the Side Chain creates a block
-[ ] submit P2P chain data to the Side Chain
-
-Later, we will aim to remove the Side Watcher from the architecture, by (a) moving to pure P2P transactions between Side Nodes, and (b) doing leader election of a Side Node to reach agreement on the submitted block.
+Later, we will aim to remove the Crdt Relayer from the architecture, by (a) moving to pure P2P transactions between Crdt Nodes, and (b) doing leader election of a Crdt Node to reach agreement on the submitted block.
 
 ## Bitcoin integration
 
@@ -75,3 +74,28 @@ You'll need to have funded the "dave" address prior to running the `btc` command
 I was using this primarily as a way to experiment with constructing and broadcasting Bitcoin transactions, with the hope that it would be possible to move on to more advanced constructions (e.g. state channels). However, now that I look at all the options, it seems that multi-party state channels in Bitcoin are (probably) impossible to construct.
 
 There is a second, unused Bitcoin client in place which uses Blockstream's Electrum server, but this didn't seem to be working properly with respect to Signet Bitcoin network during my testing, so I went with the esplora / Mutiny version instead.
+
+## Possible uses
+
+### DKG
+
+It strikes me that there are many, many systems which rely on a trusted setup, and which might be able to use Distributed Key Generation (DKG) instead. SNARK systems for instance all have this problem. Could BFT-CRDTs help here?
+
+It is not necessarily the case that e.g. signer participants and Cosmos validators are the same entities. Being able to quickly spin up a blockchain and use it to sign (potentially temporary or ephemeral) keyshare data might be pretty useful.
+
+### Cross chain transfers
+
+Might the ability to be part of multiple consensus groups at once provide new opportunities for cross-chain transfers?
+
+## Next dev tasks:
+
+- [ ] we don't need a relayer, the first crdt node can act as a leader until people decide they don't want to trust it any more
+- [ ] the leader node can have a timer in it for block creation
+- [ ] code up the ability to switch leaders (can be a human decision at first, later an (optional) automated choice)
+- [ ] pick a commit and reveal scheme to remove MEV. One thing to investigate is [single-use seals](https://docs.rgb.info/distributed-computing-concepts/single-use-seals)
+- [ ] enable Crdt Nodes should download current P2P chain/dag state so that they start - out with a consistent copy of transaction data, and also do catch-up after going off-line
+- [ ] remove the proc macro code from bft-json-crdt, it's not really needed in this implementation
+- [ ] add smart contract execution engine (CosmWasm would be a good first choice)
+- [ ] enable Crdt Nodes to download contract code for a given contract
+- [ ] enable Crdt Nodes to download current contract state for a given contract
+- [ ] switch to full P2P messaging instead of websockets

crdt-node/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "side-node"
+name = "crdt-node"
 version = "0.1.0"
 edition = "2021"
 

crdt-node/src/bft_crdt/mod.rs

@@ -6,6 +6,7 @@ use bft_json_crdt::{
 use serde::{Deserialize, Serialize};
 
 pub mod keys;
+pub mod stdin;
 pub mod websocket;
 
 #[add_crdt_fields]

crdt-node/src/bitcoin/driver.rs

@@ -1,6 +1,4 @@
-use std::str::FromStr;
-
-use bdk_wallet::bitcoin::{Address, Amount, Network};
+use bdk_wallet::bitcoin::{Amount, Network};
 
 use crate::bitcoin::clients;
 

crdt-node/src/lib.rs

@@ -10,7 +10,6 @@ pub mod bitcoin;
 pub(crate) mod cli;
 pub(crate) mod init;
 pub mod node;
-pub(crate) mod stdin;
 pub mod utils;
 
 #[tokio::main]
@@ -49,7 +48,7 @@ async fn setup(name: &String) -> SideNode {
     let (incoming_sender, incoming_receiver) = mpsc::channel::<SignedOp>(32);
     let (stdin_sender, stdin_receiver) = std::sync::mpsc::channel();
     task::spawn(async move {
-        stdin::input(stdin_sender);
+        bft_crdt::stdin::input(stdin_sender);
     });
 
     // Finally, create the node and return it

crdt-node/src/main.rs

@@ -0,0 +1,5 @@
+use crdt_node;
+
+fn main() {
+    crdt_node::run();
+}

crdt-node/src/node.rs

@@ -8,7 +8,7 @@ use crate::{bft_crdt::websocket::Client, bft_crdt::TransactionList, utils};
 pub struct SideNode {
     crdt: BaseCrdt<TransactionList>,
     bft_crdt_keys: fastcrypto::ed25519::Ed25519KeyPair,
-    bitcoin_wallet: bdk::Wallet<MemoryDatabase>,
+    _bitcoin_wallet: bdk::Wallet<MemoryDatabase>, // currently not read anywhere
     incoming_receiver: mpsc::Receiver<SignedOp>,
     stdin_receiver: std::sync::mpsc::Receiver<String>,
     handle: ezsockets::Client<Client>,
@@ -26,7 +26,7 @@ impl SideNode {
         let node = Self {
             crdt,
             bft_crdt_keys,
-            bitcoin_wallet,
+            _bitcoin_wallet: bitcoin_wallet,
             incoming_receiver,
             stdin_receiver,
             handle,

crdt-relayer/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "side-watcher"
+name = "crdt-relayer"
 version = "0.1.0"
 edition = "2021"
 

side-node/src/main.rs

@@ -1,5 +0,0 @@
-use side_node;
-
-fn main() {
-    side_node::run();
-}