diff --git a/examples/bls/README.md b/examples/bls/README.md index fb346b7..4274653 100644 --- a/examples/bls/README.md +++ b/examples/bls/README.md @@ -1,3 +1,14 @@ # BLS example -This package shows a high level integration with BLS based networks. \ No newline at end of file +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 +``` \ No newline at end of file diff --git a/examples/don/README.md b/examples/don/README.md index 85db1f2..204a6f9 100644 --- a/examples/don/README.md +++ b/examples/don/README.md @@ -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 +```