[Gateway Docs] Replace References to AppGateServer with PATH (#945)

## Summary * Update all Gateway `AppGateServer` references with `PATH` * Adapt documentation to suit `PATH` workflow. ## Issue `AppGateServer` must be deprecated and replaced by the `PATH` Gateway ## Type of change Select one or more from the following: - [ ] New feature, functionality or library - [ ] Consensus breaking; add the `consensus-breaking` label if so. See #791 for details - [ ] Bug fix - [ ] Code health or cleanup - [x] Documentation - [ ] Other (specify) ## Testing - [x] **Documentation**: `make docusaurus_start`; only needed if you make doc changes ## Sanity Checklist - [x] I have tested my changes using the available tooling - [ ] I have commented my code - [x] I have performed a self-review of my own code; both comments & source code - [ ] I create and reference any new tickets, if applicable - [ ] I have left TODOs throughout the codebase, if applicable --------- Co-authored-by: Daniel Olshansky <[email protected]>
pokt-network · Dec 11, 2024 · 471ba91 · 471ba91
1 parent 4000144
commit 471ba91
Show file tree

Hide file tree

Showing 20 changed files with 146 additions and 582 deletions.
diff --git a/docusaurus/docs/develop/contributing/observability.md b/docusaurus/docs/develop/contributing/observability.md
@@ -28,7 +28,7 @@ We are still refining our observability guidelines. If in doubt - please reach o
 In our system, metrics are exposed using the Prometheus exporter. This approach aligns with tools like Rollkit, and we
 leverage the [go-kit metrics package](https://pkg.go.dev/github.com/go-kit/kit/metrics) for custom metrics
 implementation. For practical examples of metric definitions, refer to
-[AppGate Metrics](https://github.com/pokt-network/poktroll/blob/main/pkg/appgateserver/metrics.go).
+[RelayMiner Metrics](https://github.com/pokt-network/poktroll/blob/main/pkg/relayer/proxy/metrics.go).
 
 ### Types of Metrics
 

diff --git a/docusaurus/docs/develop/developer_guide/performance_troubleshooting.md b/docusaurus/docs/develop/developer_guide/performance_troubleshooting.md
@@ -10,8 +10,8 @@ title: Performance troubleshooting
 - [How to Use `pprof`](#how-to-use-pprof)
   - [Available `pprof` Endpoints](#available-pprof-endpoints)
   - [Configure Software to Expose `pprof` Endpoints](#configure-software-to-expose-pprof-endpoints)
-    - [Full Nodes and Validator Configuration](#full-nodes-and-validator-configuration)
-    - [AppGate Server and RelayMiner](#appgate-server-and-relayminer)
+    - [Full Node \& Validator pprof](#full-node--validator-pprof)
+    - [RelayMiner pprof](#relayminer-pprof)
   - [Save the Profiling Data](#save-the-profiling-data)
   - [Explore the Profiling Data](#explore-the-profiling-data)
   - [Explore without saving data](#explore-without-saving-data)
@@ -91,17 +91,22 @@ or DoS your services if these endpoints are exposed to the internet.
 
 :::
 
-#### Full Nodes and Validator Configuration
+#### Full Node & Validator pprof
 
 In `config.toml`, you can configure `pprof_laddr` to expose a `pprof` endpoint
 on a particular network interface and port. By default, `pprof` listens on `localhost:6060`.
 
 If the value has been modified, you must restart the process.
 
-#### AppGate Server and RelayMiner
+#### RelayMiner pprof
 
-Both `AppGate Server` and `RelayMiner` can be configured to expose a `pprof`
-endpoint using a configuration file like this:
+The `RelayMiner` can be configured to expose a `pprof` endpoint using a configuration file like this:
+
+<!--
+TODO_MAINNET(@okdas): Mention PATH Gateway once it has pprof support.
+This should be the same as in the following link:
+https://github.com/pokt-network/poktroll/pull/484/files#diff-0ddf7b5ae8042c78166867229f8e61ded445c7048231d1de3c87f880f6d8a80fR109
+-->
 
 ```yaml
 pprof:

diff --git a/docusaurus/docs/develop/developer_guide/quickstart.md b/docusaurus/docs/develop/developer_guide/quickstart.md
@@ -39,12 +39,11 @@ Create a new [GitHub issue here](https://github.com/pokt-network/pocket/issues/n
   - [3.4 Stake the new Supplier](#34-stake-the-new-supplier)
   - [3.4 Prepare the RelayMiner configuration](#34-prepare-the-relayminer-configuration)
   - [3.5 Start the RelayMiner locally](#35-start-the-relayminer-locally)
-- [4. Manually Stake an Application \& Deploy an AppGate Server](#4-manually-stake-an-application--deploy-an-appgate-server)
+- [4. Manually Stake an Application \& Deploy a PATH Gateway](#4-manually-stake-an-application--deploy-a-path-gateway)
   - [4.1 View Existing Application](#41-view-existing-application)
   - [4.2 Create an Application configuration](#42-create-an-application-configuration)
   - [4.3 Stake the new Application](#43-stake-the-new-application)
-  - [4.4 Prepare the AppGate Server configuration](#44-prepare-the-appgate-server-configuration)
-  - [4.5 Start the AppGate Server locally](#45-start-the-appgate-server-locally)
+  - [4.4 Prepare the PATH Gateway Configuration](#44-prepare-the-path-gateway-configuration)
 - [5. Send A Relay](#5-send-a-relay)
   - [5.1 Send a relay on Shannon](#51-send-a-relay-on-shannon)
   - [5.2 What just happened?](#52-what-just-happened)
@@ -139,11 +138,13 @@ available commands. Looking inside the Makefile is a great way to learn how to u
 ### 1.3 Prepare your development environment
 
 Run the following command to install `golang` dependencies:
+
 ```bash
 make install_ci_deps
 ```
 
 If you encounter issues related to `mockgen` not being found or failing, try running the following command to verify its installation:
+
 ```bash
 make check_mockgen
 ```
@@ -475,13 +476,14 @@ new shell instance.
 
 :::
 
-## 4. Manually Stake an Application & Deploy an AppGate Server
+## 4. Manually Stake an Application & Deploy a PATH Gateway
+
+:::note Centralized Gateway
 
-:::note Independent Gateway
+This section will show how to deploy a `PATH Gateway` in `Centralized` mode,
+which will use its configured (i.e. owned) `Application`s to sign relays.
 
-This section will show how to deploy a Sovereign Application, which acts as its
-own Gateway. We are leaving delegated Gateways outside the scope of the
-Quickstart guide.
+_Other types of Gateways (e.g. Delegated) are outside the scope of this Quickstart guide._
 
 :::
 
@@ -531,46 +533,13 @@ You can also you re-run, `make app_list` you should see that `SHANNON_APPLICATIO
 
 ![Apps](./img/quickstart_applist.png)
 
-### 4.4 Prepare the AppGate Server configuration
-
-You can learn more about our [appgate server configs here](../../operate/configs/appgate_server_config.md).
-
-The following example should get you started:
+### 4.4 Prepare the PATH Gateway Configuration
 
-```yaml
-cat <<EOF >> shannon_appgate_config.yaml
-query_node_rpc_url: tcp://127.0.0.1:26657
-query_node_grpc_url: tcp://127.0.0.1:9090
-self_signing: true
-signing_key: shannon_application
-listening_endpoint: http://localhost:42042
-metrics:
-  enabled: true
-  addr: :9091
-EOF
-```
-
-### 4.5 Start the AppGate Server locally
-
-:::warning
-You might need to add the following to your `/etc/hosts` file:
-127.0.0.1 anvil
-127.0.0.1 relayminers
-:::
-
-And the start the appgate server locally:
-
-```bash
-poktrolld appgate-server \
-  --config shannon_appgate_config.yaml \
-  --keyring-backend test \
-  --node tcp://127.0.0.1:26657 \
-  --home=./localnet/poktrolld
-```
+You can learn more about our [PATH Gateway configs here](https://path.grove.city/operate).
 
 ## 5. Send A Relay
 
-Now that we've staked an `Application`, are running an `AppGate Server`, staked
+Now that we've staked an `Application`, are running a `PATH Gateway`, staked
 a `Supplier`, and are running a `RelayMiner`, we can send a relay!
 
 :::note Initialize Public Keys
@@ -590,7 +559,7 @@ You can use `curl`
 ```bash
 curl -X POST -H "Content-Type: application/json" \
   --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}' \
-  http://localhost:42042/anvil
+  http://anvil.localhost:3000/v1
 ```
 
 If everything worked as expected, you should see output similar to the following:
@@ -609,16 +578,16 @@ The Relay Request/Response from is captured in the sequence diagram below.
 sequenceDiagram
   actor U as User <br> (curl Client)
 
-  participant AG as AppGate Server <br> (off-chain Application Operator)
+  participant PG as PATH Gateway<br> (off-chain Application Operator)
   participant RM as RelayMiner <br> (off-chain Supplier Operator)
   participant anvil as ETH Node <br> (Anvil)
 
-  U ->> +AG: eth_blockNumber <br> (JSON-RPC Request)
-  AG ->> +RM: POKT Relay Request
+  U ->> +PG: eth_blockNumber <br> (JSON-RPC Request)
+  PG ->> +RM: POKT Relay Request
   RM ->> +anvil: eth_blockNumber
   anvil ->> -RM: eth_result
-  RM ->> -AG: POKT  Relay Response
-  AG ->> -U: eth_result  <br> (JSON-RPC Response)
+  RM ->> -PG: POKT  Relay Response
+  PG ->> -U: eth_result  <br> (JSON-RPC Response)
 ```
 
 ### 5.3 What will happen later
@@ -654,16 +623,16 @@ make supplier3_stake
 
 Running `make supplier_list` should now show that all three suppliers are staked.
 
-You can reuse the running AppGate Server to send requests, which should round-robin
-through all the available suppliers. However, since not all of them have a RelayMiner
-running, you'll see that some of requests will fail.
+You can reuse the running `PATH Gateway` to send requests. Its Quality-of-Service module
+will try to handle non-performant suppliers, but you should expect some requests to periodically
+fail.
 
 Give it a shot by running the following multiple times:
 
 ```bash
 curl -X POST -H "Content-Type: application/json" \
   --data '{"jsonrpc":"2.0","method":"eth_blockNumber","params":[],"id":1}' \
-  http://localhost:42042/anvil
+  http://anvil.localhost:3000/v1
 ```
 
 ### 5.5. Inspect the logs

diff --git a/docusaurus/docs/develop/packages/appgate_server.md b/docusaurus/docs/develop/packages/appgate_server.md