Skip to content

Commit

Permalink
add docs to run the protocol
Browse files Browse the repository at this point in the history
  • Loading branch information
pysel committed Oct 15, 2023
1 parent 894719d commit 65c1925
Showing 1 changed file with 26 additions and 3 deletions.
29 changes: 26 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,30 @@ Under said assumptions, `f` can be arbitrarily large. Even if 2 nodes run the pr

## Running a Protocol

TODO: add instructions on how to run the protocol.
There are two ways to execute a protocol: by setting arbitrary values for amount of nodes in the system, and F (configurable)
and by running a default configuration (10 nodes total, tolerating 8 Byzantine nodes).

Currently, the protocol is still under development, so it is not possible to run it yet.
Once I finish implementing it, I will add instructions on how to run it.
In either way, each node will write it's output into a file `output.txt` in the root of the project.
It will be recreated for every launch of the protocol.

### Configurable way

To run a protocol, execute:

```bash
make NODES=X F=Y launch
```

where `X` is a number of nodes and `Y` is a number of Byzantine nodes a protocol will be able to tolerate
(in other words, a number of stages a protocol will execute).

Note: available values for `Y`: [0; X-2].
Reason: there should be at least 2 honest nodes in the system.

### Default way

To run a protocol in default mode, execute:

```bash
make launch-default
```

0 comments on commit 65c1925

Please sign in to comment.