feat: add functionality to specify a git_ref for gateway probe when b… (#5094)

* feat: add functionality to specify a git_ref for gateway probe when building node status agent

* remove mac specifics

* fix: remove unused part of code, add gateway probe git ref to tag name

* fix: add cleaning gateway probe git ref

* fix: incorrect bash

* fix: incorrect output name

* workflow fix

.github/workflows/push-node-status-agent.yaml

@@ -2,6 +2,10 @@ name: Build and upload Node Status agent container to harbor.nymte.ch
 
 on:
   workflow_dispatch:
+    inputs:
+      gateway_probe_git_ref:
+        type: string
+        description: Which gateway probe git ref to build the image with
 
 env:
   WORKING_DIRECTORY: "nym-node-status-agent"
@@ -32,25 +36,26 @@ jobs:
         with:
           cmd: yq -oy '.package.version' ${{ env.WORKING_DIRECTORY }}/Cargo.toml
 
-      - name: Check if tag exists
+      - name: cleanup-gateway-probe-ref
+        id: cleanup_gateway_probe_ref
         run: |
-          if git rev-parse ${{ steps.get_version.outputs.value }} >/dev/null 2>&1; then
-            echo "Tag ${{ steps.get_version.outputs.value }} already exists"
-          fi
+          GATEWAY_PROBE_GIT_REF=${{ github.event.inputs.gateway_probe_git_ref }}
+          GIT_REF_SLUG="${GATEWAY_PROBE_GIT_REF//\//-}"
+          echo "git_ref=${GIT_REF_SLUG}" >> $GITHUB_OUTPUT
 
       - name: Remove existing tag if exists
         run: |
-          if git rev-parse ${{ env.WORKING_DIRECTORY }}-${{ steps.get_version.outputs.result }} >/dev/null 2>&1; then
-            git push --delete origin ${{ env.WORKING_DIRECTORY }}-${{ steps.get_version.outputs.result }}
-            git tag -d ${{ env.WORKING_DIRECTORY }}-${{ steps.get_version.outputs.result }}
+          if git rev-parse ${{ env.WORKING_DIRECTORY }}-${{ steps.get_version.outputs.result }}-${{ steps.cleanup_gateway_probe_ref.outputs.git_ref }} >/dev/null 2>&1; then
+            git push --delete origin ${{ env.WORKING_DIRECTORY }}-${{ steps.get_version.outputs.result }}-${{ steps.cleanup_gateway_probe_ref.outputs.git_ref }}
+            git tag -d ${{ env.WORKING_DIRECTORY }}-${{ steps.get_version.outputs.result }}-${{ steps.cleanup_gateway_probe_ref.outputs.git_ref }}
           fi
 
       - name: Create tag
         run: |
-          git tag -a ${{ env.WORKING_DIRECTORY }}-${{ steps.get_version.outputs.result }} -m "Version ${{ steps.get_version.outputs.result }}"
-          git push origin ${{ env.WORKING_DIRECTORY }}-${{ steps.get_version.outputs.result }}
+          git tag -a ${{ env.WORKING_DIRECTORY }}-${{ steps.get_version.outputs.result }}-${{ steps.cleanup_gateway_probe_ref.outputs.git_ref }} -m "Version ${{ steps.get_version.outputs.result }}-${{ steps.cleanup_gateway_probe_ref.outputs.git_ref }}"
+          git push origin ${{ env.WORKING_DIRECTORY }}-${{ steps.get_version.outputs.result }}-${{ steps.cleanup_gateway_probe_ref.outputs.git_ref }}
 
       - name: BuildAndPushImageOnHarbor
         run: |
-          docker build -f ${{ env.WORKING_DIRECTORY }}/Dockerfile . -t harbor.nymte.ch/nym/${{ env.CONTAINER_NAME }}:${{ steps.get_version.outputs.result }} -t harbor.nymte.ch/nym/${{ env.CONTAINER_NAME }}:latest
+          docker build --build-arg GIT_REF=${{ github.event.inputs.gateway_probe_git_ref }} -f ${{ env.WORKING_DIRECTORY }}/Dockerfile . -t harbor.nymte.ch/nym/${{ env.CONTAINER_NAME }}:${{ steps.get_version.outputs.result }}-${{ steps.cleanup_gateway_probe_ref.outputs.git_ref }}
           docker push harbor.nymte.ch/nym/${{ env.CONTAINER_NAME }} --all-tags

nym-node-status-agent/Cargo.toml

@@ -4,7 +4,7 @@
 
 [package]
 name = "nym-node-status-agent"
-version = "0.1.5"
+version = "0.1.4-aero-fork"
 authors.workspace = true
 repository.workspace = true
 homepage.workspace = true

nym-node-status-agent/Dockerfile

@@ -1,5 +1,7 @@
 FROM rust:latest AS builder
 
+ARG GIT_REF=main
+
 RUN apt update && apt install -yy libdbus-1-dev pkg-config libclang-dev
 
 # Install go
@@ -7,6 +9,7 @@ RUN wget https://go.dev/dl/go1.22.5.linux-amd64.tar.gz -O go.tar.gz
 RUN tar -xzvf go.tar.gz -C /usr/local
 
 RUN git clone https://github.com/nymtech/nym-vpn-client /usr/src/nym-vpn-client
+RUN cd /usr/src/nym-vpn-client && git checkout $GIT_REF
 ENV PATH=/go/bin:/usr/local/go/bin:$PATH
 WORKDIR /usr/src/nym-vpn-client/nym-vpn-core
 RUN cargo build --release --package nym-gateway-probe

nym-node-status-agent/run.sh

@@ -6,6 +6,8 @@ environment="qa"
 
 source ../envs/${environment}.env
 
+probe_git_ref="0dd5dacdda92b1ddd51cd30a3399515e45613371"
+
 export RUST_LOG="debug"
 
 crate_root=$(dirname $(realpath "$0"))
@@ -18,8 +20,8 @@ export NODE_STATUS_AGENT_PROBE_PATH="$crate_root/nym-gateway-probe"
 # build & copy over GW probe
 function copy_gw_probe() {
     pushd $gateway_probe_src
-    git switch main
-    git pull
+    git fetch -a
+    git checkout $probe_git_ref
     cargo build --release --package nym-gateway-probe
     cp target/release/nym-gateway-probe "$crate_root"
     $crate_root/nym-gateway-probe --version
@@ -48,7 +50,7 @@ function swarm() {
 export NODE_STATUS_AGENT_SERVER_ADDRESS="http://127.0.0.1"
 export NODE_STATUS_AGENT_SERVER_PORT="8000"
 
-copy_gw_probe
+# copy_gw_probe
 
 swarm 8
 

nym-node-status-api/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "nym-node-status-api"
-version = "0.1.6"
+version = "0.1.5-aero-fork"
 authors.workspace = true
 repository.workspace = true
 homepage.workspace = true
@@ -24,10 +24,14 @@ moka = { workspace = true, features = ["future"] }
 nym-bin-common = { path = "../common/bin-common", features = ["models"]}
 nym-common-models = { path = "../common/models" }
 nym-explorer-client = { path = "../explorer-api/explorer-client" }
-nym-network-defaults = { path = "../common/network-defaults" }
-nym-validator-client = { path = "../common/client-libs/validator-client" }
+# TODO temporary for this fork
+# nym-network-defaults = { path = "../common/network-defaults" }
+# nym-validator-client = { path = "../common/client-libs/validator-client" }
+nym-network-defaults = { git = "https://github.com/nymtech/nym", branch = "pre-dir-v2-fork" }
+nym-validator-client = { git = "https://github.com/nymtech/nym", branch = "pre-dir-v2-fork" }
 nym-task = { path = "../common/task" }
-nym-node-requests = { path = "../nym-node/nym-node-requests", features = ["openapi"] }
+# nym-node-requests = { path = "../nym-node/nym-node-requests", features = ["openapi"] }
+nym-node-requests = { git = "https://github.com/nymtech/nym", branch = "pre-dir-v2-fork", features = ["openapi"] }
 regex = { workspace = true }
 reqwest = { workspace = true }
 serde = { workspace = true, features = ["derive"] }

nym-node-status-api/launch_node_status_api.sh

@@ -8,7 +8,7 @@ export NYM_API_CLIENT_TIMEOUT=60
 export EXPLORER_CLIENT_TIMEOUT=60
 export NODE_STATUS_API_TESTRUN_REFRESH_INTERVAL=60
 
-export ENVIRONMENT="qa.env"
+export ENVIRONMENT="mainnet.env"
 
 function run_bare() {
     # export necessary env vars

nym-node-status-api/migrations/000_init.sql

@@ -2,7 +2,7 @@ CREATE TABLE gateways
 (
   id                      INTEGER PRIMARY KEY AUTOINCREMENT,
   gateway_identity_key    VARCHAR NOT NULL UNIQUE,
-  self_described          VARCHAR NOT NULL,
+  self_described          VARCHAR,
   explorer_pretty_bond    VARCHAR,
   last_probe_result       VARCHAR,
   last_probe_log          VARCHAR,

nym-node-status-api/src/db/models.rs

@@ -11,7 +11,7 @@ pub(crate) struct GatewayRecord {
     pub(crate) identity_key: String,
     pub(crate) bonded: bool,
     pub(crate) blacklisted: bool,
-    pub(crate) self_described: String,
+    pub(crate) self_described: Option<String>,
     pub(crate) explorer_pretty_bond: Option<String>,
     pub(crate) last_updated_utc: i64,
     pub(crate) performance: u8,

nym-node-status-api/src/db/queries/gateways.rs

@@ -6,7 +6,7 @@ use crate::{
     http::models::Gateway,
 };
 use futures_util::TryStreamExt;
-use nym_validator_client::models::NymNodeDescription;
+use nym_validator_client::models::DescribedGateway;
 use sqlx::{pool::PoolConnection, Sqlite};
 use tracing::error;
 
@@ -88,13 +88,13 @@ where
 /// Ensure all gateways that are set as bonded, are still bonded
 pub(crate) async fn ensure_gateways_still_bonded(
     pool: &DbPool,
-    gateways: &[&NymNodeDescription],
+    gateways: &[DescribedGateway],
 ) -> anyhow::Result<usize> {
     let bonded_gateways_rows = get_all_bonded_gateways_row_ids_by_status(pool, true).await?;
     let unbonded_gateways_rows = bonded_gateways_rows.iter().filter(|v| {
         !gateways
             .iter()
-            .any(|bonded| *bonded.ed25519_identity_key().to_base58_string() == v.identity_key)
+            .any(|bonded| *bonded.bond.identity() == v.identity_key)
     });
 
     let recently_unbonded_gateways = unbonded_gateways_rows.to_owned().count();

nym-node-status-api/src/monitor/mod.rs

@@ -12,9 +12,7 @@ use cosmwasm_std::Decimal;
 use nym_explorer_client::{ExplorerClient, PrettyDetailedGatewayBond};
 use nym_network_defaults::NymNetworkDetails;
 use nym_validator_client::client::NymApiClientExt;
-use nym_validator_client::models::{
-    LegacyDescribedMixNode, MixNodeBondAnnotated, NymNodeDescription,
-};
+use nym_validator_client::models::{DescribedGateway, DescribedMixNode, MixNodeBondAnnotated};
 use nym_validator_client::nym_nodes::SkimmedNode;
 use nym_validator_client::nyxd::contract_traits::PagedMixnetQueryClient;
 use nym_validator_client::nyxd::{AccountId, NyxdClient};
@@ -95,52 +93,28 @@ async fn run(
     let explorer_client =
         ExplorerClient::new_with_timeout(default_explorer_url, explorer_client_timeout)?;
     let explorer_gateways = explorer_client
-        .unstable_get_gateways()
+        .get_gateways()
         .await
-        .log_error("unstable_get_gateways")?;
+        .log_error("get_gateways")?;
 
     let api_client = NymApiClient::new_with_timeout(default_api_url, nym_api_client_timeout);
 
-    let all_nodes = api_client
-        .get_all_described_nodes()
+    let gateways = api_client
+        .get_cached_described_gateways()
         .await
-        .log_error("get_all_described_nodes")?;
-    tracing::debug!("Fetched {} total nodes", all_nodes.len());
+        .log_error("get_cached_described_gateways")?;
+    tracing::debug!("Fetched {} gateways", gateways.len());
 
-    let gateways = all_nodes
-        .iter()
-        .filter(|node| node.description.declared_role.entry)
-        .collect::<Vec<_>>();
-    tracing::debug!("Of those, {} gateways", gateways.len());
-    for gw in gateways.iter() {
-        tracing::debug!("{}", gw.ed25519_identity_key().to_base58_string());
-    }
-
-    let mixnodes = all_nodes
-        .iter()
-        .filter(|node| node.description.declared_role.mixnode)
-        .collect::<Vec<_>>();
-    tracing::debug!("Of those, {} mixnodes", mixnodes.len());
-
-    log_gw_in_explorer_not_api(explorer_gateways.as_slice(), gateways.as_slice());
-
-    let all_skimmed_nodes = api_client
-        .get_all_basic_nodes(None)
+    let skimmed_gateways = api_client
+        .get_basic_gateways(None)
         .await
-        .log_error("get_all_basic_nodes")?;
+        .log_error("get_basic_gateways")?;
 
-    let mixnodes = api_client
-        .get_cached_mixnodes()
-        .await
-        .log_error("get_cached_mixnodes")?;
-    tracing::debug!("Fetched {} mixnodes", mixnodes.len());
-
-    // let gateways_blacklisted = gateways.iter().filter(|gw|gw.)
-    let gateways_blacklisted = all_skimmed_nodes
+    let gateways_blacklisted = skimmed_gateways
         .iter()
-        .filter_map(|node| {
-            if node.performance.round_to_integer() <= 50 && node.supported_roles.entry {
-                Some(node.ed25519_identity_pubkey.to_base58_string())
+        .filter_map(|gw| {
+            if gw.performance.round_to_integer() <= 50 {
+                Some(gw.ed25519_identity_pubkey.to_owned())
             } else {
                 None
             }
@@ -177,7 +151,7 @@ async fn run(
         &gateways,
         &gateways_blacklisted,
         explorer_gateways,
-        all_skimmed_nodes,
+        skimmed_gateways,
     )?;
     queries::insert_gateways(pool, gateway_records)
         .await
@@ -189,8 +163,8 @@ async fn run(
     let count_gateways_blacklisted = gateways
         .iter()
         .filter(|gw| {
-            let gw_identity = gw.ed25519_identity_key().to_base58_string();
-            gateways_blacklisted.contains(&gw_identity)
+            let gw_identity = gw.bond.identity();
+            gateways_blacklisted.contains(gw_identity)
         })
         .count();
 
@@ -301,7 +275,7 @@ async fn run(
 }
 
 fn prepare_gateway_data(
-    gateways: &[&NymNodeDescription],
+    gateways: &[DescribedGateway],
     gateways_blacklisted: &HashSet<String>,
     explorer_gateways: Vec<PrettyDetailedGatewayBond>,
     skimmed_gateways: Vec<SkimmedNode>,
@@ -309,25 +283,24 @@ fn prepare_gateway_data(
     let mut gateway_records = Vec::new();
 
     for gateway in gateways {
-        let identity_key = gateway.ed25519_identity_key().to_base58_string();
+        let identity_key = gateway.bond.identity();
         let bonded = true;
         let last_updated_utc = chrono::offset::Utc::now().timestamp();
-        let blacklisted = gateways_blacklisted.contains(&identity_key);
+        let blacklisted = gateways_blacklisted.contains(identity_key);
 
-        let self_described = serde_json::to_string(&gateway.description)?;
+        let self_described = gateway
+            .self_described
+            .as_ref()
+            .and_then(|v| serde_json::to_string(&v).ok());
 
         let explorer_pretty_bond = explorer_gateways
             .iter()
-            .find(|g| g.gateway.identity_key.eq(&identity_key));
+            .find(|g| g.gateway.identity_key.eq(identity_key));
         let explorer_pretty_bond = explorer_pretty_bond.and_then(|g| serde_json::to_string(g).ok());
 
         let performance = skimmed_gateways
             .iter()
-            .find(|g| {
-                g.ed25519_identity_pubkey
-                    .to_base58_string()
-                    .eq(&identity_key)
-            })
+            .find(|g| g.ed25519_identity_pubkey.eq(identity_key))
             .map(|g| g.performance)
             .unwrap_or_default()
             .round_to_integer();
@@ -348,7 +321,7 @@ fn prepare_gateway_data(
 
 fn prepare_mixnode_data(
     mixnodes: &[MixNodeBondAnnotated],
-    mixnodes_described: Vec<LegacyDescribedMixNode>,
+    mixnodes_described: Vec<DescribedMixNode>,
     delegation_program_members: Vec<u32>,
 ) -> anyhow::Result<Vec<MixnodeRecord>> {
     let mut mixnode_records = Vec::new();
@@ -389,28 +362,6 @@ fn prepare_mixnode_data(
     Ok(mixnode_records)
 }
 
-fn log_gw_in_explorer_not_api(
-    explorer: &[PrettyDetailedGatewayBond],
-    api_gateways: &[&NymNodeDescription],
-) {
-    let api_gateways = api_gateways
-        .iter()
-        .map(|gw| gw.ed25519_identity_key().to_base58_string())
-        .collect::<HashSet<_>>();
-    let explorer_only = explorer
-        .iter()
-        .filter(|gw| !api_gateways.contains(&gw.gateway.identity_key.to_string()))
-        .collect::<Vec<_>>();
-
-    tracing::debug!(
-        "Gateways listed by explorer but not by Nym API: {}",
-        explorer_only.len()
-    );
-    for gw in explorer_only.iter() {
-        tracing::debug!("{}", gw.gateway.identity_key.to_string());
-    }
-}
-
 // TODO dz is there a common monorepo place this can be put?
 pub trait NumericalCheckedCast<T>
 where
@@ -470,7 +421,7 @@ async fn get_delegation_program_details(
 
     let mix_ids: Vec<u32> = delegations
         .iter()
-        .map(|delegation| delegation.node_id)
+        .map(|delegation| delegation.mix_id)
         .collect();
 
     Ok(mix_ids)