42 releases
0.3.5 | Oct 9, 2024 |
---|---|
0.3.1 | Sep 24, 2024 |
0.2.3 | Jul 29, 2024 |
0.1.2 | Mar 28, 2024 |
#25 in HTTP server
2,693 downloads per month
510KB
9K
SLoC
sn_auditor
This is a small webserver application that allows you to audit the SAFE Network Currency by gathering a DAG of Spends on the Network.
Usage
Running an auditor instance:
# 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:
-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
The following env var:
# time in seconds UTXOs are refetched in DAG crawl
UTXO_REATTEMPT_INTERVAL=3600
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 installed
- to enable the
svg-dag
feature flag (withcargo run --release --features=svg-dag
)
Dependencies
~73–110MB
~2M SLoC