Skip to content

Commit

Permalink
READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
amirylm committed Oct 25, 2023
1 parent 6b67a43 commit 299496f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
13 changes: 12 additions & 1 deletion examples/bls/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# BLS example

This package shows a high level integration with BLS based networks.
This package shows a high level integration with BLS based networks.

## Overview

Every internal network is represented by a BLS key, which is splitted into shares and distributed among the nodes in that network.
Internal messages are signed with the shares of nodes, once a threshold of signatures is reached, the nodes of that network reconstruct the signature and broadcast it to the other networks. Nodes in other networks verifies the messages using the public key of the BLS key of the producing network.

## Running the example

```shell
make test-bls
```
7 changes: 7 additions & 0 deletions examples/don/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,10 @@ This test creates a local network of nodes and sends messages between them.
A boostrapper node (kad DHT) is used for peer discovery.

DON orchestrator (`./localdon.go`) is used to manage the DONs and mock consensus rounds that produces dummy reports from a central location, which is helpful for testing.


## Running the example

```shell
make test-localdon
```

0 comments on commit 299496f

Please sign in to comment.