MASQ-Project
diff --git a/‎.githooks/pre-commit‎
Lines changed: 32 additions & 0 deletions b/‎.githooks/pre-commit‎
Lines changed: 32 additions & 0 deletions
diff --git a/‎.github/workflows/ci-matrix.yml‎
Lines changed: 41 additions & 27 deletions b/‎.github/workflows/ci-matrix.yml‎
Lines changed: 41 additions & 27 deletions
diff --git a/‎.github/workflows/dbip_download.yml‎
Lines changed: 4 additions & 9 deletions b/‎.github/workflows/dbip_download.yml‎
Lines changed: 4 additions & 9 deletions
diff --git a/‎.idea/modules.xml‎
Lines changed: 2 additions & 0 deletions b/‎.idea/modules.xml‎
Lines changed: 2 additions & 0 deletions
diff --git a/‎USER-INTERFACE-INTERFACE.md‎
Lines changed: 69 additions & 0 deletions b/‎USER-INTERFACE-INTERFACE.md‎
Lines changed: 69 additions & 0 deletions
@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# File to check (relative to repo root)
+FILENAME="ip_country/src/dbip_country.rs"
+
+if ! git diff --cached --name-only | grep -q "^$FILENAME$"; then
+  exit 0
+fi
+
+# find 'Nonexistents' country in dbip_country.rs
+@cat "$FILENAME" | grep '("NOEX", "Nonexistent")'
+NONEXISTENT=$?
+
+# Get local file size (staged version, not working copy)
+LOCAL_SIZE=$(git ls-files --stage | grep "$FILENAME" | awk '{print $2}' | xargs git cat-file -s)
+
+if [[ $LOCAL_SIZE -gt 1000000 || NONEXISTENT -gt 0 ]]; then
+  if [[ $LOCAL_SIZE -gt 1000000 ]]; then
+    echo "❌ Commit blocked: $FILENAME size it not dev version, we want to keep dev version under 1 MB."
+    echo "   Local file size:  $LOCAL_SIZE bytes"
+  fi
+  if [[ $NONEXISTENT -gt 0 ]]; then
+    echo "❌ Commit blocked: Dev file  must contain '(\"NOEX\", \"Nonexistents\")' country"
+  fi
+  echo ""
+  echo " ⚡  Please sync the file with the remote before committing using:"
+  echo "      git checkout HEAD -- ip_country/src/dbip_country.rs"
+  exit 1
+fi
+
+# All good
+exit 0
@@ -20,7 +20,7 @@ jobs:
     name: Build node on ${{ matrix.target.os }}
     runs-on: ${{ matrix.target.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.sha }}
 
@@ -36,7 +36,8 @@ jobs:
           toolchain: 1.63.0
           components: rustfmt, clippy
           override: true
-      - uses: actions/cache@v3
+
+      - uses: actions/cache@v4
         with:
           path: |
             ~/.cargo/bin/
@@ -45,10 +46,13 @@ jobs:
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
             target/
-          key: ${{ runner.os }}-cargo
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-cargo-
 
       - name: Build ${{ matrix.target.os }}
         run: |
+          git fetch
           ./ci/all.sh
           ./ci/multinode_integration_test.sh
           ./ci/collect_results.sh
@@ -59,49 +63,59 @@ jobs:
         with:
           name: Node-${{ matrix.target.name }}
           path: results
-
+      - name: diagnostics
+        if: failure()
+        run: |
+          echo "final disc diagnostics ------>"
+          df -h /Users/runner/work/Node/Node/node/target/release
   deploy_to_s3:
     needs: build
+    if: success() && (startsWith(github.head_ref, 'GH') || startsWith(github.head_ref, 'v'))
     strategy:
       matrix:
-          os: [linux, macos, windows]
-    runs-on: ubuntu-22.04
+        os: [linux, macos, windows]
+    runs-on: ubuntu-latest
     steps:
-        - uses: actions/checkout@v3
+        - uses: actions/checkout@v4
           with:
             ref: ${{ github.event.pull_request.head.sha }}
+            fetch-depth: 1
 
         - name: Download artifacts
           uses: actions/download-artifact@v4
 
         - name: Display structure of downloaded files
           run: ls -R
 
+        - name: Check artifacts exist
+          run: |
+            if [ ! -d "Node-${{ matrix.os }}/generated/bin/" ]; then
+              echo "Error: Build artifacts not found"
+              exit 1
+            fi
+
+        - name: Configure AWS Credentials
+          uses: aws-actions/configure-aws-credentials@v4
+          with:
+            aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+            aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+            aws-region: us-west-2
+
         - if: startsWith(github.head_ref, 'GH')
           name: Versioned S3 Sync
-          uses: jakejarvis/[email protected]
-          with:
-           args: --acl private --follow-symlinks --delete
-          env:
-            AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
-            AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-            AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-            AWS_REGION: 'us-west-2'
-            DEST_DIR: 'Node/${{ github.head_ref }}/Node-${{ matrix.os }}'
-            SOURCE_DIR: 'Node-${{ matrix.os }}/generated/bin/'
+          run: |
+            aws s3 sync "Node-${{ matrix.os }}/generated/bin/" "s3://${{ secrets.AWS_S3_BUCKET }}/Node/${{ github.head_ref }}/Node-${{ matrix.os }}" \
+              --delete \
+              --no-progress \
+              --acl private
 
         - if: startsWith(github.head_ref, 'v')
           name: Latest S3 Sync
-          uses: jakejarvis/[email protected]
-          with:
-           args: --acl private --follow-symlinks --delete
-          env:
-            AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
-            AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-            AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-            AWS_REGION: 'us-west-2'
-            DEST_DIR: 'Node/latest/Node-${{ matrix.os }}'
-            SOURCE_DIR: 'Node-${{ matrix.os }}/generated/bin/'
+          run: |
+            aws s3 sync "Node-${{ matrix.os }}/generated/bin/" "s3://${{ secrets.AWS_S3_BUCKET }}/Node/latest/Node-${{ matrix.os }}" \
+              --delete \
+              --no-progress \
+              --acl private
 
         - name: Invalidate Binaries CloudFront
           uses: chetan/[email protected]
 
@@ -1,9 +1,8 @@
 name: Download DBIP data and generate dbip_country.rs
 
 on:
-  workflow_dispatch:
-#  schedule:
-#    - cron: "0 0 * * *" # Runs at midnight on the 3rd of every month
+  schedule:
+    - cron: "0 0 3 * *" # Runs at midnight on the 3rd of every month
 
 env:
   TEMP_DIR: '/tmp'
@@ -26,26 +25,22 @@ jobs:
 
       - name: Download DBIP data in MMDB format
         run: |
-          set -xv
           export YEAR_MONTH=$(date +%Y-%m)
           echo "TEMP_DIR=$(mktemp -d)" >> $GITHUB_ENV
           echo "YEAR_MONTH=$YEAR_MONTH" >> $GITHUB_ENV
-          git clone https://github.com/MASQ-Project/DBIP-Experiment.git dbipexperiment
-          cd dbipexperiment/ip_country
+          cd ip_country
           mkdir -p dbip-data
           curl -L -o dbip-data/dbip-country-lite.mmdb.gz "https://download.db-ip.com/free/dbip-country-lite-$YEAR_MONTH.mmdb.gz"
           gunzip dbip-data/dbip-country-lite.mmdb.gz
 
       - name: Generate Rust source file
         run: |
-          set -xv
-          cd dbipexperiment/ip_country
+          cd ip_country
           cargo run < "dbip-data/dbip-country-lite.mmdb" > "$TEMP_DIR"/dbip_country.rs
           ls "$TEMP_DIR"
 
       - name: Commit and push generated file
         run: |
-          set -xv
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
           git fetch
 
@@ -590,6 +590,75 @@ descriptor (for example, if it's still waiting on the router to get a public IP
 Node descriptor (for example, if its neighborhood mode is not Standard), the `nodeDescriptorOpt`
 field will be null or absent.
 
+#### `exit-location`
+##### Direction: Request
+##### Correspondent: Node
+##### Layout:
+```
+"payload": {
+    "fallbackRouting": <boolean>,
+    "exitLocations": [
+            {
+                "countryCodes": [string, ..],
+                "priority": <positive integer> 
+            },
+        ],  
+    "showCountries": <boolean>
+}
+```
+##### Description:
+This command requests information about the countries available for exit in our neighborhood and allows us to set up the 
+desired locations with their priority. The priority provides the node's perspective on how important a particular country 
+is for our preferences.
+
+This command can be used in two ways which can't be combined:
+1. If we use the command with showCountries set to true.
+2. If we want to set an exit location.
+
+In case 1. it retrieves information about the available countries in our neighborhood. Other parameters are 
+ignored.
+
+In case 2. we must set showCountries to false and then configure fallbackRouting and exitLocations with our preferences.
+
+The `fallbackRouting` parameter is defaulted as `false`, if not provided. Determines whether we want to block exit for a particular 
+country. If parameter is `false` and requested country is no longer available, the route to exit will fail during construction. 
+If is set to `true`, we can exit through any available country if none of our specified exitLocations are accessible.
+
+Priorities are used to determine the preferred exit countries. Priority 1 is the highest, while higher numbers indicate 
+lower priority. For example, if we specify DE with priority 1 and FR with priority 2, then an exit through France will 
+only be used if a German exit is unavailable or significantly more expensive.
+
+#### `exit-location`
+##### Direction: Response
+##### Correspondent: UI
+##### Layout:
+
+```
+"payload": {
+    "fallbackRouting": <boolean>,
+    "exitCountrySelection": <[
+            {
+                "countryCodes": [string, ..],
+                "priority": <positive integer> 
+            },
+        ]>,
+    "missingCountries": <[string, ..]>
+    "exitCountries": <optional[string, ..]>
+}
+```
+##### Description:
+In response, the Node sends a payload to the UI that contains either the Exit Location settings (which may include missing 
+countries) or a list of exit countries.
+
+Exit Location settings consist of fallbackRouting, exitCountrySelection, and missingCountries, where:
+1. fallbackRouting is a boolean representing the user's choice to enable or disable fallback routing within the neighborhood. 
+2. exitCountrySelection is an array of objects, where each object represents a set of country codes along with their assigned priority. 
+3. missingCountries is an array of strings representing a list of countries that are currently unavailable in the Node's Neighborhood Database.
+
+Exit Countries (or exitCountries) is an optional array containing ISO country code strings. These represent the countries 
+currently available in the Node's Neighborhood Database. The user can select from these countries to configure the Exit 
+Location settings.
+
 #### `financials`
 ##### Direction: Request
 ##### Correspondent: Node