feat: docs for sn_auditor

maidsafe · May 21, 2024 · b832269 · b832269
1 parent d542383
commit b832269
Show file tree

Hide file tree

Showing 3 changed files with 178 additions and 2 deletions.
diff --git a/sn_auditor/README.md b/sn_auditor/README.md
@@ -1,2 +1,53 @@
 # sn_auditor
-Audit the SAFE Network Currency
+
+This is a small webserver application that allows you to audit the SAFE Network Currency by gathering a DAG of Spends on the Network. 
+
+![](./dag.svg)
+
+## Usage
+
+Running an auditor instance:
+
+```bash
+# on a Network with known peers
+cargo run --release --peer "/ip4/<network_peer_addr>"
+
+# on a local testnet
+cargo run --release --features=local-discovery
+```
+
+It can be run with the following flags:
+
+```bash
+  -f, --force-from-genesis
+          Force the spend DAG to be updated from genesis
+
+  -c, --clean
+          Clear the local spend DAG and start from scratch
+
+  -o, --offline-viewer <dag_file>
+          Visualize a local DAG file offline, does not connect to the Network
+
+  -b, --beta-participants <discord_names_file>
+          Beta rewards program participants to track
+          Provide a file with a list of Discord
+          usernames as argument
+
+  -k, --beta-encryption-key <hex_secret_key>
+          Secret encryption key of the beta rewards to decypher
+          discord usernames of the beta participants
+```
+
+## Endpoints
+
+The webserver listens on port `4242` and has the following endpoints:
+
+| route             | description                                       |
+|-------------------|---------------------------------------------------|
+|`"/"`              | `svg` representation of the DAG                   |
+|`"/spend/<addr>"`  | `json` information about the spend at this `addr` |
+|`"/beta-rewards"`  | `json` list of beta rewards participants          |
+
+Note that for the `"/"` endpoint to work properly you need:
+- to have [graphviz](https://graphviz.org/download/) installed
+- to enable the `svg-dag` feature flag (with `cargo run --release --features=svg-dag`)
diff --git a/sn_auditor/dag.svg b/sn_auditor/dag.svg
diff --git a/sn_auditor/src/main.rs b/sn_auditor/src/main.rs
@@ -60,7 +60,7 @@ struct Opt {
     #[clap(long, value_parser = LogFormat::parse_from_str, verbatim_doc_comment)]
     log_format: Option<LogFormat>,
 
-    /// Beta rewards program patricipants to track
+    /// Beta rewards program participants to track
     /// Provide a JSON file with a list of Discord usernames as argument
     #[clap(short, long, value_name = "discord_names_file")]
     beta_participants: Option<PathBuf>,