863433cb77
Ignore the "MOCK" environment flag. Use the cache only if the node does not know the UTXO and the "mock" feature flag is set. It is safe to rely on node's response when the feature flag is not set because the only case in which the cache contains an entry that the node does not know about is when it was imagined previously, which can only happen if mocking is enabled.
neptune-explorer
A web-based block explorer for the Neptune Cash blockchain. neptune-explorer provides a basic HTML view and a REST RPC API.
As of 2024-05-22 this code is running at https://explorer.neptune.cash.
Some design notes are available.
Installing
Compile from Source -- Linux Debian/Ubuntu
You may need to:
sudo apt install pkg-config libssl-dev
Then
git clone https://github.com/Neptune-Crypto/neptune-explorer.git
cd neptune-explorer
cargo install --locked --path .
Windows, Mac
not tested or supported. Please let us know if you get it work. patches accepted.
Running
- install neptune-core and start it, or otherwise find a running neptune-core instance.
- start neptune-explorer
nohup neptune-explorer 2>&1 > /path/to/logs/neptune-explorer.log &
Notes:
- The block-explorer automatically uses the same network (mainnet, testnet, etc) as the neptune-core instance it is connected to, and the network is displayed in the web interface.
- If neptune-core RPC server is running on a non-standard port, you can provide it with the
--neptune-rpc-portflag. - neptune-explorer listens for http requests on port 3000 by default. This can be changed with the
--listen-portflag. - Site name must be specified with the
--site-nameflag.
Connecting via Browser
Just navigate to http://localhost:3000/
Mocking
When connected to an out-of-date or unsynced neptune-core node, it might be a good idea to turn on mocking so that whenever a resource is unavailable, a random one is generated and returned. To do this, compile with the feature flag "mock" and make sure that the "MOCK" environment variable is set.
In one command: MOCK=1 cargo run --features "mock" -- --site-name testname
SSL/TLS, Nginx, etc.
If hosting for public use, it is suggested to use nginx or similar in reverse-proxy mode to connect to http://localhost:3000. Nginx can then handle SSL/TLS certs and connections, as neptune-explorer has no built-in support for that.
Logging
All logging is output to standard out.
The log level can be set through the environment variable RUST_LOG. Valid values are: trace, debug, info, warn, and error. The default value is info. E.g.: RUST_LOG=trace cargo run.