sandbox nyx rest api

* + add header into Packet Mixing docs

* + add head changes for testing

* / updated version of metatags in theme.config

* + add env file

* / theme.config to use NEXT_PUBLIC_SITE_URL from env file

* @ Fix broken link in theme.config

* - remove favicon code

* + add desription for intro pages

.dockerignore

@@ -4,4 +4,3 @@
 **/node_modules
 **/target
 dist
-documentation

.gitattributes

@@ -0,0 +1 @@
+nym-validator-rewarder/.sqlx/** diff=nodiff

.github/workflows/publish-nyms5-android-apk.yml

@@ -56,14 +56,6 @@ jobs:
           rustup target add aarch64-linux-android \
             x86_64-linux-android
 
-      - name: Build lib nym-socks5-listener
-        working-directory: sdk/lib/socks5-listener/
-        env:
-          RELEASE: true
-          RUSTFLAGS: "-C link-args=-Wl,--hash-style=gnu"
-        # build for arm64 and x86_64
-        run: ./build-android.sh aarch64 x86_64
-
       - name: Build APKs (unsigned)
         working-directory: nym-connect/native/android
         env:

.redocly.lint-ignore.yaml

@@ -0,0 +1,49 @@
+# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.
+# See https://redocly.com/docs/cli/ for more information.
+formatted-openapi.json:
+  path-parameters-defined:
+    # - >-
+    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/0/name
+    # - >-
+    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/1/name
+    # - >-
+    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/2/name
+    # - >-
+    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/3/name
+    # - >-
+    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/4/name
+    # - >-
+    #   #/paths/~1v1~1status~1mixnode~1{mix_id}~1compute-reward-estimation/post/parameters/5/name
+    # - '#/paths/~1v1~1unstable~1nym-nodes~1skimmed~1active/get/parameters/0/name'
+    # - '#/paths/~1v1~1unstable~1nym-nodes~1skimmed~1active/get/parameters/1/name'
+    # - '#/paths/~1v1~1unstable~1nym-nodes~1skimmed~1active/get/parameters/2/name'
+    # - '#/paths/~1v1~1unstable~1nym-nodes~1skimmed~1active/get/parameters/3/name'
+  operation-operationId-unique:
+    - >-
+      #/paths/~1v1~1status~1mixnodes~1active~1detailed/get/get_active_set_detailed
+    - '#/paths/~1v1~1status~1mixnodes~1detailed/get/get_mixnodes_detailed'
+    - >-
+      #/paths/~1v1~1status~1mixnodes~1rewarded~1detailed/get/get_rewarded_set_detailed
+  no-unused-components:
+    - '#/components/schemas/AxumErrorResponse'
+    - '#/components/schemas/DateQuery'
+    - '#/components/schemas/EcashTicketVerificationRejection'
+    - '#/components/schemas/ExpirationDatePathParam'
+    - '#/components/schemas/FullFatNode'
+    - '#/components/schemas/HistoricalPerformanceResponse'
+    - '#/components/schemas/HistoricalUptimeResponse'
+    - '#/components/schemas/MasterVerificationKeyResponse'
+    - '#/components/schemas/MixnodeStatusReport'
+    - '#/components/schemas/NodeId'
+    - '#/components/schemas/NodeRoleQueryParam'
+    - '#/components/schemas/NoiseDetails'
+    - '#/components/schemas/NymNodeDescription'
+    - '#/components/schemas/NymNodeDetails'
+    - '#/components/schemas/PaginationRequest'
+    - '#/components/schemas/PartialCoinIndicesSignatureResponse'
+    - '#/components/schemas/SpentCredentialsResponse'
+    - '#/components/schemas/UptimeHistoryResponse'
+    - '#/components/schemas/VerifyEcashCredentialBody'
+    - '#/components/responses/AxumErrorResponse'
+    - '#/components/responses/CirculatingSupplyResponse'
+    - '#/components/responses/RequestError'

.redocly.yaml

@@ -0,0 +1,83 @@
+extends:
+  - minimal
+apis:
+  nym-api:
+    root: ./formatted-openapi.json
+rules:
+  # https://redocly.com/docs/cli/rules/oas/operation-summary
+  operation-summary: off
+  # https://redocly.com/docs/cli/rules/oas/security-defined
+  security-defined: off
+  struct: off
+  # https://redocly.com/docs/cli/rules/oas/operation-2xx-response
+  operation-2xx-response: off
+# rules:
+#   skip-warnings: true
+  # ignore:
+  # - path: /v1/gateways
+  #   method: get
+  # - path: /v1/gateways/blacklisted
+  #   method: get
+  # - path: /v1/mixnodes
+  #   method: get
+  # - path: /v1/mixnodes/active
+  #   method: get
+  # - path: /v1/mixnodes/active/detailed
+  #   method: get
+  # - path: /v1/mixnodes/blacklisted
+  #   method: get
+  # - path: /v1/mixnodes/detailed
+  #   method: get
+  # - path: /v1/mixnodes/rewarded
+  #   method: get
+  # - path: /v1/mixnodes/rewarded/detailed
+  #   method: get
+  # - path: /v1/gateways/described
+  #   method: get
+  # # network-monitor-status (deprecated)
+  # - path: /v1/status/gateway/{identity}/avg_uptime
+  #   method: GET
+  # - path: /v1/status/gateway/{identity}/core-status-count
+  #   method: GET
+  # - path: /v1/status/gateway/{identity}/history
+  #   method: GET
+  # - path: /v1/status/gateway/{identity}/report
+  #   method: GET
+  # - path: /v1/status/gateways/detailed
+  #   method: GET
+  # - path: /v1/status/gateways/detailed-unfiltered
+  #   method: GET
+  # - path: /v1/status/mixnode/{mix_id}/avg_uptime
+  #   method: GET
+  # - path: /v1/status/mixnode/{mix_id}/compute-reward-estimation
+  #   method: POST
+  # - path: /v1/status/mixnode/{mix_id}/core-status-count
+  #   method: GET
+  # - path: /v1/status/mixnode/{mix_id}/history
+  #   method: GET
+  # - path: /v1/status/mixnode/{mix_id}/report
+  #   method: GET
+  # - path: /v1/status/mixnode/{mix_id}/reward-estimation
+  #   method: GET
+  # - path: /v1/status/mixnodes/detailed-unfiltered
+  #   method: GET
+  # # status
+  # - path: /v1/status/mixnode/{mix_id}/inclusion-probability
+  #   method: GET
+  # - path: /v1/status/mixnode/{mix_id}/stake-saturation
+  #   method: GET
+  # - path: /v1/status/mixnode/{mix_id}/status
+  #   method: GET
+  # - path: /v1/status/mixnodes/active/detailed
+  #   method: GET
+  # - path: /v1/status/mixnodes/detailed
+  #   method: GET
+  # - path: /v1/status/mixnodes/inclusion-probability
+  #   method: GET
+  # - path: /v1/status/mixnodes/rewarded/detailed
+  #   method: GET
+  # # unstable nym nodes
+  # - path: /v1/unstable/nym-nodes/gateways/skimmed
+  #   method: get
+  # - path: /v1/unstable/nym-nodes/mixnodes/skimmed
+  #   method: get

CHANGELOG.md

@@ -4,6 +4,148 @@ Post 1.0.0 release, the changelog format is based on [Keep a Changelog](https://
 
 ## [Unreleased]
 
+## [2024.14-crunch] (2024-12-11)
+
+- Merge/release/2024.14-crunch ([#5242])
+- bugfix: added explicit openapi servers to account for route prefixes ([#5237])
+- Further config score adjustments ([#5225])
+- feature: remve any filtering on node semver ([#5224])
+- Backport #5218 ([#5220])
+- Derive serialize for UserAgent (#5210) ([#5217])
+- dont consider legacy nodes for rewarded set selection ([#5215])
+- introduce UNSTABLE endpoints for returning network monitor run details ([#5214])
+- Nmv2 add debug config ([#5212])
+- nym-api NMv1 adjustments ([#5209])
+- adjusted config score penalty calculation ([#5206])
+- Fix backwards compat mac generation ([#5202])
+- merge crunch into develop ([#5199])
+- Update Security disclosure email, public key and policy ([#5195])
+- Guard storage access with cache ([#5193])
+- chore: apply 1.84 linter suggestions ([#5192])
+- improvement: make internal gateway clients use the same topology cache ([#5191])
+- Bugfix/credential proxy sequencing ([#5187])
+- Add monitor_run and testing_route indexes ([#5182])
+- Add indexes to monitor run and testing route ([#5181])
+- bugfix: fixed nym-node config migrations (again) ([#5179])
+- bugfix: use default value for verloc config when deserialising missing values ([#5177])
+- Remove peers with no allowed ip from storage ([#5175])
+- Move two minor jobs to free tier github hosted runners ([#5169])
+- Add support for DELETE to nym-http-api-client ([#5166])
+- Fix env var name ([#5165])
+- Add strum::EnumIter for TicketType ([#5164])
+- Add export_to_env to NymNetworkDetails ([#5162])
+- bugfix: correctly expose ecash-related data on nym-api ([#5155])
+- fix: validator-rewarder GH job ([#5151])
+- build(deps): bump cross-spawn from 7.0.3 to 7.0.6 in /testnet-faucet ([#5150])
+- build(deps): bump mikefarah/yq from 4.44.3 to 4.44.5 ([#5149])
+- start session collection for exit gateways ([#5148])
+- add version to clientStatsReport ([#5147])
+- update serde_json_path due to compilation issue ([#5144])
+- chore: remove standalone legacy mixnode/gateway binaries ([#5135])
+- [Product Data] Set up country reporting from vpn-client ([#5134])
+- removed ci-nym-api-tests.yml which was running outdated (and broken) tests ([#5133])
+- CI: reduce jobs running on cluster ([#5132])
+- [DOCS/operators]: Release changes v2024.13-magura & Tokenomics pages v1.0 ([#5128])
+- NS Agent auth with NS API ([#5127])
+- [Product Data] Config deserialization bug fix ([#5126])
+- bugfix: don't send empty BankMsg in ecash contract ([#5121])
+- [Product data] Data consumption with ecash ticket ([#5120])
+- feat: add GH workflow for nym-validator-rewarder ([#5119])
+- feat: add Dockerfile and add env vars for clap arguments ([#5118])
+- feature: config score ([#5117])
+- [Product Data] Add stats reporting configuration in client config  ([#5115])
+- Correct IPv6 address generation ([#5113])
+- feature: rewarding for ticketbook issuance ([#5112])
+- Add granular log on nym-node ([#5111])
+- Send mixnet packet stats using task client ([#5109])
+- Expose time range ([#5108])
+- [Product Data] Client-side stats collection  ([#5107])
+- chore: ecash contract migration to remove unused 'redemption_gateway_share' ([#5104])
+- [Product Data] Better unique user count on gateways ([#5084])
+- feat: add nym node GH workflow ([#5080])
+- IPv6 support for wireguard ([#5059])
+- Node Status API ([#5050])
+- Authenticator CLI client mode ([#5044])
+- Integrate nym-credential-proxy into workspace ([#5027])
+- [Product Data] Introduce data persistence on gateways ([#5022])
+- Bump the patch-updates group across 1 directory with 10 updates ([#5011])
+- build(deps): bump once_cell from 1.19.0 to 1.20.2 ([#4952])
+- Create TaskStatusEvent trait instead of piggybacking on Error ([#4919])
+- build(deps): bump lazy_static from 1.4.0 to 1.5.0 ([#4913])
+- Sync code with .env in build.rs ([#4876])
+- build(deps): bump axios from 1.6.0 to 1.7.5 in /nym-api/tests ([#4790])
+- Bump elliptic from 6.5.4 to 6.5.7 in /testnet-faucet ([#4768])
+
+[#5242]: https://github.com/nymtech/nym/pull/5242
+[#5237]: https://github.com/nymtech/nym/pull/5237
+[#5225]: https://github.com/nymtech/nym/pull/5225
+[#5224]: https://github.com/nymtech/nym/pull/5224
+[#5220]: https://github.com/nymtech/nym/pull/5220
+[#5217]: https://github.com/nymtech/nym/pull/5217
+[#5215]: https://github.com/nymtech/nym/pull/5215
+[#5214]: https://github.com/nymtech/nym/pull/5214
+[#5212]: https://github.com/nymtech/nym/pull/5212
+[#5209]: https://github.com/nymtech/nym/pull/5209
+[#5206]: https://github.com/nymtech/nym/pull/5206
+[#5202]: https://github.com/nymtech/nym/pull/5202
+[#5199]: https://github.com/nymtech/nym/pull/5199
+[#5195]: https://github.com/nymtech/nym/pull/5195
+[#5193]: https://github.com/nymtech/nym/pull/5193
+[#5192]: https://github.com/nymtech/nym/pull/5192
+[#5191]: https://github.com/nymtech/nym/pull/5191
+[#5187]: https://github.com/nymtech/nym/pull/5187
+[#5182]: https://github.com/nymtech/nym/pull/5182
+[#5181]: https://github.com/nymtech/nym/pull/5181
+[#5179]: https://github.com/nymtech/nym/pull/5179
+[#5177]: https://github.com/nymtech/nym/pull/5177
+[#5175]: https://github.com/nymtech/nym/pull/5175
+[#5169]: https://github.com/nymtech/nym/pull/5169
+[#5166]: https://github.com/nymtech/nym/pull/5166
+[#5165]: https://github.com/nymtech/nym/pull/5165
+[#5164]: https://github.com/nymtech/nym/pull/5164
+[#5162]: https://github.com/nymtech/nym/pull/5162
+[#5155]: https://github.com/nymtech/nym/pull/5155
+[#5151]: https://github.com/nymtech/nym/pull/5151
+[#5150]: https://github.com/nymtech/nym/pull/5150
+[#5149]: https://github.com/nymtech/nym/pull/5149
+[#5148]: https://github.com/nymtech/nym/pull/5148
+[#5147]: https://github.com/nymtech/nym/pull/5147
+[#5144]: https://github.com/nymtech/nym/pull/5144
+[#5135]: https://github.com/nymtech/nym/pull/5135
+[#5134]: https://github.com/nymtech/nym/pull/5134
+[#5133]: https://github.com/nymtech/nym/pull/5133
+[#5132]: https://github.com/nymtech/nym/pull/5132
+[#5128]: https://github.com/nymtech/nym/pull/5128
+[#5127]: https://github.com/nymtech/nym/pull/5127
+[#5126]: https://github.com/nymtech/nym/pull/5126
+[#5121]: https://github.com/nymtech/nym/pull/5121
+[#5120]: https://github.com/nymtech/nym/pull/5120
+[#5119]: https://github.com/nymtech/nym/pull/5119
+[#5118]: https://github.com/nymtech/nym/pull/5118
+[#5117]: https://github.com/nymtech/nym/pull/5117
+[#5115]: https://github.com/nymtech/nym/pull/5115
+[#5113]: https://github.com/nymtech/nym/pull/5113
+[#5112]: https://github.com/nymtech/nym/pull/5112
+[#5111]: https://github.com/nymtech/nym/pull/5111
+[#5109]: https://github.com/nymtech/nym/pull/5109
+[#5108]: https://github.com/nymtech/nym/pull/5108
+[#5107]: https://github.com/nymtech/nym/pull/5107
+[#5104]: https://github.com/nymtech/nym/pull/5104
+[#5084]: https://github.com/nymtech/nym/pull/5084
+[#5080]: https://github.com/nymtech/nym/pull/5080
+[#5059]: https://github.com/nymtech/nym/pull/5059
+[#5050]: https://github.com/nymtech/nym/pull/5050
+[#5044]: https://github.com/nymtech/nym/pull/5044
+[#5027]: https://github.com/nymtech/nym/pull/5027
+[#5022]: https://github.com/nymtech/nym/pull/5022
+[#5011]: https://github.com/nymtech/nym/pull/5011
+[#4952]: https://github.com/nymtech/nym/pull/4952
+[#4919]: https://github.com/nymtech/nym/pull/4919
+[#4913]: https://github.com/nymtech/nym/pull/4913
+[#4876]: https://github.com/nymtech/nym/pull/4876
+[#4790]: https://github.com/nymtech/nym/pull/4790
+[#4768]: https://github.com/nymtech/nym/pull/4768
+
 ## [2024.13-magura-drift] (2024-11-29)
 
 - Optimised syncing bandwidth information to storage

Cargo.lock

@@ -140,23 +140,6 @@ version = "0.1.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "e999941b234f3131b00bc13c22d06e8c5ff726d1b6318ac7eb276997bbb4fef0"
 
-[[package]]
-name = "android_log-sys"
-version = "0.3.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5ecc8056bf6ab9892dcd53216c83d1597487d7dacac16c8df6b877d127df9937"
-
-[[package]]
-name = "android_logger"
-version = "0.14.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "05b07e8e73d720a1f2e4b6014766e6039fd2e96a4fa44e2a78d0e1fa2ff49826"
-dependencies = [
- "android_log-sys",
- "env_filter",
- "log",
-]
-
 [[package]]
 name = "android_system_properties"
 version = "0.1.5"
@@ -430,6 +413,14 @@ version = "1.3.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "0c4b4d0bd25bd0b74681c0ad21497610ce1b7c91b1022cd21c80c6fbdd9476b0"
 
+[[package]]
+name = "autodoc"
+version = "0.1.0"
+dependencies = [
+ "env_logger 0.11.5",
+ "log",
+]
+
 [[package]]
 name = "axum"
 version = "0.6.20"
@@ -973,12 +964,6 @@ dependencies = [
  "serde",
 ]
 
-[[package]]
-name = "cesu8"
-version = "1.1.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6d43a04d8753f35258c91f8ec639f792891f748a1edbd759cf1dcea3382ad83c"
-
 [[package]]
 name = "cfg-if"
 version = "1.0.0"
@@ -1174,16 +1159,6 @@ dependencies = [
  "windows-sys 0.48.0",
 ]
 
-[[package]]
-name = "combine"
-version = "4.6.7"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ba5a308b75df32fe02788e748662718f03fde005016435c444eea572398219fd"
-dependencies = [
- "bytes",
- "memchr",
-]
-
 [[package]]
 name = "comfy-table"
 version = "7.1.1"
@@ -2354,6 +2329,19 @@ dependencies = [
  "termcolor",
 ]
 
+[[package]]
+name = "env_logger"
+version = "0.11.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e13fa619b91fb2381732789fc5de83b45675e882f66623b7d8cb4f643017018d"
+dependencies = [
+ "anstream",
+ "anstyle",
+ "env_filter",
+ "humantime 2.1.0",
+ "log",
+]
+
 [[package]]
 name = "envy"
 version = "0.4.2"
@@ -2461,26 +2449,6 @@ dependencies = [
  "tokio",
 ]
 
-[[package]]
-name = "ext-trait"
-version = "1.0.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d772df1c1a777963712fb68e014235e80863d6a91a85c4e06ba2d16243a310e5"
-dependencies = [
- "ext-trait-proc_macros",
-]
-
-[[package]]
-name = "ext-trait-proc_macros"
-version = "1.0.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1ab7934152eaf26aa5aa9f7371408ad5af4c31357073c9e84c3b9d7f11ad639a"
-dependencies = [
- "proc-macro2",
- "quote",
- "syn 1.0.109",
-]
-
 [[package]]
 name = "extension-storage"
 version = "1.3.0-rc.0"
@@ -2497,21 +2465,6 @@ dependencies = [
  "zeroize",
 ]
 
-[[package]]
-name = "extension-traits"
-version = "1.0.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a296e5a895621edf9fa8329c83aa1cb69a964643e36cf54d8d7a69b789089537"
-dependencies = [
- "ext-trait",
-]
-
-[[package]]
-name = "extern-c"
-version = "0.1.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "320bea982e85d42441eb25c49b41218e7eaa2657e8f90bc4eca7437376751e23"
-
 [[package]]
 name = "eyre"
 version = "0.6.12"
@@ -3709,28 +3662,6 @@ version = "1.0.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b"
 
-[[package]]
-name = "jni"
-version = "0.21.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1a87aa2bb7d2af34197c04845522473242e1aa17c12f4935d5856491a7fb8c97"
-dependencies = [
- "cesu8",
- "cfg-if",
- "combine",
- "jni-sys",
- "log",
- "thiserror",
- "walkdir",
- "windows-sys 0.45.0",
-]
-
-[[package]]
-name = "jni-sys"
-version = "0.3.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8eaf4bc02d17cbdd7ff4c7438cafcdf7fb9a4613313ad11b4f8fefe7d3fa0130"
-
 [[package]]
 name = "js-sys"
 version = "0.3.72"
@@ -3899,6 +3830,12 @@ dependencies = [
  "scopeguard",
 ]
 
+[[package]]
+name = "lockfree-object-pool"
+version = "0.1.6"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9374ef4228402d4b7e403e5838cb880d9ee663314b0a900d5a6aabf0c213552e"
+
 [[package]]
 name = "log"
 version = "0.4.22"
@@ -3920,22 +3857,6 @@ dependencies = [
  "tracing-subscriber",
 ]
 
-[[package]]
-name = "macro_rules_attribute"
-version = "0.1.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cf0c9b980bf4f3a37fd7b1c066941dd1b1d0152ce6ee6e8fe8c49b9f6810d862"
-dependencies = [
- "macro_rules_attribute-proc_macro",
- "paste",
-]
-
-[[package]]
-name = "macro_rules_attribute-proc_macro"
-version = "0.1.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "58093314a45e00c77d5c508f76e77c3396afbbc0d01506e7fae47b018bac2b1d"
-
 [[package]]
 name = "macroific"
 version = "1.3.1"
@@ -4434,27 +4355,6 @@ dependencies = [
  "libc",
 ]
 
-[[package]]
-name = "num_enum"
-version = "0.7.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4e613fc340b2220f734a8595782c551f1250e969d87d3be1ae0579e8d4065179"
-dependencies = [
- "num_enum_derive",
-]
-
-[[package]]
-name = "num_enum_derive"
-version = "0.7.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "af1844ef2428cc3e1cb900be36181049ef3d3193c63e43026cfe202983b27a56"
-dependencies = [
- "proc-macro-crate",
- "proc-macro2",
- "quote",
- "syn 2.0.90",
-]
-
 [[package]]
 name = "num_threads"
 version = "0.1.7"
@@ -4695,7 +4595,6 @@ dependencies = [
  "opentelemetry-jaeger",
  "pretty_env_logger",
  "schemars",
- "semver 1.0.23",
  "serde",
  "serde_json",
  "tracing-opentelemetry",
@@ -5052,6 +4951,7 @@ dependencies = [
  "sha2 0.9.9",
  "subtle 2.5.0",
  "thiserror",
+ "utoipa",
  "zeroize",
 ]
 
@@ -5080,6 +4980,7 @@ dependencies = [
  "serde",
  "serde_json",
  "thiserror",
+ "utoipa",
  "vergen",
 ]
 
@@ -5107,7 +5008,7 @@ dependencies = [
 
 [[package]]
 name = "nym-credential-proxy"
-version = "0.1.3"
+version = "0.1.6"
 dependencies = [
  "anyhow",
  "async-trait",
@@ -5127,6 +5028,7 @@ dependencies = [
  "nym-credentials",
  "nym-credentials-interface",
  "nym-crypto",
+ "nym-ecash-contract-common",
  "nym-http-api-common",
  "nym-network-defaults",
  "nym-validator-client",
@@ -5270,6 +5172,7 @@ dependencies = [
  "strum 0.26.3",
  "thiserror",
  "time",
+ "utoipa",
 ]
 
 [[package]]
@@ -5636,12 +5539,15 @@ dependencies = [
  "axum-client-ip",
  "bytes",
  "colored",
+ "futures",
  "mime",
  "serde",
  "serde_json",
  "serde_yaml",
+ "tower 0.4.13",
  "tracing",
  "utoipa",
+ "zeroize",
 ]
 
 [[package]]
@@ -5935,7 +5841,7 @@ dependencies = [
 
 [[package]]
 name = "nym-node"
-version = "1.1.12"
+version = "1.2.0"
 dependencies = [
  "anyhow",
  "async-trait",
@@ -6370,28 +6276,6 @@ dependencies = [
  "url",
 ]
 
-[[package]]
-name = "nym-socks5-listener"
-version = "0.1.0"
-dependencies = [
- "android_logger",
- "anyhow",
- "futures",
- "jni",
- "lazy_static",
- "log",
- "nym-bin-common",
- "nym-client-core",
- "nym-config",
- "nym-credential-storage",
- "nym-crypto",
- "nym-socks5-client-core",
- "rand",
- "safer-ffi",
- "serde",
- "tokio",
-]
-
 [[package]]
 name = "nym-socks5-proxy-helpers"
 version = "0.1.0"
@@ -6648,6 +6532,7 @@ dependencies = [
  "serde_json",
  "sha2 0.10.8",
  "time",
+ "utoipa",
 ]
 
 [[package]]
@@ -6714,6 +6599,7 @@ dependencies = [
  "thiserror",
  "ts-rs",
  "url",
+ "utoipa",
  "x25519-dalek",
 ]
 
@@ -7520,53 +7406,10 @@ version = "0.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "926d36b9553851b8b0005f1275891b392ee4d2d833852c417ed025477350fb9d"
 dependencies = [
- "env_logger",
+ "env_logger 0.7.1",
  "log",
 ]
 
-[[package]]
-name = "prettyplease"
-version = "0.1.25"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6c8646e95016a7a6c4adea95bafa8a16baab64b583356217f2c85db4a39d9a86"
-dependencies = [
- "proc-macro2",
- "syn 1.0.109",
-]
-
-[[package]]
-name = "proc-macro-crate"
-version = "3.1.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6d37c51ca738a55da99dc0c4a34860fd675453b8b36209178c2249bb13651284"
-dependencies = [
- "toml_edit 0.21.1",
-]
-
-[[package]]
-name = "proc-macro-error"
-version = "1.0.4"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "da25490ff9892aab3fcf7c36f08cfb902dd3e71ca0f9f9517bea02a73a5ce38c"
-dependencies = [
- "proc-macro-error-attr",
- "proc-macro2",
- "quote",
- "syn 1.0.109",
- "version_check",
-]
-
-[[package]]
-name = "proc-macro-error-attr"
-version = "1.0.4"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a1be40180e52ecc98ad80b184934baf3d0d29f979574e439af5a55274b35f869"
-dependencies = [
- "proc-macro2",
- "quote",
- "version_check",
-]
-
 [[package]]
 name = "proc-macro-error-attr2"
 version = "2.0.0"
@@ -7998,7 +7841,6 @@ checksum = "566cafdd92868e0939d3fb961bd0dc25fcfaaed179291093b3d43e6b3150ea10"
 dependencies = [
  "base64 0.22.1",
  "bytes",
- "futures-channel",
  "futures-core",
  "futures-util",
  "http 1.1.0",
@@ -8431,38 +8273,6 @@ version = "1.0.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "f3cb5ba0dc43242ce17de99c180e96db90b235b8a9fdc9543c96d2209116bd9f"
 
-[[package]]
-name = "safer-ffi"
-version = "0.1.13"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "435fdd58b61a6f1d8545274c1dfa458e905ff68c166e65e294a0130ef5e675bd"
-dependencies = [
- "extern-c",
- "inventory",
- "libc",
- "macro_rules_attribute",
- "paste",
- "safer_ffi-proc_macros",
- "scopeguard",
- "stabby",
- "uninit",
- "unwind_safe",
- "with_builtin_macros",
-]
-
-[[package]]
-name = "safer_ffi-proc_macros"
-version = "0.1.13"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f0f25be5ba5f319542edb31925517e0380245ae37df50a9752cdbc05ef948156"
-dependencies = [
- "macro_rules_attribute",
- "prettyplease",
- "proc-macro2",
- "quote",
- "syn 1.0.109",
-]
-
 [[package]]
 name = "same-file"
 version = "1.0.6"
@@ -8895,12 +8705,6 @@ dependencies = [
  "digest 0.10.7",
 ]
 
-[[package]]
-name = "sha2-const-stable"
-version = "0.1.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5f179d4e11094a893b82fff208f74d448a7512f99f5a0acbd5c679b705f83ed9"
-
 [[package]]
 name = "sharded-slab"
 version = "0.1.7"
@@ -8962,6 +8766,12 @@ dependencies = [
  "rand_core 0.6.4",
 ]
 
+[[package]]
+name = "simd-adler32"
+version = "0.3.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d66dc143e6b11c1eddc06d5c423cfc97062865baf299914ab64caa38182078fe"
+
 [[package]]
 name = "siphasher"
 version = "0.3.11"
@@ -9301,40 +9111,6 @@ dependencies = [
  "tokio",
 ]
 
-[[package]]
-name = "stabby"
-version = "36.1.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "311d6bcf0070c462ff626122ec2246f42bd2acd44b28908eedbfd07d500c7d99"
-dependencies = [
- "rustversion",
- "stabby-abi",
-]
-
-[[package]]
-name = "stabby-abi"
-version = "36.1.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e6daae1a0707399f56d27fce7f212e50e31d215112a447e1bbcd837ae1bf5f49"
-dependencies = [
- "rustversion",
- "sha2-const-stable",
- "stabby-macros",
-]
-
-[[package]]
-name = "stabby-macros"
-version = "36.1.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "43cf89a0cc9131279235baf8599b0e073fbcb096419204de0cc5d1a48ae73f74"
-dependencies = [
- "proc-macro-crate",
- "proc-macro2",
- "quote",
- "rand",
- "syn 1.0.109",
-]
-
 [[package]]
 name = "stable-pattern"
 version = "0.1.0"
@@ -10027,7 +9803,7 @@ dependencies = [
  "serde",
  "serde_spanned",
  "toml_datetime",
- "toml_edit 0.22.14",
+ "toml_edit",
 ]
 
 [[package]]
@@ -10039,17 +9815,6 @@ dependencies = [
  "serde",
 ]
 
-[[package]]
-name = "toml_edit"
-version = "0.21.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6a8534fd7f78b5405e860340ad6575217ce99f38d4d5c8f2442cb5ecb50090e1"
-dependencies = [
- "indexmap 2.2.6",
- "toml_datetime",
- "winnow 0.5.40",
-]
-
 [[package]]
 name = "toml_edit"
 version = "0.22.14"
@@ -10060,7 +9825,7 @@ dependencies = [
  "serde",
  "serde_spanned",
  "toml_datetime",
- "winnow 0.6.13",
+ "winnow",
 ]
 
 [[package]]
@@ -10653,15 +10418,6 @@ dependencies = [
  "weedle2",
 ]
 
-[[package]]
-name = "uninit"
-version = "0.5.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3e130f2ed46ca5d8ec13c7ff95836827f92f5f5f37fd2b2bf16f33c408d98bb6"
-dependencies = [
- "extension-traits",
-]
-
 [[package]]
 name = "universal-hash"
 version = "0.5.1"
@@ -10684,12 +10440,6 @@ version = "0.9.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1"
 
-[[package]]
-name = "unwind_safe"
-version = "0.1.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0976c77def3f1f75c4ef892a292c31c0bbe9e3d0702c63044d7c76db298171a3"
-
 [[package]]
 name = "url"
 version = "2.5.2"
@@ -10722,9 +10472,9 @@ checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
 
 [[package]]
 name = "utoipa"
-version = "4.2.3"
+version = "5.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c5afb1a60e207dca502682537fefcfd9921e71d0b83e9576060f09abc6efab23"
+checksum = "514a48569e4e21c86d0b84b5612b5e73c0b2cf09db63260134ba426d4e8ea714"
 dependencies = [
  "indexmap 2.2.6",
  "serde",
@@ -10734,11 +10484,10 @@ dependencies = [
 
 [[package]]
 name = "utoipa-gen"
-version = "4.3.0"
+version = "5.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7bf0e16c02bc4bf5322ab65f10ab1149bdbcaa782cba66dc7057370a3f8190be"
+checksum = "5629efe65599d0ccd5d493688cbf6e03aa7c1da07fe59ff97cf5977ed0637f66"
 dependencies = [
- "proc-macro-error",
  "proc-macro2",
  "quote",
  "regex",
@@ -10748,14 +10497,13 @@ dependencies = [
 
 [[package]]
 name = "utoipa-swagger-ui"
-version = "7.1.0"
+version = "8.0.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "943e0ff606c6d57d410fd5663a4d7c074ab2c5f14ab903b9514565e59fa1189e"
+checksum = "a5c80b4dd79ea382e8374d67dcce22b5c6663fa13a82ad3886441d1bbede5e35"
 dependencies = [
  "axum 0.7.7",
  "mime_guess",
  "regex",
- "reqwest 0.12.4",
  "rust-embed",
  "serde",
  "serde_json",
@@ -10766,18 +10514,18 @@ dependencies = [
 
 [[package]]
 name = "utoipauto"
-version = "0.1.14"
+version = "0.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "608b8f2279483be386261655b562e40877ea434eb92093c894a644fda2021860"
+checksum = "cba36db2c397c614110554a60fbb4bb97d5f8c6823775c766e6f455e37377047"
 dependencies = [
  "utoipauto-macro",
 ]
 
 [[package]]
 name = "utoipauto-core"
-version = "0.1.12"
+version = "0.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "17e82ab96c5a55263b5bed151b8426410d93aa909a453acdbd4b6792b5af7d64"
+checksum = "268d76aaebb80eba79240b805972e52d7d410d4bcc52321b951318b0f440cd60"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -10786,9 +10534,9 @@ dependencies = [
 
 [[package]]
 name = "utoipauto-macro"
-version = "0.1.12"
+version = "0.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "86b8338dc3c9526011ffaa2aa6bd60ddfda9d49d2123108690755c6e34844212"
+checksum = "382673bda1d05c85b4550d32fd4192ccd4cffe9a908543a0795d1e7682b36246"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -11379,15 +11127,6 @@ version = "0.52.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "bec47e5bfd1bff0eeaf6d8b485cc1074891a197ab4225d504cb7a1ab88b02bf0"
 
-[[package]]
-name = "winnow"
-version = "0.5.40"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f593a95398737aeed53e489c785df13f3618e41dbcd6718c6addbf1395aa6876"
-dependencies = [
- "memchr",
-]
-
 [[package]]
 name = "winnow"
 version = "0.6.13"
@@ -11417,26 +11156,6 @@ dependencies = [
  "windows-sys 0.48.0",
 ]
 
-[[package]]
-name = "with_builtin_macros"
-version = "0.0.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a59d55032495429b87f9d69954c6c8602e4d3f3e0a747a12dea6b0b23de685da"
-dependencies = [
- "with_builtin_macros-proc_macros",
-]
-
-[[package]]
-name = "with_builtin_macros-proc_macros"
-version = "0.0.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "15bd7679c15e22924f53aee34d4e448c45b674feb6129689af88593e129f8f42"
-dependencies = [
- "proc-macro2",
- "quote",
- "syn 1.0.109",
-]
-
 [[package]]
 name = "wyz"
 version = "0.5.1"
@@ -11520,9 +11239,9 @@ dependencies = [
 
 [[package]]
 name = "zip"
-version = "1.1.4"
+version = "2.1.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9cc23c04387f4da0374be4533ad1208cbb091d5c11d070dfef13676ad6497164"
+checksum = "40dd8c92efc296286ce1fbd16657c5dbefff44f1b4ca01cc5f517d8b7b3d3e2e"
 dependencies = [
  "arbitrary",
  "crc32fast",
@@ -11530,8 +11249,9 @@ dependencies = [
  "displaydoc",
  "flate2",
  "indexmap 2.2.6",
- "num_enum",
+ "memchr",
  "thiserror",
+ "zopfli",
 ]
 
 [[package]]
@@ -11561,3 +11281,17 @@ dependencies = [
  "wasmtimer",
  "zeroize",
 ]
+
+[[package]]
+name = "zopfli"
+version = "0.8.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e5019f391bac5cf252e93bbcc53d039ffd62c7bfb7c150414d61369afe57e946"
+dependencies = [
+ "bumpalo",
+ "crc32fast",
+ "lockfree-object-pool",
+ "log",
+ "once_cell",
+ "simd-adler32",
+]

Cargo.toml

@@ -98,7 +98,7 @@ members = [
     "common/wasm/utils",
     "common/wireguard",
     "common/wireguard-types",
-    # "documentation/autodoc",
+    "documentation/autodoc",
     "explorer-api",
     "explorer-api/explorer-api-requests",
     "explorer-api/explorer-client",
@@ -107,7 +107,6 @@ members = [
     "sdk/ffi/cpp",
     "sdk/ffi/go",
     "sdk/ffi/shared",
-    "sdk/lib/socks5-listener",
     "sdk/rust/nym-sdk",
     "service-providers/authenticator",
     "service-providers/common",
@@ -346,9 +345,9 @@ tracing-log = "0.2"
 ts-rs = "10.0.0"
 tungstenite = { version = "0.20.1", default-features = false }
 url = "2.5"
-utoipa = "4.2"
-utoipa-swagger-ui = "7.1"
-utoipauto = "0.1"
+utoipa = "5.2"
+utoipa-swagger-ui = "8.0"
+utoipauto = "0.2"
 uuid = "*"
 vergen = { version = "=8.3.1", default-features = false }
 walkdir = "2"
@@ -417,10 +416,6 @@ web-sys = "0.3.72"
 [profile.dev.package.sqlx-macros]
 opt-level = 3
 
-[profile.release.package.nym-socks5-listener]
-strip = true
-codegen-units = 1
-
 [profile.release.package.nym-client-wasm]
 # lto = true
 opt-level = 'z'

README.md

@@ -14,6 +14,7 @@ The platform is composed of multiple Rust crates. Top-level executable binary cr
 * `nym-socks5-client` - a Socks5 proxy you can run on your machine and use with existing applications.
 * `nym-explorer` - a (projected) block explorer and (existing) mixnet viewer.
 * `nym-wallet` - a desktop wallet implemented using the [Tauri](https://tauri.studio/en/docs/about/intro) framework.
+* `nym-cli` - a tool for interacting with the network from the CLI. 
 <!-- coming soon
 * `nym-network-monitor` - sends packets through the full system to check that they are working as expected, and stores node uptime histories as the basis of a rewards system ("mixmining" or "proof-of-mixing").
 -->
@@ -35,24 +36,20 @@ client ───► Gateway ──┘  mix  │  mix  ┌─►mix ───►
 ### Building
 
 * Platform build instructions are available on Nym [Operators Guide documentation](https://nymtech.net/operators/binaries/building-nym.html).
-* Wallet build instructions are available on Nym [Technical docs](https://nymtech.net/docs/wallet/desktop-wallet.html).
+* Wallet build instructions are available [here](https://github.com/nymtech/nym/tree/master/nym-wallet#installation-prerequisites---linux--mac).
 
 ### Developing
 
-There's a [`sandbox.env`](https://github.com/nymtech/nym/envs/sandbox.env) file provided which you can rename to `.env` if you want convenient testing environment. Read more about sandbox environment in our [Operators Guide page](https://nymtech.net/operators/sandbox.html).
-
 References for developers:
 
-* [Developers Portal](https://nymtech.net/developers)
-* [Typescript SDKs](https://sdk.nymtech.net/)
-* [Technical Documentation - Nym network overview](https://nymtech.net/docs/)
-* [Release Cycle - git flow](https://nymtech.net/operators/release-cycle.html)
+* [Dev Docs](https://nymtech.net/docs/developers)
+* [SDKs](https://nymtech.net/docs/developers/rust)
+* [Network Docs](https://nymtech.net/docs/network)
+* [Release Cycle - git flow](https://nymtech.net/docs/operators/release-cycle)
 
 ### Developer chat
 
-You can chat to us in two places:
-* The #dev channel on [Matrix](https://matrix.to/#/#dev:nymtech.chat)
-* The various developer channels on [Discord](https://nymtech.net/go/discord)
+You can chat to us in the #dev channel on [Matrix](https://matrix.to/#/#dev:nymtech.chat) or on the [Nym Forum](https://forum.nymtech.net).
 
 ### Tokenomics & Rewards
 

clients/native/src/commands/run.rs

@@ -3,13 +3,10 @@
 
 use crate::commands::try_load_current_config;
 use crate::{
-    client::{config::Config, SocketClient},
+    client::SocketClient,
     commands::{override_config, OverrideConfig},
-    error::ClientError,
 };
 use clap::Args;
-use log::*;
-use nym_bin_common::version_checker::is_minor_version_compatible;
 use nym_client_core::cli_helpers::client_run::CommonClientRunArgs;
 use std::error::Error;
 use std::net::IpAddr;
@@ -48,36 +45,12 @@ impl From<Run> for OverrideConfig {
     }
 }
 
-// this only checks compatibility between config the binary. It does not take into consideration
-// network version. It might do so in the future.
-fn version_check(cfg: &Config) -> bool {
-    let binary_version = env!("CARGO_PKG_VERSION");
-    let config_version = &cfg.base.client.version;
-    if binary_version == config_version {
-        true
-    } else {
-        warn!("The native-client binary has different version than what is specified in config file! {} and {}", binary_version, config_version);
-        if is_minor_version_compatible(binary_version, config_version) {
-            info!("but they are still semver compatible. However, consider running the `upgrade` command");
-            true
-        } else {
-            error!("and they are semver incompatible! - please run the `upgrade` command before attempting `run` again");
-            false
-        }
-    }
-}
-
 pub(crate) async fn execute(args: Run) -> Result<(), Box<dyn Error + Send + Sync>> {
     eprintln!("Starting client {}...", args.common_args.id);
 
     let mut config = try_load_current_config(&args.common_args.id).await?;
     config = override_config(config, OverrideConfig::from(args.clone()));
 
-    if !version_check(&config) {
-        error!("failed the local version check");
-        return Err(Box::new(ClientError::FailedLocalVersionCheck));
-    }
-
     SocketClient::new(config, args.common_args.custom_mixnet)
         .run_socket_forever()
         .await

clients/native/src/error.rs

@@ -17,9 +17,6 @@ pub enum ClientError {
     #[error("Failed to validate the loaded config")]
     ConfigValidationFailure,
 
-    #[error("Failed local version check, client and config mismatch")]
-    FailedLocalVersionCheck,
-
     #[error("Attempted to start the client in invalid socket mode")]
     InvalidSocketMode,
 

clients/socks5/src/commands/run.rs

@@ -2,14 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::commands::try_load_current_config;
-use crate::config::Config;
-use crate::{
-    commands::{override_config, OverrideConfig},
-    error::Socks5ClientError,
-};
+use crate::commands::{override_config, OverrideConfig};
 use clap::Args;
-use log::*;
-use nym_bin_common::version_checker::is_minor_version_compatible;
 use nym_client_core::cli_helpers::client_run::CommonClientRunArgs;
 use nym_client_core::client::base_client::storage::OnDiskPersistent;
 use nym_client_core::client::topology_control::geo_aware_provider::CountryGroup;
@@ -82,38 +76,12 @@ fn validate_country_group(s: &str) -> Result<CountryGroup, String> {
     }
 }
 
-// this only checks compatibility between config the binary. It does not take into consideration
-// network version. It might do so in the future.
-fn version_check(cfg: &Config) -> bool {
-    let binary_version = env!("CARGO_PKG_VERSION");
-    let config_version = &cfg.core.base.client.version;
-    if binary_version == config_version {
-        true
-    } else {
-        warn!(
-            "The socks5-client binary has different version than what is specified in config file! {binary_version} and {config_version}",
-        );
-        if is_minor_version_compatible(binary_version, config_version) {
-            info!("but they are still semver compatible. However, consider running the `upgrade` command");
-            true
-        } else {
-            error!("and they are semver incompatible! - please run the `upgrade` command before attempting `run` again");
-            false
-        }
-    }
-}
-
 pub(crate) async fn execute(args: Run) -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
     eprintln!("Starting client {}...", args.common_args.id);
 
     let mut config = try_load_current_config(&args.common_args.id).await?;
     config = override_config(config, OverrideConfig::from(args.clone()));
 
-    if !version_check(&config) {
-        error!("failed the local version check");
-        return Err(Box::new(Socks5ClientError::FailedLocalVersionCheck));
-    }
-
     let storage =
         OnDiskPersistent::from_paths(config.storage_paths.common_paths, &config.core.base.debug)
             .await?;

clients/socks5/src/error.rs

@@ -14,9 +14,6 @@ pub enum Socks5ClientError {
     #[error("Failed to validate the loaded config")]
     ConfigValidationFailure,
 
-    #[error("Failed local version check, client and config mismatch")]
-    FailedLocalVersionCheck,
-
     #[error("Fail to bind address")]
     FailToBindAddress,
 

common/authenticator-requests/src/lib.rs

@@ -8,6 +8,7 @@ pub mod v3;
 pub mod v4;
 
 mod error;
+mod util;
 
 pub use error::Error;
 pub use v4 as latest;

common/authenticator-requests/src/util.rs

@@ -0,0 +1,71 @@
+// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+#[cfg(test)]
+pub(crate) mod tests {
+    pub(crate) const CREDENTIAL_BYTES: [u8; 1245] = [
+        0, 0, 4, 133, 96, 179, 223, 185, 136, 23, 213, 166, 59, 203, 66, 69, 209, 181, 227, 254,
+        16, 102, 98, 237, 59, 119, 170, 111, 31, 194, 51, 59, 120, 17, 115, 229, 79, 91, 11, 139,
+        154, 2, 212, 23, 68, 70, 167, 3, 240, 54, 224, 171, 221, 1, 69, 48, 60, 118, 119, 249, 123,
+        35, 172, 227, 131, 96, 232, 209, 187, 123, 4, 197, 102, 90, 96, 45, 125, 135, 140, 99, 1,
+        151, 17, 131, 143, 157, 97, 107, 139, 232, 212, 87, 14, 115, 253, 255, 166, 167, 186, 43,
+        90, 96, 173, 105, 120, 40, 10, 163, 250, 224, 214, 200, 178, 4, 160, 16, 130, 59, 76, 193,
+        39, 240, 3, 101, 141, 209, 183, 226, 186, 207, 56, 210, 187, 7, 164, 240, 164, 205, 37, 81,
+        184, 214, 193, 195, 90, 205, 238, 225, 195, 104, 12, 123, 203, 57, 233, 243, 215, 145, 195,
+        196, 57, 38, 125, 172, 18, 47, 63, 165, 110, 219, 180, 40, 58, 116, 92, 254, 160, 98, 48,
+        92, 254, 232, 107, 184, 80, 234, 60, 160, 235, 249, 76, 41, 38, 165, 28, 40, 136, 74, 48,
+        166, 50, 245, 23, 201, 140, 101, 79, 93, 235, 128, 186, 146, 126, 180, 134, 43, 13, 186,
+        19, 195, 48, 168, 201, 29, 216, 95, 176, 198, 132, 188, 64, 39, 212, 150, 32, 52, 53, 38,
+        228, 199, 122, 226, 217, 75, 40, 191, 151, 48, 164, 242, 177, 79, 14, 122, 105, 151, 85,
+        88, 199, 162, 17, 96, 103, 83, 178, 128, 9, 24, 30, 74, 108, 241, 85, 240, 166, 97, 241,
+        85, 199, 11, 198, 226, 234, 70, 107, 145, 28, 208, 114, 51, 12, 234, 108, 101, 202, 112,
+        48, 185, 22, 159, 67, 109, 49, 27, 149, 90, 109, 32, 226, 112, 7, 201, 208, 209, 104, 31,
+        97, 134, 204, 145, 27, 181, 206, 181, 106, 32, 110, 136, 115, 249, 201, 111, 5, 245, 203,
+        71, 121, 169, 126, 151, 178, 236, 59, 221, 195, 48, 135, 115, 6, 50, 227, 74, 97, 107, 107,
+        213, 90, 2, 203, 154, 138, 47, 128, 52, 134, 128, 224, 51, 65, 240, 90, 8, 55, 175, 180,
+        178, 204, 206, 168, 110, 51, 57, 189, 169, 48, 169, 136, 121, 99, 51, 170, 178, 214, 74, 1,
+        96, 151, 167, 25, 173, 180, 171, 155, 10, 55, 142, 234, 190, 113, 90, 79, 80, 244, 71, 166,
+        30, 235, 113, 150, 133, 1, 218, 17, 109, 111, 223, 24, 216, 177, 41, 2, 204, 65, 221, 212,
+        207, 236, 144, 6, 65, 224, 55, 42, 1, 1, 161, 134, 118, 127, 111, 220, 110, 127, 240, 71,
+        223, 129, 12, 93, 20, 220, 60, 56, 71, 146, 184, 95, 132, 69, 28, 56, 53, 192, 213, 22,
+        119, 230, 152, 225, 182, 188, 163, 219, 37, 175, 247, 73, 14, 247, 38, 72, 243, 1, 48, 131,
+        59, 8, 13, 96, 143, 185, 127, 241, 161, 217, 24, 149, 193, 40, 16, 30, 202, 151, 28, 119,
+        240, 153, 101, 156, 61, 193, 72, 245, 199, 181, 12, 231, 65, 166, 67, 142, 121, 207, 202,
+        58, 197, 113, 188, 248, 42, 124, 105, 48, 161, 241, 55, 209, 36, 194, 27, 63, 233, 144,
+        189, 85, 117, 234, 9, 139, 46, 31, 206, 114, 95, 131, 29, 240, 13, 81, 142, 140, 133, 33,
+        30, 41, 141, 37, 80, 217, 95, 221, 76, 115, 86, 201, 165, 51, 252, 9, 28, 209, 1, 48, 150,
+        74, 248, 212, 187, 222, 66, 210, 3, 200, 19, 217, 171, 184, 42, 148, 53, 150, 57, 50, 6,
+        227, 227, 62, 49, 42, 148, 148, 157, 82, 191, 58, 24, 34, 56, 98, 120, 89, 105, 176, 85,
+        15, 253, 241, 41, 153, 195, 136, 1, 48, 142, 126, 213, 101, 223, 79, 133, 230, 105, 38,
+        161, 149, 2, 21, 136, 150, 42, 72, 218, 85, 146, 63, 223, 58, 108, 186, 183, 248, 62, 20,
+        47, 34, 113, 160, 177, 204, 181, 16, 24, 212, 224, 35, 84, 51, 168, 56, 136, 11, 1, 48,
+        135, 242, 62, 149, 230, 178, 32, 224, 119, 26, 234, 163, 237, 224, 114, 95, 112, 140, 170,
+        150, 96, 125, 136, 221, 180, 78, 18, 11, 12, 184, 2, 198, 217, 119, 43, 69, 4, 172, 109,
+        55, 183, 40, 131, 172, 161, 88, 183, 101, 1, 48, 173, 216, 22, 73, 42, 255, 211, 93, 249,
+        87, 159, 115, 61, 91, 55, 130, 17, 216, 60, 34, 122, 55, 8, 244, 244, 153, 151, 57, 5, 144,
+        178, 55, 249, 64, 211, 168, 34, 148, 56, 89, 92, 203, 70, 124, 219, 152, 253, 165, 0, 32,
+        203, 116, 63, 7, 240, 222, 82, 86, 11, 149, 167, 72, 224, 55, 190, 66, 201, 65, 168, 184,
+        96, 47, 194, 241, 168, 124, 7, 74, 214, 250, 37, 76, 32, 218, 69, 122, 103, 215, 145, 169,
+        24, 212, 229, 168, 106, 10, 144, 31, 13, 25, 178, 242, 250, 106, 159, 40, 48, 163, 165, 61,
+        130, 57, 146, 4, 73, 32, 254, 233, 125, 135, 212, 29, 111, 4, 177, 114, 15, 210, 170, 82,
+        108, 110, 62, 166, 81, 209, 106, 176, 156, 14, 133, 242, 60, 127, 120, 242, 28, 97, 0, 1,
+        32, 103, 93, 109, 89, 240, 91, 1, 84, 150, 50, 206, 157, 203, 49, 220, 120, 234, 175, 234,
+        150, 126, 225, 94, 163, 164, 199, 138, 114, 62, 99, 106, 112, 1, 32, 171, 40, 220, 82, 241,
+        203, 76, 146, 111, 139, 182, 179, 237, 182, 115, 75, 128, 201, 107, 43, 214, 0, 135, 217,
+        160, 68, 150, 232, 144, 114, 237, 98, 32, 30, 134, 232, 59, 93, 163, 253, 244, 13, 202, 52,
+        147, 168, 83, 121, 123, 95, 21, 210, 209, 225, 223, 143, 49, 10, 205, 238, 1, 22, 83, 81,
+        70, 1, 32, 26, 76, 6, 234, 160, 50, 139, 102, 161, 232, 155, 106, 130, 171, 226, 210, 233,
+        178, 85, 247, 71, 123, 55, 53, 46, 67, 148, 137, 156, 207, 208, 107, 1, 32, 102, 31, 4, 98,
+        110, 156, 144, 61, 229, 140, 198, 84, 196, 238, 128, 35, 131, 182, 137, 125, 241, 95, 69,
+        131, 170, 27, 2, 144, 75, 72, 242, 102, 3, 32, 121, 80, 45, 173, 56, 65, 218, 27, 40, 251,
+        197, 32, 169, 104, 123, 110, 90, 78, 153, 166, 38, 9, 129, 228, 99, 8, 1, 116, 142, 233,
+        162, 69, 32, 216, 169, 159, 116, 95, 12, 63, 176, 195, 6, 183, 123, 135, 75, 61, 112, 106,
+        83, 235, 176, 41, 27, 248, 48, 71, 165, 170, 12, 92, 103, 103, 81, 32, 58, 74, 75, 145,
+        192, 94, 153, 69, 80, 128, 241, 3, 16, 117, 192, 86, 161, 103, 44, 174, 211, 196, 182, 124,
+        55, 11, 107, 142, 49, 88, 6, 41, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
+        6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6,
+        6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 6, 0, 37, 139, 240, 0, 0,
+        0, 0, 0, 0, 0, 1,
+    ];
+    pub(crate) const RECIPIENT: &str = "CytBseW6yFXUMzz4SGAKdNLGR7q3sJLLYxyBGvutNEQV.4QXYyEVc5fUDjmmi8PrHN9tdUFV4PCvSJE1278cHyvoe@4sBbL1ngf1vtNqykydQKTFh26sQCw888GpUqvPvyNB4f";
+}

common/authenticator-requests/src/v2/registration.rs

@@ -29,7 +29,7 @@ pub type Taken = Option<SystemTime>;
 
 pub const BANDWIDTH_CAP_PER_DAY: u64 = 1024 * 1024 * 1024; // 1 GB
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct InitMessage {
     /// Base64 encoded x25519 public key
     pub pub_key: PeerPublicKey,
@@ -41,7 +41,7 @@ impl InitMessage {
     }
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct FinalMessage {
     /// Gateway client data
     pub gateway_client: GatewayClient,
@@ -50,28 +50,28 @@ pub struct FinalMessage {
     pub credential: Option<CredentialSpendingData>,
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct RegistrationData {
     pub nonce: u64,
     pub gateway_data: GatewayClient,
     pub wg_port: u16,
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct RegistredData {
     pub pub_key: PeerPublicKey,
     pub private_ip: IpAddr,
     pub wg_port: u16,
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct RemainingBandwidthData {
     pub available_bandwidth: i64,
 }
 
 /// Client that wants to register sends its PublicKey bytes mac digest encrypted with a DH shared secret.
 /// Gateway/Nym node can then verify pub_key payload using the same process
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct GatewayClient {
     /// Base64 encoded x25519 public key
     pub pub_key: PeerPublicKey,
@@ -147,7 +147,7 @@ impl GatewayClient {
 
 // TODO: change the inner type into generic array of size HmacSha256::OutputSize
 // TODO2: rely on our internal crypto/hmac
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct ClientMac(Vec<u8>);
 
 impl fmt::Display for ClientMac {

common/authenticator-requests/src/v2/request.rs

@@ -87,7 +87,7 @@ impl AuthenticatorRequest {
     }
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub enum AuthenticatorRequestData {
     Initial(InitMessage),
     Final(Box<FinalMessage>),

common/authenticator-requests/src/v2/response.rs

@@ -100,28 +100,28 @@ impl AuthenticatorResponse {
     }
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub enum AuthenticatorResponseData {
     PendingRegistration(PendingRegistrationResponse),
     Registered(RegisteredResponse),
     RemainingBandwidth(RemainingBandwidthResponse),
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct PendingRegistrationResponse {
     pub request_id: u64,
     pub reply_to: Recipient,
     pub reply: RegistrationData,
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct RegisteredResponse {
     pub request_id: u64,
     pub reply_to: Recipient,
     pub reply: RegistredData,
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct RemainingBandwidthResponse {
     pub request_id: u64,
     pub reply_to: Recipient,

common/authenticator-requests/src/v3/conversion.rs

@@ -19,6 +19,24 @@ impl From<v2::request::AuthenticatorRequest> for v3::request::AuthenticatorReque
     }
 }
 
+impl TryFrom<v3::request::AuthenticatorRequest> for v2::request::AuthenticatorRequest {
+    type Error = crate::Error;
+
+    fn try_from(
+        authenticator_request: v3::request::AuthenticatorRequest,
+    ) -> Result<Self, Self::Error> {
+        Ok(Self {
+            protocol: Protocol {
+                version: 2,
+                service_provider_type: ServiceProviderType::Authenticator,
+            },
+            data: authenticator_request.data.try_into()?,
+            reply_to: authenticator_request.reply_to,
+            request_id: authenticator_request.request_id,
+        })
+    }
+}
+
 impl From<v2::request::AuthenticatorRequestData> for v3::request::AuthenticatorRequestData {
     fn from(authenticator_request_data: v2::request::AuthenticatorRequestData) -> Self {
         match authenticator_request_data {
@@ -35,6 +53,29 @@ impl From<v2::request::AuthenticatorRequestData> for v3::request::AuthenticatorR
     }
 }
 
+impl TryFrom<v3::request::AuthenticatorRequestData> for v2::request::AuthenticatorRequestData {
+    type Error = crate::Error;
+
+    fn try_from(
+        authenticator_request_data: v3::request::AuthenticatorRequestData,
+    ) -> Result<Self, Self::Error> {
+        match authenticator_request_data {
+            v3::request::AuthenticatorRequestData::Initial(init_msg) => Ok(
+                v2::request::AuthenticatorRequestData::Initial(init_msg.into()),
+            ),
+            v3::request::AuthenticatorRequestData::Final(gw_client) => Ok(
+                v2::request::AuthenticatorRequestData::Final(gw_client.into()),
+            ),
+            v3::request::AuthenticatorRequestData::QueryBandwidth(pub_key) => Ok(
+                v2::request::AuthenticatorRequestData::QueryBandwidth(pub_key),
+            ),
+            v3::request::AuthenticatorRequestData::TopUpBandwidth(_) => Err(
+                Self::Error::Conversion("no top up bandwidth variant in v2".to_string()),
+            ),
+        }
+    }
+}
+
 impl From<v2::registration::InitMessage> for v3::registration::InitMessage {
     fn from(init_msg: v2::registration::InitMessage) -> Self {
         Self {
@@ -43,6 +84,14 @@ impl From<v2::registration::InitMessage> for v3::registration::InitMessage {
     }
 }
 
+impl From<v3::registration::InitMessage> for v2::registration::InitMessage {
+    fn from(init_msg: v3::registration::InitMessage) -> Self {
+        Self {
+            pub_key: init_msg.pub_key,
+        }
+    }
+}
+
 impl From<Box<v2::registration::FinalMessage>> for Box<v3::registration::FinalMessage> {
     fn from(gw_client: Box<v2::registration::FinalMessage>) -> Self {
         Box::new(v3::registration::FinalMessage {
@@ -52,6 +101,15 @@ impl From<Box<v2::registration::FinalMessage>> for Box<v3::registration::FinalMe
     }
 }
 
+impl From<Box<v3::registration::FinalMessage>> for Box<v2::registration::FinalMessage> {
+    fn from(gw_client: Box<v3::registration::FinalMessage>) -> Self {
+        Box::new(v2::registration::FinalMessage {
+            gateway_client: gw_client.gateway_client.into(),
+            credential: gw_client.credential,
+        })
+    }
+}
+
 impl From<v2::registration::GatewayClient> for v3::registration::GatewayClient {
     fn from(gw_client: v2::registration::GatewayClient) -> Self {
         Self {
@@ -93,7 +151,10 @@ impl TryFrom<v3::response::AuthenticatorResponse> for v2::response::Authenticato
         Ok(Self {
             data: authenticator_response.data.try_into()?,
             reply_to: authenticator_response.reply_to,
-            protocol: authenticator_response.protocol,
+            protocol: Protocol {
+                version: 2,
+                service_provider_type: authenticator_response.protocol.service_provider_type,
+            },
         })
     }
 }
@@ -101,7 +162,10 @@ impl TryFrom<v3::response::AuthenticatorResponse> for v2::response::Authenticato
 impl From<v2::response::AuthenticatorResponse> for v3::response::AuthenticatorResponse {
     fn from(value: v2::response::AuthenticatorResponse) -> Self {
         Self {
-            protocol: value.protocol,
+            protocol: Protocol {
+                version: 3,
+                service_provider_type: value.protocol.service_provider_type,
+            },
             data: value.data.into(),
             reply_to: value.reply_to,
         }
@@ -270,3 +334,511 @@ impl From<v2::registration::RemainingBandwidthData> for v3::registration::Remain
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use std::{net::IpAddr, str::FromStr};
+
+    use nym_credentials_interface::CredentialSpendingData;
+    use nym_crypto::asymmetric::encryption::PrivateKey;
+    use nym_sphinx::addressing::Recipient;
+    use nym_wireguard_types::PeerPublicKey;
+    use x25519_dalek::PublicKey;
+
+    use super::*;
+    use crate::util::tests::{CREDENTIAL_BYTES, RECIPIENT};
+
+    #[test]
+    fn upgrade_initial_req() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) = v2::request::AuthenticatorRequest::new_initial_request(
+            v2::registration::InitMessage::new(pub_key),
+            reply_to,
+        );
+        let upgraded_msg = v3::request::AuthenticatorRequest::from(msg);
+
+        assert_eq!(
+            upgraded_msg.protocol,
+            Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            upgraded_msg.data,
+            v3::request::AuthenticatorRequestData::Initial(v3::registration::InitMessage {
+                pub_key
+            })
+        );
+    }
+
+    #[test]
+    fn downgrade_initial_req() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) = v3::request::AuthenticatorRequest::new_initial_request(
+            v3::registration::InitMessage::new(pub_key),
+            reply_to,
+        );
+        let downgraded_msg = v2::request::AuthenticatorRequest::try_from(msg).unwrap();
+
+        assert_eq!(
+            downgraded_msg.protocol,
+            Protocol {
+                version: 2,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            downgraded_msg.data,
+            v2::request::AuthenticatorRequestData::Initial(v2::registration::InitMessage {
+                pub_key
+            })
+        );
+    }
+
+    #[test]
+    fn upgrade_final_req() {
+        let mut rng = rand::thread_rng();
+
+        let local_secret = PrivateKey::new(&mut rng);
+        let remote_secret = x25519_dalek::StaticSecret::random_from_rng(&mut rng);
+        let private_ip = IpAddr::from_str("10.10.10.10").unwrap();
+        let nonce = 42;
+        let gateway_client = v2::registration::GatewayClient::new(
+            &local_secret,
+            (&remote_secret).into(),
+            private_ip,
+            nonce,
+        );
+        let credential = Some(CredentialSpendingData::try_from_bytes(&CREDENTIAL_BYTES).unwrap());
+        let final_message = v2::registration::FinalMessage {
+            gateway_client,
+            credential: credential.clone(),
+        };
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) =
+            v2::request::AuthenticatorRequest::new_final_request(final_message, reply_to);
+        let upgraded_msg = v3::request::AuthenticatorRequest::from(msg);
+
+        assert_eq!(
+            upgraded_msg.protocol,
+            Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            upgraded_msg.data,
+            v3::request::AuthenticatorRequestData::Final(Box::new(
+                v3::registration::FinalMessage {
+                    gateway_client: v3::registration::GatewayClient::new(
+                        &local_secret,
+                        (&remote_secret).into(),
+                        private_ip,
+                        nonce,
+                    ),
+                    credential
+                }
+            ))
+        );
+    }
+
+    #[test]
+    fn downgrade_final_req() {
+        let mut rng = rand::thread_rng();
+
+        let local_secret = PrivateKey::new(&mut rng);
+        let remote_secret = x25519_dalek::StaticSecret::random_from_rng(&mut rng);
+        let private_ip = IpAddr::from_str("10.10.10.10").unwrap();
+        let nonce = 42;
+        let gateway_client = v3::registration::GatewayClient::new(
+            &local_secret,
+            (&remote_secret).into(),
+            private_ip,
+            nonce,
+        );
+        let credential = Some(CredentialSpendingData::try_from_bytes(&CREDENTIAL_BYTES).unwrap());
+        let final_message = v3::registration::FinalMessage {
+            gateway_client,
+            credential: credential.clone(),
+        };
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) =
+            v3::request::AuthenticatorRequest::new_final_request(final_message, reply_to);
+        let upgraded_msg = v2::request::AuthenticatorRequest::try_from(msg).unwrap();
+
+        assert_eq!(
+            upgraded_msg.protocol,
+            Protocol {
+                version: 2,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            upgraded_msg.data,
+            v2::request::AuthenticatorRequestData::Final(Box::new(
+                v2::registration::FinalMessage {
+                    gateway_client: v2::registration::GatewayClient::new(
+                        &local_secret,
+                        (&remote_secret).into(),
+                        private_ip,
+                        nonce,
+                    ),
+                    credential
+                }
+            ))
+        );
+    }
+
+    #[test]
+    fn upgrade_query_req() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) = v2::request::AuthenticatorRequest::new_query_request(pub_key, reply_to);
+        let upgraded_msg = v3::request::AuthenticatorRequest::from(msg);
+
+        assert_eq!(
+            upgraded_msg.protocol,
+            Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            upgraded_msg.data,
+            v3::request::AuthenticatorRequestData::QueryBandwidth(pub_key)
+        );
+    }
+
+    #[test]
+    fn downgrade_query_req() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) = v3::request::AuthenticatorRequest::new_query_request(pub_key, reply_to);
+        let downgraded_msg = v2::request::AuthenticatorRequest::try_from(msg).unwrap();
+
+        assert_eq!(
+            downgraded_msg.protocol,
+            Protocol {
+                version: 2,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            downgraded_msg.data,
+            v2::request::AuthenticatorRequestData::QueryBandwidth(pub_key)
+        );
+    }
+
+    #[test]
+    fn downgrade_topup_req() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let credential = CredentialSpendingData::try_from_bytes(&CREDENTIAL_BYTES).unwrap();
+        let top_up_message = v3::topup::TopUpMessage {
+            pub_key,
+            credential,
+        };
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) =
+            v3::request::AuthenticatorRequest::new_topup_request(top_up_message, reply_to);
+        assert!(v2::request::AuthenticatorRequest::try_from(msg).is_err());
+    }
+
+    #[test]
+    fn upgrade_pending_reg_resp() {
+        let mut rng = rand::thread_rng();
+
+        let local_secret = PrivateKey::new(&mut rng);
+        let remote_secret = x25519_dalek::StaticSecret::random_from_rng(&mut rng);
+        let private_ip = IpAddr::from_str("10.10.10.10").unwrap();
+        let nonce = 42;
+        let wg_port = 51822;
+        let gateway_data = v2::registration::GatewayClient::new(
+            &local_secret,
+            (&remote_secret).into(),
+            private_ip,
+            nonce,
+        );
+        let registration_data = v2::registration::RegistrationData {
+            nonce,
+            gateway_data,
+            wg_port,
+        };
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v2::response::AuthenticatorResponse::new_pending_registration_success(
+            registration_data,
+            request_id,
+            reply_to,
+        );
+        let upgraded_msg = v3::response::AuthenticatorResponse::from(msg);
+
+        assert_eq!(
+            upgraded_msg.protocol,
+            Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            upgraded_msg.data,
+            v3::response::AuthenticatorResponseData::PendingRegistration(
+                v3::response::PendingRegistrationResponse {
+                    request_id,
+                    reply_to,
+                    reply: v3::registration::RegistrationData {
+                        nonce,
+                        gateway_data: v3::registration::GatewayClient::new(
+                            &local_secret,
+                            (&remote_secret).into(),
+                            private_ip,
+                            nonce,
+                        ),
+                        wg_port,
+                    }
+                }
+            )
+        );
+    }
+
+    #[test]
+    fn downgrade_pending_reg_resp() {
+        let mut rng = rand::thread_rng();
+
+        let local_secret = PrivateKey::new(&mut rng);
+        let remote_secret = x25519_dalek::StaticSecret::random_from_rng(&mut rng);
+        let private_ip = IpAddr::from_str("10.10.10.10").unwrap();
+        let nonce = 42;
+        let wg_port = 51822;
+        let gateway_data = v3::registration::GatewayClient::new(
+            &local_secret,
+            (&remote_secret).into(),
+            private_ip,
+            nonce,
+        );
+        let registration_data = v3::registration::RegistrationData {
+            nonce,
+            gateway_data,
+            wg_port,
+        };
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v3::response::AuthenticatorResponse::new_pending_registration_success(
+            registration_data,
+            request_id,
+            reply_to,
+        );
+        let downgraded_msg = v2::response::AuthenticatorResponse::try_from(msg).unwrap();
+
+        assert_eq!(
+            downgraded_msg.protocol,
+            Protocol {
+                version: 2,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            downgraded_msg.data,
+            v2::response::AuthenticatorResponseData::PendingRegistration(
+                v2::response::PendingRegistrationResponse {
+                    request_id,
+                    reply_to,
+                    reply: v2::registration::RegistrationData {
+                        nonce,
+                        gateway_data: v2::registration::GatewayClient::new(
+                            &local_secret,
+                            (&remote_secret).into(),
+                            private_ip,
+                            nonce,
+                        ),
+                        wg_port,
+                    }
+                }
+            )
+        );
+    }
+
+    #[test]
+    fn upgrade_registered_resp() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let private_ip = IpAddr::from_str("10.10.10.10").unwrap();
+        let wg_port = 51822;
+        let registred_data = v2::registration::RegistredData {
+            pub_key,
+            private_ip,
+            wg_port,
+        };
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v2::response::AuthenticatorResponse::new_registered(
+            registred_data,
+            reply_to,
+            request_id,
+        );
+        let upgraded_msg = v3::response::AuthenticatorResponse::from(msg);
+
+        assert_eq!(
+            upgraded_msg.protocol,
+            Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            upgraded_msg.data,
+            v3::response::AuthenticatorResponseData::Registered(v3::response::RegisteredResponse {
+                request_id,
+                reply_to,
+                reply: v3::registration::RegistredData {
+                    wg_port,
+                    pub_key,
+                    private_ip
+                }
+            })
+        );
+    }
+
+    #[test]
+    fn downgrade_registered_resp() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let private_ip = IpAddr::from_str("10.10.10.10").unwrap();
+        let wg_port = 51822;
+        let registred_data = v3::registration::RegistredData {
+            pub_key,
+            private_ip,
+            wg_port,
+        };
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v3::response::AuthenticatorResponse::new_registered(
+            registred_data,
+            reply_to,
+            request_id,
+        );
+        let downgraded_msg = v2::response::AuthenticatorResponse::try_from(msg).unwrap();
+
+        assert_eq!(
+            downgraded_msg.protocol,
+            Protocol {
+                version: 2,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            downgraded_msg.data,
+            v2::response::AuthenticatorResponseData::Registered(v2::response::RegisteredResponse {
+                request_id,
+                reply_to,
+                reply: v2::registration::RegistredData {
+                    wg_port,
+                    pub_key,
+                    private_ip
+                }
+            })
+        );
+    }
+
+    #[test]
+    fn upgrade_remaining_bandwidth_resp() {
+        let available_bandwidth = 42;
+        let remaining_bandwidth_data = Some(v2::registration::RemainingBandwidthData {
+            available_bandwidth,
+        });
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v2::response::AuthenticatorResponse::new_remaining_bandwidth(
+            remaining_bandwidth_data,
+            reply_to,
+            request_id,
+        );
+        let upgraded_msg = v3::response::AuthenticatorResponse::from(msg);
+
+        assert_eq!(
+            upgraded_msg.protocol,
+            Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            upgraded_msg.data,
+            v3::response::AuthenticatorResponseData::RemainingBandwidth(
+                v3::response::RemainingBandwidthResponse {
+                    request_id,
+                    reply_to,
+                    reply: Some(v3::registration::RemainingBandwidthData {
+                        available_bandwidth,
+                    })
+                }
+            )
+        );
+    }
+
+    #[test]
+    fn downgrade_remaining_bandwidth_resp() {
+        let available_bandwidth = 42;
+        let remaining_bandwidth_data = Some(v3::registration::RemainingBandwidthData {
+            available_bandwidth,
+        });
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v3::response::AuthenticatorResponse::new_remaining_bandwidth(
+            remaining_bandwidth_data,
+            reply_to,
+            request_id,
+        );
+        let downgraded_msg = v2::response::AuthenticatorResponse::try_from(msg).unwrap();
+
+        assert_eq!(
+            downgraded_msg.protocol,
+            Protocol {
+                version: 2,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            downgraded_msg.data,
+            v2::response::AuthenticatorResponseData::RemainingBandwidth(
+                v2::response::RemainingBandwidthResponse {
+                    request_id,
+                    reply_to,
+                    reply: Some(v2::registration::RemainingBandwidthData {
+                        available_bandwidth,
+                    })
+                }
+            )
+        );
+    }
+
+    #[test]
+    fn downgrade_topup_resp() {
+        let available_bandwidth = 42;
+        let remaining_bandwidth_data = v3::registration::RemainingBandwidthData {
+            available_bandwidth,
+        };
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v3::response::AuthenticatorResponse::new_topup_bandwidth(
+            remaining_bandwidth_data,
+            reply_to,
+            request_id,
+        );
+        assert!(v2::response::AuthenticatorResponse::try_from(msg).is_err());
+    }
+}

common/authenticator-requests/src/v3/registration.rs

@@ -29,7 +29,7 @@ pub type Taken = Option<SystemTime>;
 
 pub const BANDWIDTH_CAP_PER_DAY: u64 = 250 * 1024 * 1024 * 1024; // 250 GB
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct InitMessage {
     /// Base64 encoded x25519 public key
     pub pub_key: PeerPublicKey,
@@ -41,7 +41,7 @@ impl InitMessage {
     }
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct FinalMessage {
     /// Gateway client data
     pub gateway_client: GatewayClient,
@@ -50,28 +50,28 @@ pub struct FinalMessage {
     pub credential: Option<CredentialSpendingData>,
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct RegistrationData {
     pub nonce: u64,
     pub gateway_data: GatewayClient,
     pub wg_port: u16,
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct RegistredData {
     pub pub_key: PeerPublicKey,
     pub private_ip: IpAddr,
     pub wg_port: u16,
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct RemainingBandwidthData {
     pub available_bandwidth: i64,
 }
 
 /// Client that wants to register sends its PublicKey bytes mac digest encrypted with a DH shared secret.
 /// Gateway/Nym node can then verify pub_key payload using the same process
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct GatewayClient {
     /// Base64 encoded x25519 public key
     pub pub_key: PeerPublicKey,
@@ -147,7 +147,7 @@ impl GatewayClient {
 
 // TODO: change the inner type into generic array of size HmacSha256::OutputSize
 // TODO2: rely on our internal crypto/hmac
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct ClientMac(Vec<u8>);
 
 impl fmt::Display for ClientMac {

common/authenticator-requests/src/v3/request.rs

@@ -106,7 +106,7 @@ impl AuthenticatorRequest {
     }
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub enum AuthenticatorRequestData {
     Initial(InitMessage),
     Final(Box<FinalMessage>),

common/authenticator-requests/src/v3/response.rs

@@ -120,7 +120,7 @@ impl AuthenticatorResponse {
     }
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub enum AuthenticatorResponseData {
     PendingRegistration(PendingRegistrationResponse),
     Registered(RegisteredResponse),
@@ -128,28 +128,28 @@ pub enum AuthenticatorResponseData {
     TopUpBandwidth(TopUpBandwidthResponse),
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct PendingRegistrationResponse {
     pub request_id: u64,
     pub reply_to: Recipient,
     pub reply: RegistrationData,
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct RegisteredResponse {
     pub request_id: u64,
     pub reply_to: Recipient,
     pub reply: RegistredData,
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct RemainingBandwidthResponse {
     pub request_id: u64,
     pub reply_to: Recipient,
     pub reply: Option<RemainingBandwidthData>,
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct TopUpBandwidthResponse {
     pub request_id: u64,
     pub reply_to: Recipient,

common/authenticator-requests/src/v3/topup.rs

@@ -5,7 +5,7 @@ use nym_credentials_interface::CredentialSpendingData;
 use nym_wireguard_types::PeerPublicKey;
 use serde::{Deserialize, Serialize};
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct TopUpMessage {
     /// Base64 encoded x25519 public key
     pub pub_key: PeerPublicKey,

common/authenticator-requests/src/v4/conversion.rs

@@ -3,37 +3,82 @@
 
 use nym_service_provider_requests_common::{Protocol, ServiceProviderType};
 
-use crate::{v2, v3, v4};
+use crate::{v3, v4};
 
-impl From<v3::request::AuthenticatorRequest> for v4::request::AuthenticatorRequest {
-    fn from(authenticator_request: v3::request::AuthenticatorRequest) -> Self {
-        Self {
+impl TryFrom<v3::request::AuthenticatorRequest> for v4::request::AuthenticatorRequest {
+    type Error = crate::Error;
+    fn try_from(
+        authenticator_request: v3::request::AuthenticatorRequest,
+    ) -> Result<Self, Self::Error> {
+        Ok(Self {
             protocol: Protocol {
                 version: 4,
                 service_provider_type: ServiceProviderType::Authenticator,
             },
-            data: authenticator_request.data.into(),
+            data: authenticator_request.data.try_into()?,
             reply_to: authenticator_request.reply_to,
             request_id: authenticator_request.request_id,
+        })
+    }
+}
+
+impl TryFrom<v4::request::AuthenticatorRequest> for v3::request::AuthenticatorRequest {
+    type Error = crate::Error;
+    fn try_from(
+        authenticator_request: v4::request::AuthenticatorRequest,
+    ) -> Result<Self, Self::Error> {
+        Ok(Self {
+            protocol: Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator,
+            },
+            data: authenticator_request.data.try_into()?,
+            reply_to: authenticator_request.reply_to,
+            request_id: authenticator_request.request_id,
+        })
+    }
+}
+
+impl TryFrom<v3::request::AuthenticatorRequestData> for v4::request::AuthenticatorRequestData {
+    type Error = crate::Error;
+    fn try_from(
+        authenticator_request_data: v3::request::AuthenticatorRequestData,
+    ) -> Result<Self, Self::Error> {
+        match authenticator_request_data {
+            v3::request::AuthenticatorRequestData::Initial(init_msg) => Ok(
+                v4::request::AuthenticatorRequestData::Initial(init_msg.into()),
+            ),
+            v3::request::AuthenticatorRequestData::Final(_) => Err(Self::Error::Conversion(
+                "mac hash breaking change".to_string(),
+            )),
+            v3::request::AuthenticatorRequestData::QueryBandwidth(pub_key) => Ok(
+                v4::request::AuthenticatorRequestData::QueryBandwidth(pub_key),
+            ),
+            v3::request::AuthenticatorRequestData::TopUpBandwidth(top_up_message) => Ok(
+                v4::request::AuthenticatorRequestData::TopUpBandwidth(top_up_message.into()),
+            ),
         }
     }
 }
 
-impl From<v3::request::AuthenticatorRequestData> for v4::request::AuthenticatorRequestData {
-    fn from(authenticator_request_data: v3::request::AuthenticatorRequestData) -> Self {
+impl TryFrom<v4::request::AuthenticatorRequestData> for v3::request::AuthenticatorRequestData {
+    type Error = crate::Error;
+    fn try_from(
+        authenticator_request_data: v4::request::AuthenticatorRequestData,
+    ) -> Result<Self, Self::Error> {
         match authenticator_request_data {
-            v3::request::AuthenticatorRequestData::Initial(init_msg) => {
-                v4::request::AuthenticatorRequestData::Initial(init_msg.into())
-            }
-            v3::request::AuthenticatorRequestData::Final(gw_client) => {
-                v4::request::AuthenticatorRequestData::Final(gw_client.into())
-            }
-            v3::request::AuthenticatorRequestData::QueryBandwidth(pub_key) => {
-                v4::request::AuthenticatorRequestData::QueryBandwidth(pub_key)
-            }
-            v3::request::AuthenticatorRequestData::TopUpBandwidth(top_up_message) => {
-                v4::request::AuthenticatorRequestData::TopUpBandwidth(top_up_message.into())
-            }
+            v4::request::AuthenticatorRequestData::Initial(init_msg) => Ok(
+                v3::request::AuthenticatorRequestData::Initial(init_msg.into()),
+            ),
+            v4::request::AuthenticatorRequestData::Final(_) => Err(Self::Error::Conversion(
+                "mac hash breaking change".to_string(),
+            )),
+            v4::request::AuthenticatorRequestData::QueryBandwidth(pub_key) => Ok(
+                v3::request::AuthenticatorRequestData::QueryBandwidth(pub_key),
+            ),
+            v4::request::AuthenticatorRequestData::TopUpBandwidth(top_up_message) => Ok(
+                v3::request::AuthenticatorRequestData::TopUpBandwidth(top_up_message.into()),
+            ),
         }
     }
 }
@@ -46,12 +91,11 @@ impl From<v3::registration::InitMessage> for v4::registration::InitMessage {
     }
 }
 
-impl From<Box<v3::registration::FinalMessage>> for Box<v4::registration::FinalMessage> {
-    fn from(gw_client: Box<v3::registration::FinalMessage>) -> Self {
-        Box::new(v4::registration::FinalMessage {
-            gateway_client: gw_client.gateway_client.into(),
-            credential: gw_client.credential,
-        })
+impl From<v4::registration::InitMessage> for v3::registration::InitMessage {
+    fn from(init_msg: v4::registration::InitMessage) -> Self {
+        Self {
+            pub_key: init_msg.pub_key,
+        }
     }
 }
 
@@ -64,67 +108,26 @@ impl From<Box<v3::topup::TopUpMessage>> for Box<v4::topup::TopUpMessage> {
     }
 }
 
-impl From<v2::registration::GatewayClient> for v4::registration::GatewayClient {
-    fn from(gw_client: v2::registration::GatewayClient) -> Self {
-        Self {
-            pub_key: gw_client.pub_key,
-            private_ips: gw_client.private_ip.into(),
-            mac: gw_client.mac.into(),
-        }
+impl From<Box<v4::topup::TopUpMessage>> for Box<v3::topup::TopUpMessage> {
+    fn from(top_up_message: Box<v4::topup::TopUpMessage>) -> Self {
+        Box::new(v3::topup::TopUpMessage {
+            pub_key: top_up_message.pub_key,
+            credential: top_up_message.credential,
+        })
     }
 }
 
-impl From<v3::registration::GatewayClient> for v4::registration::GatewayClient {
-    fn from(gw_client: v3::registration::GatewayClient) -> Self {
-        Self {
-            pub_key: gw_client.pub_key,
-            private_ips: gw_client.private_ip.into(),
-            mac: gw_client.mac.into(),
-        }
-    }
-}
-
-impl From<v4::registration::GatewayClient> for v3::registration::GatewayClient {
-    fn from(gw_client: v4::registration::GatewayClient) -> Self {
-        Self {
-            pub_key: gw_client.pub_key,
-            private_ip: gw_client.private_ips.ipv4.into(),
-            mac: gw_client.mac.into(),
-        }
-    }
-}
-
-impl From<v4::registration::GatewayClient> for v2::registration::GatewayClient {
-    fn from(gw_client: v4::registration::GatewayClient) -> Self {
-        Self {
-            pub_key: gw_client.pub_key,
-            private_ip: gw_client.private_ips.ipv4.into(),
-            mac: gw_client.mac.into(),
-        }
-    }
-}
-
-impl From<v2::registration::ClientMac> for v4::registration::ClientMac {
-    fn from(mac: v2::registration::ClientMac) -> Self {
-        Self::new(mac.to_vec())
-    }
-}
-
-impl From<v3::registration::ClientMac> for v4::registration::ClientMac {
-    fn from(mac: v3::registration::ClientMac) -> Self {
-        Self::new(mac.to_vec())
-    }
-}
-
-impl From<v4::registration::ClientMac> for v3::registration::ClientMac {
-    fn from(mac: v4::registration::ClientMac) -> Self {
-        Self::new(mac.to_vec())
-    }
-}
-
-impl From<v4::registration::ClientMac> for v2::registration::ClientMac {
-    fn from(mac: v4::registration::ClientMac) -> Self {
-        Self::new(mac.to_vec())
+impl TryFrom<v3::response::AuthenticatorResponse> for v4::response::AuthenticatorResponse {
+    type Error = crate::Error;
+    fn try_from(value: v3::response::AuthenticatorResponse) -> Result<Self, Self::Error> {
+        Ok(Self {
+            protocol: Protocol {
+                version: 4,
+                service_provider_type: value.protocol.service_provider_type,
+            },
+            data: value.data.try_into()?,
+            reply_to: value.reply_to,
+        })
     }
 }
 
@@ -137,11 +140,40 @@ impl TryFrom<v4::response::AuthenticatorResponse> for v3::response::Authenticato
         Ok(Self {
             data: authenticator_response.data.try_into()?,
             reply_to: authenticator_response.reply_to,
-            protocol: authenticator_response.protocol,
+            protocol: Protocol {
+                version: 3,
+                service_provider_type: authenticator_response.protocol.service_provider_type,
+            },
         })
     }
 }
 
+impl TryFrom<v3::response::AuthenticatorResponseData> for v4::response::AuthenticatorResponseData {
+    type Error = crate::Error;
+    fn try_from(
+        authenticator_response_data: v3::response::AuthenticatorResponseData,
+    ) -> Result<Self, Self::Error> {
+        match authenticator_response_data {
+            v3::response::AuthenticatorResponseData::PendingRegistration(_) => Err(
+                Self::Error::Conversion("mac hash breaking change".to_string()),
+            ),
+
+            v3::response::AuthenticatorResponseData::Registered(registered_response) => Ok(
+                v4::response::AuthenticatorResponseData::Registered(registered_response.into()),
+            ),
+
+            v3::response::AuthenticatorResponseData::RemainingBandwidth(
+                remaining_bandwidth_response,
+            ) => Ok(v4::response::AuthenticatorResponseData::RemainingBandwidth(
+                remaining_bandwidth_response.into(),
+            )),
+            v3::response::AuthenticatorResponseData::TopUpBandwidth(top_up_response) => Ok(
+                v4::response::AuthenticatorResponseData::TopUpBandwidth(top_up_response.into()),
+            ),
+        }
+    }
+}
+
 impl TryFrom<v4::response::AuthenticatorResponseData> for v3::response::AuthenticatorResponseData {
     type Error = crate::Error;
 
@@ -149,13 +181,10 @@ impl TryFrom<v4::response::AuthenticatorResponseData> for v3::response::Authenti
         authenticator_response_data: v4::response::AuthenticatorResponseData,
     ) -> Result<Self, Self::Error> {
         match authenticator_response_data {
-            v4::response::AuthenticatorResponseData::PendingRegistration(
-                pending_registration_response,
-            ) => Ok(
-                v3::response::AuthenticatorResponseData::PendingRegistration(
-                    pending_registration_response.into(),
-                ),
+            v4::response::AuthenticatorResponseData::PendingRegistration(_) => Err(
+                Self::Error::Conversion("mac hash breaking change".to_string()),
             ),
+
             v4::response::AuthenticatorResponseData::Registered(registered_response) => Ok(
                 v3::response::AuthenticatorResponseData::Registered(registered_response.into()),
             ),
@@ -173,8 +202,8 @@ impl TryFrom<v4::response::AuthenticatorResponseData> for v3::response::Authenti
     }
 }
 
-impl From<v4::response::PendingRegistrationResponse> for v3::response::PendingRegistrationResponse {
-    fn from(value: v4::response::PendingRegistrationResponse) -> Self {
+impl From<v4::response::RegisteredResponse> for v3::response::RegisteredResponse {
+    fn from(value: v4::response::RegisteredResponse) -> Self {
         Self {
             request_id: value.request_id,
             reply_to: value.reply_to,
@@ -183,8 +212,8 @@ impl From<v4::response::PendingRegistrationResponse> for v3::response::PendingRe
     }
 }
 
-impl From<v4::response::RegisteredResponse> for v3::response::RegisteredResponse {
-    fn from(value: v4::response::RegisteredResponse) -> Self {
+impl From<v3::response::RegisteredResponse> for v4::response::RegisteredResponse {
+    fn from(value: v3::response::RegisteredResponse) -> Self {
         Self {
             request_id: value.request_id,
             reply_to: value.reply_to,
@@ -193,6 +222,16 @@ impl From<v4::response::RegisteredResponse> for v3::response::RegisteredResponse
     }
 }
 
+impl From<v3::response::RemainingBandwidthResponse> for v4::response::RemainingBandwidthResponse {
+    fn from(value: v3::response::RemainingBandwidthResponse) -> Self {
+        Self {
+            request_id: value.request_id,
+            reply_to: value.reply_to,
+            reply: value.reply.map(Into::into),
+        }
+    }
+}
+
 impl From<v4::response::RemainingBandwidthResponse> for v3::response::RemainingBandwidthResponse {
     fn from(value: v4::response::RemainingBandwidthResponse) -> Self {
         Self {
@@ -203,11 +242,31 @@ impl From<v4::response::RemainingBandwidthResponse> for v3::response::RemainingB
     }
 }
 
-impl From<v4::registration::RegistrationData> for v3::registration::RegistrationData {
-    fn from(value: v4::registration::RegistrationData) -> Self {
+impl From<v3::response::TopUpBandwidthResponse> for v4::response::TopUpBandwidthResponse {
+    fn from(value: v3::response::TopUpBandwidthResponse) -> Self {
         Self {
-            nonce: value.nonce,
-            gateway_data: value.gateway_data.into(),
+            request_id: value.request_id,
+            reply_to: value.reply_to,
+            reply: value.reply.into(),
+        }
+    }
+}
+
+impl From<v4::response::TopUpBandwidthResponse> for v3::response::TopUpBandwidthResponse {
+    fn from(value: v4::response::TopUpBandwidthResponse) -> Self {
+        Self {
+            request_id: value.request_id,
+            reply_to: value.reply_to,
+            reply: value.reply.into(),
+        }
+    }
+}
+
+impl From<v3::registration::RegistredData> for v4::registration::RegistredData {
+    fn from(value: v3::registration::RegistredData) -> Self {
+        Self {
+            pub_key: value.pub_key,
+            private_ips: value.private_ip.into(),
             wg_port: value.wg_port,
         }
     }
@@ -223,6 +282,14 @@ impl From<v4::registration::RegistredData> for v3::registration::RegistredData {
     }
 }
 
+impl From<v3::registration::RemainingBandwidthData> for v4::registration::RemainingBandwidthData {
+    fn from(value: v3::registration::RemainingBandwidthData) -> Self {
+        Self {
+            available_bandwidth: value.available_bandwidth,
+        }
+    }
+}
+
 impl From<v4::registration::RemainingBandwidthData> for v3::registration::RemainingBandwidthData {
     fn from(value: v4::registration::RemainingBandwidthData) -> Self {
         Self {
@@ -230,3 +297,441 @@ impl From<v4::registration::RemainingBandwidthData> for v3::registration::Remain
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use std::{
+        net::{Ipv4Addr, Ipv6Addr},
+        str::FromStr,
+    };
+
+    use nym_credentials_interface::CredentialSpendingData;
+    use nym_crypto::asymmetric::encryption::PrivateKey;
+    use nym_sphinx::addressing::Recipient;
+    use nym_wireguard_types::PeerPublicKey;
+    use x25519_dalek::PublicKey;
+
+    use super::*;
+    use crate::util::tests::{CREDENTIAL_BYTES, RECIPIENT};
+
+    #[test]
+    fn upgrade_initial_req() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) = v3::request::AuthenticatorRequest::new_initial_request(
+            v3::registration::InitMessage::new(pub_key),
+            reply_to,
+        );
+        let upgraded_msg = v4::request::AuthenticatorRequest::try_from(msg).unwrap();
+
+        assert_eq!(
+            upgraded_msg.protocol,
+            Protocol {
+                version: 4,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            upgraded_msg.data,
+            v4::request::AuthenticatorRequestData::Initial(v4::registration::InitMessage {
+                pub_key
+            })
+        );
+    }
+
+    #[test]
+    fn downgrade_initial_req() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) = v4::request::AuthenticatorRequest::new_initial_request(
+            v4::registration::InitMessage::new(pub_key),
+            reply_to,
+        );
+        let downgraded_msg = v3::request::AuthenticatorRequest::try_from(msg).unwrap();
+
+        assert_eq!(
+            downgraded_msg.protocol,
+            Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            downgraded_msg.data,
+            v3::request::AuthenticatorRequestData::Initial(v3::registration::InitMessage {
+                pub_key
+            })
+        );
+    }
+
+    #[test]
+    fn upgrade_final_req() {
+        let mut rng = rand::thread_rng();
+
+        let local_secret = PrivateKey::new(&mut rng);
+        let remote_secret = x25519_dalek::StaticSecret::random_from_rng(&mut rng);
+        let ipv4 = Ipv4Addr::from_str("10.10.10.10").unwrap();
+        let nonce = 42;
+        let gateway_client = v3::registration::GatewayClient::new(
+            &local_secret,
+            (&remote_secret).into(),
+            ipv4.into(),
+            nonce,
+        );
+        let credential = Some(CredentialSpendingData::try_from_bytes(&CREDENTIAL_BYTES).unwrap());
+        let final_message = v3::registration::FinalMessage {
+            gateway_client,
+            credential: credential.clone(),
+        };
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) =
+            v3::request::AuthenticatorRequest::new_final_request(final_message, reply_to);
+        assert!(v4::request::AuthenticatorRequest::try_from(msg).is_err());
+    }
+
+    #[test]
+    fn downgrade_final_req() {
+        let mut rng = rand::thread_rng();
+
+        let local_secret = PrivateKey::new(&mut rng);
+        let remote_secret = x25519_dalek::StaticSecret::random_from_rng(&mut rng);
+        let ipv4 = Ipv4Addr::from_str("10.10.10.10").unwrap();
+        let private_ips =
+            v4::registration::IpPair::new(ipv4, Ipv6Addr::from_str("fc01::10").unwrap());
+        let nonce = 42;
+        let gateway_client = v4::registration::GatewayClient::new(
+            &local_secret,
+            (&remote_secret).into(),
+            private_ips,
+            nonce,
+        );
+        let credential = Some(CredentialSpendingData::try_from_bytes(&CREDENTIAL_BYTES).unwrap());
+        let final_message = v4::registration::FinalMessage {
+            gateway_client,
+            credential: credential.clone(),
+        };
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) =
+            v4::request::AuthenticatorRequest::new_final_request(final_message, reply_to);
+        assert!(v3::request::AuthenticatorRequest::try_from(msg).is_err());
+    }
+
+    #[test]
+    fn upgrade_query_req() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) = v3::request::AuthenticatorRequest::new_query_request(pub_key, reply_to);
+        let upgraded_msg = v4::request::AuthenticatorRequest::try_from(msg).unwrap();
+
+        assert_eq!(
+            upgraded_msg.protocol,
+            Protocol {
+                version: 4,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            upgraded_msg.data,
+            v4::request::AuthenticatorRequestData::QueryBandwidth(pub_key)
+        );
+    }
+
+    #[test]
+    fn downgrade_query_req() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) = v4::request::AuthenticatorRequest::new_query_request(pub_key, reply_to);
+        let downgraded_msg = v3::request::AuthenticatorRequest::try_from(msg).unwrap();
+
+        assert_eq!(
+            downgraded_msg.protocol,
+            Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            downgraded_msg.data,
+            v3::request::AuthenticatorRequestData::QueryBandwidth(pub_key)
+        );
+    }
+
+    #[test]
+    fn downgrade_topup_req() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let credential = CredentialSpendingData::try_from_bytes(&CREDENTIAL_BYTES).unwrap();
+        let top_up_message = v4::topup::TopUpMessage {
+            pub_key,
+            credential: credential.clone(),
+        };
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let (msg, _) =
+            v4::request::AuthenticatorRequest::new_topup_request(top_up_message, reply_to);
+        let downgraded_msg = v3::request::AuthenticatorRequest::try_from(msg).unwrap();
+
+        assert_eq!(
+            downgraded_msg.protocol,
+            Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            downgraded_msg.data,
+            v3::request::AuthenticatorRequestData::TopUpBandwidth(Box::new(
+                v3::topup::TopUpMessage {
+                    pub_key,
+                    credential
+                }
+            ))
+        );
+    }
+
+    #[test]
+    fn upgrade_pending_reg_resp() {
+        let mut rng = rand::thread_rng();
+
+        let local_secret = PrivateKey::new(&mut rng);
+        let remote_secret = x25519_dalek::StaticSecret::random_from_rng(&mut rng);
+        let ipv4 = Ipv4Addr::from_str("10.10.10.10").unwrap();
+        let nonce = 42;
+        let wg_port = 51822;
+        let gateway_data = v3::registration::GatewayClient::new(
+            &local_secret,
+            (&remote_secret).into(),
+            ipv4.into(),
+            nonce,
+        );
+        let registration_data = v3::registration::RegistrationData {
+            nonce,
+            gateway_data,
+            wg_port,
+        };
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v3::response::AuthenticatorResponse::new_pending_registration_success(
+            registration_data,
+            request_id,
+            reply_to,
+        );
+        assert!(v4::response::AuthenticatorResponse::try_from(msg).is_err());
+    }
+
+    #[test]
+    fn downgrade_pending_reg_resp() {
+        let mut rng = rand::thread_rng();
+
+        let local_secret = PrivateKey::new(&mut rng);
+        let remote_secret = x25519_dalek::StaticSecret::random_from_rng(&mut rng);
+        let ipv4 = Ipv4Addr::from_str("10.10.10.10").unwrap();
+        let private_ips =
+            v4::registration::IpPair::new(ipv4, Ipv6Addr::from_str("fc01::10").unwrap());
+        let nonce = 42;
+        let wg_port = 51822;
+        let gateway_data = v4::registration::GatewayClient::new(
+            &local_secret,
+            (&remote_secret).into(),
+            private_ips,
+            nonce,
+        );
+        let registration_data = v4::registration::RegistrationData {
+            nonce,
+            gateway_data,
+            wg_port,
+        };
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v4::response::AuthenticatorResponse::new_pending_registration_success(
+            registration_data,
+            request_id,
+            reply_to,
+        );
+        assert!(v3::response::AuthenticatorResponse::try_from(msg).is_err());
+    }
+
+    #[test]
+    fn upgrade_registered_resp() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let ipv4 = Ipv4Addr::from_str("10.1.10.10").unwrap();
+        let private_ips =
+            v4::registration::IpPair::new(ipv4, Ipv6Addr::from_str("fc01::a0a").unwrap());
+        let wg_port = 51822;
+        let registred_data = v3::registration::RegistredData {
+            pub_key,
+            private_ip: ipv4.into(),
+            wg_port,
+        };
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v3::response::AuthenticatorResponse::new_registered(
+            registred_data,
+            reply_to,
+            request_id,
+        );
+        let upgraded_msg = v4::response::AuthenticatorResponse::try_from(msg).unwrap();
+
+        assert_eq!(
+            upgraded_msg.protocol,
+            Protocol {
+                version: 4,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            upgraded_msg.data,
+            v4::response::AuthenticatorResponseData::Registered(v4::response::RegisteredResponse {
+                request_id,
+                reply_to,
+                reply: v4::registration::RegistredData {
+                    wg_port,
+                    pub_key,
+                    private_ips
+                }
+            })
+        );
+    }
+
+    #[test]
+    fn downgrade_registered_resp() {
+        let pub_key = PeerPublicKey::new(PublicKey::from([0; 32]));
+        let ipv4 = Ipv4Addr::from_str("10.10.10.10").unwrap();
+        let private_ips =
+            v4::registration::IpPair::new(ipv4, Ipv6Addr::from_str("fc01::10").unwrap());
+        let wg_port = 51822;
+        let registred_data = v4::registration::RegistredData {
+            pub_key,
+            private_ips,
+            wg_port,
+        };
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v4::response::AuthenticatorResponse::new_registered(
+            registred_data,
+            reply_to,
+            request_id,
+        );
+        let downgraded_msg = v3::response::AuthenticatorResponse::try_from(msg).unwrap();
+
+        assert_eq!(
+            downgraded_msg.protocol,
+            Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            downgraded_msg.data,
+            v3::response::AuthenticatorResponseData::Registered(v3::response::RegisteredResponse {
+                request_id,
+                reply_to,
+                reply: v3::registration::RegistredData {
+                    wg_port,
+                    pub_key,
+                    private_ip: ipv4.into()
+                }
+            })
+        );
+    }
+
+    #[test]
+    fn upgrade_remaining_bandwidth_resp() {
+        let available_bandwidth = 42;
+        let remaining_bandwidth_data = Some(v3::registration::RemainingBandwidthData {
+            available_bandwidth,
+        });
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v3::response::AuthenticatorResponse::new_remaining_bandwidth(
+            remaining_bandwidth_data,
+            reply_to,
+            request_id,
+        );
+        let upgraded_msg = v4::response::AuthenticatorResponse::try_from(msg).unwrap();
+
+        assert_eq!(
+            upgraded_msg.protocol,
+            Protocol {
+                version: 4,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            upgraded_msg.data,
+            v4::response::AuthenticatorResponseData::RemainingBandwidth(
+                v4::response::RemainingBandwidthResponse {
+                    request_id,
+                    reply_to,
+                    reply: Some(v4::registration::RemainingBandwidthData {
+                        available_bandwidth,
+                    })
+                }
+            )
+        );
+    }
+
+    #[test]
+    fn downgrade_remaining_bandwidth_resp() {
+        let available_bandwidth = 42;
+        let remaining_bandwidth_data = Some(v4::registration::RemainingBandwidthData {
+            available_bandwidth,
+        });
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v4::response::AuthenticatorResponse::new_remaining_bandwidth(
+            remaining_bandwidth_data,
+            reply_to,
+            request_id,
+        );
+        let downgraded_msg = v3::response::AuthenticatorResponse::try_from(msg).unwrap();
+
+        assert_eq!(
+            downgraded_msg.protocol,
+            Protocol {
+                version: 3,
+                service_provider_type: ServiceProviderType::Authenticator
+            }
+        );
+        assert_eq!(
+            downgraded_msg.data,
+            v3::response::AuthenticatorResponseData::RemainingBandwidth(
+                v3::response::RemainingBandwidthResponse {
+                    request_id,
+                    reply_to,
+                    reply: Some(v3::registration::RemainingBandwidthData {
+                        available_bandwidth,
+                    })
+                }
+            )
+        );
+    }
+
+    #[test]
+    fn downgrade_topup_resp() {
+        let available_bandwidth = 42;
+        let remaining_bandwidth_data = v4::registration::RemainingBandwidthData {
+            available_bandwidth,
+        };
+        let request_id = 123;
+        let reply_to = Recipient::try_from_base58_string(RECIPIENT).unwrap();
+
+        let msg = v4::response::AuthenticatorResponse::new_topup_bandwidth(
+            remaining_bandwidth_data,
+            reply_to,
+            request_id,
+        );
+        assert!(v3::response::AuthenticatorResponse::try_from(msg).is_err());
+    }
+}

common/authenticator-requests/src/v4/registration.rs

@@ -81,7 +81,7 @@ impl From<IpAddr> for IpPair {
     }
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct InitMessage {
     /// Base64 encoded x25519 public key
     pub pub_key: PeerPublicKey,
@@ -93,7 +93,7 @@ impl InitMessage {
     }
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct FinalMessage {
     /// Gateway client data
     pub gateway_client: GatewayClient,
@@ -102,28 +102,28 @@ pub struct FinalMessage {
     pub credential: Option<CredentialSpendingData>,
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct RegistrationData {
     pub nonce: u64,
     pub gateway_data: GatewayClient,
     pub wg_port: u16,
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct RegistredData {
     pub pub_key: PeerPublicKey,
     pub private_ips: IpPair,
     pub wg_port: u16,
 }
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct RemainingBandwidthData {
     pub available_bandwidth: i64,
 }
 
 /// Client that wants to register sends its PublicKey bytes mac digest encrypted with a DH shared secret.
 /// Gateway/Nym node can then verify pub_key payload using the same process
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct GatewayClient {
     /// Base64 encoded x25519 public key
     pub pub_key: PeerPublicKey,
@@ -199,7 +199,7 @@ impl GatewayClient {
 
 // TODO: change the inner type into generic array of size HmacSha256::OutputSize
 // TODO2: rely on our internal crypto/hmac
-#[derive(Debug, Clone)]
+#[derive(Debug, Clone, PartialEq)]
 pub struct ClientMac(Vec<u8>);
 
 impl fmt::Display for ClientMac {

common/authenticator-requests/src/v4/request.rs

@@ -20,7 +20,7 @@ fn generate_random() -> u64 {
     rng.next_u64()
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct AuthenticatorRequest {
     pub protocol: Protocol,
     pub data: AuthenticatorRequestData,
@@ -106,7 +106,7 @@ impl AuthenticatorRequest {
     }
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub enum AuthenticatorRequestData {
     Initial(InitMessage),
     Final(Box<FinalMessage>),

common/authenticator-requests/src/v4/response.rs

@@ -10,7 +10,7 @@ use crate::make_bincode_serializer;
 
 use super::VERSION;
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct AuthenticatorResponse {
     pub protocol: Protocol,
     pub data: AuthenticatorResponseData,
@@ -120,7 +120,7 @@ impl AuthenticatorResponse {
     }
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub enum AuthenticatorResponseData {
     PendingRegistration(PendingRegistrationResponse),
     Registered(RegisteredResponse),
@@ -128,28 +128,28 @@ pub enum AuthenticatorResponseData {
     TopUpBandwidth(TopUpBandwidthResponse),
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct PendingRegistrationResponse {
     pub request_id: u64,
     pub reply_to: Recipient,
     pub reply: RegistrationData,
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct RegisteredResponse {
     pub request_id: u64,
     pub reply_to: Recipient,
     pub reply: RegistredData,
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct RemainingBandwidthResponse {
     pub request_id: u64,
     pub reply_to: Recipient,
     pub reply: Option<RemainingBandwidthData>,
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct TopUpBandwidthResponse {
     pub request_id: u64,
     pub reply_to: Recipient,

common/authenticator-requests/src/v4/topup.rs

@@ -5,7 +5,7 @@ use nym_credentials_interface::CredentialSpendingData;
 use nym_wireguard_types::PeerPublicKey;
 use serde::{Deserialize, Serialize};
 
-#[derive(Serialize, Deserialize, Debug, Clone)]
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
 pub struct TopUpMessage {
     /// Base64 encoded x25519 public key
     pub pub_key: PeerPublicKey,

common/bandwidth-controller/src/acquire/mod.rs

@@ -17,7 +17,7 @@ use nym_validator_client::coconut::all_ecash_api_clients;
 use nym_validator_client::nym_api::EpochId;
 use nym_validator_client::nyxd::contract_traits::EcashSigningClient;
 use nym_validator_client::nyxd::contract_traits::{DkgQueryClient, EcashQueryClient};
-use nym_validator_client::nyxd::cosmwasm_client::ToSingletonContractData;
+use nym_validator_client::nyxd::cosmwasm_client::ContractResponseData;
 use nym_validator_client::EcashApiClient;
 use rand::rngs::OsRng;
 

common/bin-common/Cargo.toml

@@ -15,7 +15,6 @@ const-str = { workspace = true }
 log = { workspace = true }
 pretty_env_logger = { workspace = true }
 schemars = { workspace = true, features = ["preserve_order"], optional = true }
-semver.workspace = true
 serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true, optional = true }
 
@@ -44,5 +43,5 @@ tracing = [
     "tracing-opentelemetry",
     "opentelemetry",
 ]
-clap = [ "dep:clap", "dep:clap_complete", "dep:clap_complete_fig" ]
+clap = ["dep:clap", "dep:clap_complete", "dep:clap_complete_fig"]
 models = []

common/bin-common/src/lib.rs

@@ -3,7 +3,6 @@
 
 pub mod build_information;
 pub mod logging;
-pub mod version_checker;
 
 #[cfg(feature = "clap")]
 pub mod completions;

common/bin-common/src/version_checker/mod.rs

@@ -1,78 +0,0 @@
-// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-pub use semver::Version;
-
-/// Checks if the version is minor version compatible.
-///
-/// Checks whether given `version` is compatible with a given semantic version requirement `req`
-/// according to major-minor semver rules. The semantic version requirement can be passed as a full,
-/// concrete version number, because that's what we'll have in our Cargo.toml files (e.g. 0.3.2).
-/// The patch number in the requirement gets dropped and replaced with a wildcard (0.3.*) as all
-/// minor versions should be compatible with each other.
-pub fn is_minor_version_compatible(version: &str, req: &str) -> bool {
-    let expected_version = match Version::parse(version) {
-        Ok(v) => v,
-        Err(_) => return false,
-    };
-    let req_version = match Version::parse(req) {
-        Ok(v) => v,
-        Err(_) => return false,
-    };
-
-    expected_version.major == req_version.major && expected_version.minor == req_version.minor
-}
-
-pub fn parse_version(raw_version: &str) -> Result<Version, semver::Error> {
-    Version::parse(raw_version)
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn version_0_3_0_is_compatible_with_requirement_0_3_x() {
-        assert!(is_minor_version_compatible("0.3.0", "0.3.2"));
-    }
-
-    #[test]
-    fn version_0_3_1_is_compatible_with_minimum_requirement_0_3_x() {
-        assert!(is_minor_version_compatible("0.3.1", "0.3.2"));
-    }
-
-    #[test]
-    fn version_0_3_2_is_compatible_with_minimum_requirement_0_3_x() {
-        assert!(is_minor_version_compatible("0.3.2", "0.3.0"));
-    }
-
-    #[test]
-    fn version_0_2_0_is_not_compatible_with_requirement_0_3_x() {
-        assert!(!is_minor_version_compatible("0.2.0", "0.3.2"));
-    }
-
-    #[test]
-    fn version_0_4_0_is_not_compatible_with_requirement_0_3_x() {
-        assert!(!is_minor_version_compatible("0.4.0", "0.3.2"));
-    }
-
-    #[test]
-    fn version_1_3_2_is_not_compatible_with_requirement_0_3_x() {
-        assert!(!is_minor_version_compatible("1.3.2", "0.3.2"));
-    }
-
-    #[test]
-    fn version_0_4_0_rc_1_is_compatible_with_version_0_4_0_rc_1() {
-        assert!(is_minor_version_compatible("0.4.0-rc.1", "0.4.0-rc.1"));
-    }
-
-    #[test]
-    fn returns_false_on_foo_version() {
-        assert!(!is_minor_version_compatible("foo", "0.3.2"));
-    }
-
-    #[test]
-    fn returns_false_on_bar_version() {
-        assert!(!is_minor_version_compatible("0.3.2", "bar"));
-    }
-}

common/client-core/src/cli_helpers/client_add_gateway.rs

@@ -115,8 +115,13 @@ where
         hardcoded_topology.get_gateways()
     } else {
         let mut rng = rand::thread_rng();
-        crate::init::helpers::current_gateways(&mut rng, &core.client.nym_api_urls, user_agent)
-            .await?
+        crate::init::helpers::current_gateways(
+            &mut rng,
+            &core.client.nym_api_urls,
+            user_agent,
+            core.debug.topology.minimum_gateway_performance,
+        )
+        .await?
     };
 
     // since we're registering with a brand new gateway,

common/client-core/src/cli_helpers/client_init.rs

@@ -170,8 +170,13 @@ where
         hardcoded_topology.get_gateways()
     } else {
         let mut rng = rand::thread_rng();
-        crate::init::helpers::current_gateways(&mut rng, &core.client.nym_api_urls, user_agent)
-            .await?
+        crate::init::helpers::current_gateways(
+            &mut rng,
+            &core.client.nym_api_urls,
+            user_agent,
+            core.debug.topology.minimum_gateway_performance,
+        )
+        .await?
     };
 
     let gateway_setup = GatewaySetup::New {

common/client-core/src/client/base_client/mod.rs

@@ -514,15 +514,10 @@ where
                     min_gateway_performance: config_topology.minimum_gateway_performance,
                 },
                 nym_api_urls,
-                env!("CARGO_PKG_VERSION").to_string(),
                 user_agent,
             )),
             config::TopologyStructure::GeoAware(group_by) => {
-                Box::new(GeoAwareTopologyProvider::new(
-                    nym_api_urls,
-                    env!("CARGO_PKG_VERSION").to_string(),
-                    group_by,
-                ))
+                Box::new(GeoAwareTopologyProvider::new(nym_api_urls, group_by))
             }
         })
     }

common/client-core/src/client/topology_control/geo_aware_provider.rs

@@ -85,15 +85,10 @@ fn check_layer_integrity(topology: NymTopology) -> Result<(), ()> {
 pub struct GeoAwareTopologyProvider {
     validator_client: nym_validator_client::client::NymApiClient,
     filter_on: GroupBy,
-    client_version: String,
 }
 
 impl GeoAwareTopologyProvider {
-    pub fn new(
-        mut nym_api_urls: Vec<Url>,
-        client_version: String,
-        filter_on: GroupBy,
-    ) -> GeoAwareTopologyProvider {
+    pub fn new(mut nym_api_urls: Vec<Url>, filter_on: GroupBy) -> GeoAwareTopologyProvider {
         log::info!(
             "Creating geo-aware topology provider with filter on {}",
             filter_on
@@ -105,14 +100,13 @@ impl GeoAwareTopologyProvider {
                 nym_api_urls[0].clone(),
             ),
             filter_on,
-            client_version,
         }
     }
 
     async fn get_topology(&self) -> Option<NymTopology> {
         let mixnodes = match self
             .validator_client
-            .get_all_basic_active_mixing_assigned_nodes(Some(self.client_version.clone()))
+            .get_all_basic_active_mixing_assigned_nodes()
             .await
         {
             Err(err) => {
@@ -124,7 +118,7 @@ impl GeoAwareTopologyProvider {
 
         let gateways = match self
             .validator_client
-            .get_all_basic_entry_assigned_nodes(Some(self.client_version.clone()))
+            .get_all_basic_entry_assigned_nodes()
             .await
         {
             Err(err) => {

common/client-core/src/client/topology_control/nym_api_provider.rs

@@ -35,18 +35,11 @@ pub struct NymApiTopologyProvider {
 
     validator_client: nym_validator_client::client::NymApiClient,
     nym_api_urls: Vec<Url>,
-
-    client_version: String,
     currently_used_api: usize,
 }
 
 impl NymApiTopologyProvider {
-    pub fn new(
-        config: Config,
-        mut nym_api_urls: Vec<Url>,
-        client_version: String,
-        user_agent: Option<UserAgent>,
-    ) -> Self {
+    pub fn new(config: Config, mut nym_api_urls: Vec<Url>, user_agent: Option<UserAgent>) -> Self {
         nym_api_urls.shuffle(&mut thread_rng());
 
         let validator_client = if let Some(user_agent) = user_agent {
@@ -62,7 +55,6 @@ impl NymApiTopologyProvider {
             config,
             validator_client,
             nym_api_urls,
-            client_version,
             currently_used_api: 0,
         }
     }
@@ -99,7 +91,7 @@ impl NymApiTopologyProvider {
     async fn get_current_compatible_topology(&mut self) -> Option<NymTopology> {
         let mixnodes = match self
             .validator_client
-            .get_all_basic_active_mixing_assigned_nodes(Some(self.client_version.clone()))
+            .get_all_basic_active_mixing_assigned_nodes()
             .await
         {
             Err(err) => {
@@ -111,7 +103,7 @@ impl NymApiTopologyProvider {
 
         let gateways = match self
             .validator_client
-            .get_all_basic_entry_assigned_nodes(Some(self.client_version.clone()))
+            .get_all_basic_entry_assigned_nodes()
             .await
         {
             Err(err) => {

common/client-core/src/init/helpers.rs

@@ -7,7 +7,7 @@ use futures::{SinkExt, StreamExt};
 use log::{debug, info, trace, warn};
 use nym_crypto::asymmetric::identity;
 use nym_gateway_client::GatewayClient;
-use nym_topology::{gateway, mix};
+use nym_topology::gateway;
 use nym_validator_client::client::IdentityKeyRef;
 use nym_validator_client::UserAgent;
 use rand::{seq::SliceRandom, Rng};
@@ -82,6 +82,7 @@ pub async fn current_gateways<R: Rng>(
     rng: &mut R,
     nym_apis: &[Url],
     user_agent: Option<UserAgent>,
+    minimum_performance: u8,
 ) -> Result<Vec<gateway::LegacyNode>, ClientCoreError> {
     let nym_api = nym_apis
         .choose(rng)
@@ -94,44 +95,27 @@ pub async fn current_gateways<R: Rng>(
 
     log::debug!("Fetching list of gateways from: {nym_api}");
 
-    let gateways = client.get_all_basic_entry_assigned_nodes(None).await?;
-    log::debug!("Found {} gateways", gateways.len());
+    let gateways = client.get_all_basic_entry_assigned_nodes().await?;
+    info!("nym api reports {} gateways", gateways.len());
+
     log::trace!("Gateways: {:#?}", gateways);
 
     let valid_gateways = gateways
         .iter()
+        .filter(|g| g.performance.round_to_integer() >= minimum_performance)
         .filter_map(|gateway| gateway.try_into().ok())
         .collect::<Vec<gateway::LegacyNode>>();
     log::debug!("After checking validity: {}", valid_gateways.len());
     log::trace!("Valid gateways: {:#?}", valid_gateways);
 
-    log::info!("nym-api reports {} valid gateways", valid_gateways.len());
+    log::info!(
+        "and {} after validity and performance filtering",
+        valid_gateways.len()
+    );
 
     Ok(valid_gateways)
 }
 
-pub async fn current_mixnodes<R: Rng>(
-    rng: &mut R,
-    nym_apis: &[Url],
-) -> Result<Vec<mix::LegacyNode>, ClientCoreError> {
-    let nym_api = nym_apis
-        .choose(rng)
-        .ok_or(ClientCoreError::ListOfNymApisIsEmpty)?;
-    let client = nym_validator_client::client::NymApiClient::new(nym_api.clone());
-
-    log::trace!("Fetching list of mixnodes from: {nym_api}");
-
-    let mixnodes = client
-        .get_all_basic_active_mixing_assigned_nodes(None)
-        .await?;
-    let valid_mixnodes = mixnodes
-        .iter()
-        .filter_map(|mixnode| mixnode.try_into().ok())
-        .collect::<Vec<mix::LegacyNode>>();
-
-    Ok(valid_mixnodes)
-}
-
 #[cfg(not(target_arch = "wasm32"))]
 async fn connect(endpoint: &str) -> Result<WsConn, ClientCoreError> {
     match tokio::time::timeout(CONN_TIMEOUT, connect_async(endpoint)).await {

common/client-libs/gateway-client/src/bandwidth.rs

@@ -87,8 +87,10 @@ impl ClientBandwidth {
 
         if remaining < 0 {
             tracing::warn!("OUT OF BANDWIDTH. remaining: {remaining_bi2}");
-        } else {
+        } else if remaining < 1_000_000 {
             tracing::info!("remaining bandwidth: {remaining_bi2}");
+        } else {
+            tracing::debug!("remaining bandwidth: {remaining_bi2}");
         }
 
         self.inner

common/client-libs/gateway-client/src/client/mod.rs

@@ -139,6 +139,10 @@ impl<C, St> GatewayClient<C, St> {
         self.gateway_identity
     }
 
+    pub fn shared_key(&self) -> Option<Arc<SharedGatewayKey>> {
+        self.shared_key.clone()
+    }
+
     pub fn ws_fd(&self) -> Option<RawFd> {
         match &self.connection {
             SocketState::Available(conn) => ws_fd(conn.as_ref()),
@@ -408,7 +412,7 @@ impl<C, St> GatewayClient<C, St> {
             }
 
             Some(_) => {
-                info!("the gateway is using exactly the same (or older) protocol version as we are. We're good to continue!");
+                debug!("the gateway is using exactly the same (or older) protocol version as we are. We're good to continue!");
                 Ok(())
             }
         }
@@ -992,24 +996,6 @@ impl<C, St> GatewayClient<C, St> {
         }
         Ok(())
     }
-
-    #[deprecated(note = "this method does not deal with upgraded keys for legacy clients")]
-    pub async fn authenticate_and_start(
-        &mut self,
-    ) -> Result<AuthenticationResponse, GatewayClientError>
-    where
-        C: DkgQueryClient + Send + Sync,
-        St: CredentialStorage,
-        <St as CredentialStorage>::StorageError: Send + Sync + 'static,
-    {
-        let shared_key = self.perform_initial_authentication().await?;
-        self.claim_initial_bandwidth().await?;
-
-        // this call is NON-blocking
-        self.start_listening_for_mixnet_messages()?;
-
-        Ok(shared_key)
-    }
 }
 
 // type alias for an ease of use

common/client-libs/gateway-client/src/socket_state.rs

@@ -111,6 +111,11 @@ impl PartiallyDelegatedRouter {
             }
         };
 
+        if self.stream_return.is_canceled() {
+            // nothing to do, receiver has been dropped
+            return;
+        }
+
         let return_res = match ret {
             Err(err) => self.stream_return.send(Err(err)),
             Ok(_) => {

common/client-libs/validator-client/src/client.rs

@@ -19,8 +19,8 @@ use nym_api_requests::ecash::{
     PartialExpirationDateSignatureResponse, VerificationKeyResponse,
 };
 use nym_api_requests::models::{
-    ApiHealthResponse, GatewayCoreStatusResponse, MixnodeCoreStatusResponse, MixnodeStatusResponse,
-    NymNodeDescription, RewardEstimationResponse, StakeSaturationResponse,
+    ApiHealthResponse, GatewayBondAnnotated, GatewayCoreStatusResponse, MixnodeCoreStatusResponse,
+    MixnodeStatusResponse, NymNodeDescription, RewardEstimationResponse, StakeSaturationResponse,
 };
 use nym_api_requests::models::{LegacyDescribedGateway, MixNodeBondAnnotated};
 use nym_api_requests::nym_nodes::SkimmedNode;
@@ -257,6 +257,13 @@ impl<C, S> Client<C, S> {
         Ok(self.nym_api.get_gateways().await?)
     }
 
+    #[deprecated]
+    pub async fn get_cached_gateways_detailed_unfiltered(
+        &self,
+    ) -> Result<Vec<GatewayBondAnnotated>, ValidatorClientError> {
+        Ok(self.nym_api.get_gateways_detailed_unfiltered().await?)
+    }
+
     // TODO: combine with NymApiClient...
     pub async fn get_all_cached_described_nodes(
         &self,
@@ -351,34 +358,19 @@ impl NymApiClient {
     }
 
     #[deprecated(note = "use get_all_basic_active_mixing_assigned_nodes instead")]
-    pub async fn get_basic_mixnodes(
-        &self,
-        semver_compatibility: Option<String>,
-    ) -> Result<Vec<SkimmedNode>, ValidatorClientError> {
-        Ok(self
-            .nym_api
-            .get_basic_mixnodes(semver_compatibility)
-            .await?
-            .nodes)
+    pub async fn get_basic_mixnodes(&self) -> Result<Vec<SkimmedNode>, ValidatorClientError> {
+        Ok(self.nym_api.get_basic_mixnodes().await?.nodes)
     }
 
     #[deprecated(note = "use get_all_basic_entry_assigned_nodes instead")]
-    pub async fn get_basic_gateways(
-        &self,
-        semver_compatibility: Option<String>,
-    ) -> Result<Vec<SkimmedNode>, ValidatorClientError> {
-        Ok(self
-            .nym_api
-            .get_basic_gateways(semver_compatibility)
-            .await?
-            .nodes)
+    pub async fn get_basic_gateways(&self) -> Result<Vec<SkimmedNode>, ValidatorClientError> {
+        Ok(self.nym_api.get_basic_gateways().await?.nodes)
     }
 
     /// retrieve basic information for nodes are capable of operating as an entry gateway
     /// this includes legacy gateways and nym-nodes
     pub async fn get_all_basic_entry_assigned_nodes(
         &self,
-        semver_compatibility: Option<String>,
     ) -> Result<Vec<SkimmedNode>, ValidatorClientError> {
         // TODO: deal with paging in macro or some helper function or something, because it's the same pattern everywhere
         let mut page = 0;
@@ -387,12 +379,7 @@ impl NymApiClient {
         loop {
             let mut res = self
                 .nym_api
-                .get_basic_entry_assigned_nodes(
-                    semver_compatibility.clone(),
-                    false,
-                    Some(page),
-                    None,
-                )
+                .get_basic_entry_assigned_nodes(false, Some(page), None)
                 .await?;
 
             nodes.append(&mut res.nodes.data);
@@ -410,7 +397,6 @@ impl NymApiClient {
     /// this includes legacy mixnodes and nym-nodes
     pub async fn get_all_basic_active_mixing_assigned_nodes(
         &self,
-        semver_compatibility: Option<String>,
     ) -> Result<Vec<SkimmedNode>, ValidatorClientError> {
         // TODO: deal with paging in macro or some helper function or something, because it's the same pattern everywhere
         let mut page = 0;
@@ -419,12 +405,7 @@ impl NymApiClient {
         loop {
             let mut res = self
                 .nym_api
-                .get_basic_active_mixing_assigned_nodes(
-                    semver_compatibility.clone(),
-                    false,
-                    Some(page),
-                    None,
-                )
+                .get_basic_active_mixing_assigned_nodes(false, Some(page), None)
                 .await?;
 
             nodes.append(&mut res.nodes.data);
@@ -442,7 +423,6 @@ impl NymApiClient {
     /// this includes legacy mixnodes and nym-nodes
     pub async fn get_all_basic_mixing_capable_nodes(
         &self,
-        semver_compatibility: Option<String>,
     ) -> Result<Vec<SkimmedNode>, ValidatorClientError> {
         // TODO: deal with paging in macro or some helper function or something, because it's the same pattern everywhere
         let mut page = 0;
@@ -451,12 +431,7 @@ impl NymApiClient {
         loop {
             let mut res = self
                 .nym_api
-                .get_basic_mixing_capable_nodes(
-                    semver_compatibility.clone(),
-                    false,
-                    Some(page),
-                    None,
-                )
+                .get_basic_mixing_capable_nodes(false, Some(page), None)
                 .await?;
 
             nodes.append(&mut res.nodes.data);
@@ -471,10 +446,7 @@ impl NymApiClient {
     }
 
     /// retrieve basic information for all bonded nodes on the network
-    pub async fn get_all_basic_nodes(
-        &self,
-        semver_compatibility: Option<String>,
-    ) -> Result<Vec<SkimmedNode>, ValidatorClientError> {
+    pub async fn get_all_basic_nodes(&self) -> Result<Vec<SkimmedNode>, ValidatorClientError> {
         // TODO: deal with paging in macro or some helper function or something, because it's the same pattern everywhere
         let mut page = 0;
         let mut nodes = Vec::new();
@@ -482,7 +454,7 @@ impl NymApiClient {
         loop {
             let mut res = self
                 .nym_api
-                .get_basic_nodes(semver_compatibility.clone(), false, Some(page), None)
+                .get_basic_nodes(false, Some(page), None)
                 .await?;
 
             nodes.append(&mut res.nodes.data);

common/client-libs/validator-client/src/nym_api/mod.rs

@@ -102,6 +102,23 @@ pub trait NymApiClientExt: ApiClient {
         .await
     }
 
+    #[deprecated]
+    #[instrument(level = "debug", skip(self))]
+    async fn get_gateways_detailed_unfiltered(
+        &self,
+    ) -> Result<Vec<GatewayBondAnnotated>, NymAPIError> {
+        self.get_json(
+            &[
+                routes::API_VERSION,
+                routes::STATUS,
+                routes::GATEWAYS,
+                routes::DETAILED_UNFILTERED,
+            ],
+            NO_PARAMS,
+        )
+        .await
+    }
+
     #[deprecated]
     #[instrument(level = "debug", skip(self))]
     async fn get_mixnodes_detailed_unfiltered(
@@ -188,16 +205,7 @@ pub trait NymApiClientExt: ApiClient {
 
     #[deprecated]
     #[tracing::instrument(level = "debug", skip_all)]
-    async fn get_basic_mixnodes(
-        &self,
-        semver_compatibility: Option<String>,
-    ) -> Result<CachedNodesResponse<SkimmedNode>, NymAPIError> {
-        let params = if let Some(semver_compatibility) = &semver_compatibility {
-            vec![("semver_compatibility", semver_compatibility.as_str())]
-        } else {
-            vec![]
-        };
-
+    async fn get_basic_mixnodes(&self) -> Result<CachedNodesResponse<SkimmedNode>, NymAPIError> {
         self.get_json(
             &[
                 routes::API_VERSION,
@@ -206,23 +214,14 @@ pub trait NymApiClientExt: ApiClient {
                 "mixnodes",
                 "skimmed",
             ],
-            &params,
+            NO_PARAMS,
         )
         .await
     }
 
     #[deprecated]
     #[instrument(level = "debug", skip(self))]
-    async fn get_basic_gateways(
-        &self,
-        semver_compatibility: Option<String>,
-    ) -> Result<CachedNodesResponse<SkimmedNode>, NymAPIError> {
-        let params = if let Some(semver_compatibility) = &semver_compatibility {
-            vec![("semver_compatibility", semver_compatibility.as_str())]
-        } else {
-            vec![]
-        };
-
+    async fn get_basic_gateways(&self) -> Result<CachedNodesResponse<SkimmedNode>, NymAPIError> {
         self.get_json(
             &[
                 routes::API_VERSION,
@@ -231,7 +230,7 @@ pub trait NymApiClientExt: ApiClient {
                 "gateways",
                 "skimmed",
             ],
-            &params,
+            NO_PARAMS,
         )
         .await
     }
@@ -241,17 +240,12 @@ pub trait NymApiClientExt: ApiClient {
     #[instrument(level = "debug", skip(self))]
     async fn get_basic_entry_assigned_nodes(
         &self,
-        semver_compatibility: Option<String>,
         no_legacy: bool,
         page: Option<u32>,
         per_page: Option<u32>,
     ) -> Result<PaginatedCachedNodesResponse<SkimmedNode>, NymAPIError> {
         let mut params = Vec::new();
 
-        if let Some(arg) = &semver_compatibility {
-            params.push(("semver_compatibility", arg.clone()))
-        }
-
         if no_legacy {
             params.push(("no_legacy", "true".to_string()))
         }
@@ -283,17 +277,12 @@ pub trait NymApiClientExt: ApiClient {
     #[instrument(level = "debug", skip(self))]
     async fn get_basic_active_mixing_assigned_nodes(
         &self,
-        semver_compatibility: Option<String>,
         no_legacy: bool,
         page: Option<u32>,
         per_page: Option<u32>,
     ) -> Result<PaginatedCachedNodesResponse<SkimmedNode>, NymAPIError> {
         let mut params = Vec::new();
 
-        if let Some(arg) = &semver_compatibility {
-            params.push(("semver_compatibility", arg.clone()))
-        }
-
         if no_legacy {
             params.push(("no_legacy", "true".to_string()))
         }
@@ -325,17 +314,12 @@ pub trait NymApiClientExt: ApiClient {
     #[instrument(level = "debug", skip(self))]
     async fn get_basic_mixing_capable_nodes(
         &self,
-        semver_compatibility: Option<String>,
         no_legacy: bool,
         page: Option<u32>,
         per_page: Option<u32>,
     ) -> Result<PaginatedCachedNodesResponse<SkimmedNode>, NymAPIError> {
         let mut params = Vec::new();
 
-        if let Some(arg) = &semver_compatibility {
-            params.push(("semver_compatibility", arg.clone()))
-        }
-
         if no_legacy {
             params.push(("no_legacy", "true".to_string()))
         }
@@ -365,17 +349,12 @@ pub trait NymApiClientExt: ApiClient {
     #[instrument(level = "debug", skip(self))]
     async fn get_basic_nodes(
         &self,
-        semver_compatibility: Option<String>,
         no_legacy: bool,
         page: Option<u32>,
         per_page: Option<u32>,
     ) -> Result<PaginatedCachedNodesResponse<SkimmedNode>, NymAPIError> {
         let mut params = Vec::new();
 
-        if let Some(arg) = &semver_compatibility {
-            params.push(("semver_compatibility", arg.clone()))
-        }
-
         if no_legacy {
             params.push(("no_legacy", "true".to_string()))
         }

common/client-libs/validator-client/src/nyxd/contract_traits/mixnet_query_client.rs

@@ -26,10 +26,11 @@ use nym_mixnet_contract_common::{
     reward_params::{Performance, RewardingParams},
     rewarding::{EstimatedCurrentEpochRewardResponse, PendingRewardResponse},
     ContractBuildInformation, ContractState, ContractStateParams, CurrentIntervalResponse,
-    Delegation, EpochEventId, EpochStatus, GatewayBond, GatewayBondResponse,
-    GatewayOwnershipResponse, IdentityKey, IdentityKeyRef, IntervalEventId, MixNodeBond,
-    MixNodeDetails, MixOwnershipResponse, MixnodeDetailsByIdentityResponse, MixnodeDetailsResponse,
-    NodeId, NumberOfPendingEventsResponse, NymNodeBond, NymNodeDetails,
+    CurrentNymNodeVersionResponse, Delegation, EpochEventId, EpochStatus, GatewayBond,
+    GatewayBondResponse, GatewayOwnershipResponse, HistoricalNymNodeVersionEntry, IdentityKey,
+    IdentityKeyRef, IntervalEventId, MixNodeBond, MixNodeDetails, MixOwnershipResponse,
+    MixnodeDetailsByIdentityResponse, MixnodeDetailsResponse, NodeId,
+    NumberOfPendingEventsResponse, NymNodeBond, NymNodeDetails, NymNodeVersionHistoryResponse,
     PagedAllDelegationsResponse, PagedDelegatorDelegationsResponse, PagedGatewayResponse,
     PagedMixnodeBondsResponse, PagedNodeDelegationsResponse, PendingEpochEvent,
     PendingEpochEventResponse, PendingEpochEventsResponse, PendingIntervalEvent,
@@ -71,6 +72,22 @@ pub trait MixnetQueryClient {
             .await
     }
 
+    async fn get_nym_node_version_history_paged(
+        &self,
+        start_after: Option<u32>,
+        limit: Option<u32>,
+    ) -> Result<NymNodeVersionHistoryResponse, NyxdError> {
+        self.query_mixnet_contract(MixnetQueryMsg::GetNymNodeVersionHistory { limit, start_after })
+            .await
+    }
+
+    async fn get_current_nym_node_version(
+        &self,
+    ) -> Result<CurrentNymNodeVersionResponse, NyxdError> {
+        self.query_mixnet_contract(MixnetQueryMsg::GetCurrentNymNodeVersion {})
+            .await
+    }
+
     async fn get_mixnet_contract_state(&self) -> Result<ContractState, NyxdError> {
         self.query_mixnet_contract(MixnetQueryMsg::GetState {})
             .await
@@ -638,6 +655,12 @@ pub trait PagedMixnetQueryClient: MixnetQueryClient {
     ) -> Result<Vec<PendingIntervalEvent>, NyxdError> {
         collect_paged!(self, get_pending_interval_events_paged, events)
     }
+
+    async fn get_full_nym_node_version_history(
+        &self,
+    ) -> Result<Vec<HistoricalNymNodeVersionEntry>, NyxdError> {
+        collect_paged!(self, get_nym_node_version_history_paged, history)
+    }
 }
 
 #[async_trait]
@@ -724,6 +747,7 @@ where
 mod tests {
     use super::*;
     use crate::nyxd::contract_traits::tests::IgnoreValue;
+    use nym_mixnet_contract_common::QueryMsg;
 
     // it's enough that this compiles and clippy is happy about it
     #[allow(dead_code)]
@@ -924,6 +948,10 @@ mod tests {
             MixnetQueryMsg::GetRewardedSetMetadata {} => {
                 client.get_rewarded_set_metadata().ignore()
             }
+            QueryMsg::GetCurrentNymNodeVersion {} => client.get_current_nym_node_version().ignore(),
+            QueryMsg::GetNymNodeVersionHistory { limit, start_after } => client
+                .get_nym_node_version_history_paged(start_after, limit)
+                .ignore(),
         }
     }
 }

common/client-libs/validator-client/src/nyxd/cosmwasm_client/helpers.rs

@@ -13,6 +13,44 @@ use tracing::error;
 
 pub use cosmrs::abci::MsgResponse;
 
+pub fn parse_singleton_u32_from_contract_response(b: Vec<u8>) -> Result<u32, NyxdError> {
+    if b.len() != 4 {
+        return Err(NyxdError::MalformedResponseData {
+            got: b.len(),
+            expected: 4,
+        });
+    }
+    Ok(u32::from_be_bytes([b[0], b[1], b[2], b[3]]))
+}
+
+pub fn parse_singleton_u64_from_contract_response(b: Vec<u8>) -> Result<u64, NyxdError> {
+    if b.len() != 8 {
+        return Err(NyxdError::MalformedResponseData {
+            got: b.len(),
+            expected: 8,
+        });
+    }
+    Ok(u64::from_be_bytes([
+        b[0], b[1], b[2], b[3], b[4], b[5], b[6], b[7],
+    ]))
+}
+
+#[derive(Debug, Clone)]
+pub struct ParsedContractResponse {
+    pub message_index: usize,
+    pub response: Vec<u8>,
+}
+
+impl ParsedContractResponse {
+    pub fn parse_singleton_u32_contract_data(self) -> Result<u32, NyxdError> {
+        parse_singleton_u32_from_contract_response(self.response)
+    }
+
+    pub fn parse_singleton_u64_contract_data(self) -> Result<u64, NyxdError> {
+        parse_singleton_u64_from_contract_response(self.response)
+    }
+}
+
 pub fn parse_msg_responses(data: Bytes) -> Vec<MsgResponse> {
     // it seems that currently, on wasmd 0.43 + tendermint-rs 0.37 + cosmrs 0.17.0-pre
     // the data is left in undecoded base64 form, but I'd imagine this might change so if the decoding fails,
@@ -34,35 +72,25 @@ pub fn parse_msg_responses(data: Bytes) -> Vec<MsgResponse> {
 }
 
 // requires there's a single response message
-pub trait ToSingletonContractData: Sized {
+pub trait ContractResponseData: Sized {
     fn parse_singleton_u32_contract_data(&self) -> Result<u32, NyxdError> {
         let b = self.to_singleton_contract_data()?;
-        if b.len() != 4 {
-            return Err(NyxdError::MalformedResponseData {
-                got: b.len(),
-                expected: 4,
-            });
-        }
-        Ok(u32::from_be_bytes([b[0], b[1], b[2], b[3]]))
+        parse_singleton_u32_from_contract_response(b)
     }
 
     fn parse_singleton_u64_contract_data(&self) -> Result<u64, NyxdError> {
         let b = self.to_singleton_contract_data()?;
-        if b.len() != 8 {
-            return Err(NyxdError::MalformedResponseData {
-                got: b.len(),
-                expected: 8,
-            });
-        }
-        Ok(u64::from_be_bytes([
-            b[0], b[1], b[2], b[3], b[4], b[5], b[6], b[7],
-        ]))
+        parse_singleton_u64_from_contract_response(b)
     }
 
     fn to_singleton_contract_data(&self) -> Result<Vec<u8>, NyxdError>;
+
+    fn to_unchecked_contract_data(&self) -> Result<Vec<Vec<u8>>, NyxdError>;
+
+    fn to_contract_data(&self) -> Result<Vec<ParsedContractResponse>, NyxdError>;
 }
 
-impl ToSingletonContractData for ExecuteResult {
+impl ContractResponseData for ExecuteResult {
     fn to_singleton_contract_data(&self) -> Result<Vec<u8>, NyxdError> {
         if self.msg_responses.len() != 1 {
             return Err(NyxdError::UnexpectedNumberOfMsgResponses {
@@ -72,6 +100,30 @@ impl ToSingletonContractData for ExecuteResult {
 
         self.msg_responses[0].to_contract_response_data()
     }
+
+    fn to_unchecked_contract_data(&self) -> Result<Vec<Vec<u8>>, NyxdError> {
+        self.msg_responses
+            .iter()
+            .map(ToContractResponseData::to_contract_response_data)
+            .collect()
+    }
+
+    fn to_contract_data(&self) -> Result<Vec<ParsedContractResponse>, NyxdError> {
+        let mut response = Vec::new();
+
+        for (message_index, msg) in self.msg_responses.iter().enumerate() {
+            // unfortunately `Name` trait has not been derived for `MsgExecuteContractResponse`,
+            // so we have to make an explicit string comparison instead
+            if msg.type_url == "/cosmwasm.wasm.v1.MsgExecuteContractResponse" {
+                response.push(ParsedContractResponse {
+                    message_index,
+                    response: msg.to_contract_response_data()?,
+                })
+            }
+        }
+
+        Ok(response)
+    }
 }
 
 pub trait ToContractResponseData: Sized {

common/client-libs/validator-client/src/nyxd/cosmwasm_client/mod.rs

@@ -23,7 +23,7 @@ use tendermint_rpc::endpoint::*;
 use tendermint_rpc::query::Query;
 use tendermint_rpc::{Error as TendermintRpcError, Order, Paging, SimpleRequest};
 
-pub use helpers::{ToContractResponseData, ToSingletonContractData};
+pub use helpers::{ContractResponseData, ToContractResponseData};
 
 #[cfg(feature = "http-client")]
 use crate::http_client;

common/cosmwasm-smart-contracts/contracts-common/Cargo.toml

@@ -13,6 +13,7 @@ cosmwasm-std = { workspace = true }
 cosmwasm-schema = { workspace = true }
 cw-storage-plus = { workspace = true }
 schemars = { workspace = true }
+utoipa = { workspace = true, optional = true }
 serde = { workspace = true, features = ["derive"] }
 thiserror = { workspace = true }
 
@@ -23,4 +24,5 @@ serde_json = { workspace = true }
 vergen = { workspace = true, features = ["build", "git", "gitcl", "rustc", "cargo"] }
 
 [features]
-naive_float = []
+naive_float = []
+utoipa = ["dep:utoipa"]

common/cosmwasm-smart-contracts/contracts-common/src/types.rs

@@ -221,6 +221,7 @@ fn default_unknown() -> String {
 // TODO: there's no reason this couldn't be used for proper binaries, but in that case
 // perhaps the struct should get renamed and moved to a "more" common crate
 #[cw_serde]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct ContractBuildInformation {
     /// Provides the name of the binary, i.e. the content of `CARGO_PKG_NAME` environmental variable.
     #[serde(default = "default_unknown")]

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/ActiveSetUpdate.ts

@@ -0,0 +1,18 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Specification on how the active set should be updated.
+ */
+export type ActiveSetUpdate = { 
+/**
+ * The expected number of nodes assigned entry gateway role (i.e. [`Role::EntryGateway`])
+ */
+entry_gateways: number, 
+/**
+ * The expected number of nodes assigned exit gateway role (i.e. [`Role::ExitGateway`])
+ */
+exit_gateways: number, 
+/**
+ * The expected number of nodes assigned the 'mixnode' role, i.e. total of [`Role::Layer1`], [`Role::Layer2`] and [`Role::Layer3`].
+ */
+mixnodes: number, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/GatewayConfigUpdate.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type GatewayConfigUpdate = { host: string, mix_port: number, clients_port: number, location: string, version: string, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/Interval.ts

@@ -0,0 +1,30 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Specification of a rewarding interval.
+ */
+export type Interval = { 
+/**
+ * Monotonously increasing id of this interval.
+ */
+id: number, 
+/**
+ * Number of epochs in this interval.
+ */
+epochs_in_interval: number, 
+/**
+ * The timestamp indicating the start of the current rewarding epoch.
+ */
+current_epoch_start: string, 
+/**
+ * Monotonously increasing id of the current epoch in this interval.
+ */
+current_epoch_id: number, 
+/**
+ * The duration of all epochs in this interval.
+ */
+epoch_length: { secs: number; nanos: number; }, 
+/**
+ * The total amount of elapsed epochs since the first epoch of the first interval.
+ */
+total_elapsed_epochs: number, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/IntervalRewardParams.ts

@@ -0,0 +1,51 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Parameters required by the mix-mining reward distribution that do not change during an interval.
+ */
+export type IntervalRewardParams = { 
+/**
+ * Current value of the rewarding pool.
+ * It is expected to be constant throughout the interval.
+ */
+reward_pool: string, 
+/**
+ * Current value of the staking supply.
+ * It is expected to be constant throughout the interval.
+ */
+staking_supply: string, 
+/**
+ * Defines the percentage of stake needed to reach saturation for all of the nodes in the rewarded set.
+ * Also known as `beta`.
+ */
+staking_supply_scale_factor: string, 
+/**
+ * Current value of the computed reward budget per epoch, per node.
+ * It is expected to be constant throughout the interval.
+ */
+epoch_reward_budget: string, 
+/**
+ * Current value of the stake saturation point.
+ * It is expected to be constant throughout the interval.
+ */
+stake_saturation_point: string, 
+/**
+ * Current value of the sybil resistance percent (`alpha`).
+ * It is not really expected to be changing very often.
+ * As a matter of fact, unless there's a very specific reason, it should remain constant.
+ */
+sybil_resistance: string, 
+/**
+ * Current active set work factor.
+ * It is not really expected to be changing very often.
+ * As a matter of fact, unless there's a very specific reason, it should remain constant.
+ */
+active_set_work_factor: string, 
+/**
+ * Current maximum interval pool emission.
+ * Assuming all nodes in the rewarded set are fully saturated and have 100% performance,
+ * this % of the reward pool would get distributed in rewards to all operators and its delegators.
+ * It is not really expected to be changing very often.
+ * As a matter of fact, unless there's a very specific reason, it should remain constant.
+ */
+interval_pool_emission: string, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/IntervalRewardingParamsUpdate.ts

@@ -0,0 +1,35 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { RewardedSetParams } from "./RewardedSetParams";
+
+/**
+ * Specification on how the rewarding params should be updated.
+ */
+export type IntervalRewardingParamsUpdate = { 
+/**
+ * Defines the new value of the reward pool.
+ */
+reward_pool: string | null, 
+/**
+ * Defines the new value of the staking supply.
+ */
+staking_supply: string | null, 
+/**
+ * Defines the new value of the staking supply scale factor.
+ */
+staking_supply_scale_factor: string | null, 
+/**
+ * Defines the new value of the sybil resistance percent.
+ */
+sybil_resistance_percent: string | null, 
+/**
+ * Defines the new value of the active set work factor.
+ */
+active_set_work_factor: string | null, 
+/**
+ * Defines the new value of the interval pool emission rate.
+ */
+interval_pool_emission: string | null, 
+/**
+ * Defines the parameters of the rewarded set.
+ */
+rewarded_set_params: RewardedSetParams | null, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/MixNodeConfigUpdate.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type MixNodeConfigUpdate = { host: string, mix_port: number, verloc_port: number, http_api_port: number, version: string, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/Mixnode.ts

@@ -0,0 +1,34 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Information provided by the node operator during bonding that are used to allow other entities to use the services of this node.
+ */
+export type MixNode = { 
+/**
+ * Network address of this mixnode, for example 1.1.1.1 or foo.mixnode.com
+ */
+host: string, 
+/**
+ * Port used by this mixnode for listening for mix packets.
+ */
+mix_port: number, 
+/**
+ * Port used by this mixnode for listening for verloc requests.
+ */
+verloc_port: number, 
+/**
+ * Port used by this mixnode for its http(s) API
+ */
+http_api_port: number, 
+/**
+ * Base58-encoded x25519 public key used for sphinx key derivation.
+ */
+sphinx_key: string, 
+/**
+ * Base58-encoded ed25519 EdDSA public key.
+ */
+identity_key: string, 
+/**
+ * The self-reported semver version of this mixnode.
+ */
+version: string, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/NodeConfigUpdate.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type NodeConfigUpdate = { host: string | null, custom_http_port: number | null, restore_default_http_port: boolean, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/NodeRewardingParameters.ts

@@ -0,0 +1,15 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Parameters used for rewarding particular node.
+ */
+export type NodeRewardingParameters = { 
+/**
+ * Performance of the particular node in the current epoch.
+ */
+performance: string, 
+/**
+ * Amount of work performed by this node in the current epoch
+ * also known as 'omega' in the paper
+ */
+work_factor: string, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/NymNode.ts

@@ -0,0 +1,20 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Information provided by the node operator during bonding that are used to allow other entities to use the services of this node.
+ */
+export type NymNode = { 
+/**
+ * Network address of this nym-node, for example 1.1.1.1 or foo.mixnode.com
+ * that is used to discover other capabilities of this node.
+ */
+host: string, 
+/**
+ * Allow specifying custom port for accessing the http, and thus self-described, api
+ * of this node for the capabilities discovery.
+ */
+custom_http_port: number | null, 
+/**
+ * Base58-encoded ed25519 EdDSA public key.
+ */
+identity_key: string, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/PendingMixnodeChanges.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PendingMixNodeChanges = { pledge_change: number | null, cost_params_change: number | null, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/PendingNodeChanges.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PendingNodeChanges = { pledge_change: number | null, cost_params_change: number | null, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/RewardEstimate.ts

@@ -0,0 +1,20 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type RewardEstimate = { 
+/**
+ * The amount of **decimal** coins that are going to get distributed to the node,
+ * i.e. the operator and all its delegators.
+ */
+total_node_reward: string, 
+/**
+ * The share of the reward that is going to get distributed to the node operator.
+ */
+operator: string, 
+/**
+ * The share of the reward that is going to get distributed among the node delegators.
+ */
+delegates: string, 
+/**
+ * The operating cost of this node. Note: it's already included in the operator reward.
+ */
+operating_cost: string, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/RewardedSetParams.ts

@@ -0,0 +1,19 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type RewardedSetParams = { 
+/**
+ * The expected number of nodes assigned entry gateway role (i.e. [`Role::EntryGateway`])
+ */
+entry_gateways: number, 
+/**
+ * The expected number of nodes assigned exit gateway role (i.e. [`Role::ExitGateway`])
+ */
+exit_gateways: number, 
+/**
+ * The expected number of nodes assigned the 'mixnode' role, i.e. total of [`Role::Layer1`], [`Role::Layer2`] and [`Role::Layer3`].
+ */
+mixnodes: number, 
+/**
+ * Number of nodes in the 'standby' set. (i.e. [`Role::Standby`])
+ */
+standby: number, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/RewardingParams.ts

@@ -0,0 +1,12 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { IntervalRewardParams } from "./IntervalRewardParams";
+import type { RewardedSetParams } from "./RewardedSetParams";
+
+/**
+ * Parameters used for reward calculation.
+ */
+export type RewardingParams = { 
+/**
+ * Parameters that should remain unchanged throughout an interval.
+ */
+interval: IntervalRewardParams, rewarded_set: RewardedSetParams, };

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/Role.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type Role = "EntryGateway" | "Layer1" | "Layer2" | "Layer3" | "ExitGateway" | "Standby";

common/cosmwasm-smart-contracts/mixnet-contract/bindings/ts-packages/types/src/types/rust/UnbondedMixnode.ts

@@ -0,0 +1,23 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Basic information of a node that used to be part of the mix network but has already unbonded.
+ */
+export type UnbondedMixnode = { 
+/**
+ * Base58-encoded ed25519 EdDSA public key.
+ */
+identity_key: string, 
+/**
+ * Address of the owner of this mixnode.
+ */
+owner: string, 
+/**
+ * Entity who bonded this mixnode on behalf of the owner.
+ * If exists, it's most likely the address of the vesting contract.
+ */
+proxy: string | null, 
+/**
+ * Block height at which this mixnode has unbonded.
+ */
+unbonding_height: number, };

common/cosmwasm-smart-contracts/mixnet-contract/src/config_score.rs

@@ -0,0 +1,673 @@
+// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+use cosmwasm_schema::cw_serde;
+use cosmwasm_std::Decimal;
+use std::cmp::Ordering;
+use std::ops::{Add, Sub};
+
+#[cw_serde]
+pub struct HistoricalNymNodeVersion {
+    /// Version of the nym node that is going to be used for determining the version score of a node.
+    /// note: value stored here is pre-validated `semver::Version`
+    pub semver: String,
+
+    /// Block height of when this version has been added to the contract
+    pub introduced_at_height: u64,
+
+    /// The absolute version difference as compared against the first version introduced into the contract.
+    pub difference_since_genesis: TotalVersionDifference,
+}
+
+impl HistoricalNymNodeVersion {
+    pub fn genesis(semver: String, height: u64) -> HistoricalNymNodeVersion {
+        HistoricalNymNodeVersion {
+            semver,
+            introduced_at_height: height,
+            difference_since_genesis: Default::default(),
+        }
+    }
+
+    // SAFETY: the value stored in the contract is always valid
+    // if you manually construct that struct with invalid value, it's on you.
+    #[allow(clippy::unwrap_used)]
+    pub fn semver_unchecked(&self) -> semver::Version {
+        self.semver.parse().unwrap()
+    }
+
+    /// Return [`TotalVersionDifference`] for a new release version that is going to be pushed right after this one
+    /// this function cannot be called against 2 arbitrary versions
+    #[inline]
+    pub fn cumulative_difference_since_genesis(
+        &self,
+        new_version: &semver::Version,
+    ) -> TotalVersionDifference {
+        let self_semver = self.semver_unchecked();
+        let mut new_absolute = self.difference_since_genesis;
+        if new_version.major > self_semver.major {
+            new_absolute.major += (new_version.major - self_semver.major) as u32
+        } else if new_version.minor > self_semver.minor {
+            new_absolute.minor += (new_version.minor - self_semver.minor) as u32
+        } else if new_version.patch > self_semver.patch {
+            new_absolute.patch += (new_version.patch - self_semver.patch) as u32
+        } else if new_version.pre != self_semver.pre {
+            new_absolute.prerelease += 1
+        }
+        new_absolute
+    }
+
+    pub fn relative_difference(&self, other: &Self) -> TotalVersionDifference {
+        if self.difference_since_genesis > other.difference_since_genesis {
+            self.difference_since_genesis - other.difference_since_genesis
+        } else {
+            other.difference_since_genesis - self.difference_since_genesis
+        }
+    }
+
+    pub fn difference_against_legacy(
+        &self,
+        legacy_version: &semver::Version,
+    ) -> TotalVersionDifference {
+        let current = self.semver_unchecked();
+        let major_diff = (current.major as i64 - legacy_version.major as i64).unsigned_abs() as u32;
+        let minor_diff = (current.minor as i64 - legacy_version.minor as i64).unsigned_abs() as u32;
+        let patch_diff = (current.patch as i64 - legacy_version.patch as i64).unsigned_abs() as u32;
+        let prerelease_diff = if current.pre == legacy_version.pre {
+            0
+        } else {
+            1
+        };
+
+        let mut diff = TotalVersionDifference::default();
+        // if there's a major increase, ignore minor and patch and treat it as 0
+        if major_diff != 0 {
+            diff.major += major_diff;
+            return diff;
+        }
+
+        // if there's a minor increase, ignore patch and treat is as 0
+        if minor_diff != 0 {
+            diff.minor += minor_diff;
+            return diff;
+        }
+
+        diff.patch = patch_diff;
+        diff.prerelease = prerelease_diff;
+        diff
+    }
+}
+
+#[cw_serde]
+#[derive(Default, Copy, PartialOrd, Ord, Eq)]
+pub struct TotalVersionDifference {
+    pub major: u32,
+    pub minor: u32,
+    pub patch: u32,
+    pub prerelease: u32,
+}
+
+impl Add for TotalVersionDifference {
+    type Output = TotalVersionDifference;
+    fn add(self, rhs: TotalVersionDifference) -> Self::Output {
+        TotalVersionDifference {
+            major: self.major.add(rhs.major),
+            minor: self.minor.add(rhs.minor),
+            patch: self.patch.add(rhs.patch),
+            prerelease: self.prerelease.add(rhs.prerelease),
+        }
+    }
+}
+
+impl Sub for TotalVersionDifference {
+    type Output = TotalVersionDifference;
+    fn sub(self, rhs: TotalVersionDifference) -> Self::Output {
+        TotalVersionDifference {
+            major: self.major.saturating_sub(rhs.major),
+            minor: self.minor.saturating_sub(rhs.minor),
+            patch: self.patch.saturating_sub(rhs.patch),
+            prerelease: self.prerelease.saturating_sub(rhs.prerelease),
+        }
+    }
+}
+
+#[cw_serde]
+pub struct HistoricalNymNodeVersionEntry {
+    /// The unique, ordered, id of this particular entry
+    pub id: u32,
+
+    /// Data associated with this particular version
+    pub version_information: HistoricalNymNodeVersion,
+}
+
+impl From<(u32, HistoricalNymNodeVersion)> for HistoricalNymNodeVersionEntry {
+    fn from((id, version_information): (u32, HistoricalNymNodeVersion)) -> Self {
+        HistoricalNymNodeVersionEntry {
+            id,
+            version_information,
+        }
+    }
+}
+
+impl PartialOrd for HistoricalNymNodeVersionEntry {
+    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
+        // we only care about id for the purposes of ordering as they should have unique data
+        self.id.partial_cmp(&other.id)
+    }
+}
+
+#[cw_serde]
+pub struct NymNodeVersionHistoryResponse {
+    pub history: Vec<HistoricalNymNodeVersionEntry>,
+
+    /// Field indicating paging information for the following queries if the caller wishes to get further entries.
+    pub start_next_after: Option<u32>,
+}
+
+#[cw_serde]
+pub struct CurrentNymNodeVersionResponse {
+    pub version: Option<HistoricalNymNodeVersionEntry>,
+}
+
+#[cw_serde]
+pub struct ConfigScoreParams {
+    /// Defines weights for calculating numbers of versions behind the current release.
+    pub version_weights: OutdatedVersionWeights,
+
+    /// Defines the parameters of the formula for calculating the version score
+    pub version_score_formula_params: VersionScoreFormulaParams,
+}
+
+/// Defines weights for calculating numbers of versions behind the current release.
+#[cw_serde]
+#[derive(Copy)]
+pub struct OutdatedVersionWeights {
+    pub major: u32,
+    pub minor: u32,
+    pub patch: u32,
+    pub prerelease: u32,
+}
+
+fn is_one_semver_difference(this: &semver::Version, other: &semver::Version) -> bool {
+    let major_diff = (this.major as i64 - other.major as i64).unsigned_abs() as u32;
+    let minor_diff = (this.minor as i64 - other.minor as i64).unsigned_abs() as u32;
+    let patch_diff = (this.patch as i64 - other.patch as i64).unsigned_abs() as u32;
+    let prerelease_diff = if this.pre == other.pre { 0 } else { 1 };
+
+    if major_diff == 1 {
+        return true;
+    }
+
+    if major_diff == 0 && minor_diff == 1 {
+        return true;
+    }
+
+    if major_diff == 0 && minor_diff == 0 && patch_diff == 1 {
+        return true;
+    }
+
+    prerelease_diff == 1
+}
+
+impl OutdatedVersionWeights {
+    pub fn difference_to_versions_behind_factor(&self, diff: TotalVersionDifference) -> u32 {
+        diff.major * self.major
+            + diff.minor * self.minor
+            + diff.patch * self.patch
+            + diff.prerelease * self.prerelease
+    }
+
+    // INVARIANT: release chain is sorted
+    // do NOT call this method directly from inside the contract. it's too inefficient
+    // it relies on some external caching.
+    pub fn versions_behind_factor(
+        &self,
+        node_version: &semver::Version,
+        release_chain: &[HistoricalNymNodeVersionEntry],
+    ) -> u32 {
+        let Some(latest) = release_chain.last() else {
+            return 0;
+        };
+
+        let latest_semver = latest.version_information.semver_unchecked();
+
+        // if you're more recent than the latest, you get the benefit of the doubt, the release might have not yet been commited to the chain
+        // but only if you're only a single semver ahead, otherwise you get penalty equivalent of being major version behind for cheating
+        if node_version > &latest_semver {
+            return if is_one_semver_difference(node_version, &latest_semver) {
+                0
+            } else {
+                self.major
+            };
+        }
+
+        // find your position in the release chain, if we fail, we assume that the node comes from before the changes were introduced
+        // in which case we simply calculate the absolute difference between the genesis entry and add up the total difference
+        let version_diff = match release_chain
+            .iter()
+            .rfind(|h| &h.version_information.semver_unchecked() <= node_version)
+        {
+            Some(h) => {
+                // first chain entry that is smaller (or equal) to the provided node version
+                // now, calculate the difference to the genesis version and ultimately against the current head
+                let diff_since_genesis = if h.version_information.semver == node_version.to_string()
+                {
+                    h.version_information.difference_since_genesis
+                } else {
+                    h.version_information
+                        .cumulative_difference_since_genesis(node_version)
+                };
+                latest.version_information.difference_since_genesis - diff_since_genesis
+            }
+            None => {
+                // SAFETY: since we managed to get 'last' entry, it means the release chain is not empty,
+                // so we must be able to obtain the first entry
+                #[allow(clippy::unwrap_used)]
+                let genesis = release_chain.first().unwrap();
+
+                let difference_from_genesis = genesis
+                    .version_information
+                    .difference_against_legacy(node_version);
+                difference_from_genesis + latest.version_information.difference_since_genesis
+            }
+        };
+
+        self.difference_to_versions_behind_factor(version_diff)
+    }
+}
+
+impl Default for OutdatedVersionWeights {
+    fn default() -> Self {
+        OutdatedVersionWeights {
+            major: 100,
+            minor: 10,
+            patch: 1,
+            prerelease: 1,
+        }
+    }
+}
+
+/// Given the formula of version_score = penalty ^ (versions_behind_factor ^ penalty_scaling)
+/// define the relevant parameters
+#[cw_serde]
+#[derive(Copy)]
+pub struct VersionScoreFormulaParams {
+    pub penalty: Decimal,
+    pub penalty_scaling: Decimal,
+}
+
+impl Default for VersionScoreFormulaParams {
+    fn default() -> Self {
+        #[allow(clippy::unwrap_used)]
+        VersionScoreFormulaParams {
+            penalty: "0.995".parse().unwrap(),
+            penalty_scaling: "1.65".parse().unwrap(),
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use std::ops::Deref;
+
+    // simple wrapper for tests
+    struct ReleaseChain {
+        inner: Vec<HistoricalNymNodeVersionEntry>,
+    }
+
+    impl Deref for ReleaseChain {
+        type Target = [HistoricalNymNodeVersionEntry];
+        fn deref(&self) -> &Self::Target {
+            self.inner.deref()
+        }
+    }
+
+    impl ReleaseChain {
+        fn new(initial: &str) -> Self {
+            ReleaseChain {
+                inner: vec![HistoricalNymNodeVersionEntry {
+                    id: 0,
+                    version_information: HistoricalNymNodeVersion {
+                        semver: initial.to_string(),
+                        introduced_at_height: 123,
+                        difference_since_genesis: TotalVersionDifference::default(),
+                    },
+                }],
+            }
+        }
+
+        fn with_release(mut self, raw: &str) -> Self {
+            self.push_new(raw);
+            self
+        }
+
+        fn push_new(&mut self, raw: &str) {
+            let latest = self.inner.last().unwrap();
+            let new_version: semver::Version = raw.parse().unwrap();
+
+            let new_absolute = latest
+                .version_information
+                .cumulative_difference_since_genesis(&new_version);
+
+            self.inner.push(HistoricalNymNodeVersionEntry {
+                id: latest.id + 1,
+                version_information: HistoricalNymNodeVersion {
+                    semver: new_version.to_string(),
+                    introduced_at_height: latest.version_information.introduced_at_height + 1,
+                    difference_since_genesis: new_absolute,
+                },
+            })
+        }
+    }
+
+    #[test]
+    fn versions_behind_factor() {
+        // helper to compact the parsing
+        fn s(raw: &str) -> semver::Version {
+            raw.parse().unwrap()
+        }
+
+        let weights = OutdatedVersionWeights::default();
+
+        // no releases:
+        let res = weights.versions_behind_factor(&s("1.1.13"), &[]);
+        assert_eq!(0, res);
+
+        // ###############################
+        // single released version (1.1.13)
+        // ###############################
+        let mut release_chain = ReleaseChain::new("1.1.13");
+
+        // "legacy" versions
+        let res = weights.versions_behind_factor(&s("1.0.12"), &release_chain);
+        assert_eq!(10, res);
+        let res = weights.versions_behind_factor(&s("1.0.4"), &release_chain);
+        assert_eq!(10, res);
+        let res = weights.versions_behind_factor(&s("1.0.1"), &release_chain);
+        assert_eq!(10, res);
+        let res = weights.versions_behind_factor(&s("0.1.12"), &release_chain);
+        assert_eq!(100, res);
+
+        let res = weights.versions_behind_factor(&s("1.1.12"), &release_chain);
+        assert_eq!(1, res);
+        let res = weights.versions_behind_factor(&s("1.1.11"), &release_chain);
+        assert_eq!(2, res);
+        let res = weights.versions_behind_factor(&s("1.1.9"), &release_chain);
+        assert_eq!(4, res);
+
+        // current version
+        let res = weights.versions_behind_factor(&s("1.1.13"), &release_chain);
+        assert_eq!(0, res);
+
+        // "ahead" versions
+        let res = weights.versions_behind_factor(&s("1.1.14"), &release_chain);
+        assert_eq!(0, res);
+        let res = weights.versions_behind_factor(&s("1.2.0"), &release_chain);
+        assert_eq!(0, res);
+        let res = weights.versions_behind_factor(&s("2.0.0"), &release_chain);
+        assert_eq!(0, res);
+
+        // cheating ahead:
+        let res = weights.versions_behind_factor(&s("1.1.15"), &release_chain);
+        assert_eq!(100, res);
+        let res = weights.versions_behind_factor(&s("1.3.0"), &release_chain);
+        assert_eq!(100, res);
+        let res = weights.versions_behind_factor(&s("3.0.0"), &release_chain);
+        assert_eq!(100, res);
+
+        // ###############################
+        // small patch release chain (1.1.13 => 1.1.14 => 1.1.15 => 1.1.16)
+        // ###############################
+        release_chain.push_new("1.1.14");
+        release_chain.push_new("1.1.15");
+        release_chain.push_new("1.1.16");
+
+        // "legacy" versions
+        let res = weights.versions_behind_factor(&s("1.0.12"), &release_chain);
+        assert_eq!(13, res);
+        let res = weights.versions_behind_factor(&s("1.0.4"), &release_chain);
+        assert_eq!(13, res);
+        let res = weights.versions_behind_factor(&s("1.0.1"), &release_chain);
+        assert_eq!(13, res);
+        let res = weights.versions_behind_factor(&s("0.1.12"), &release_chain);
+        assert_eq!(103, res);
+
+        let res = weights.versions_behind_factor(&s("1.1.12"), &release_chain);
+        assert_eq!(4, res);
+        let res = weights.versions_behind_factor(&s("1.1.11"), &release_chain);
+        assert_eq!(5, res);
+        let res = weights.versions_behind_factor(&s("1.1.9"), &release_chain);
+        assert_eq!(7, res);
+
+        // current version
+        let res = weights.versions_behind_factor(&s("1.1.16"), &release_chain);
+        assert_eq!(0, res);
+
+        // present in the chain
+        let res = weights.versions_behind_factor(&s("1.1.15"), &release_chain);
+        assert_eq!(1, res);
+        let res = weights.versions_behind_factor(&s("1.1.14"), &release_chain);
+        assert_eq!(2, res);
+        let res = weights.versions_behind_factor(&s("1.1.13"), &release_chain);
+        assert_eq!(3, res);
+
+        // "ahead" versions
+        let res = weights.versions_behind_factor(&s("1.1.17"), &release_chain);
+        assert_eq!(0, res);
+        let res = weights.versions_behind_factor(&s("1.2.0"), &release_chain);
+        assert_eq!(0, res);
+        let res = weights.versions_behind_factor(&s("2.0.0"), &release_chain);
+        assert_eq!(0, res);
+
+        // cheating ahead:
+        let res = weights.versions_behind_factor(&s("1.1.18"), &release_chain);
+        assert_eq!(100, res);
+        let res = weights.versions_behind_factor(&s("1.3.0"), &release_chain);
+        assert_eq!(100, res);
+        let res = weights.versions_behind_factor(&s("3.0.0"), &release_chain);
+        assert_eq!(100, res);
+
+        // ###############################
+        // small minor release chain (1.2.0 => 1.3.0 => 1.4.0)
+        // ###############################
+        let release_chain = ReleaseChain::new("1.2.0")
+            .with_release("1.3.0")
+            .with_release("1.4.0");
+
+        // "legacy" versions
+        let res = weights.versions_behind_factor(&s("1.0.12"), &release_chain);
+        assert_eq!(40, res);
+        let res = weights.versions_behind_factor(&s("1.0.4"), &release_chain);
+        assert_eq!(40, res);
+        let res = weights.versions_behind_factor(&s("1.0.1"), &release_chain);
+        assert_eq!(40, res);
+        let res = weights.versions_behind_factor(&s("0.1.12"), &release_chain);
+        assert_eq!(120, res);
+
+        let res = weights.versions_behind_factor(&s("1.1.12"), &release_chain);
+        assert_eq!(30, res);
+        let res = weights.versions_behind_factor(&s("1.1.11"), &release_chain);
+        assert_eq!(30, res);
+        let res = weights.versions_behind_factor(&s("1.1.9"), &release_chain);
+        assert_eq!(30, res);
+
+        // current version
+        let res = weights.versions_behind_factor(&s("1.4.0"), &release_chain);
+        assert_eq!(0, res);
+
+        // present in the chain
+        let res = weights.versions_behind_factor(&s("1.2.0"), &release_chain);
+        assert_eq!(20, res);
+        let res = weights.versions_behind_factor(&s("1.3.0"), &release_chain);
+        assert_eq!(10, res);
+
+        // weird in between
+        let res = weights.versions_behind_factor(&s("1.2.1"), &release_chain);
+        assert_eq!(20, res);
+        let res = weights.versions_behind_factor(&s("1.3.3"), &release_chain);
+        assert_eq!(10, res);
+
+        // "ahead" versions
+        let res = weights.versions_behind_factor(&s("1.4.1"), &release_chain);
+        assert_eq!(0, res);
+        let res = weights.versions_behind_factor(&s("1.5.0"), &release_chain);
+        assert_eq!(0, res);
+        let res = weights.versions_behind_factor(&s("2.0.0"), &release_chain);
+        assert_eq!(0, res);
+
+        // cheating ahead:
+        let res = weights.versions_behind_factor(&s("1.4.2"), &release_chain);
+        assert_eq!(100, res);
+        let res = weights.versions_behind_factor(&s("1.6.0"), &release_chain);
+        assert_eq!(100, res);
+        let res = weights.versions_behind_factor(&s("3.0.0"), &release_chain);
+        assert_eq!(100, res);
+
+        // ###############################
+        // mixed release chain (1.1.13 => 1.2.0 => 1.2.1 => 1.3.0 => 1.3.1 => 1.3.2 => 1.4.0)
+        // ###############################
+        let release_chain = ReleaseChain::new("1.1.13")
+            .with_release("1.2.0")
+            .with_release("1.2.1")
+            .with_release("1.3.0")
+            .with_release("1.3.1-importantpre")
+            .with_release("1.3.1")
+            .with_release("1.3.2")
+            .with_release("1.4.0");
+
+        // "legacy" versions
+        let res = weights.versions_behind_factor(&s("1.0.12"), &release_chain);
+        assert_eq!(44, res);
+        let res = weights.versions_behind_factor(&s("1.0.4"), &release_chain);
+        assert_eq!(44, res);
+        let res = weights.versions_behind_factor(&s("1.0.1"), &release_chain);
+        assert_eq!(44, res);
+        let res = weights.versions_behind_factor(&s("0.1.12"), &release_chain);
+        assert_eq!(134, res);
+
+        let res = weights.versions_behind_factor(&s("1.1.12"), &release_chain);
+        assert_eq!(35, res);
+        let res = weights.versions_behind_factor(&s("1.1.11"), &release_chain);
+        assert_eq!(36, res);
+        let res = weights.versions_behind_factor(&s("1.1.9"), &release_chain);
+        assert_eq!(38, res);
+
+        // current version
+        let res = weights.versions_behind_factor(&s("1.4.0"), &release_chain);
+        assert_eq!(0, res);
+
+        // present in the chain
+        let res = weights.versions_behind_factor(&s("1.1.13"), &release_chain);
+        assert_eq!(34, res);
+        let res = weights.versions_behind_factor(&s("1.2.0"), &release_chain);
+        assert_eq!(24, res);
+        let res = weights.versions_behind_factor(&s("1.2.1"), &release_chain);
+        assert_eq!(23, res);
+        let res = weights.versions_behind_factor(&s("1.3.0"), &release_chain);
+        assert_eq!(13, res);
+        let res = weights.versions_behind_factor(&s("1.3.1-importantpre"), &release_chain);
+        assert_eq!(12, res);
+        let res = weights.versions_behind_factor(&s("1.3.1"), &release_chain);
+        assert_eq!(11, res);
+        let res = weights.versions_behind_factor(&s("1.3.2"), &release_chain);
+        assert_eq!(10, res);
+
+        // weird in between
+        let res = weights.versions_behind_factor(&s("1.2.3"), &release_chain);
+        assert_eq!(21, res);
+        let res = weights.versions_behind_factor(&s("1.3.69"), &release_chain);
+        assert_eq!(10, res);
+
+        // "ahead" versions
+        let res = weights.versions_behind_factor(&s("1.4.1"), &release_chain);
+        assert_eq!(0, res);
+        let res = weights.versions_behind_factor(&s("1.5.0"), &release_chain);
+        assert_eq!(0, res);
+        let res = weights.versions_behind_factor(&s("2.0.0"), &release_chain);
+        assert_eq!(0, res);
+
+        // cheating ahead:
+        let res = weights.versions_behind_factor(&s("1.4.2"), &release_chain);
+        assert_eq!(100, res);
+        let res = weights.versions_behind_factor(&s("1.6.0"), &release_chain);
+        assert_eq!(100, res);
+        let res = weights.versions_behind_factor(&s("3.0.0"), &release_chain);
+        assert_eq!(100, res);
+
+        // ###############################
+        // skipped patch chain (1.1.13 => 1.2.0 => 1.2.1 => 1.2.4 => [1.3.0])
+        // ###############################
+        let mut release_chain = ReleaseChain::new("1.1.13")
+            .with_release("1.2.0")
+            .with_release("1.2.1")
+            .with_release("1.2.4");
+
+        // current
+        let res = weights.versions_behind_factor(&s("1.2.4"), &release_chain);
+        assert_eq!(0, res);
+
+        // on 'skipped' version
+        let res = weights.versions_behind_factor(&s("1.2.2"), &release_chain);
+        assert_eq!(2, res);
+
+        // on version before the skip
+        let res = weights.versions_behind_factor(&s("1.2.1"), &release_chain);
+        assert_eq!(3, res);
+
+        release_chain.push_new("1.3.0");
+        // current
+        let res = weights.versions_behind_factor(&s("1.3.0"), &release_chain);
+        assert_eq!(0, res);
+
+        // on 'skipped' version
+        let res = weights.versions_behind_factor(&s("1.2.2"), &release_chain);
+        assert_eq!(12, res);
+
+        // on version before the skip
+        let res = weights.versions_behind_factor(&s("1.2.1"), &release_chain);
+        assert_eq!(13, res);
+
+        // ###############################
+        // skipped minor chain (1.1.13 => 1.2.0 => 1.2.1 => 1.4.0 => [1.5.0])
+        // ###############################
+        let mut release_chain = ReleaseChain::new("1.1.13")
+            .with_release("1.2.0")
+            .with_release("1.2.1")
+            .with_release("1.4.0");
+
+        // current
+        let res = weights.versions_behind_factor(&s("1.4.0"), &release_chain);
+        assert_eq!(0, res);
+
+        // on 'skipped' version
+        let res = weights.versions_behind_factor(&s("1.3.0"), &release_chain);
+        assert_eq!(10, res);
+
+        // on version before the skip
+        let res = weights.versions_behind_factor(&s("1.2.1"), &release_chain);
+        assert_eq!(20, res);
+
+        let res = weights.versions_behind_factor(&s("1.2.0"), &release_chain);
+        assert_eq!(21, res);
+
+        release_chain.push_new("1.5.0");
+
+        // current
+        let res = weights.versions_behind_factor(&s("1.5.0"), &release_chain);
+        assert_eq!(0, res);
+
+        let res = weights.versions_behind_factor(&s("1.4.0"), &release_chain);
+        assert_eq!(10, res);
+
+        // on 'skipped' version
+        let res = weights.versions_behind_factor(&s("1.3.0"), &release_chain);
+        assert_eq!(20, res);
+
+        // on version before the skip
+        let res = weights.versions_behind_factor(&s("1.2.1"), &release_chain);
+        assert_eq!(30, res);
+
+        let res = weights.versions_behind_factor(&s("1.2.0"), &release_chain);
+        assert_eq!(31, res);
+    }
+}

common/cosmwasm-smart-contracts/mixnet-contract/src/error.rs

@@ -275,6 +275,9 @@ pub enum MixnetContractError {
 
     #[error("the provided nym-node version is not a valid semver. got: {provided}")]
     InvalidNymNodeSemver { provided: String },
+
+    #[error("the provided nym-node version is not greater than the current one. got: {provided}. current: {current}")]
+    NonIncreasingSemver { provided: String, current: String },
 }
 
 impl MixnetContractError {

common/cosmwasm-smart-contracts/mixnet-contract/src/events.rs

@@ -141,6 +141,7 @@ pub const NEW_INTERVAL_OPERATING_COST_RANGE_KEY: &str = "new_interval_operating_
 pub const NEW_VERSION_WEIGHTS_RANGE_KEY: &str = "new_version_weights_range";
 pub const NEW_VERSION_SCORE_FORMULA_PARAMS_KEY: &str = "new_version_score_formula_params";
 pub const NYM_NODE_CURRENT_SEMVER_KEY: &str = "new_current_semver";
+pub const NYM_NODE_CURRENT_SEMVER_ID_KEY: &str = "new_current_semver_id";
 
 pub const OLD_REWARDING_VALIDATOR_ADDRESS_KEY: &str = "old_rewarding_validator_address";
 pub const NEW_REWARDING_VALIDATOR_ADDRESS_KEY: &str = "new_rewarding_validator_address";
@@ -481,12 +482,6 @@ pub fn new_settings_update_event(update: &ContractStateParamsUpdate) -> Event {
 
     // check for config score params updates
     if let Some(config_score_update) = &update.config_score_params {
-        if let Some(current_nym_node_semver) = &config_score_update.current_nym_node_semver {
-            event.attributes.push(attr(
-                NYM_NODE_CURRENT_SEMVER_KEY,
-                current_nym_node_semver.to_string(),
-            ))
-        }
         if let Some(version_weights) = &config_score_update.version_weights {
             event.attributes.push(attr(
                 NEW_VERSION_WEIGHTS_RANGE_KEY,
@@ -506,9 +501,10 @@ pub fn new_settings_update_event(update: &ContractStateParamsUpdate) -> Event {
     event
 }
 
-pub fn new_update_nym_node_semver_event(new_version: &str) -> Event {
+pub fn new_update_nym_node_semver_event(new_version: &str, new_id: u32) -> Event {
     Event::new(MixnetEventType::NymNodeSemverUpdate)
         .add_attribute(NYM_NODE_CURRENT_SEMVER_KEY, new_version)
+        .add_attribute(NYM_NODE_CURRENT_SEMVER_ID_KEY, new_id.to_string())
 }
 
 pub fn new_not_found_node_operator_rewarding_event(interval: Interval, node_id: NodeId) -> Event {

common/cosmwasm-smart-contracts/mixnet-contract/src/gateway.rs

@@ -42,9 +42,11 @@ pub struct Gateway {
 #[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct GatewayBond {
     /// Original amount pledged by the operator of this node.
+    #[cfg_attr(feature = "utoipa", schema(value_type = crate::CoinSchema))]
     pub pledge_amount: Coin,
 
     /// Address of the owner of this gateway.
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub owner: Addr,
 
     /// Block height at which this gateway has been bonded.
@@ -55,6 +57,7 @@ pub struct GatewayBond {
 
     /// Entity who bonded this gateway on behalf of the owner.
     /// If exists, it's most likely the address of the vesting contract.
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub proxy: Option<Addr>,
 }
 

common/cosmwasm-smart-contracts/mixnet-contract/src/lib.rs

@@ -5,6 +5,7 @@
 #![warn(clippy::unwrap_used)]
 #![warn(clippy::todo)]
 
+mod config_score;
 pub mod constants;
 pub mod delegation;
 pub mod error;
@@ -21,6 +22,7 @@ pub mod rewarding;
 pub mod signing_types;
 pub mod types;
 
+pub use config_score::*;
 pub use constants::*;
 pub use contracts_common::types::*;
 pub use cosmwasm_std::{Addr, Coin, Decimal, Fraction};

common/cosmwasm-smart-contracts/mixnet-contract/src/mixnode.rs

@@ -81,20 +81,25 @@ impl MixNodeDetails {
 
 // currently this struct is shared between mixnodes and nymnodes
 #[cw_serde]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct NodeRewarding {
     /// Information provided by the operator that influence the cost function.
     pub cost_params: NodeCostParams,
 
     /// Total pledge and compounded reward earned by the node operator.
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub operator: Decimal,
 
     /// Total delegation and compounded reward earned by all node delegators.
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub delegates: Decimal,
 
     /// Cumulative reward earned by the "unit delegation" since the block 0.
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub total_unit_reward: Decimal,
 
     /// Value of the theoretical "unit delegation" that has delegated to this node at block 0.
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub unit_delegation: Decimal,
 
     /// Marks the epoch when this node was last rewarded so that we wouldn't accidentally attempt
@@ -491,14 +496,17 @@ impl NodeRewarding {
     ::cosmwasm_schema::schemars::JsonSchema,
 )]
 #[schemars(crate = "::cosmwasm_schema::schemars")]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct MixNodeBond {
     /// Unique id assigned to the bonded mixnode.
     pub mix_id: NodeId,
 
     /// Address of the owner of this mixnode.
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub owner: Addr,
 
     /// Original amount pledged by the operator of this node.
+    #[cfg_attr(feature = "utoipa", schema(value_type = crate::CoinSchema))]
     pub original_pledge: Coin,
 
     // REMOVED (but might be needed due to legacy things, idk yet)
@@ -509,6 +517,7 @@ pub struct MixNodeBond {
 
     /// Entity who bonded this mixnode on behalf of the owner.
     /// If exists, it's most likely the address of the vesting contract.
+    #[cfg_attr(feature = "utoipa", schema(value_type = Option<String>))]
     pub proxy: Option<Addr>,
 
     /// Block height at which this mixnode has been bonded.
@@ -544,6 +553,7 @@ impl MixNodeBond {
     feature = "generate-ts",
     ts(export, export_to = "ts-packages/types/src/types/rust/Mixnode.ts")
 )]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct MixNode {
     /// Network address of this mixnode, for example 1.1.1.1 or foo.mixnode.com
     pub host: String,
@@ -570,11 +580,14 @@ pub struct MixNode {
 /// The cost parameters, or the cost function, defined for the particular mixnode that influences
 /// how the rewards should be split between the node operator and its delegators.
 #[cw_serde]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct NodeCostParams {
     /// The profit margin of the associated node, i.e. the desired percent of the reward to be distributed to the operator.
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub profit_margin_percent: Percent,
 
     /// Operating cost of the associated node per the entire interval.
+    #[cfg_attr(feature = "utoipa", schema(value_type = crate::CoinSchema))]
     pub interval_operating_cost: Coin,
 }
 
@@ -669,7 +682,9 @@ pub struct PendingMixNodeChanges {
 }
 
 #[derive(Default, Copy, Clone, Debug, Serialize, Deserialize, JsonSchema)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct LegacyPendingMixNodeChanges {
+    #[cfg_attr(feature = "utoipa", schema(value_type = Option<u32>))]
     pub pledge_change: Option<EpochEventId>,
 }
 

common/cosmwasm-smart-contracts/mixnet-contract/src/msg.rs

@@ -25,6 +25,7 @@ use std::time::Duration;
 
 #[cfg(feature = "schema")]
 use crate::{
+    config_score::{CurrentNymNodeVersionResponse, NymNodeVersionHistoryResponse},
     delegation::{
         NodeDelegationResponse, PagedAllDelegationsResponse, PagedDelegatorDelegationsResponse,
         PagedNodeDelegationsResponse,
@@ -423,6 +424,20 @@ pub enum QueryMsg {
     #[cfg_attr(feature = "schema", returns(ContractState))]
     GetState {},
 
+    /// Get the current expected version of a Nym Node.
+    #[cfg_attr(feature = "schema", returns(CurrentNymNodeVersionResponse))]
+    GetCurrentNymNodeVersion {},
+
+    /// Get the version history of Nym Node.
+    #[cfg_attr(feature = "schema", returns(NymNodeVersionHistoryResponse))]
+    GetNymNodeVersionHistory {
+        /// Controls the maximum number of entries returned by the query. Note that too large values will be overwritten by a saner default.
+        limit: Option<u32>,
+
+        /// Pagination control for the values returned by the query. Note that the provided value itself will **not** be used for the response.
+        start_after: Option<u32>,
+    },
+
     /// Gets the current parameters used for reward calculation.
     #[cfg_attr(feature = "schema", returns(RewardingParams))]
     GetRewardingParams {},

common/cosmwasm-smart-contracts/mixnet-contract/src/nym_node.rs

@@ -231,6 +231,7 @@ pub struct RoleMetadata {
 
 /// Full details associated with given node.
 #[cw_serde]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct NymNodeDetails {
     /// Basic bond information of this node, such as owner address, original pledge, etc.
     pub bond_information: NymNodeBond,
@@ -288,14 +289,19 @@ impl NymNodeDetails {
 }
 
 #[cw_serde]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct NymNodeBond {
     /// Unique id assigned to the bonded node.
+    #[cfg_attr(feature = "utoipa", schema(value_type = u32))]
     pub node_id: NodeId,
 
     /// Address of the owner of this nym-node.
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub owner: Addr,
 
     /// Original amount pledged by the operator of this node.
+
+    #[cfg_attr(feature = "utoipa", schema(value_type = crate::CoinSchema))]
     pub original_pledge: Coin,
 
     /// Block height at which this nym-node has been bonded.
@@ -348,6 +354,7 @@ impl NymNodeBond {
     feature = "generate-ts",
     ts(export, export_to = "ts-packages/types/src/types/rust/NymNode.ts")
 )]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct NymNode {
     /// Network address of this nym-node, for example 1.1.1.1 or foo.mixnode.com
     /// that is used to discover other capabilities of this node.
@@ -358,6 +365,7 @@ pub struct NymNode {
     pub custom_http_port: Option<u16>,
 
     /// Base58-encoded ed25519 EdDSA public key.
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub identity_key: IdentityKey,
     // TODO: I don't think we want to include sphinx keys here,
     // given we want to rotate them and keeping that in sync with contract will be a PITA
@@ -435,8 +443,11 @@ pub struct NodeConfigUpdate {
         export_to = "ts-packages/types/src/types/rust/PendingNodeChanges.ts"
     )
 )]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct PendingNodeChanges {
+    #[cfg_attr(feature = "utoipa", schema(value_type = Option<u32>))]
     pub pledge_change: Option<EpochEventId>,
+    #[cfg_attr(feature = "utoipa", schema(value_type = Option<u32>))]
     pub cost_params_change: Option<IntervalEventId>,
 }
 

common/cosmwasm-smart-contracts/mixnet-contract/src/reward_params.rs

@@ -21,31 +21,37 @@ pub type WorkFactor = Decimal;
 )]
 #[cw_serde]
 #[derive(Copy)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct IntervalRewardParams {
     /// Current value of the rewarding pool.
     /// It is expected to be constant throughout the interval.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub reward_pool: Decimal,
 
     /// Current value of the staking supply.
     /// It is expected to be constant throughout the interval.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub staking_supply: Decimal,
 
     /// Defines the percentage of stake needed to reach saturation for all of the nodes in the rewarded set.
     /// Also known as `beta`.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub staking_supply_scale_factor: Percent,
 
     // computed values
     /// Current value of the computed reward budget per epoch, per node.
     /// It is expected to be constant throughout the interval.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub epoch_reward_budget: Decimal,
 
     /// Current value of the stake saturation point.
     /// It is expected to be constant throughout the interval.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub stake_saturation_point: Decimal,
 
     // constants(-ish)
@@ -54,6 +60,7 @@ pub struct IntervalRewardParams {
     /// It is not really expected to be changing very often.
     /// As a matter of fact, unless there's a very specific reason, it should remain constant.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub sybil_resistance: Percent,
 
     // default: 10
@@ -61,6 +68,7 @@ pub struct IntervalRewardParams {
     /// It is not really expected to be changing very often.
     /// As a matter of fact, unless there's a very specific reason, it should remain constant.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub active_set_work_factor: Decimal,
 
     // default: 2%
@@ -70,6 +78,7 @@ pub struct IntervalRewardParams {
     /// It is not really expected to be changing very often.
     /// As a matter of fact, unless there's a very specific reason, it should remain constant.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub interval_pool_emission: Percent,
 }
 
@@ -90,6 +99,7 @@ impl IntervalRewardParams {
 )]
 #[cw_serde]
 #[derive(Copy)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct RewardingParams {
     /// Parameters that should remain unchanged throughout an interval.
     pub interval: IntervalRewardParams,
@@ -254,6 +264,7 @@ impl RewardingParams {
 )]
 #[cw_serde]
 #[derive(Copy)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct RewardedSetParams {
     /// The expected number of nodes assigned entry gateway role (i.e. [`Role::EntryGateway`])
     pub entry_gateways: u32,

common/cosmwasm-smart-contracts/mixnet-contract/src/rewarding/mod.rs

@@ -17,10 +17,12 @@ pub mod simulator;
 )]
 #[cw_serde]
 #[derive(Copy, Default)]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub struct RewardEstimate {
     /// The amount of **decimal** coins that are going to get distributed to the node,
     /// i.e. the operator and all its delegators.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub total_node_reward: Decimal,
 
     // note that operator reward includes the operating_cost,
@@ -28,14 +30,17 @@ pub struct RewardEstimate {
     // in that case the operator reward would still be `1nym` as opposed to 0
     /// The share of the reward that is going to get distributed to the node operator.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub operator: Decimal,
 
     /// The share of the reward that is going to get distributed among the node delegators.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub delegates: Decimal,
 
     /// The operating cost of this node. Note: it's already included in the operator reward.
     #[cfg_attr(feature = "generate-ts", ts(type = "string"))]
+    #[cfg_attr(feature = "utoipa", schema(value_type = String))]
     pub operating_cost: Decimal,
 }
 

common/cosmwasm-smart-contracts/mixnet-contract/src/types.rs

@@ -1,11 +1,12 @@
 // Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
+use crate::config_score::{ConfigScoreParams, OutdatedVersionWeights, VersionScoreFormulaParams};
 use crate::nym_node::Role;
 use contracts_common::Percent;
 use cosmwasm_schema::cw_serde;
+use cosmwasm_std::Coin;
 use cosmwasm_std::{Addr, Uint128};
-use cosmwasm_std::{Coin, Decimal};
 use std::fmt::{Display, Formatter};
 
 // type aliases for better reasoning about available data
@@ -133,6 +134,14 @@ where
     }
 }
 
+#[cfg(feature = "utoipa")]
+#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
+#[cfg_attr(feature = "utoipa", schema(title = "Coin"))]
+pub struct CoinSchema {
+    pub denom: String,
+    pub amount: String,
+}
+
 /// The current state of the mixnet contract.
 #[cw_serde]
 pub struct ContractState {
@@ -221,96 +230,14 @@ impl OperatorsParamsUpdate {
     }
 }
 
-#[cw_serde]
-pub struct ConfigScoreParams {
-    /// Current version of the nym node that is going to be used for determining the version score of a node.
-    /// note: value stored here is pre-validated `semver::Version`
-    pub current_nym_node_semver: String,
-
-    /// Defines weights for calculating numbers of versions behind the current release.
-    pub version_weights: OutdatedVersionWeights,
-
-    /// Defines the parameters of the formula for calculating the version score
-    pub version_score_formula_params: VersionScoreFormulaParams,
-}
-
-impl ConfigScoreParams {
-    // SAFETY: the value stored in the contract is always valid
-    #[allow(clippy::unwrap_used)]
-    pub fn unchecked_nym_node_version(&self) -> semver::Version {
-        self.current_nym_node_semver.parse().unwrap()
-    }
-
-    pub fn versions_behind(&self, node_semver: &semver::Version) -> u32 {
-        let expected = self.unchecked_nym_node_version();
-
-        let major_diff = (node_semver.major as i64 - expected.major as i64).unsigned_abs() as u32;
-        let minor_diff = (node_semver.minor as i64 - expected.minor as i64).unsigned_abs() as u32;
-        let patch_diff = (node_semver.patch as i64 - expected.patch as i64).unsigned_abs() as u32;
-        let prerelease_diff = if node_semver.pre == expected.pre {
-            0
-        } else {
-            1
-        };
-
-        major_diff * self.version_weights.major
-            + minor_diff * self.version_weights.minor
-            + patch_diff * self.version_weights.patch
-            + prerelease_diff * self.version_weights.prerelease
-    }
-}
-
-/// Defines weights for calculating numbers of versions behind the current release.
-#[cw_serde]
-#[derive(Copy)]
-pub struct OutdatedVersionWeights {
-    pub major: u32,
-    pub minor: u32,
-    pub patch: u32,
-    pub prerelease: u32,
-}
-
-impl Default for OutdatedVersionWeights {
-    fn default() -> Self {
-        OutdatedVersionWeights {
-            major: 100,
-            minor: 10,
-            patch: 1,
-            prerelease: 1,
-        }
-    }
-}
-
-/// Given the formula of version_score = penalty ^ (num_versions_behind ^ penalty_scaling)
-/// define the relevant parameters
-#[cw_serde]
-#[derive(Copy)]
-pub struct VersionScoreFormulaParams {
-    pub penalty: Decimal,
-    pub penalty_scaling: Decimal,
-}
-
-impl Default for VersionScoreFormulaParams {
-    fn default() -> Self {
-        #[allow(clippy::unwrap_used)]
-        VersionScoreFormulaParams {
-            penalty: "0.8".parse().unwrap(),
-            penalty_scaling: "2.0".parse().unwrap(),
-        }
-    }
-}
-
 #[cw_serde]
 pub struct ConfigScoreParamsUpdate {
-    pub current_nym_node_semver: Option<String>,
     pub version_weights: Option<OutdatedVersionWeights>,
     pub version_score_formula_params: Option<VersionScoreFormulaParams>,
 }
 
 impl ConfigScoreParamsUpdate {
     pub fn contains_updates(&self) -> bool {
-        self.current_nym_node_semver.is_some()
-            || self.version_weights.is_some()
-            || self.version_score_formula_params.is_some()
+        self.version_weights.is_some() || self.version_score_formula_params.is_some()
     }
 }

common/cosmwasm-smart-contracts/vesting-contract/bindings/ts-packages/types/src/types/rust/Period.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The vesting period.
+ */
+export type Period = "Before" | { "In": number } | "After";

common/credential-verification/src/ecash/credential_sender.rs

@@ -17,7 +17,7 @@ use nym_validator_client::nym_api::EpochId;
 use nym_validator_client::nyxd::contract_traits::{
     EcashSigningClient, MultisigQueryClient, MultisigSigningClient, PagedMultisigQueryClient,
 };
-use nym_validator_client::nyxd::cosmwasm_client::ToSingletonContractData;
+use nym_validator_client::nyxd::cosmwasm_client::ContractResponseData;
 use nym_validator_client::nyxd::cw3::Status;
 use nym_validator_client::nyxd::AccountId;
 use nym_validator_client::EcashApiClient;

common/credentials-interface/Cargo.toml

@@ -16,6 +16,7 @@ serde = { workspace = true, features = ["derive"] }
 thiserror = { workspace = true }
 strum = { workspace = true, features = ["derive"] }
 time = { workspace = true, features = ["serde"] }
+utoipa = { workspace = true }
 rand = { workspace = true }
 
 nym-compact-ecash = { path = "../nym_offline_compact_ecash" }

common/crypto/Cargo.toml

@@ -41,6 +41,6 @@ aead = ["dep:aead", "aead/std", "aes-gcm-siv", "generic-array"]
 serde = ["dep:serde", "serde_bytes", "ed25519-dalek/serde", "x25519-dalek/serde"]
 asymmetric = ["x25519-dalek", "ed25519-dalek", "zeroize"]
 hashing = ["blake3", "digest", "hkdf", "hmac", "generic-array"]
-stream_cipher = ["aes", "ctr", "cipher", "cipher/zeroize", "generic-array"]
+stream_cipher = ["aes", "ctr", "cipher", "generic-array"]
 sphinx = ["nym-sphinx-types/sphinx"]
 outfox = ["nym-sphinx-types/outfox"]

common/crypto/src/asymmetric/identity/mod.rs

@@ -6,6 +6,7 @@ use ed25519_dalek::{Signer, SigningKey};
 pub use ed25519_dalek::{Verifier, PUBLIC_KEY_LENGTH, SECRET_KEY_LENGTH, SIGNATURE_LENGTH};
 use nym_pemstore::traits::{PemStorableKey, PemStorableKeyPair};
 use std::fmt::{self, Debug, Display, Formatter};
+use std::hash::{Hash, Hasher};
 use std::str::FromStr;
 use thiserror::Error;
 use zeroize::{Zeroize, ZeroizeOnDrop};
@@ -122,6 +123,14 @@ impl PemStorableKeyPair for KeyPair {
 #[derive(Copy, Clone, Eq, PartialEq)]
 pub struct PublicKey(ed25519_dalek::VerifyingKey);
 
+impl Hash for PublicKey {
+    fn hash<H: Hasher>(&self, state: &mut H) {
+        // each public key has unique bytes representation which can be used
+        // for the hash implementation
+        self.to_bytes().hash(state)
+    }
+}
+
 impl Display for PublicKey {
     fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
         Display::fmt(&self.to_base58_string(), f)

common/exit-policy/src/policy/address_policy.rs

@@ -86,7 +86,6 @@ impl Display for AddressPolicyAction {
 /// ```
 #[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq)]
 #[cfg_attr(feature = "openapi", derive(utoipa::ToSchema))]
-#[cfg_attr(feature = "openapi", aliases(ExitPolicy))]
 pub struct AddressPolicy {
     /// A list of rules to apply to find out whether an address is
     /// contained by this policy.
@@ -727,10 +726,10 @@ mod test {
         let policy = AddressPolicy::parse_from_torrc(
             r#"
 ExitPolicy reject 1.2.3.4/32:*
-ExitPolicy reject 1.2.3.5:* 
+ExitPolicy reject 1.2.3.5:*
 ExitPolicy reject 1.2.3.6/16:*
-ExitPolicy reject 1.2.3.6/16:123-456 
-ExitPolicy accept *:53 
+ExitPolicy reject 1.2.3.6/16:123-456
+ExitPolicy accept *:53
 ExitPolicy accept6 *6:119
 ExitPolicy accept *4:120
 ExitPolicy reject6 [FC00::]/7:*

common/http-api-client/src/lib.rs

@@ -282,7 +282,7 @@ impl Client {
         }
     }
 
-    pub async fn create_delete_request<K, V>(
+    pub fn create_delete_request<K, V>(
         &self,
         path: PathSegments<'_>,
         params: Params<'_, K, V>,

common/http-api-common/Cargo.toml

@@ -15,12 +15,15 @@ axum-client-ip.workspace = true
 axum.workspace = true
 bytes = { workspace = true }
 colored.workspace = true
+futures = { workspace = true }
 mime = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 serde_json.workspace = true
 serde_yaml = { workspace = true }
+tower = { workspace = true }
 tracing.workspace = true
 utoipa = { workspace = true, optional = true }
+zeroize = { workspace = true }
 
 [features]
 utoipa = ["dep:utoipa"]

common/http-api-common/src/lib.rs

@@ -7,10 +7,9 @@ use axum::Json;
 use bytes::{BufMut, BytesMut};
 use serde::{Deserialize, Serialize};
 
-pub mod logging;
+pub mod middleware;
 
 #[derive(Debug, Clone)]
-#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
 pub enum FormattedResponse<T> {
     Json(Json<T>),
     Yaml(Yaml<T>),

common/http-api-common/src/middleware/bearer_auth.rs

@@ -1,5 +1,5 @@
 // Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: GPL-3.0-only
+// SPDX-License-Identifier: Apache-2.0
 
 use axum::http::{header, HeaderValue, StatusCode};
 use axum::response::IntoResponse;

common/http-api-common/src/middleware/logging.rs

@@ -1,5 +1,5 @@
 // Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: GPL-3.0-only
+// SPDX-License-Identifier: Apache-2.0
 
 use axum::extract::Request;
 use axum::http::header::{HOST, USER_AGENT};
@@ -11,6 +11,7 @@ use colored::Colorize;
 use std::time::Instant;
 use tracing::info;
 
+/// Simple logger for requests
 pub async fn logger(
     InsecureClientIp(addr): InsecureClientIp,
     request: Request,

common/http-api-common/src/middleware/mod.rs

@@ -0,0 +1,5 @@
+// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
+// SPDX-License-Identifier: Apache-2.0
+
+pub mod bearer_auth;
+pub mod logging;

common/nym_offline_compact_ecash/Cargo.toml

@@ -20,6 +20,7 @@ rand = { workspace = true }
 thiserror = { workspace = true }
 sha2 = "0.9"
 bs58 = { workspace = true }
+utoipa = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 rayon = { workspace = true, optional = true }
 zeroize = { workspace = true, features = ["zeroize_derive"] }
@@ -63,4 +64,4 @@ par_signing = ["rayon"]
 # but given it's not done very frequently, it shouldn't be too much of a problem
 # furthermore, we can't and shouldn't dedicate the entire nym-api CPU just for verification,
 # but this feature might potentially be desirable for clients.
-par_verify = ["rayon"]
+par_verify = ["rayon"]

common/nym_offline_compact_ecash/src/common_types.rs

@@ -4,10 +4,10 @@
 use crate::ecash_group_parameters;
 use crate::error::Result;
 use crate::helpers::{g1_tuple_to_bytes, recover_g1_tuple};
-use bls12_381::{G1Projective, Scalar};
 use serde::{Deserialize, Serialize};
 use subtle::Choice;
 
+pub use bls12_381::{G1Projective, G2Projective, Scalar};
 pub type SignerIndex = u64;
 
 #[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)]

common/nym_offline_compact_ecash/src/lib.rs

@@ -36,7 +36,7 @@ pub mod common_types;
 pub mod constants;
 pub mod error;
 mod helpers;
-mod proofs;
+pub mod proofs;
 pub mod scheme;
 pub mod tests;
 mod traits;

common/nym_offline_compact_ecash/src/utils.rs

@@ -16,6 +16,7 @@ use group::{Curve, Group};
 use itertools::Itertools;
 use std::borrow::Borrow;
 use std::ops::Neg;
+use utoipa::ToSchema;
 
 pub struct Polynomial {
     coefficients: Vec<Scalar>,
@@ -51,6 +52,17 @@ impl Polynomial {
     }
 }
 
+#[derive(ToSchema)]
+#[schema(title = "G2Projective")]
+pub struct G2ProjectiveSchema {
+    #[schema(content_encoding = "base16")]
+    pub x: [u64; 6],
+    #[schema(content_encoding = "base16")]
+    pub y: [u64; 6],
+    #[schema(content_encoding = "base16")]
+    pub z: [u64; 6],
+}
+
 #[inline]
 pub fn generate_lagrangian_coefficients_at_origin(points: &[u64]) -> Vec<Scalar> {
     let x = Scalar::zero();

common/service-provider-requests-common/src/lib.rs

@@ -11,7 +11,7 @@ pub enum ServiceProviderType {
     Authenticator = 2,
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize)]
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
 pub struct Protocol {
     pub version: u8,
     pub service_provider_type: ServiceProviderType,

common/ticketbooks-merkle/Cargo.toml

@@ -14,6 +14,7 @@ readme.workspace = true
 sha2 = { workspace = true }
 rs_merkle = { workspace = true }
 schemars = { workspace = true }
+utoipa = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 time = { workspace = true }
 
@@ -23,4 +24,4 @@ nym-serde-helpers = { path = "../serde-helpers", features = ["date", "base64", "
 [dev-dependencies]
 rand_chacha = { workspace = true }
 rand = { workspace = true }
-serde_json = { workspace = true }
+serde_json = { workspace = true }

common/ticketbooks-merkle/src/lib.rs

@@ -14,15 +14,18 @@ use serde::{Deserialize, Serialize};
 use sha2::Digest;
 use std::fmt::{Debug, Formatter};
 use time::Date;
+use utoipa::ToSchema;
 
 // no point in importing the entire contract commons just for this one type
 pub type DepositId = u32;
 pub type DKGEpochId = u64;
 
-#[derive(Clone, Serialize, Deserialize, Debug, PartialEq, JsonSchema)]
+#[derive(Clone, Serialize, Deserialize, Debug, PartialEq, JsonSchema, ToSchema)]
 #[serde(rename_all = "camelCase")]
 pub struct IssuedTicketbook {
+    #[schema(value_type = u32)]
     pub deposit_id: DepositId,
+    #[schema(value_type = u32)]
     pub epoch_id: DKGEpochId,
 
     // 96 bytes serialised 'BlindedSignature'
@@ -37,9 +40,11 @@ pub struct IssuedTicketbook {
 
     #[schemars(with = "String")]
     #[serde(with = "nym_serde_helpers::date")]
+    #[schema(value_type = String)]
     pub expiration_date: Date,
 
     #[schemars(with = "String")]
+    #[schema(value_type = String)]
     pub ticketbook_type: TicketType,
 }
 
@@ -80,7 +85,7 @@ pub struct InsertedMerkleLeaf {
     pub leaf: MerkleLeaf,
 }
 
-#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialOrd, PartialEq, Eq)]
+#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialOrd, PartialEq, Eq, ToSchema)]
 pub struct MerkleLeaf {
     #[schemars(with = "String")]
     #[serde(with = "nym_serde_helpers::hex")]
@@ -162,16 +167,14 @@ impl IssuedTicketbooksMerkleTree {
     }
 }
 
-#[derive(Serialize, Deserialize, JsonSchema)]
+#[derive(Serialize, Deserialize, JsonSchema, ToSchema)]
 pub struct IssuedTicketbooksFullMerkleProof {
     #[schemars(with = "String")]
     #[serde(with = "inner_proof_base64_serde")]
+    #[schema(value_type = String)]
     inner_proof: MerkleProof<Sha256>,
-
     included_leaves: Vec<MerkleLeaf>,
-
     total_leaves: usize,
-
     #[schemars(with = "String")]
     #[serde(with = "nym_serde_helpers::hex")]
     root: Vec<u8>,

common/topology/src/filter.rs

@@ -1,55 +0,0 @@
-// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use nym_bin_common::version_checker;
-use std::collections::{BTreeMap, HashMap};
-use std::hash::Hash;
-
-pub trait Versioned: Clone {
-    fn version(&self) -> String;
-}
-
-pub trait VersionFilterable<T> {
-    #[must_use]
-    fn filter_by_version(&self, expected_version: &str) -> Self;
-}
-
-impl<T> VersionFilterable<T> for Vec<T>
-where
-    T: Versioned,
-{
-    fn filter_by_version(&self, expected_version: &str) -> Self {
-        self.iter()
-            .filter(|node| {
-                version_checker::is_minor_version_compatible(&node.version(), expected_version)
-            })
-            .cloned()
-            .collect()
-    }
-}
-
-impl<T, K, V> VersionFilterable<T> for HashMap<K, V>
-where
-    K: Eq + Hash + Clone,
-    V: VersionFilterable<T>,
-    T: Versioned,
-{
-    fn filter_by_version(&self, expected_version: &str) -> Self {
-        self.iter()
-            .map(|(k, v)| (k.clone(), v.filter_by_version(expected_version)))
-            .collect()
-    }
-}
-
-impl<T, K, V> VersionFilterable<T> for BTreeMap<K, V>
-where
-    K: Eq + Ord + Clone,
-    V: VersionFilterable<T>,
-    T: Versioned,
-{
-    fn filter_by_version(&self, expected_version: &str) -> Self {
-        self.iter()
-            .map(|(k, v)| (k.clone(), v.filter_by_version(expected_version)))
-            .collect()
-    }
-}

common/topology/src/gateway.rs

@@ -1,7 +1,7 @@
 // Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{filter, NetworkAddress, NodeVersion};
+use crate::{NetworkAddress, NodeVersion};
 use nym_api_requests::nym_nodes::SkimmedNode;
 use nym_crypto::asymmetric::{encryption, identity};
 use nym_mixnet_contract_common::NodeId;
@@ -126,13 +126,6 @@ impl fmt::Display for LegacyNode {
     }
 }
 
-impl filter::Versioned for LegacyNode {
-    fn version(&self) -> String {
-        // TODO: return semver instead
-        self.version.to_string()
-    }
-}
-
 impl<'a> From<&'a LegacyNode> for SphinxNode {
     fn from(node: &'a LegacyNode) -> Self {
         let node_address_bytes = NymNodeRoutingAddress::from(node.mix_host)

common/topology/src/lib.rs

@@ -4,7 +4,6 @@
 #![allow(unknown_lints)]
 // clippy::to_string_trait_impl is not on stable as of 1.77
 
-use crate::filter::VersionFilterable;
 pub use error::NymTopologyError;
 use log::{debug, info, warn};
 use nym_api_requests::nym_nodes::{CachedNodesResponse, SkimmedNode};
@@ -25,7 +24,6 @@ use std::str::FromStr;
 use ::serde::{Deserialize, Deserializer, Serialize, Serializer};
 
 pub mod error;
-pub mod filter;
 pub mod gateway;
 pub mod mix;
 pub mod random_route_provider;
@@ -465,19 +463,6 @@ impl NymTopology {
 
         Ok(())
     }
-
-    #[must_use]
-    pub fn filter_system_version(&self, expected_version: &str) -> Self {
-        self.filter_node_versions(expected_version)
-    }
-
-    #[must_use]
-    pub fn filter_node_versions(&self, expected_mix_version: &str) -> Self {
-        NymTopology {
-            mixes: self.mixes.filter_by_version(expected_mix_version),
-            gateways: self.gateways.clone(),
-        }
-    }
 }
 
 #[cfg(feature = "serializable")]

common/topology/src/mix.rs

@@ -1,7 +1,7 @@
 // Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::{filter, NetworkAddress, NodeVersion};
+use crate::{NetworkAddress, NodeVersion};
 use nym_api_requests::nym_nodes::{NodeRole, SkimmedNode};
 use nym_crypto::asymmetric::{encryption, identity};
 pub use nym_mixnet_contract_common::LegacyMixLayer;
@@ -89,13 +89,6 @@ impl LegacyNode {
     }
 }
 
-impl filter::Versioned for LegacyNode {
-    fn version(&self) -> String {
-        // TODO: return semver instead
-        self.version.to_string()
-    }
-}
-
 impl<'a> From<&'a LegacyNode> for SphinxNode {
     fn from(node: &'a LegacyNode) -> Self {
         let node_address_bytes = NymNodeRoutingAddress::from(node.mix_host)

common/types/Cargo.toml

@@ -22,6 +22,7 @@ strum = { workspace = true, features = ["derive"] }
 thiserror = { workspace = true }
 ts-rs = { workspace = true }
 url = { workspace = true }
+utoipa = { workspace = true }
 x25519-dalek = { workspace = true, features = ["static_secrets"] }
 
 cosmwasm-std = { workspace = true }