Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
amirylm committed Oct 2, 2023
1 parent 0a11f00 commit 6ca1731
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions examples/don/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,19 @@ This package shows a high level integration with DONs.
Multiple nodes are created for serving multiple DONs.
Each node is composed of the following components:
- p2p agent integrated with grpc (`../api/grpc/*`)
- orchestrator (`./lib/node.go`) to manage the internal processes within the node
- node orchestrator (`./lib/node.go`) to manage the internal processes within the node
- producer (`./lib/transmitter.go`) to publish messages
- message consumer (`./lib/consumer.go`)
- verifier (`./lib/verifier.go`) and signer (`./lib/signer.go`) to verify and sign messages

The nodes are connected to each other via a local p2p network.
A boostrapper node (kad DHT) is used for peer discovery, providing an entry point to the network.

Within `./tests`, you can find the following tests:

**Local Test**

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 (`./tests/testdon.go`) is used to manage the DONs and mock consensus rounds that produces dummy reports from a central location, which is helpful for testing.

`Sha256Signer` is used for signing/verifying messages, it doesn't rely on keys and is used for testing with key infrastructure.

0 comments on commit 6ca1731

Please sign in to comment.