From 6ca173149d899cb98ac7b31f77f1bdac1a90f715 Mon Sep 17 00:00:00 2001 From: amirylm Date: Mon, 2 Oct 2023 17:17:57 +0300 Subject: [PATCH] update readme --- examples/don/README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/examples/don/README.md b/examples/don/README.md index d2c6f7e..277af84 100644 --- a/examples/don/README.md +++ b/examples/don/README.md @@ -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. \ No newline at end of file + +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.