diff --git a/README.md b/README.md index 2d9ea67..3c9f2a9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # neptune-explorer -A web-based block explorer for the [Neptune Cash blockchain](https://neptune.cash). neptune-explorer provides a basic HTML view and a REST RPC API. +A web-based block explorer for the [Neptune Privacy blockchain](https://neptune.cash). 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. diff --git a/templates/web/html/components/head.html b/templates/web/html/components/head.html index 8d028bf..322de1d 100644 --- a/templates/web/html/components/head.html +++ b/templates/web/html/components/head.html @@ -1,4 +1,4 @@ - + diff --git a/templates/web/html/page/README.md b/templates/web/html/page/README.md new file mode 100644 index 0000000..e68e792 --- /dev/null +++ b/templates/web/html/page/README.md @@ -0,0 +1,67 @@ +# neptune-explorer + +A web-based block explorer for the [Neptune Privacy blockchain](https://neptune.io/). 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](./doc/design_notes.md) 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/neptuneprivacy/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 + +1. install [xnt-core](https://github.com/neptuneprivacy/xnt-core) and start it, or otherwise find a running xnt-core instance. +2. start neptune-explorer + +``` +nohup neptune-explorer --site-domain testdomain 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-port` flag. +* neptune-explorer listens for http requests on port 3000 by default. This can be changed with the `--listen-port` flag. +* Site name can be specified with the --site-name flag. +* Site domain *must* be specified with the `--site-domain` flag. + + +## 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-domain testdomain` + +## 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`. diff --git a/templates/web/html/page/announcement.html b/templates/web/html/page/announcement.html index f04b750..7e340e8 100644 --- a/templates/web/html/page/announcement.html +++ b/templates/web/html/page/announcement.html @@ -71,7 +71,7 @@ {{input.utxo.get_native_currency_amount().display_n_decimals(5)}} - NPT + XNT {% } %} @@ -113,7 +113,7 @@ {{output.utxo.get_native_currency_amount().display_n_decimals(5)}} - NPT + XNT {% } %} diff --git a/templates/web/html/page/root.html b/templates/web/html/page/root.html index 2c656da..2b86d5d 100644 --- a/templates/web/html/page/root.html +++ b/templates/web/html/page/root.html @@ -9,7 +9,7 @@

- + {{self.state.config.site_name}} (network: {{self.state.network}})

The blockchain tip is at height: {{self.tip_height}} diff --git a/templates/web/html/page/utxo.html b/templates/web/html/page/utxo.html index f937586..a33eabf 100644 --- a/templates/web/html/page/utxo.html +++ b/templates/web/html/page/utxo.html @@ -66,7 +66,7 @@ {% if utxo_info.utxo().has_native_currency() { %} Amount: - {{utxo_info.utxo().get_native_currency_amount().display_n_decimals(5)}} NPT + {{utxo_info.utxo().get_native_currency_amount().display_n_decimals(5)}} XNT {% } %} {% if let Some(release_date) = utxo_info.utxo().release_date() { %} diff --git a/templates/web/image/neptune-favicon.png b/templates/web/image/neptune-favicon.png deleted file mode 100644 index 5fbdcf0..0000000 Binary files a/templates/web/image/neptune-favicon.png and /dev/null differ diff --git a/templates/web/image/neptune-icon-white-on-blue.svg b/templates/web/image/neptune-icon-white-on-blue.svg new file mode 100644 index 0000000..07ea565 --- /dev/null +++ b/templates/web/image/neptune-icon-white-on-blue.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/templates/web/image/neptune-logo-blue.svg b/templates/web/image/neptune-logo-blue.svg new file mode 100644 index 0000000..2ac9e54 --- /dev/null +++ b/templates/web/image/neptune-logo-blue.svg @@ -0,0 +1,4 @@ + + + + diff --git a/templates/web/image/neptune-logo-circle-small.png b/templates/web/image/neptune-logo-circle-small.png deleted file mode 100644 index c6d511f..0000000 Binary files a/templates/web/image/neptune-logo-circle-small.png and /dev/null differ diff --git a/templates/web/image/neptune-logo-circle.png b/templates/web/image/neptune-logo-circle.png deleted file mode 100644 index dc60669..0000000 Binary files a/templates/web/image/neptune-logo-circle.png and /dev/null differ diff --git a/templates/web/image/neptune-logo.png b/templates/web/image/neptune-logo.png deleted file mode 100644 index a85ad86..0000000 Binary files a/templates/web/image/neptune-logo.png and /dev/null differ