Max/new explorer url (#5522)
* new api link for explorer v2 * remove footer add explorer to navbar * include image * @ fix menu icons * + explorer link in footer --------- Co-authored-by: RadekSabacky <radek@nymtech.net>
This commit is contained in:
mfahampshire
@@ -0,0 +1,23 @@
|
||||
import Image from "next/image";
|
||||
import Link from "next/link";
|
||||
import explorerLogo from "../public/images/smiley.png";
|
||||
|
||||
export const Explorer = () => {
|
||||
return (
|
||||
<Link
|
||||
href={"https://nym.com/explorer"}
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
<Image
|
||||
src={explorerLogo}
|
||||
style = {{
|
||||
marginRight: "0.6rem"
|
||||
}}
|
||||
alt={"Network Explorer"}
|
||||
width={24}
|
||||
height={24}
|
||||
/>
|
||||
</Link>
|
||||
);
|
||||
};
|
||||
@@ -5,7 +5,7 @@ const links = [
|
||||
["Matrix", "https://matrix.to/#/#dev:nymtech.chat"],
|
||||
["GitHub", "https://nymtech.net/go/github/nym"],
|
||||
["Nym Wallet", "https://nymtech.net/download/wallet"],
|
||||
["Nym Explorer", "https://explorer.nymtech.net/"],
|
||||
["Nym Explorer", "https://nym.com/explorer/"],
|
||||
["Nym Blog", "https://nymtech.medium.com/"],
|
||||
["Twitter", "https://nymtech.net/go/x"],
|
||||
["Telegram", "https://nymtech.net/go/telegram"],
|
||||
|
||||
@@ -6,10 +6,6 @@ import { useTheme } from "@mui/material/styles";
|
||||
import Image from "next/image";
|
||||
import Link from "next/link";
|
||||
|
||||
// import networkDocs from "../public/images/landing/network-docs.png";
|
||||
// import developerDocs from "../public/images/landing/developer-docs.png";
|
||||
// import sdkDocs from "../public/images/landing/sdk-docs.png";
|
||||
// import operatorGuide from "../public/images/landing/operator-guide.png";
|
||||
import networkDocs from "../public/images/landing/Vector1.png";
|
||||
import developerDocs from "../public/images/landing/Vector2.png";
|
||||
import sdkDocs from "../public/images/landing/Vector3.png";
|
||||
@@ -41,13 +37,6 @@ export const LandingPage = () => {
|
||||
href: "/developers",
|
||||
icon: sdkDocs,
|
||||
},
|
||||
// {
|
||||
// text: "SDKs",
|
||||
// description: "Rust and Typescript SDK docs",
|
||||
|
||||
// href: "/developers/rust",
|
||||
// icon: sdkDocs,
|
||||
// },
|
||||
{
|
||||
text: "APIs",
|
||||
description: "Interactive API specs for Nym infrastructure",
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
import { Box } from "@mui/material";
|
||||
import Image from "next/image";
|
||||
import Link from "next/link";
|
||||
import matrixLogo from "../public/images/matrix-logo.png";
|
||||
|
||||
export const Matrix = () => {
|
||||
return (
|
||||
<Link
|
||||
@@ -9,7 +9,14 @@ export const Matrix = () => {
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
<Image src={matrixLogo} alt={"Matrix Logo"} width={20} height={24} />
|
||||
<Image src={matrixLogo}
|
||||
style = {{
|
||||
marginRight: "0.6rem"
|
||||
}}
|
||||
alt={"Matrix Logo"}
|
||||
width={20}
|
||||
height={24}
|
||||
/>
|
||||
</Link>
|
||||
);
|
||||
};
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
|
||||
# Explorer API
|
||||
|
||||
The Explorer API is the backend for the [Mixnet Explorer](https://explorer.nymtech.net/).
|
||||
The Explorer API is the backend for the [Mixnet Explorer](https://nym.com/explorer).
|
||||
|
||||
**This will soon be deprecated in favour of the [Node Status API](ns-api.mdx).**
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ The `--id` in the example above is a local identifier so that you can name your
|
||||
|
||||
The `--use-reply-surbs` field denotes whether you wish to send [SURBs](../../network/concepts/anonymous-replies) along with your request. It defaults to `false`, we are explicitly setting it as `true`. It defaults to `false` for compatibility with versions of the pre-smoosh `nym-network-requester` binary which will soon be deprecated.
|
||||
|
||||
The `--provider` field needs to be filled with the Nym address of an Exit Gateway that can make network requests on your behalf. You can select one from the [mixnet explorer](https://explorer.nymtech.net/network-components/gateways) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [Harbourmaster](https://harbourmaster.nymtech.net/).
|
||||
The `--provider` field needs to be filled with the Nym address of an Exit Gateway that can make network requests on your behalf. You can select one from the [mixnet explorer](https://nym.com/explorer) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [Harbourmaster](https://harbourmaster.nymtech.net/).
|
||||
|
||||
## Choosing a Gateway
|
||||
By default - as in the example above - your client will choose a random gateway to connect to.
|
||||
@@ -42,6 +42,6 @@ However, there are several options for choosing a gateway, if you do not want on
|
||||
* send few ping messages to all of them, and measure response times.
|
||||
* create a weighted distribution to randomly choose one, favouring ones with lower latency.
|
||||
|
||||
You can select one from the [mixnet explorer](https://explorer.nymtech.net/network-components/gateways) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [Harbourmaster](https://harbourmaster.nymtech.net/).
|
||||
You can select one from the [mixnet explorer](https://nym.com/explorer) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [Harbourmaster](https://harbourmaster.nymtech.net/).
|
||||
|
||||
> Note this doesn't mean that your client will pick the closest gateway to you, but it will be far more likely to connect to gateway with a 20ms ping rather than 200ms
|
||||
|
||||
@@ -31,7 +31,7 @@ Initialising a new client instance can be done with the following command:
|
||||
|
||||
The `--id` in the example above is a local identifier so that you can name your clients; it is **never** transmitted over the network.
|
||||
|
||||
There is an optional `--gateway` flag that you can use if you want to use a specific gateway. The supplied argument is the `Identity Key` of the gateway you wish to use, which can be found on the [mixnet explorer](https://explorer.nymtech.net/network-components/gateways). Alternatively, you could use [Harbourmaster](https://harbourmaster.nymtech.net/)
|
||||
There is an optional `--gateway` flag that you can use if you want to use a specific gateway. The supplied argument is the `Identity Key` of the gateway you wish to use, which can be found on the [mixnet explorer](https://nym.com/explorer). Alternatively, you could use [Harbourmaster](https://harbourmaster.nymtech.net/)
|
||||
|
||||
Not passing this argument will randomly select a gateway for your client.
|
||||
|
||||
|
||||
@@ -19,4 +19,4 @@ To illustrate this: `DpB3cHAchJiNBQi5FrZx2csXb1mrHkpYh9Wzf8Rjsuko.ANNWrvHqMYuert
|
||||
|
||||
- `DpB3cHAchJiNBQi5FrZx2csXb1mrHkpYh9Wzf8Rjsuko`: is the client's identity key;
|
||||
- `ANNWrvHqMYuertHGHUrZdBntQhpzfbWekB39qez9U2Vx`: is the client's Diffie Hellman key;
|
||||
- `2BuMSfMW3zpeAjKXyKLhmY4QW1DXurrtSPEJ6CjX3SEh`: is the gateway's identity, which is what you'll need to check the state of the gateway in the [Nym Explorer](https://explorer.nymtech.net/network-components/gateways).
|
||||
- `2BuMSfMW3zpeAjKXyKLhmY4QW1DXurrtSPEJ6CjX3SEh`: is the gateway's identity, which is what you'll need to check the state of the gateway in the [Nym Explorer](https://nym.com/explorer).
|
||||
|
||||
@@ -10,7 +10,7 @@ Yes, there are..
|
||||
|
||||
**Built by Nym**
|
||||
|
||||
* [Nym Explorer](https://explorer.nymtech.net/)
|
||||
* [Nym Explorer](https://nym.com/explorer)
|
||||
* [Sandbox testnet](https://sandbox-explorer.nymtech.net/)
|
||||
* [Nym Harbourmaster](https://harbourmaster.nymtech.net)
|
||||
|
||||
|
||||
+1
-1
@@ -259,7 +259,7 @@ That can be done only on an IP+destination port basis, however. Common P2P ports
|
||||
|
||||
<p>
|
||||
You also have the option of blocking this IP address and others on the Nym network if you so desire.
|
||||
The Nym project provides a <a href="https://explorer.nymtech.net/network-components/gateways">
|
||||
The Nym project provides a <a href="https://nym.com/explorer">
|
||||
web service</a> to fetch a list of all IP addresses of Nym Gateway Exit nodes that allow exiting to a
|
||||
specified IP:port combination. Please be considerate when using these options.</p>
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
Nym Node operators running Gateway functionality are already familiar with the monitoring tool [Harbourmaster.nymtech.net](https://harbourmaster.nymtech.net). Under the hood of Nym Harbourmaster runs iterations of `nym-gateway-probe` doing various checks and displaying the results on the interface. Operators don't have to rely on the probe ran by Nym and wait for the data to refresh. With `nym-gateway-probe` everyone can check any Gateway's networking status from their own computer at any time. In one command the client queries data from:
|
||||
|
||||
- [`nym-api`](https://validator.nymtech.net/api/v1/gateways)
|
||||
- [`explorer-api`](https://explorer.nymtech.net/api/v1/gateways)
|
||||
- [`explorer-api`](https://mainnet-node-status-api.nymtech.cc/swagger/#/Gateways)
|
||||
- [`harbour-master`](https://harbourmaster.nymtech.net/)
|
||||
|
||||
|
||||
@@ -88,4 +88,3 @@ For any `nym-node --mode exit-gateway` the aim is to have this outcome:
|
||||
**If your Gateway is blacklisted, the probe will not work.**
|
||||
|
||||
If you don't provide a `--gateway` flag it will pick a random one to test.
|
||||
|
||||
|
||||
@@ -360,7 +360,7 @@ $1 \ NYM = 1 \_ 000 \_ 000 \ uNYM$
|
||||
|
||||
The Reward Estimation API endpoint allows Mix Node operators to estimate the rewards they could earn for running a Nym Mix Node with a specific `MIX_ID`.
|
||||
|
||||
> The `<MIX_ID>` can be found in the "Mix ID" column of the [Network Explorer](https://explorer.nymtech.net/network-components/mixnodes/active).
|
||||
> The `<MIX_ID>` can be found in the "Mix ID" column of the [Network Explorer](https://nym.com/explorer).
|
||||
|
||||
The endpoint is a particularly common for Mix Node operators as it can provide an estimate of potential earnings based on factors such as the amount of traffic routed through the Mix Node, the quality of the Mix Node's performance, and the overall demand for Mix Nodes in the network. This information can be useful for Mix Node operators in deciding whether or not to run a Mix Node and in optimizing its operations for maximum profitability.
|
||||
|
||||
|
||||
@@ -73,7 +73,7 @@ The directory structure for each node will be roughly as follows:
|
||||
```
|
||||
|
||||
<Callout>
|
||||
If you `cat` the `public_sphinx.pem` key, the output will be different from the public key you will see on Nym [dashboard](https://explorer.nymtech.net/). The reason for this is that `.pem` files are encoded in **base64**, however on the web they are in **base58**. Don't be confused if your keys look different. They are the same keys, just with different encoding.
|
||||
If you `cat` the `public_sphinx.pem` key, the output will be different from the public key you will see on Nym [dashboard](https://nym.com/explorer). The reason for this is that `.pem` files are encoded in **base64**, however on the web they are in **base58**. Don't be confused if your keys look different. They are the same keys, just with different encoding.
|
||||
</Callout>
|
||||
|
||||
### Accidentally killing your node process on exiting session
|
||||
@@ -101,7 +101,7 @@ You don't have to do any additional configuration for your node to implement thi
|
||||
### How can I tell my node is up and running and mixing traffic?
|
||||
|
||||
First of all check the 'Mixnodes' section of either of the Nym Network Explorers:
|
||||
* [Mainnet](https://explorer.nymtech.net/)
|
||||
* [Mainnet](https://nym.com/explorer)
|
||||
* [Sandbox testnet](https://sandbox-explorer.nymtech.net/)
|
||||
|
||||
You can also check [Nym Harbourmaster](https://harbourmaster.nymtech.net) which now also includes mixnode mode.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 136 KiB |
@@ -1,7 +1,8 @@
|
||||
import React from "react";
|
||||
import { DocsThemeConfig, useConfig } from "nextra-theme-docs";
|
||||
import { Footer } from "./components/footer";
|
||||
// import { Footer } from "./components/footer";
|
||||
import { Matrix } from "./components/matrix-link";
|
||||
import { Explorer } from "./components/explorer-link";
|
||||
import { useRouter } from "next/router";
|
||||
|
||||
const config: DocsThemeConfig = {
|
||||
@@ -66,9 +67,9 @@ const config: DocsThemeConfig = {
|
||||
},
|
||||
docsRepositoryBase:
|
||||
"https://github.com/nymtech/nym/tree/develop/documentation/docs/",
|
||||
footer: {
|
||||
text: Footer,
|
||||
},
|
||||
// footer: {
|
||||
// text: Footer,
|
||||
// },
|
||||
darkMode: true,
|
||||
nextThemes: {
|
||||
defaultTheme: "dark",
|
||||
@@ -77,8 +78,14 @@ const config: DocsThemeConfig = {
|
||||
defaultMenuCollapseLevel: 1,
|
||||
autoCollapse: true,
|
||||
},
|
||||
|
||||
navbar: {
|
||||
extraContent: <Matrix />,
|
||||
extraContent: (
|
||||
<>
|
||||
<Explorer />
|
||||
<Matrix />
|
||||
</>
|
||||
),
|
||||
},
|
||||
toc: {
|
||||
float: false,
|
||||
|
||||
Reference in New Issue
Block a user