dave/bft-crdt-experiment
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed README formatting

Browse Source
This commit is contained in:
Dave Hrycyszyn
2024-06-27 10:59:46 +01:00
parent d937f9ffaa
commit b206c0e6ce
5 changed files with 9 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.idea/.gitignore generated vendored
View File

@@ -1,5 +0,0 @@
# Default ignored files
/shelf/
/workspace.xml
# Editor-based HTTP Client requests
/httpRequests/

8
.idea/modules.xml generated
View File

@@ -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>

17
.idea/side.iml generated
View File

@@ -1,17 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="EMPTY_MODULE" version="4">
<component name="NewModuleRootManager">
<content url="file://$MODULE_DIR$">
<sourceFolder url="file://$MODULE_DIR$/crates/bft-json-crdt/benches" isTestSource="true" />
<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" />
<excludeFolder url="file://$MODULE_DIR$/target" />
</content>
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />
</component>
</module>

6
.idea/vcs.xml generated
View File

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

18
README.md
View File

@@ -40,13 +40,13 @@ The Side Nodes make up a system of BFT-CRDT-producing nodes that can make a bloc
Next dev tasks: Next dev tasks:
[ ] enable Side Nodes to download current P2P chain state so that they start out with a consistent copy of transaction data - [ ] enable Side Nodes to download current P2P chain state so that they start - out with a consistent copy of transaction data
[ ] remove the proc macro code from bft-json-crdt - [ ] remove the proc macro code from bft-json-crdt
[ ] add smart contract execution engine (CosmWasm would be a good first choice) - [ ] 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 contract code for a given contract
[ ] enable Side Nodes to download current contract state for a given contract - [ ] enable Side Nodes to download current contract state for a given contract
[ ] switch to full P2P messaging instead of websockets - [ ] 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. - [ ] 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.
### Side Watcher ### Side Watcher
@@ -54,8 +54,8 @@ The Side Watcher is a simple relayer node that sits between the Side Chain (Cosm
To fulfill the promises in the Lite Paper, the Side Watcher needs to: 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 - [ ] make a block for the P2P when the Side Chain creates a block
[ ] submit P2P chain data to the Side Chain - [ ] 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 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.