[FEATURE] Add solana, pokt, moonbeam, and add emit prom metrics (#34)

pokt-network · Apr 21, 2024 · 214d195 · 214d195
1 parent b206247
commit 214d195
Show file tree

Hide file tree

Showing 29 changed files with 846 additions and 275 deletions.
diff --git a/.env.sample b/.env.sample
@@ -6,4 +6,6 @@ POKT_APPLICATIONS_ENCRYPTION_KEY=
 SESSION_CACHE_TTL=75m
 DB_CONNECTION_URL=postgres://myuser:mypassword@postgres:5432/postgres?sslmode=disable
 API_KEY=
-ALTRUIST_REQUEST_TIMEOUT=10s
+ALTRUIST_REQUEST_TIMEOUT=10s
+EMIT_SERVICE_URL_PROM_METRICS=false
+CHAIN_NETWORK=morse_mainnet
diff --git a/cmd/gateway_server/internal/config/dot_env_config_provider.go b/cmd/gateway_server/internal/config/dot_env_config_provider.go
@@ -3,6 +3,7 @@ package config
 import (
 	"fmt"
 	"github.com/joho/godotenv"
+	"github.com/pokt-network/gateway-server/internal/chain_network"
 	"github.com/pokt-network/gateway-server/internal/global_config"
 	"os"
 	"strconv"
@@ -15,6 +16,8 @@ const (
 
 // Environment variable names
 const (
+	chainNetworkEnv                  = "CHAIN_NETWORK"
+	emitServiceUrlPromMetricsEnv     = "EMIT_SERVICE_URL_PROM_METRICS"
 	poktRPCFullHostEnv               = "POKT_RPC_FULL_HOST"
 	httpServerPortEnv                = "HTTP_SERVER_PORT"
 	poktRPCTimeoutEnv                = "POKT_RPC_TIMEOUT"
@@ -29,13 +32,15 @@ const (
 // DotEnvGlobalConfigProvider implements the GatewayServerProvider interface.
 type DotEnvGlobalConfigProvider struct {
 	poktRPCFullHost               string
+	chainNetwork                  chain_network.ChainNetwork
 	httpServerPort                uint
 	poktRPCRequestTimeout         time.Duration
 	sessionCacheTTL               time.Duration
 	environmentStage              global_config.EnvironmentStage
 	poktApplicationsEncryptionKey string
 	databaseConnectionUrl         string
 	apiKey                        string
+	emitServiceUrlPromMetrics     bool
 	altruistRequestTimeout        time.Duration
 }
 
@@ -83,6 +88,16 @@ func (c DotEnvGlobalConfigProvider) GetAltruistRequestTimeout() time.Duration {
 	return c.altruistRequestTimeout
 }
 
+// ShouldEmitServiceUrl returns whether to emit service url tags as part of relay metrics.
+func (c DotEnvGlobalConfigProvider) ShouldEmitServiceUrlPromMetrics() bool {
+	return c.emitServiceUrlPromMetrics
+}
+
+// GetChainNetwork returns the current network, this can be useful for identifying the correct chain ids dependent on testnet or mainnet.
+func (c DotEnvGlobalConfigProvider) GetChainNetwork() chain_network.ChainNetwork {
+	return c.chainNetwork
+}
+
 // NewDotEnvConfigProvider creates a new instance of DotEnvGlobalConfigProvider.
 func NewDotEnvConfigProvider() *DotEnvGlobalConfigProvider {
 	_ = godotenv.Load()
@@ -108,7 +123,14 @@ func NewDotEnvConfigProvider() *DotEnvGlobalConfigProvider {
 		altruistRequestTimeoutDuration = defaultAltruistRequestTimeout
 	}
 
+	emitServiceUrlPromMetrics, err := strconv.ParseBool(getEnvVar(emitServiceUrlPromMetricsEnv, "false"))
+
+	if err != nil {
+		emitServiceUrlPromMetrics = false
+	}
+
 	return &DotEnvGlobalConfigProvider{
+		emitServiceUrlPromMetrics:     emitServiceUrlPromMetrics,
 		poktRPCFullHost:               getEnvVar(poktRPCFullHostEnv, ""),
 		httpServerPort:                uint(httpServerPort),
 		poktRPCRequestTimeout:         poktRPCTimeout,
@@ -117,6 +139,7 @@ func NewDotEnvConfigProvider() *DotEnvGlobalConfigProvider {
 		environmentStage:              global_config.EnvironmentStage(getEnvVar(environmentStageEnv, "")),
 		poktApplicationsEncryptionKey: getEnvVar(poktApplicationsEncryptionKeyEnv, ""),
 		apiKey:                        getEnvVar(apiKey, ""),
+		chainNetwork:                  chain_network.ChainNetwork(getEnvVar(chainNetworkEnv, string(chain_network.MorseMainnet))),
 		altruistRequestTimeout:        altruistRequestTimeoutDuration,
 	}
 }

diff --git a/cmd/gateway_server/internal/controllers/relay.go b/cmd/gateway_server/internal/controllers/relay.go
@@ -57,6 +57,8 @@ func (c *RelayController) HandleRelay(ctx *fasthttp.RequestCtx) {
 	return
 }
 
+// getPathSegmented: returns the chain being requested and other parts to be proxied to pokt nodes
+// Example: /relay/0001/v1/client, returns 0001, /v1/client
 func getPathSegmented(path []byte) (chain, otherParts string) {
 	paths := strings.Split(string(path), "/")
 

diff --git a/cmd/gateway_server/main.go b/cmd/gateway_server/main.go
@@ -67,7 +67,7 @@ func main() {
 	poktApplicationRegistry := apps_registry.NewCachedAppsRegistry(client, querier, gatewayConfigProvider, logger.Named("pokt_application_registry"))
 	chainConfigurationRegistry := chain_configurations_registry.NewCachedChainConfigurationRegistry(querier, logger.Named("chain_configurations_registry"))
 	sessionRegistry := session_registry.NewCachedSessionRegistryService(client, poktApplicationRegistry, sessionCache, nodeCache, logger.Named("session_registry"))
-	nodeSelectorService := node_selector_service.NewNodeSelectorService(sessionRegistry, client, chainConfigurationRegistry, logger.Named("node_selector"))
+	nodeSelectorService := node_selector_service.NewNodeSelectorService(sessionRegistry, client, chainConfigurationRegistry, gatewayConfigProvider, logger.Named("node_selector"))
 
 	relayer := relayer.NewRelayer(client, sessionRegistry, poktApplicationRegistry, nodeSelectorService, chainConfigurationRegistry, userAgent, gatewayConfigProvider, logger.Named("relayer"))
 

diff --git a/docs/node-selection.md b/docs/node-selection.md
@@ -20,7 +20,7 @@ heuristics:
 ## Node Selector
 After the sessions are primed, the nodes are fed to the `NodeSelectorService` which is responsible for:
 1. Running various QoS checks (Height and Data Integrity Checks)
-2. Exposing functions for the main process to select a healthy node `findNode(chainId) string`
+2. Exposing functions for the main process to select a healthy node `FindNode(chainId string) string`
 
 ### Checks Framework
 The gateway server provides a simple interface called a `CheckJob`. This interface consists of three simple functions
@@ -33,10 +33,24 @@ type CheckJob interface {
 ```
 Under the hood, the NodeSelectorService is responsible for asynchronously executing all the initialized `CheckJobs`.
 
+### Existing QoS checks:
+- **Height Check:** The general flow would be:
+   1) Query all node operators height, 
+   2) compares heights with other node operators within a specific threshold
+   3) filters out node operators that exceed the configurable block height tolerance.
+
+- **Data Integrity Check:** The general flow would be: 
+   1) Retrieve a unique block identifier (i.e block hash or total block tx count, etc) with a configurable block offset for randomness, 
+   2) Query other node operators for the same block identifier
+   3) filter out other node operators that return a different identifier.
+
 Some existing implementations of Checks can be found in:
 1. [evm_data_integrity_check.go](..%2Finternal%2Fnode_selector_service%2Fchecks%2Fevm_data_integrity_check%2Fevm_data_integrity_check.go)
 2. [evm_height_check.go](..%2Finternal%2Fnode_selector_service%2Fchecks%2Fevm_height_check%2Fevm_height_check.go)
-
+3. [pokt_height_check.go](..%2Finternal%2Fnode_selector_service%2Fchecks%2Fpokt_height_check%2Fpokt_height_check.go)
+4. [pokt_data_integrity_check.go](..%2Finternal%2Fnode_selector_service%2Fchecks%2Fpokt_data_integrity_check%2Fpokt_data_integrity_check.go)
+5. [solana_height_check.go](..%2Finternal%2Fnode_selector_service%2Fchecks%2Fsolana_height_check%2Fsolana_height_check.go)
+6. [solana_data_integrity_check.go](..%2Finternal%2Fnode_selector_service%2Fchecks%2Fsolana_data_integrity_check%2Fsolana_data_integrity_check.go)
 ### Adding custom QoS checks
 
 Every custom check must conform to the `CheckJob` interface. The gateway server provides a base check:
@@ -49,7 +63,7 @@ ChainConfiguration chain_configurations_registry.ChainConfigurationsService
 ```
 that developers should inherit. This base check provides a list of nodes to check and a `PocketRelayer` that allows the developer to send requests to the nodes in the network, and `ChainConfiguration` service that allows for per-chain specific check configurations.
 
-Checks are designed to be opinionated and there are numerous ways to implement whether a node is healthy or not by definition. Therefore, implementing custom QoS checks will be dependent on the chain or data source the developer is looking to support.  For example, the developer may want to send a request to a Solana node with a custom JSON-RPC method to see if the node is synced by using the provided `PocketRelayer` to send a request to the node through Pocket network.
+Checks are designed to be opinionated and there are numerous ways to implement whether a node is healthy or not by definition. Therefore, implementing custom QoS checks will be dependent on the chain or data source the developer is looking to support.  For example, the developer may want to send a request to a custom blockchain node with a custom JSON-RPC method to see if the node is synced by using the provided `PocketRelayer` to send a request to the node through Pocket network.
 If the node is not synced, the developer can set a custom punishment through the various functions exposed in [qos_node.go](..%2Finternal%2Fnode_selector_service%2Fmodels%2Fqos_node.go), such as `SetTimeoutUntil` to punish the node.
 
 Once the developer is finished implementing the CheckJob, they can enable the QoS check by initializing the newly created check into the `enabledChecks` variable inside [node_selector_service.go](..%2Finternal%2Fnode_selector_service%2Fnode_selector_service.go) and are encouraged to open up a PR for inclusion in the official repository.
@@ -58,7 +72,7 @@ Once the developer is finished implementing the CheckJob, they can enable the Qo
 
 - Long term persistent results
     - Pros: More data to work with on determining if a node is healthy
-    - Cons: Expensive, more complex logic, and can be punishing to new node operators
+    - Cons: Expensive, more complex logic (due to geographic regions) and can be punishing to new node operators
 - Rolling up the results for long term storage & historical look back
 
 

diff --git a/docs/quick-onboarding-guide.md b/docs/quick-onboarding-guide.md
@@ -39,17 +39,18 @@ Create an encryption password for your app stake keys. This password will be use
 Fill out the `.env` variables for the gateway server. This can be done by injecting environment variables directly or using a `.env` file.
 
 ### Env Variables Description
-| Variable Name                       | Description                                         | Example Value                                                                                     |
-|-------------------------------------|-----------------------------------------------------|---------------------------------------------------------------------------------------------------|
-| `POKT_RPC_FULL_HOST`                | Used for dispatching sessions                       | `https://pokt-testnet-rpc.nodies.org` (a complimentary testnet dispatcher URL provided by Nodies) |
-| `HTTP_SERVER_PORT`                  | Gateway server port                                 | `8080`                                                                                            |
-| `POKT_RPC_TIMEOUT`                  | Max response time for a POKT node to respond        | `10s`                                                                                             |
-| `ALTRUIST_REQUEST_TIMEOUT`          | Max response time for an altruist backup to respond | `10s`                                                                                             |
-| `ENVIRONMENT_STAGE`                 | Log verbosity                                       | `development`, `production`                                                                       |
-| `SESSION_CACHE_TTL`                 | Duration for sessions to stay in cache              | `75m`                                                                                             |
-| `POKT_APPLICATIONS_ENCRYPTION_KEY`  | User-generated encryption key                       | `a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6`                                                                |
-| `DB_CONNECTION_URL`                 | PostgreSQL Database connection URL                  | `postgres://user:password@localhost:5432/postgres`                                                |
-
+| Variable Name                      | Description                                                | Example Value                                                                                     |
+|------------------------------------|------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
+| `POKT_RPC_FULL_HOST`               | Used for dispatching sessions                              | `https://pokt-testnet-rpc.nodies.org` (a complimentary testnet dispatcher URL provided by Nodies) |
+| `HTTP_SERVER_PORT`                 | Gateway server port                                        | `8080`                                                                                            |
+| `POKT_RPC_TIMEOUT`                 | Max response time for a POKT node to respond               | `10s`                                                                                             |
+| `ALTRUIST_REQUEST_TIMEOUT`         | Max response time for an altruist backup to respond        | `10s`                                                                                             |
+| `ENVIRONMENT_STAGE`                | Log verbosity                                              | `development`, `production`                                                                       |
+| `SESSION_CACHE_TTL`                | Duration for sessions to stay in cache                     | `75m`                                                                                             |
+| `POKT_APPLICATIONS_ENCRYPTION_KEY` | User-generated encryption key                              | `a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6`                                                                |
+| `DB_CONNECTION_URL`                | PostgreSQL Database connection URL                         | `postgres://user:password@localhost:5432/postgres`                                                |
+| `EMIT_SERVICE_URL_PROM_METRICS`    | Boolean flag to enable service url for relay metrics       | `false`, `true`                                                                                   |
+| `CHAIN_NETWORK`                    | Identifies which network the gateway server is running on. | `morse_mainnet`, `morse_testnet`                                                                  |
 See [.env.sample](..%2F.env.sample) for a sample.
 
 ## 4. Run Migration Script

diff --git a/internal/chain_network/chain_network.go b/internal/chain_network/chain_network.go
@@ -0,0 +1,8 @@
+package chain_network
+
+type ChainNetwork string
+
+const (
+	MorseMainnet ChainNetwork = "morse_mainnet"
+	MorseTestnet ChainNetwork = "morse_testnet"
+)
diff --git a/internal/global_config/config_provider.go b/internal/global_config/config_provider.go
@@ -1,6 +1,9 @@
 package global_config
 
-import "time"
+import (
+	"github.com/pokt-network/gateway-server/internal/chain_network"
+	"time"
+)
 
 type EnvironmentStage string
 
@@ -14,6 +17,12 @@ type GlobalConfigProvider interface {
 	EnvironmentProvider
 	PoktNodeConfigProvider
 	AltruistConfigProvider
+	PromMetricsProvider
+	ChainNetworkProvider
+}
+
+type PromMetricsProvider interface {
+	ShouldEmitServiceUrlPromMetrics() bool
 }
 
 type SecretProvider interface {
@@ -37,3 +46,7 @@ type PoktNodeConfigProvider interface {
 type AltruistConfigProvider interface {
 	GetAltruistRequestTimeout() time.Duration
 }
+
+type ChainNetworkProvider interface {
+	GetChainNetwork() chain_network.ChainNetwork
+}
diff --git a/internal/node_selector_service/checks/async_relay_handler.go b/internal/node_selector_service/checks/async_relay_handler.go
@@ -13,7 +13,7 @@ type nodeRelayResponse struct {
 	Error error
 }
 
-func SendRelaysAsync(relayer pokt_v0.PocketRelayer, nodes []*models.QosNode, payload string, method string) chan *nodeRelayResponse {
+func SendRelaysAsync(relayer pokt_v0.PocketRelayer, nodes []*models.QosNode, payload string, method string, path string) chan *nodeRelayResponse {
 	// Define a channel to receive relay responses
 	relayResponses := make(chan *nodeRelayResponse, len(nodes))
 	var wg sync.WaitGroup
@@ -23,7 +23,7 @@ func SendRelaysAsync(relayer pokt_v0.PocketRelayer, nodes []*models.QosNode, pay
 		defer wg.Done()
 		relay, err := relayer.SendRelay(&relayer_models.SendRelayRequest{
 			Signer:             node.GetAppStakeSigner(),
-			Payload:            &relayer_models.Payload{Data: payload, Method: method},
+			Payload:            &relayer_models.Payload{Data: payload, Method: method, Path: path},
 			Chain:              node.GetChain(),
 			SelectedNodePubKey: node.GetPublicKey(),
 			Session:            node.MorseSession,