update cargo locks

version bump for next release

CHANGELOG.md

@@ -4,14 +4,29 @@ Post 1.0.0 release, the changelog format is based on [Keep a Changelog](https://
 
 ## [Unreleased]
 
-- nym-network-statistics properly handles signals ([#3209])
-- add socks5 support for Rust SDK ([#3226], [#3255])
-- add coconut bandwidth credential support for Rust SDK ([#3273]) 
+## [v1.1.16] (2023-04-25)
 
-[#3209]: https://github.com/nymtech/nym/issues/3209
-[#3226]: https://github.com/nymtech/nym/pull/3226
-[#3255]: https://github.com/nymtech/nym/pull/3255
-[#3273]: https://github.com/nymtech/nym/pull/3273
+- Explorer - Fix sorting function on Stake Saturation. It is currently working per page and not globally ([#3320])
+- Poisson process gets stuck at too slow rate. Rework to more aggressively up-regulate ([#3309])
+- decrease the logging level of warnings associated with clients dropping packets due to gateway being overloaded (I'd say reduce it to debug/trace) - there are few sources of those, e.g. in real and cover traffic streams ([#3299])
+- Make the buffer size in `AvailableReader` depend on packet sizes the client is using + introduce read timeouts ([#3213])
+- Rust SDK - Support coconut, credential storage etc ([#2755])
+- version bump for next release ([#3349])
+- added coconut credential generation example ([#3339])
+- update mix-node setup docs with node description ([#3325])
+- exposed missing gateway commands in nym-cli ([#3324])
+- make sure to clear inner 'ack_map' in 'GatewaysReader' ([#3300])
+
+[#3320]: https://github.com/nymtech/nym/issues/3320
+[#3309]: https://github.com/nymtech/nym/issues/3309
+[#3299]: https://github.com/nymtech/nym/issues/3299
+[#3213]: https://github.com/nymtech/nym/issues/3213
+[#2755]: https://github.com/nymtech/nym/issues/2755
+[#3349]: https://github.com/nymtech/nym/pull/3349
+[#3339]: https://github.com/nymtech/nym/pull/3339
+[#3325]: https://github.com/nymtech/nym/pull/3325
+[#3324]: https://github.com/nymtech/nym/pull/3324
+[#3300]: https://github.com/nymtech/nym/pull/3300
 
 ## [v1.1.15] (2023-04-18)
 

Cargo.lock

@@ -1576,7 +1576,7 @@ checksum = "0206175f82b8d6bf6652ff7d71a1e27fd2e4efde587fd368662814d6ec1d9ce0"
 
 [[package]]
 name = "explorer-api"
-version = "1.1.15"
+version = "1.1.16"
 dependencies = [
  "chrono",
  "clap 4.1.11",
@@ -3011,7 +3011,7 @@ dependencies = [
 
 [[package]]
 name = "nym-api"
-version = "1.1.16"
+version = "1.1.17"
 dependencies = [
  "anyhow",
  "async-trait",
@@ -3142,7 +3142,7 @@ dependencies = [
 
 [[package]]
 name = "nym-cli"
-version = "1.1.15"
+version = "1.1.16"
 dependencies = [
  "anyhow",
  "base64 0.13.1",
@@ -3203,7 +3203,7 @@ dependencies = [
 
 [[package]]
 name = "nym-client"
-version = "1.1.15"
+version = "1.1.16"
 dependencies = [
  "clap 4.1.11",
  "dirs",
@@ -3471,7 +3471,7 @@ dependencies = [
 
 [[package]]
 name = "nym-gateway"
-version = "1.1.15"
+version = "1.1.16"
 dependencies = [
  "anyhow",
  "async-trait",
@@ -3600,7 +3600,7 @@ dependencies = [
 
 [[package]]
 name = "nym-mixnet-contract-common"
-version = "0.4.0"
+version = "0.5.0"
 dependencies = [
  "bs58",
  "cosmwasm-std",
@@ -3619,7 +3619,7 @@ dependencies = [
 
 [[package]]
 name = "nym-mixnode"
-version = "1.1.16"
+version = "1.1.17"
 dependencies = [
  "anyhow",
  "bs58",
@@ -3721,7 +3721,7 @@ dependencies = [
 
 [[package]]
 name = "nym-network-requester"
-version = "1.1.15"
+version = "1.1.16"
 dependencies = [
  "async-file-watcher",
  "async-trait",
@@ -3763,7 +3763,7 @@ dependencies = [
 
 [[package]]
 name = "nym-network-statistics"
-version = "1.1.15"
+version = "1.1.16"
 dependencies = [
  "dirs",
  "log",
@@ -3879,7 +3879,7 @@ dependencies = [
 
 [[package]]
 name = "nym-socks5-client"
-version = "1.1.15"
+version = "1.1.16"
 dependencies = [
  "clap 4.1.11",
  "lazy_static",
@@ -4202,7 +4202,7 @@ dependencies = [
 
 [[package]]
 name = "nym-vesting-contract"
-version = "1.3.1"
+version = "1.4.0"
 dependencies = [
  "cosmwasm-derive",
  "cosmwasm-std",
@@ -4220,7 +4220,7 @@ dependencies = [
 
 [[package]]
 name = "nym-vesting-contract-common"
-version = "0.5.0"
+version = "0.6.0"
 dependencies = [
  "cosmwasm-std",
  "nym-contracts-common",

clients/native/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-client"
-version = "1.1.15"
+version = "1.1.16"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>", "Jędrzej Stuczyński <andrew@nymtech.net>"]
 description = "Implementation of the Nym Client"
 edition = "2021"

clients/socks5/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-socks5-client"
-version = "1.1.15"
+version = "1.1.16"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>"]
 description = "A SOCKS5 localhost proxy that converts incoming messages to Sphinx and sends them to a Nym address"
 edition = "2021"

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

@@ -1,6 +1,6 @@
 [package]
 name = "nym-mixnet-contract-common"
-version = "0.4.0"
+version = "0.5.0"
 description = "Common library for the Nym mixnet contract"
 rust-version = "1.62"
 edition = { workspace = true }

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

@@ -1,6 +1,6 @@
 [package]
 name = "nym-vesting-contract-common"
-version = "0.5.0"
+version = "0.6.0"
 description = "Common library for the Nym vesting contract"
 edition = { workspace = true }
 authors = { workspace = true }
@@ -9,7 +9,7 @@ repository = { workspace = true }
 
 [dependencies]
 cosmwasm-std = { workspace = true }
-mixnet-contract-common = { path = "../mixnet-contract", package = "nym-mixnet-contract-common", version = "0.4.0" }
+mixnet-contract-common = { path = "../mixnet-contract", package = "nym-mixnet-contract-common", version = "0.5.0" }
 contracts-common = { path = "../contracts-common", package = "nym-contracts-common", version = "0.4.0" }
 serde = { version = "1.0", features = ["derive"] }
 schemars = "0.8"

common/socks5-client-core/src/lib.rs

@@ -7,15 +7,10 @@ use crate::socks::{
     authentication::{AuthenticationMethods, Authenticator, User},
     server::SphinxSocksServer,
 };
-
 use futures::channel::mpsc;
 use futures::StreamExt;
 use log::*;
 use nym_bandwidth_controller::BandwidthController;
-#[cfg(target_os = "android")]
-use nym_client_core::client::base_client::helpers::setup_empty_reply_surb_backend;
-#[cfg(not(target_os = "android"))]
-use nym_client_core::client::base_client::non_wasm_helpers;
 use nym_client_core::client::base_client::{
     BaseClientBuilder, ClientInput, ClientOutput, ClientState,
 };
@@ -28,6 +23,12 @@ use nym_validator_client::nyxd::QueryNyxdClient;
 use nym_validator_client::Client;
 use std::error::Error;
 
+#[cfg(target_os = "android")]
+use nym_client_core::client::base_client::helpers::setup_empty_reply_surb_backend;
+#[cfg(not(target_os = "android"))]
+use nym_client_core::client::base_client::non_wasm_helpers;
+use nym_client_core::config::DebugConfig;
+
 pub mod config;
 pub mod error;
 pub mod socks;
@@ -102,6 +103,7 @@ impl NymClient {
 
     pub fn start_socks5_listener(
         socks5_config: &Socks5,
+        debug_config: DebugConfig,
         client_input: ClientInput,
         client_output: ClientOutput,
         client_status: ClientState,
@@ -126,6 +128,11 @@ impl NymClient {
             ..
         } = client_status;
 
+        let packet_size = debug_config
+            .traffic
+            .secondary_packet_size
+            .unwrap_or(debug_config.traffic.primary_packet_size);
+
         let authenticator = Authenticator::new(auth_methods, allowed_users);
         let mut sphinx_socks = SphinxSocksServer::new(
             socks5_config.get_listening_port(),
@@ -134,6 +141,7 @@ impl NymClient {
             self_address,
             shared_lane_queue_lengths,
             socks::client::Config::new(
+                packet_size,
                 socks5_config.get_provider_interface_version(),
                 socks5_config.get_socks5_protocol_version(),
                 socks5_config.get_send_anonymously(),
@@ -255,6 +263,7 @@ impl NymClient {
 
         Self::start_socks5_listener(
             self.config.get_socks5(),
+            *self.config.get_debug_settings(),
             client_input,
             client_output,
             client_state,

common/socks5-client-core/src/socks/client.rs

@@ -17,6 +17,7 @@ use nym_socks5_requests::{
     ConnectionId, RemoteAddress, Socks5ProtocolVersion, Socks5ProviderRequest, Socks5Request,
 };
 use nym_sphinx::addressing::clients::Recipient;
+use nym_sphinx::params::PacketSize;
 use nym_task::connections::{LaneQueueLengths, TransmissionLane};
 use nym_task::TaskClient;
 use pin_project::pin_project;
@@ -131,6 +132,7 @@ impl AsyncWrite for StreamState {
 
 #[derive(Debug, Copy, Clone)]
 pub(crate) struct Config {
+    biggest_packet_size: PacketSize,
     provider_interface_version: ProviderInterfaceVersion,
     socks5_protocol_version: Socks5ProtocolVersion,
     use_surbs_for_responses: bool,
@@ -140,6 +142,7 @@ pub(crate) struct Config {
 
 impl Config {
     pub(crate) fn new(
+        biggest_packet_size: PacketSize,
         provider_interface_version: ProviderInterfaceVersion,
         socks5_protocol_version: Socks5ProtocolVersion,
         use_surbs_for_responses: bool,
@@ -147,6 +150,7 @@ impl Config {
         per_request_surbs: u32,
     ) -> Self {
         Self {
+            biggest_packet_size,
             provider_interface_version,
             socks5_protocol_version,
             use_surbs_for_responses,
@@ -410,6 +414,9 @@ impl SocksClient {
             remote_proxy_target,
             conn_receiver,
             input_sender,
+            // FIXME: this does NOT include overhead due to acks or chunking
+            // (so actual true plaintext is smaller)
+            self.config.biggest_packet_size.plaintext_size(),
             connection_id,
             Some(self.lane_queue_lengths.clone()),
             self.shutdown_listener.clone(),

common/socks5/proxy-helpers/src/available_reader.rs

@@ -1,208 +1,36 @@
-// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use bytes::{BufMut, Bytes, BytesMut};
+use bytes::Bytes;
 use futures::Stream;
-use std::cell::RefCell;
-use std::future::Future;
 use std::io;
-use std::ops::DerefMut;
 use std::pin::Pin;
 use std::task::{Context, Poll};
 use tokio::io::AsyncRead;
-use tokio::time::{sleep, Duration, Instant, Sleep};
-use tokio_util::io::poll_read_buf;
 
-const MAX_READ_AMOUNT: usize = 500 * 1000; // 0.5MB
-const GRACE_DURATION: Duration = Duration::from_millis(1);
+// note, min_capacity doesn't mean we're going to always read at least this amount of data,
+// it defines the smallest allowed (by yours truly) upper bound
+const MIN_CAPACITY: usize = 16 * 1024;
+const DEFAULT_CAPACITY: usize = 64 * 1024;
 
-pub struct AvailableReader<'a, R: AsyncRead + Unpin> {
-    // TODO: come up with a way to avoid using RefCell (not sure if possible though due to having to
-    // mutably borrow both inner reader and buffer at the same time)
-    buf: RefCell<BytesMut>,
-    inner: RefCell<&'a mut R>,
-    grace_period: Option<Pin<Box<Sleep>>>,
+pub struct AvailableReader<R> {
+    inner: tokio_util::io::ReaderStream<R>,
 }
 
-impl<'a, R> AvailableReader<'a, R>
-where
-    R: AsyncRead + Unpin,
-{
-    const BUF_INCREMENT: usize = 4096;
+impl<R: AsyncRead> AvailableReader<R> {
+    pub fn new(reader: R, capacity: Option<usize>) -> Self {
+        let capacity = capacity.unwrap_or(DEFAULT_CAPACITY).max(MIN_CAPACITY);
 
-    pub fn new(reader: &'a mut R) -> Self {
         AvailableReader {
-            buf: RefCell::new(BytesMut::with_capacity(Self::BUF_INCREMENT)),
-            inner: RefCell::new(reader),
-            grace_period: Some(Box::pin(sleep(GRACE_DURATION))),
+            inner: tokio_util::io::ReaderStream::with_capacity(reader, capacity),
         }
     }
 }
 
-impl<'a, R: AsyncRead + Unpin> Stream for AvailableReader<'a, R> {
+impl<R: AsyncRead + Unpin> Stream for AvailableReader<R> {
     type Item = io::Result<Bytes>;
 
     fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
-        // if we have no space in buffer left - expand it
-        if !self.buf.borrow().has_remaining_mut() {
-            self.buf.borrow_mut().reserve(Self::BUF_INCREMENT);
-        }
-
-        // note: poll_read_buf calls `buf.advance_mut(n)`
-        let poll_res = poll_read_buf(
-            Pin::new(self.inner.borrow_mut().deref_mut()),
-            cx,
-            self.buf.borrow_mut().deref_mut(),
-        );
-
-        match poll_res {
-            Poll::Pending => {
-                // there's nothing for us here, just return whatever we have (assuming we read anything!)
-                if self.buf.borrow().is_empty() {
-                    Poll::Pending
-                } else {
-                    // if exists - check grace period
-                    if let Some(grace_period) = self.grace_period.as_mut() {
-                        if Pin::new(grace_period).poll(cx).is_pending() {
-                            return Poll::Pending;
-                        }
-                    }
-
-                    let buf = self.buf.replace(BytesMut::new());
-                    Poll::Ready(Some(Ok(buf.freeze())))
-                }
-            }
-            Poll::Ready(Err(err)) => Poll::Ready(Some(Err(err))),
-            Poll::Ready(Ok(n)) => {
-                // if exists - reset grace period
-                if let Some(grace_period) = self.grace_period.as_mut() {
-                    let now = Instant::now();
-                    grace_period.as_mut().reset(now + GRACE_DURATION);
-                }
-
-                // if we read a non-0 amount, we're not done yet!
-                if n == 0 {
-                    let buf = self.buf.replace(BytesMut::new());
-                    if !buf.is_empty() {
-                        Poll::Ready(Some(Ok(buf.freeze())))
-                    } else {
-                        Poll::Ready(None)
-                    }
-                } else {
-                    // tell the waker we should be polled again!
-                    cx.waker().wake_by_ref();
-
-                    // if we reached our maximum amount - return it
-                    let read_bytes_len = self.buf.borrow().len();
-                    if read_bytes_len >= MAX_READ_AMOUNT {
-                        let buf = self.buf.replace(BytesMut::new());
-                        return Poll::Ready(Some(Ok(buf.freeze())));
-                    }
-                    Poll::Pending
-                }
-            }
-        }
+        Pin::new(&mut self.inner).poll_next(cx)
     }
 }
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use futures::{poll, StreamExt};
-    use std::io::Cursor;
-    use std::time::Duration;
-    use tokio::io::AsyncReadExt;
-    use tokio_test::assert_pending;
-
-    #[tokio::test]
-    async fn available_reader_reads_all_available_data_smaller_than_its_buf() {
-        let data = vec![42u8; 100];
-        let mut reader = Cursor::new(data.clone());
-
-        let mut available_reader = AvailableReader::new(&mut reader);
-        let read_data = available_reader.next().await.unwrap().unwrap();
-
-        assert_eq!(read_data, data);
-        assert!(available_reader.next().await.is_none());
-    }
-
-    #[tokio::test]
-    async fn available_reader_reads_all_available_data_bigger_than_its_buf() {
-        let data = vec![42u8; AvailableReader::<Cursor<Vec<u8>>>::BUF_INCREMENT + 100];
-        let mut reader = Cursor::new(data.clone());
-
-        let mut available_reader = AvailableReader::new(&mut reader);
-        let read_data = available_reader.next().await.unwrap().unwrap();
-
-        assert_eq!(read_data, data);
-        assert!(available_reader.next().await.is_none());
-    }
-
-    #[tokio::test]
-    async fn available_reader_will_not_wait_for_more_data_if_it_already_has_some() {
-        let first_data_chunk = vec![42u8; 100];
-        let second_data_chunk = vec![123u8; 100];
-
-        let mut reader_mock = tokio_test::io::Builder::new()
-            .read(&first_data_chunk)
-            .wait(Duration::from_millis(100)) // delay is irrelevant, what matters is that we don't get everything immediately
-            .read(&second_data_chunk)
-            .build();
-
-        let mut available_reader = AvailableReader::new(&mut reader_mock);
-        let read_data = available_reader.next().await.unwrap().unwrap();
-
-        assert_eq!(read_data, first_data_chunk);
-        assert_pending!(poll!(available_reader.next()));
-
-        // before dropping the mock, we need to empty it
-        let mut buf = vec![0u8; second_data_chunk.len()];
-        assert_eq!(reader_mock.read(&mut buf).await.unwrap(), 100);
-    }
-
-    #[tokio::test]
-    async fn available_reader_will_wait_for_more_data_if_it_doesnt_have_anything() {
-        let data = vec![42u8; 100];
-
-        let mut reader_mock = tokio_test::io::Builder::new()
-            .wait(Duration::from_millis(100))
-            .read(&data)
-            .build();
-
-        let mut available_reader = AvailableReader::new(&mut reader_mock);
-        let read_data = available_reader.next().await.unwrap().unwrap();
-
-        assert_eq!(read_data, data);
-        assert!(available_reader.next().await.is_none());
-    }
-
-    // perhaps the issue of tokio io builder will be resolved in tokio 0.3?
-    // #[tokio::test]
-    // async fn available_reader_will_wait_for_more_data_if_its_within_grace_period() {
-    //     let first_data_chunk = vec![42u8; 100];
-    //     let second_data_chunk = vec![123u8; 100];
-    //
-    //     let combined_chunks: Vec<_> = first_data_chunk
-    //         .iter()
-    //         .cloned()
-    //         .chain(second_data_chunk.iter().cloned())
-    //         .collect();
-    //
-    //     let mut reader_mock = tokio_test::io::Builder::new()
-    //         .read(&first_data_chunk)
-    //         .wait(Duration::from_millis(2))
-    //         .read(&second_data_chunk)
-    //         .build();
-    //
-    //     let mut available_reader = AvailableReader {
-    //         buf: RefCell::new(BytesMut::with_capacity(4096)),
-    //         inner: RefCell::new(&mut reader_mock),
-    //         grace_period: Some(delay_for(Duration::from_millis(5))),
-    //     };
-    //
-    //     let read_data = available_reader.next().await.unwrap().unwrap();
-    //
-    //     assert_eq!(read_data, combined_chunks);
-    //     assert!(available_reader.next().await.is_none())
-    // }
-}

common/socks5/proxy-helpers/src/proxy_runner/inbound.rs

@@ -167,6 +167,7 @@ pub(super) async fn run_inbound<F, S>(
     remote_source_address: String,
     connection_id: ConnectionId,
     mix_sender: MixProxySender<S>,
+    available_plaintext_per_mix_packet: usize,
     adapter_fn: F,
     shutdown_notify: Arc<Notify>,
     lane_queue_lengths: Option<LaneQueueLengths>,
@@ -176,7 +177,9 @@ where
     F: Fn(ConnectionId, Vec<u8>, bool) -> S + Send + 'static,
     S: Debug,
 {
-    let mut available_reader = AvailableReader::new(&mut reader);
+    // TODO: this multiplication by 4 is completely arbitrary here
+    let mut available_reader =
+        AvailableReader::new(&mut reader, Some(available_plaintext_per_mix_packet * 4));
     let mut message_sender = OrderedMessageSender::new();
     let shutdown_future = shutdown_notify.notified().then(|_| sleep(SHUTDOWN_TIMEOUT));
 

common/socks5/proxy-helpers/src/proxy_runner/mod.rs

@@ -1,4 +1,4 @@
-// Copyright 2021 - Nym Technologies SA <contact@nymtech.net>
+// Copyright 2021-2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::connection_controller::ConnectionReceiver;
@@ -49,6 +49,8 @@ pub struct ProxyRunner<S> {
     connection_id: ConnectionId,
     lane_queue_lengths: Option<LaneQueueLengths>,
 
+    available_plaintext_per_mix_packet: usize,
+
     // Listens to shutdown commands from higher up
     shutdown_listener: TaskClient,
 }
@@ -64,6 +66,7 @@ where
         remote_source_address: String,
         mix_receiver: ConnectionReceiver,
         mix_sender: MixProxySender<S>,
+        available_plaintext_per_mix_packet: usize,
         connection_id: ConnectionId,
         lane_queue_lengths: Option<LaneQueueLengths>,
         shutdown_listener: TaskClient,
@@ -76,6 +79,7 @@ where
             remote_source_address,
             connection_id,
             lane_queue_lengths,
+            available_plaintext_per_mix_packet,
             shutdown_listener,
         }
     }
@@ -96,6 +100,7 @@ where
             self.remote_source_address.clone(),
             self.connection_id,
             self.mix_sender.clone(),
+            self.available_plaintext_per_mix_packet,
             adapter_fn,
             Arc::clone(&shutdown_notify),
             self.lane_queue_lengths.clone(),

contracts/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## Unreleased
 
+## [v1.4.0] (2023-04-25)
+- Allow mixnode operators to decrease their bond amount without having to rebond (will require a lot of testing EXACT reward values to make sure the "unit delegation" isn't broken afterwards) ([#3233])
+- Fix a few clippy warnings in contract test code ([#3340])
+- Add --all-targets to clippy for contracts ([#3337])
+- A branch with all clippy warnings dealt with in contracts ([#3294])
+
+[#3233]: https://github.com/nymtech/nym/issues/3233
+[#3340]: https://github.com/nymtech/nym/pull/3340
+[#3337]: https://github.com/nymtech/nym/pull/3337
+[#3294]: https://github.com/nymtech/nym/pull/3294
+
 ## [v1.3.1] (2023-04-18)
 - Add a query to the vesting contract for the amount of delegated tokens towards a particular `mix_id` (might be needed by NG) ([#3228])
 

contracts/Cargo.lock

@@ -1068,7 +1068,7 @@ dependencies = [
 
 [[package]]
 name = "nym-mixnet-contract"
-version = "1.3.1"
+version = "1.4.0"
 dependencies = [
  "bs58",
  "cosmwasm-derive",
@@ -1092,7 +1092,7 @@ dependencies = [
 
 [[package]]
 name = "nym-mixnet-contract-common"
-version = "0.4.0"
+version = "0.5.0"
 dependencies = [
  "bs58",
  "cosmwasm-std",
@@ -1164,7 +1164,7 @@ dependencies = [
 
 [[package]]
 name = "nym-vesting-contract"
-version = "1.3.1"
+version = "1.4.0"
 dependencies = [
  "base64 0.21.0",
  "cosmwasm-crypto",
@@ -1187,7 +1187,7 @@ dependencies = [
 
 [[package]]
 name = "nym-vesting-contract-common"
-version = "0.5.0"
+version = "0.6.0"
 dependencies = [
  "cosmwasm-std",
  "nym-contracts-common",

contracts/mixnet/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-mixnet-contract"
-version = "1.3.1"
+version = "1.4.0"
 description = "Nym mixnet contract"
 edition = { workspace = true }
 authors = { workspace = true }
@@ -22,8 +22,8 @@ name = "mixnet_contract"
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-mixnet-contract-common = { path = "../../common/cosmwasm-smart-contracts/mixnet-contract", package = "nym-mixnet-contract-common", version = "0.4.0" }
-vesting-contract-common = { path = "../../common/cosmwasm-smart-contracts/vesting-contract", package = "nym-vesting-contract-common", version = "0.5.0" }
+mixnet-contract-common = { path = "../../common/cosmwasm-smart-contracts/mixnet-contract", package = "nym-mixnet-contract-common", version = "0.5.0" }
+vesting-contract-common = { path = "../../common/cosmwasm-smart-contracts/vesting-contract", package = "nym-vesting-contract-common", version = "0.6.0" }
 nym-contracts-common = { path = "../../common/cosmwasm-smart-contracts/contracts-common", version = "0.4.0" }
 
 cosmwasm-std = { workspace = true }

contracts/vesting/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-vesting-contract"
-version = "1.3.1"
+version = "1.4.0"
 description = "Nym vesting contract"
 edition = { workspace = true }
 authors = { workspace = true }
@@ -20,9 +20,9 @@ name = "vesting_contract"
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-mixnet-contract-common = { path = "../../common/cosmwasm-smart-contracts/mixnet-contract", package = "nym-mixnet-contract-common", version = "0.4.0" }
+mixnet-contract-common = { path = "../../common/cosmwasm-smart-contracts/mixnet-contract", package = "nym-mixnet-contract-common", version = "0.5.0" }
 contracts-common = { path = "../../common/cosmwasm-smart-contracts/contracts-common", package = "nym-contracts-common", version = "0.4.0" }
-vesting-contract-common = { path = "../../common/cosmwasm-smart-contracts/vesting-contract", package = "nym-vesting-contract-common", version = "0.5.0" }
+vesting-contract-common = { path = "../../common/cosmwasm-smart-contracts/vesting-contract", package = "nym-vesting-contract-common", version = "0.6.0" }
 
 cosmwasm-std = { workspace = true }
 cosmwasm-derive = { workspace = true }

documentation/dev-portal/book.toml

@@ -49,10 +49,10 @@ assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
 [preprocessor.variables.variables]
 # code prerequisites versions
 minimum_rust_version = "1.66"
-# minimum_node_version = ""
-# nym platform code most recent release
-platform_release_version = "v1.1.15"
-
+platform_release_version = "v1.1.16"
+upcoming_platform_release_version = "v1.1.17" # to use when adding 'edit on github' plugin
+mix_node_release_version = "v1.1.17"
+#
 [preprocessor.last-changed]
 command = "mdbook-last-changed"
 renderer = ["html"]

documentation/docs/book.toml

@@ -1,5 +1,5 @@
 [book]
-title = "Nym Docs v1.1.15"
+title = "Nym Docs v1.1.16"
 authors = ["Max Hampshire"]
 description = "Nym technical documentation"
 language = "en"
@@ -48,8 +48,9 @@ assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
 # https://gitlab.com/tglman/mdbook-variables/
 [preprocessor.variables.variables]
 minimum_rust_version = "1.66"
-platform_release_version = "v1.1.15"
-mix_node_release_version = "v1.1.16"
+platform_release_version = "v1.1.16"
+upcoming_platform_release_version = "v1.1.17" # to use in 'edit page on github' plugin (coming soon)
+mix_node_release_version = "v1.1.17"
 # used by the cmdrun preprocessor - relative path from inside src/<dir>
 # binaries_path = '../../../../target/release/'
 

documentation/docs/src/nodes/mix-node-setup.md

@@ -196,8 +196,6 @@ Follow these steps to update the information about your mix node which is public
 You can either do this graphically via the Desktop Wallet, or the CLI.
 
 #### Updating node information via the Desktop Wallet
-Node operators can update node information and change node settings such as the amount of self-bond (increase or decrease) via the desktop wallet.
-
 * Navigate to the `Bonding` page and click the `Node Settings` link in the top right corner:
 ![Bonding page](../images/wallet-screenshots/bonding.png)
 
@@ -357,6 +355,20 @@ username        soft nofile 4096
 
 Then reboot your server and restart your mixnode.
 
+## Node Description
+Node description is a short text that describes your node. It is displayed in the `nym-mixnode list` command and in the `nym-mixnode node-details` command. it also shows up in the node explorer to let people know what your node is about and link to your website.
+
+To set your node description, create a file called `description.toml` and put it in the same directory as your `config.toml` file. The file should look like this:
+
+```toml
+name = "Winston Smith"
+description = "I am the Sphinx"
+link = "https://nymtech.net"
+location = "Giza, Egypt"
+```
+
+you will need to restart your node for the changes to take effect.
+
 ## Node Families
 
 Node family involves setting up a group of mix nodes that work together to provide greater privacy and security for network communications. This is achieved by having the nodes in the family share information and routes, creating a decentralized network that makes it difficult for third parties to monitor or track communication traffic.

documentation/docs/src/sdk/rust.md

@@ -18,12 +18,14 @@ In the future the SDK will be made up of several components, each of which will
 
 | Component | Functionality                                                                         | Released |
 | --------- | ------------------------------------------------------------------------------------- | -------- |
-| Mixnet    | Create / load clients & keypairs, subscribe to Mixnet events, send & receive messages | ✔️       |
-| Coconut   | Create & verify Coconut credentials                                                   | ❌       |
+| Mixnet    | Create / load clients & keypairs, subscribe to Mixnet events, send & receive messages | ✔️        |
+| Coconut   | Create & verify Coconut credentials                                                   | 🛠️       |
 | Validator | Sign & broadcast Nyx blockchain transactions, query the blockchain                    | ❌       |
 
 The `mixnet` component currently exposes the logic of two clients: the websocket client, and the socks client.
 
+The `coconut` component is currently being worked on. Right now it exposes logic allowing for the creation of coconut credentials on the Sandbox testnet.
+
 ## Websocket client examples
 > All the codeblocks below can be found in the `nym-sdk` [examples directory](https://github.com/nymtech/nym/tree/release/{{platform_release_version}}/sdk/rust/nym-sdk/examples) in the monorepo.
 
@@ -83,11 +85,21 @@ If you aren't running a Validator and Nym API, and just want to import a specifi
 ```
 
 ## Socks client example
-
 There is also the option to embed the [`socks5-client`](../clients/socks5-client.md) into your app code (`examples/socks5.rs`):
 
 ```rust,noplayground
 {{#include ../../../../sdk/rust/nym-sdk/examples/socks5.rs}}
 ```
 
-> If you are looking at implementing Nym as a transport layer for a crypto wallet or desktop app, this is probably the best place to start.
+```admonish info
+If you are looking at implementing Nym as a transport layer for a crypto wallet or desktop app, this is probably the best place to start.
+```
+
+## Coconut credential generation
+The following code shows how you can use the SDK to create and use a [credential](../bandwidth-credentials.md) representing paid bandwidth on the Sandbox testnet.
+
+```rust,noplayground
+{{#include ../../../../sdk/rust/nym-sdk/examples/bandwidth.rs}}
+```
+
+You can read more about Coconut credentials (also referred to as `zk-Nym`) [here](../cococnut.md).

explorer-api/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "explorer-api"
-version = "1.1.15"
+version = "1.1.16"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

gateway/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "nym-gateway"
-version = "1.1.15"
+version = "1.1.16"
 authors = [
     "Dave Hrycyszyn <futurechimp@users.noreply.github.com>",
     "Jędrzej Stuczyński <andrew@nymtech.net>",

mixnode/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "nym-mixnode"
-version = "1.1.16"
+version = "1.1.17"
 authors = [
     "Dave Hrycyszyn <futurechimp@users.noreply.github.com>",
     "Jędrzej Stuczyński <andrew@nymtech.net>",

nym-api/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "nym-api"
-version = "1.1.16"
+version = "1.1.17"
 authors = [
     "Dave Hrycyszyn <futurechimp@users.noreply.github.com>",
     "Jędrzej Stuczyński <andrew@nymtech.net>",

nym-connect/desktop/Cargo.lock

@@ -3494,7 +3494,7 @@ dependencies = [
 
 [[package]]
 name = "nym-mixnet-contract-common"
-version = "0.4.0"
+version = "0.5.0"
 dependencies = [
  "bs58",
  "cosmwasm-std",
@@ -3841,7 +3841,7 @@ dependencies = [
 
 [[package]]
 name = "nym-vesting-contract"
-version = "1.3.1"
+version = "1.4.0"
 dependencies = [
  "cosmwasm-derive",
  "cosmwasm-std",
@@ -3859,7 +3859,7 @@ dependencies = [
 
 [[package]]
 name = "nym-vesting-contract-common"
-version = "0.5.0"
+version = "0.6.0"
 dependencies = [
  "cosmwasm-std",
  "nym-contracts-common",

nym-wallet/Cargo.lock

@@ -2916,7 +2916,7 @@ dependencies = [
 
 [[package]]
 name = "nym-mixnet-contract-common"
-version = "0.4.0"
+version = "0.5.0"
 dependencies = [
  "bs58",
  "cosmwasm-std",
@@ -3040,7 +3040,7 @@ dependencies = [
 
 [[package]]
 name = "nym-vesting-contract"
-version = "1.3.1"
+version = "1.4.0"
 dependencies = [
  "cosmwasm-derive",
  "cosmwasm-std",
@@ -3058,7 +3058,7 @@ dependencies = [
 
 [[package]]
 name = "nym-vesting-contract-common"
-version = "0.5.0"
+version = "0.6.0"
 dependencies = [
  "cosmwasm-std",
  "nym-contracts-common",

sdk/rust/nym-sdk/src/mixnet/client.rs

@@ -506,6 +506,7 @@ where
             .socks5_config
             .clone()
             .ok_or(Error::Socks5Config { set: false })?;
+        let debug_config = self.config.debug_config;
         let (mut started_client, nym_address) = self.connect_to_mixnet_common().await?;
         let (socks5_status_tx, mut socks5_status_rx) = mpsc::channel(128);
 
@@ -515,6 +516,7 @@ where
 
         nym_socks5_client_core::NymClient::start_socks5_listener(
             &socks5_config,
+            debug_config,
             client_input,
             client_output,
             client_state.clone(),

service-providers/network-requester/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "nym-network-requester"
-version = "1.1.15"
+version = "1.1.16"
 authors.workspace = true
 edition.workspace = true
 rust-version = "1.65"

service-providers/network-requester/src/core.rs

@@ -29,6 +29,7 @@ use nym_socks5_requests::{
 };
 use nym_sphinx::addressing::clients::Recipient;
 use nym_sphinx::anonymous_replies::requests::AnonymousSenderTag;
+use nym_sphinx::params::PacketSize;
 use nym_statistics_common::collector::StatisticsSender;
 use nym_task::connections::LaneQueueLengths;
 use nym_task::{TaskClient, TaskManager};
@@ -57,6 +58,8 @@ pub struct NRServiceProviderBuilder {
 }
 
 struct NRServiceProvider {
+    config: Config,
+
     outbound_request_filter: OutboundRequestFilter,
     open_proxy: bool,
     mixnet_client: nym_sdk::mixnet::MixnetClient,
@@ -242,6 +245,7 @@ impl NRServiceProviderBuilder {
         start_allowed_list_reloader(self.allowed_hosts, shutdown.subscribe()).await;
 
         let service_provider = NRServiceProvider {
+            config: self.config,
             outbound_request_filter: self.outbound_request_filter,
             open_proxy: self.open_proxy,
             mixnet_client,
@@ -329,6 +333,7 @@ impl NRServiceProvider {
         connection_id: ConnectionId,
         remote_addr: String,
         return_address: reply::MixnetAddress,
+        biggest_packet_size: PacketSize,
         controller_sender: ControllerSender,
         mix_input_sender: MixProxySender<MixnetMessage>,
         lane_queue_lengths: LaneQueueLengths,
@@ -385,6 +390,7 @@ impl NRServiceProvider {
         // run the proxy on the connection
         conn.run_proxy(
             remote_version,
+            biggest_packet_size,
             mix_receiver,
             mix_input_sender,
             lane_queue_lengths,
@@ -437,6 +443,11 @@ impl NRServiceProvider {
             return;
         }
 
+        let traffic_config = self.config.get_base().get_debug_config().traffic;
+        let packet_size = traffic_config
+            .secondary_packet_size
+            .unwrap_or(traffic_config.primary_packet_size);
+
         let controller_sender_clone = self.controller_sender.clone();
         let mix_input_sender_clone = self.mix_input_sender.clone();
         let lane_queue_lengths_clone = self.mixnet_client.shared_lane_queue_lengths();
@@ -449,6 +460,7 @@ impl NRServiceProvider {
                 conn_id,
                 remote_addr,
                 return_address,
+                packet_size,
                 controller_sender_clone,
                 mix_input_sender_clone,
                 lane_queue_lengths_clone,

service-providers/network-requester/src/socks5/tcp.rs

@@ -7,6 +7,7 @@ use nym_service_providers_common::interface::RequestVersion;
 use nym_socks5_proxy_helpers::connection_controller::ConnectionReceiver;
 use nym_socks5_proxy_helpers::proxy_runner::{MixProxySender, ProxyRunner};
 use nym_socks5_requests::{ConnectionId, RemoteAddress, Socks5Request};
+use nym_sphinx::params::PacketSize;
 use nym_task::connections::LaneQueueLengths;
 use nym_task::TaskClient;
 use std::io;
@@ -42,6 +43,7 @@ impl Connection {
     pub(crate) async fn run_proxy(
         &mut self,
         remote_version: RequestVersion<Socks5Request>,
+        biggest_packet_size: PacketSize,
         mix_receiver: ConnectionReceiver,
         mix_sender: MixProxySender<MixnetMessage>,
         lane_queue_lengths: LaneQueueLengths,
@@ -57,6 +59,9 @@ impl Connection {
             remote_source_address,
             mix_receiver,
             mix_sender,
+            // FIXME: this does NOT include overhead due to acks or chunking
+            // (so actual true plaintext is smaller)
+            biggest_packet_size.plaintext_size(),
             connection_id,
             Some(lane_queue_lengths),
             shutdown,

service-providers/network-statistics/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-network-statistics"
-version = "1.1.15"
+version = "1.1.16"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

tools/nym-cli/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nym-cli"
-version = "1.1.15"
+version = "1.1.16"
 authors.workspace = true
 edition = "2021"