updated module path

Cargo.toml

@@ -160,8 +160,7 @@ license = "Apache-2.0"
 [workspace.dependencies]
 anyhow = "1.0.71"
 async-trait = "0.1.68"
-axum = "0.7.5"
-axum-extra = "0.9.3"
+axum = "0.6.20"
 base64 = "0.21.4"
 bs58 = "0.5.0"
 bip39 = { version = "2.0.0", features = ["zeroize"] }
@@ -172,16 +171,15 @@ dotenvy = "0.15.6"
 futures = "0.3.28"
 generic-array = "0.14.7"
 getrandom = "0.2.10"
-headers = "0.4.0"
 humantime-serde = "1.1.1"
-hyper = "1.3.1"
+hyper = "0.14.27"
 k256 = "0.13"
 lazy_static = "1.4.0"
 log = "0.4"
 once_cell = "1.7.2"
 parking_lot = "0.12.1"
 rand = "0.8.5"
-reqwest = { version = "0.12.4", default-features = false }
+reqwest = { version = "0.11.22", default-features = false }
 schemars = "0.8.1"
 serde = "1.0.152"
 serde_json = "1.0.91"
@@ -195,8 +193,8 @@ tokio-tungstenite = { version = "0.20.1" }
 tracing = "0.1.37"
 tungstenite = { version = "0.20.1", default-features = false }
 ts-rs = "7.0.0"
-utoipa = "4.2.0"
-utoipa-swagger-ui = "6.0.0"
+utoipa = "3.5.0"
+utoipa-swagger-ui = "3.1.5"
 url = "2.4"
 zeroize = "1.6.0"
 

common/client-core/Cargo.toml

@@ -3,7 +3,7 @@ name = "nym-client-core"
 version = "1.1.15"
 authors = ["Dave Hrycyszyn <futurechimp@users.noreply.github.com>"]
 edition = "2021"
-rust-version = "1.70"
+rust-version = "1.66"
 license.workspace = true
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
@@ -25,6 +25,7 @@ si-scale = "0.2.2"
 tap = "1.0.1"
 thiserror = { workspace = true }
 url = { workspace = true, features = ["serde"] }
+tungstenite = { workspace = true, default-features = false }
 tokio = { workspace = true, features = ["macros"] }
 time = { workspace = true }
 zeroize = { workspace = true }
@@ -47,7 +48,7 @@ nym-validator-client = { path = "../client-libs/validator-client", default-featu
 nym-task = { path = "../task" }
 nym-credential-storage = { path = "../credential-storage" }
 nym-network-defaults = { path = "../network-defaults" }
-nym-client-core-config-types = { path = "./config-types", features = ["disk-persistence"] }
+nym-client-core-config-types = { path = "./config-types", features = ["disk-persistence"]}
 nym-client-core-surb-storage = { path = "./surb-storage" }
 nym-client-core-gateways-storage = { path = "./gateways-storage" }
 
@@ -73,17 +74,8 @@ workspace = true
 features = ["time"]
 
 [target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio-tungstenite]
-workspace = true
-features = ["rustls-tls-webpki-roots"]
-
-[target."cfg(not(target_arch = \"wasm32\"))".dependencies.tungstenite]
-workspace = true
-default-features = true
-features = ["rustls-tls-webpki-roots"]
-
-[target."cfg(target_arch = \"wasm32\")".dependencies.tungstenite]
-workspace = true
-default-features = false
+version = "0.20.1"
+features = ["rustls-tls-native-roots"]
 
 [target."cfg(target_arch = \"wasm32\")".dependencies.wasm-bindgen-futures]
 workspace = true

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

@@ -39,7 +39,7 @@ use log::{debug, error, info, warn};
 use nym_bandwidth_controller::BandwidthController;
 use nym_client_core_gateways_storage::{GatewayDetails, GatewaysDetailsStore};
 use nym_credential_storage::storage::Storage as CredentialStorage;
-use nym_crypto::asymmetric::{encryption, identity};
+use nym_crypto::asymmetric::encryption;
 use nym_gateway_client::{
     AcknowledgementReceiver, GatewayClient, GatewayConfig, MixnetMessageReceiver, PacketRouter,
 };
@@ -670,7 +670,6 @@ where
         let self_address = Self::mix_address(&init_res);
         let ack_key = init_res.client_keys.ack_key();
         let encryption_keys = init_res.client_keys.encryption_keypair();
-        let identity_keys = init_res.client_keys.identity_keypair();
 
         // the components are started in very specific order. Unless you know what you are doing,
         // do not change that.
@@ -793,7 +792,6 @@ where
 
         Ok(BaseClient {
             address: self_address,
-            identity_keys,
             client_input: ClientInputStatus::AwaitingProducer {
                 client_input: ClientInput {
                     connection_command_sender: client_connection_tx,
@@ -818,7 +816,6 @@ where
 
 pub struct BaseClient {
     pub address: Recipient,
-    pub identity_keys: Arc<identity::KeyPair>,
     pub client_input: ClientInputStatus,
     pub client_output: ClientOutputStatus,
     pub client_state: ClientState,

common/client-libs/gateway-client/Cargo.toml

@@ -48,7 +48,10 @@ features = ["net", "sync", "time"]
 
 [target."cfg(not(target_arch = \"wasm32\"))".dependencies.tokio-tungstenite]
 workspace = true
-features = ["rustls-tls-webpki-roots"]
+# the choice of this particular tls feature was arbitrary;
+# if you reckon a different one would be more appropriate, feel free to change it
+# features = ["native-tls"]
+features = ["rustls-tls-native-roots"]
 
 # wasm-only dependencies
 [target."cfg(target_arch = \"wasm32\")".dependencies.wasm-bindgen]

common/client-libs/validator-client/Cargo.toml

@@ -24,6 +24,7 @@ nym-group-contract-common = { path = "../../cosmwasm-smart-contracts/group-contr
 nym-service-provider-directory-common = { path = "../../cosmwasm-smart-contracts/service-provider-directory" }
 serde = { workspace = true, features = ["derive"] }
 serde_json = { workspace = true }
+reqwest = { workspace = true, features = ["json"] }
 nym-http-api-client = { path = "../../../common/http-api-client"}
 thiserror = { workspace = true }
 log = { workspace = true }
@@ -66,14 +67,6 @@ cosmwasm-std = { workspace = true }
 workspace = true
 features = ["tokio"]
 
-[target."cfg(target_arch = \"wasm32\")".dependencies.reqwest]
-workspace = true
-features = ["json"]
-
-[target."cfg(not(target_arch = \"wasm32\"))".dependencies.reqwest]
-workspace = true
-features = ["json", "rustls-tls"]
-
 [dev-dependencies]
 bip39 = { workspace = true }
 cosmrs = { workspace = true, features = ["bip32"] }

common/commands/src/validator/mixnet/delegators/delegate_to_multiple_mixnodes.rs

@@ -157,7 +157,7 @@ async fn fetch_delegation_data(
             // If a pending undelegate tx is found, remove it from delegation map
             Undelegate { owner, mix_id, .. } => {
                 if owner == address.as_ref()
-                    && existing_delegation_map.contains_key(&mix_id.to_string())
+                    && existing_delegation_map.get(&mix_id.to_string()).is_some()
                 {
                     existing_delegation_map.remove(&mix_id.to_string());
                 }

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

@@ -328,8 +328,4 @@ impl EpochState {
     pub fn is_dealing_exchange(&self) -> bool {
         matches!(self, EpochState::DealingExchange { .. })
     }
-
-    pub fn is_waiting_initialisation(&self) -> bool {
-        matches!(self, EpochState::WaitingInitialisation)
-    }
 }

common/credential-storage/src/error.rs

@@ -18,7 +18,4 @@ pub enum StorageError {
 
     #[error("No unused credential in database. You need to buy at least one")]
     NoCredential,
-
-    #[error("Database unique constraint violation. Is the credential already imported?")]
-    ConstraintUnique,
 }

common/credential-storage/src/persistent_storage.rs

@@ -69,21 +69,9 @@ impl Storage for PersistentStorage {
                 bandwidth_credential.credential_data,
                 bandwidth_credential.epoch_id,
             )
-            .await
-            .map_err(|err| {
-                // There is one error we want to handle specifically.
-                // Check if database_error is `SqliteError` with code 2067 which
-                // means UNIQUE constraint violation
-                if let Some(db_error) = err.as_database_error() {
-                    if db_error.code().map_or(false, |code| code == "2067") {
-                        StorageError::ConstraintUnique
-                    } else {
-                        err.into()
-                    }
-                } else {
-                    err.into()
-                }
-            })
+            .await?;
+
+        Ok(())
     }
 
     async fn get_next_unspent_credential(

common/credentials-interface/src/lib.rs

@@ -8,11 +8,11 @@ use std::str::FromStr;
 use thiserror::Error;
 
 pub use nym_coconut::{
-    aggregate_signature_shares, aggregate_signature_shares_and_verify, aggregate_verification_keys,
-    blind_sign, hash_to_scalar, keygen, prepare_blind_sign, prove_bandwidth_credential,
-    verify_credential, Attribute, Base58, BlindSignRequest, BlindedSerialNumber, BlindedSignature,
-    Bytable, CoconutError, KeyPair, Parameters, PrivateAttribute, PublicAttribute, SecretKey,
-    Signature, SignatureShare, VerificationKey, VerifyCredentialRequest,
+    aggregate_signature_shares, aggregate_verification_keys, blind_sign, hash_to_scalar, keygen,
+    prepare_blind_sign, prove_bandwidth_credential, verify_credential, Attribute, Base58,
+    BlindSignRequest, BlindedSerialNumber, BlindedSignature, Bytable, CoconutError, KeyPair,
+    Parameters, PrivateAttribute, PublicAttribute, SecretKey, Signature, SignatureShare,
+    VerificationKey, VerifyCredentialRequest,
 };
 
 pub const VOUCHER_INFO_TYPE: &str = "BandwidthVoucher";

common/credentials/src/coconut/bandwidth/freepass.rs

@@ -12,8 +12,7 @@ use serde::{Deserialize, Serialize};
 use time::{Duration, OffsetDateTime, Time};
 use zeroize::{Zeroize, ZeroizeOnDrop};
 
-pub const DEFAULT_FREE_PASS_VALIDITY: Duration = Duration::WEEK; // 1 week
-pub const MAX_FREE_PASS_VALIDITY: Duration = Duration::weeks(12); // 12 weeks
+pub const MAX_FREE_PASS_VALIDITY: Duration = Duration::WEEK; // 1 week
 
 #[derive(Debug, Zeroize, ZeroizeOnDrop, Serialize, Deserialize)]
 pub struct FreePassIssuedData {
@@ -78,9 +77,9 @@ impl FreePassIssuanceData {
     }
 
     pub fn default_expiry_date() -> OffsetDateTime {
-        // set it to the furthest midnight in the future such as it's no more than a week away,
+        // set it to furthest midnight in the future such as it's no more than a week away,
         // i.e. if it's currently for example 9:43 on 2nd March 2024, it will set it to 0:00 on 9th March 2024
-        (OffsetDateTime::now_utc() + DEFAULT_FREE_PASS_VALIDITY).replace_time(Time::MIDNIGHT)
+        (OffsetDateTime::now_utc() + MAX_FREE_PASS_VALIDITY).replace_time(Time::MIDNIGHT)
     }
 
     pub fn expiry_date_attribute(&self) -> &Attribute {

common/credentials/src/coconut/bandwidth/issuance.rs

@@ -10,19 +10,18 @@ use crate::coconut::bandwidth::{
 use crate::coconut::utils::scalar_serde_helper;
 use crate::error::Error;
 use nym_credentials_interface::{
-    aggregate_signature_shares, aggregate_signature_shares_and_verify, hash_to_scalar,
-    prepare_blind_sign, Attribute, BlindedSerialNumber, BlindedSignature, Parameters,
-    PrivateAttribute, PublicAttribute, Signature, SignatureShare, VerificationKey,
+    aggregate_signature_shares, hash_to_scalar, prepare_blind_sign, Attribute, BlindedSerialNumber,
+    BlindedSignature, Parameters, PrivateAttribute, PublicAttribute, Signature, SignatureShare,
+    VerificationKey,
 };
 use nym_crypto::asymmetric::{encryption, identity};
 use nym_validator_client::nym_api::EpochId;
+use nym_validator_client::nyxd::{Coin, Hash};
 use nym_validator_client::signing::AccountData;
 use serde::{Deserialize, Serialize};
 use time::OffsetDateTime;
 use zeroize::{Zeroize, ZeroizeOnDrop};
 
-pub use nym_validator_client::nyxd::{Coin, Hash};
-
 #[derive(Zeroize, ZeroizeOnDrop, Serialize, Deserialize)]
 pub enum BandwidthCredentialIssuanceDataVariant {
     Voucher(BandwidthVoucherIssuanceData),
@@ -266,13 +265,6 @@ impl IssuanceBandwidthCredential {
         self.unblind_signature(validator_vk, &signing_data, blinded_signature)
     }
 
-    pub fn unchecked_aggregate_signature_shares(
-        &self,
-        shares: &[SignatureShare],
-    ) -> Result<Signature, Error> {
-        aggregate_signature_shares(shares).map_err(Error::SignatureAggregationError)
-    }
-
     pub fn aggregate_signature_shares(
         &self,
         verification_key: &VerificationKey,
@@ -287,7 +279,7 @@ impl IssuanceBandwidthCredential {
         attributes.extend_from_slice(&private_attributes);
         attributes.extend_from_slice(&public_attributes);
 
-        aggregate_signature_shares_and_verify(params, verification_key, &attributes, shares)
+        aggregate_signature_shares(params, verification_key, &attributes, shares)
             .map_err(Error::SignatureAggregationError)
     }
 

common/credentials/src/coconut/bandwidth/voucher.rs

@@ -6,7 +6,7 @@ use crate::coconut::utils::scalar_serde_helper;
 use crate::error::Error;
 use nym_api_requests::coconut::BlindSignRequestBody;
 use nym_credentials_interface::{
-    hash_to_scalar, Attribute, BlindSignRequest, BlindedSignature, CredentialType, PublicAttribute,
+    hash_to_scalar, Attribute, BlindSignRequest, BlindedSignature, PublicAttribute,
 };
 use nym_crypto::asymmetric::{encryption, identity};
 use nym_validator_client::nyxd::{Coin, Hash};
@@ -123,10 +123,6 @@ impl BandwidthVoucherIssuanceData {
         &self.value_prehashed
     }
 
-    pub fn typ() -> CredentialType {
-        CredentialType::Voucher
-    }
-
     pub fn tx_hash(&self) -> Hash {
         self.deposit_tx_hash
     }

common/network-defaults/src/mainnet.rs

@@ -18,12 +18,9 @@ pub const VESTING_CONTRACT_ADDRESS: &str =
     "n1nc5tatafv6eyq7llkr2gv50ff9e22mnf70qgjlv737ktmt4eswrq73f2nw";
 
 pub const COCONUT_BANDWIDTH_CONTRACT_ADDRESS: &str = "";
-pub const GROUP_CONTRACT_ADDRESS: &str =
-    "n1e2zq4886zzewpvpucmlw8v9p7zv692f6yck4zjzxh699dkcmlrfqk2knsr";
-pub const MULTISIG_CONTRACT_ADDRESS: &str =
-    "n1txayqfz5g9qww3rlflpg025xd26m9payz96u54x4fe3s2ktz39xqk67gzx";
-pub const COCONUT_DKG_CONTRACT_ADDRESS: &str =
-    "n19604yflqggs9mk2z26mqygq43q2kr3n932egxx630svywd5mpxjsztfpvx";
+pub const GROUP_CONTRACT_ADDRESS: &str = "";
+pub const MULTISIG_CONTRACT_ADDRESS: &str = "";
+pub const COCONUT_DKG_CONTRACT_ADDRESS: &str = "";
 pub const EPHEMERA_CONTRACT_ADDRESS: &str = "";
 
 pub const REWARDING_VALIDATOR_ADDRESS: &str = "n10yyd98e2tuwu0f7ypz9dy3hhjw7v772q6287gy";

common/nymcoconut/benches/benchmarks.rs

@@ -6,10 +6,10 @@ use criterion::{criterion_group, criterion_main, Criterion};
 use ff::Field;
 use group::{Curve, Group};
 use nym_coconut::{
-    aggregate_signature_shares_and_verify, aggregate_verification_keys, blind_sign,
-    prepare_blind_sign, prove_bandwidth_credential, random_scalars_refs, setup, ttp_keygen,
-    verify_credential, verify_partial_blind_signature, Attribute, BlindedSignature, Parameters,
-    Signature, SignatureShare, VerificationKey,
+    aggregate_signature_shares, aggregate_verification_keys, blind_sign, prepare_blind_sign,
+    prove_bandwidth_credential, random_scalars_refs, setup, ttp_keygen, verify_credential,
+    verify_partial_blind_signature, Attribute, BlindedSignature, Parameters, Signature,
+    SignatureShare, VerificationKey,
 };
 use rand::seq::SliceRandom;
 use std::ops::Neg;
@@ -99,7 +99,7 @@ fn unblind_and_aggregate(
     let mut attributes = vec![];
     attributes.extend_from_slice(private_attributes);
     attributes.extend_from_slice(public_attributes);
-    aggregate_signature_shares_and_verify(
+    aggregate_signature_shares(
         params,
         verification_key,
         &attributes,

common/nymcoconut/src/lib.rs

@@ -4,18 +4,14 @@
 #![warn(clippy::expect_used)]
 #![warn(clippy::unwrap_used)]
 
-pub use bls12_381::Scalar;
 pub use elgamal::elgamal_keygen;
 pub use elgamal::ElGamalKeyPair;
 pub use elgamal::PublicKey;
 pub use error::CoconutError;
-pub use scheme::aggregation::aggregate_key_shares;
 pub use scheme::aggregation::aggregate_signature_shares;
-pub use scheme::aggregation::aggregate_signature_shares_and_verify;
 pub use scheme::aggregation::aggregate_verification_keys;
 pub use scheme::issuance::blind_sign;
 pub use scheme::issuance::prepare_blind_sign;
-pub use scheme::issuance::sign;
 pub use scheme::issuance::verify_partial_blind_signature;
 pub use scheme::issuance::BlindSignRequest;
 pub use scheme::keygen::keygen;
@@ -23,19 +19,16 @@ pub use scheme::keygen::ttp_keygen;
 pub use scheme::keygen::KeyPair;
 pub use scheme::keygen::SecretKey;
 pub use scheme::keygen::VerificationKey;
-pub use scheme::keygen::VerificationKeyShare;
 pub use scheme::setup::setup;
 pub use scheme::setup::Parameters;
 pub use scheme::verification::check_vk_pairing;
 pub use scheme::verification::prove_bandwidth_credential;
-pub use scheme::verification::verify;
 pub use scheme::verification::verify_credential;
 pub use scheme::verification::BlindedSerialNumber;
 pub use scheme::verification::VerifyCredentialRequest;
 pub use scheme::BlindedSignature;
 pub use scheme::Signature;
 pub use scheme::SignatureShare;
-pub use scheme::SignerIndex;
 pub use traits::Base58;
 pub use traits::Bytable;
 pub use utils::hash_to_scalar;

common/nymcoconut/src/scheme/aggregation.rs

@@ -12,7 +12,7 @@ use crate::error::{CoconutError, Result};
 use crate::scheme::verification::check_bilinear_pairing;
 use crate::scheme::{PartialSignature, Signature, SignatureShare, SignerIndex, VerificationKey};
 use crate::utils::perform_lagrangian_interpolation_at_origin;
-use crate::{Attribute, Parameters, VerificationKeyShare};
+use crate::{Attribute, Parameters};
 
 pub(crate) trait Aggregatable: Sized {
     fn aggregate(aggregatable: &[Self], indices: Option<&[SignerIndex]>) -> Result<Self>;
@@ -80,23 +80,7 @@ pub fn aggregate_verification_keys(
     Aggregatable::aggregate(keys, indices)
 }
 
-pub fn aggregate_key_shares(shares: &[VerificationKeyShare]) -> Result<VerificationKey> {
-    let (keys, indices): (Vec<_>, Vec<_>) = shares
-        .iter()
-        .map(|share| (share.key.clone(), share.index))
-        .unzip();
-
-    aggregate_verification_keys(&keys, Some(&indices))
-}
-
 pub fn aggregate_signatures(
-    signatures: &[PartialSignature],
-    indices: Option<&[SignerIndex]>,
-) -> Result<Signature> {
-    Aggregatable::aggregate(signatures, indices)
-}
-
-pub fn aggregate_signatures_and_verify(
     params: &Parameters,
     verification_key: &VerificationKey,
     attributes: &[&Attribute],
@@ -104,7 +88,11 @@ pub fn aggregate_signatures_and_verify(
     indices: Option<&[SignerIndex]>,
 ) -> Result<Signature> {
     // aggregate the signature
-    let signature = aggregate_signatures(signatures, indices)?;
+
+    let signature = match Aggregatable::aggregate(signatures, indices) {
+        Ok(res) => res,
+        Err(err) => return Err(err),
+    };
 
     // Verify the signature
     let alpha = verification_key.alpha;
@@ -128,16 +116,7 @@ pub fn aggregate_signatures_and_verify(
     Ok(signature)
 }
 
-pub fn aggregate_signature_shares(shares: &[SignatureShare]) -> Result<Signature> {
-    let (signatures, indices): (Vec<_>, Vec<_>) = shares
-        .iter()
-        .map(|share| (*share.signature(), share.index()))
-        .unzip();
-
-    aggregate_signatures(&signatures, Some(&indices))
-}
-
-pub fn aggregate_signature_shares_and_verify(
+pub fn aggregate_signature_shares(
     params: &Parameters,
     verification_key: &VerificationKey,
     attributes: &[&Attribute],
@@ -148,7 +127,7 @@ pub fn aggregate_signature_shares_and_verify(
         .map(|share| (*share.signature(), share.index()))
         .unzip();
 
-    aggregate_signatures_and_verify(
+    aggregate_signatures(
         params,
         verification_key,
         attributes,
@@ -231,7 +210,7 @@ mod tests {
 
     #[test]
     fn signature_aggregation_works_for_any_subset_of_signatures() {
-        let params = Parameters::new(2).unwrap();
+        let mut params = Parameters::new(2).unwrap();
         random_scalars_refs!(attributes, params, 2);
 
         let keypairs = ttp_keygen(&params, 3, 5).unwrap();
@@ -248,12 +227,12 @@ mod tests {
 
         let sigs = sks
             .iter()
-            .map(|sk| sign(&params, sk, &attributes).unwrap())
+            .map(|sk| sign(&mut params, sk, &attributes).unwrap())
             .collect::<Vec<_>>();
 
         // aggregating (any) threshold works
         let aggr_vk_1 = aggregate_verification_keys(&vks[..3], Some(&[1, 2, 3])).unwrap();
-        let aggr_sig1 = aggregate_signatures_and_verify(
+        let aggr_sig1 = aggregate_signatures(
             &params,
             &aggr_vk_1,
             &attributes,
@@ -263,7 +242,7 @@ mod tests {
         .unwrap();
 
         let aggr_vk_2 = aggregate_verification_keys(&vks[2..], Some(&[3, 4, 5])).unwrap();
-        let aggr_sig2 = aggregate_signatures_and_verify(
+        let aggr_sig2 = aggregate_signatures(
             &params,
             &aggr_vk_1,
             &attributes,
@@ -279,7 +258,7 @@ mod tests {
 
         // aggregating threshold+1 works
         let aggr_vk_more = aggregate_verification_keys(&vks[1..], Some(&[2, 3, 4, 5])).unwrap();
-        let aggr_more = aggregate_signatures_and_verify(
+        let aggr_more = aggregate_signatures(
             &params,
             &aggr_vk_more,
             &attributes,
@@ -291,7 +270,7 @@ mod tests {
 
         // aggregating all
         let aggr_vk_all = aggregate_verification_keys(&vks, Some(&[1, 2, 3, 4, 5])).unwrap();
-        let aggr_all = aggregate_signatures_and_verify(
+        let aggr_all = aggregate_signatures(
             &params,
             &aggr_vk_all,
             &attributes,
@@ -303,7 +282,7 @@ mod tests {
 
         // not taking enough points (threshold was 3) should fail
         let aggr_vk_not_enough = aggregate_verification_keys(&vks[..2], Some(&[1, 2])).unwrap();
-        let aggr_not_enough = aggregate_signatures_and_verify(
+        let aggr_not_enough = aggregate_signatures(
             &params,
             &aggr_vk_not_enough,
             &attributes,
@@ -315,7 +294,7 @@ mod tests {
 
         // taking wrong index should fail
         let aggr_vk_bad = aggregate_verification_keys(&vks[2..], Some(&[1, 2, 3])).unwrap();
-        assert!(aggregate_signatures_and_verify(
+        assert!(aggregate_signatures(
             &params,
             &aggr_vk_bad,
             &attributes,
@@ -351,14 +330,9 @@ mod tests {
             .unzip();
 
         let aggr_vk_all = aggregate_verification_keys(&vks, None).unwrap();
-        assert!(aggregate_signatures_and_verify(
-            &params,
-            &aggr_vk_all,
-            &attributes,
-            &signatures,
-            None
-        )
-        .is_err());
+        assert!(
+            aggregate_signatures(&params, &aggr_vk_all, &attributes, &signatures, None).is_err()
+        );
     }
 
     #[test]
@@ -378,15 +352,11 @@ mod tests {
             .unzip();
         let aggr_vk_all = aggregate_verification_keys(&vks, None).unwrap();
 
-        assert!(aggregate_signatures_and_verify(
-            &params,
-            &aggr_vk_all,
-            &attributes,
-            &signatures,
-            Some(&[])
-        )
-        .is_err());
-        assert!(aggregate_signatures_and_verify(
+        assert!(
+            aggregate_signatures(&params, &aggr_vk_all, &attributes, &signatures, Some(&[]))
+                .is_err()
+        );
+        assert!(aggregate_signatures(
             &params,
             &aggr_vk_all,
             &attributes,
@@ -413,7 +383,7 @@ mod tests {
             .unzip();
         let aggr_vk_all = aggregate_verification_keys(&vks, None).unwrap();
 
-        assert!(aggregate_signatures_and_verify(
+        assert!(aggregate_signatures(
             &params,
             &aggr_vk_all,
             &attributes,

common/nymcoconut/src/scheme/issuance.rs

@@ -13,8 +13,9 @@ use crate::scheme::setup::Parameters;
 use crate::scheme::BlindedSignature;
 use crate::scheme::SecretKey;
 use crate::Attribute;
+/// Creates a Coconut Signature under a given secret key on a set of public attributes only.
+#[cfg(test)]
 use crate::Signature;
-
 // TODO: possibly completely remove those two functions.
 // They only exist to have a simpler and smaller code snippets to test
 // basic functionalities.
@@ -157,10 +158,6 @@ impl BlindSignRequest {
         )
     }
 
-    pub fn verify_commitment_hash(&self, public_attributes: &[&Attribute]) -> bool {
-        self.commitment_hash == compute_hash(self.commitment, public_attributes)
-    }
-
     pub fn get_commitment_hash(&self) -> G1Projective {
         self.commitment_hash
     }
@@ -429,9 +426,9 @@ pub fn verify_partial_blind_signature(
         .into()
 }
 
-/// Creates a Coconut Signature under a given secret key on a set of public attributes only.
+#[cfg(test)]
 pub fn sign(
-    params: &Parameters,
+    params: &mut Parameters,
     secret_key: &SecretKey,
     public_attributes: &[&Attribute],
 ) -> Result<Signature> {

common/nymcoconut/src/scheme/keygen.rs

@@ -151,6 +151,10 @@ impl Base58 for SecretKey {}
 // TODO: perhaps change points to affine representation
 // to make verification slightly more efficient?
 #[derive(Debug, PartialEq, Eq, Clone)]
+#[cfg_attr(
+    feature = "key-zeroize",
+    derive(zeroize::Zeroize, zeroize::ZeroizeOnDrop)
+)]
 pub struct VerificationKey {
     // TODO add gen2 as per the paper or imply it from the fact library is using bls381?
     pub(crate) alpha: G2Projective,
@@ -407,23 +411,12 @@ impl Bytable for VerificationKey {
 
 impl Base58 for VerificationKey {}
 
-#[derive(Debug, Clone)]
-pub struct VerificationKeyShare {
-    pub key: VerificationKey,
-    pub index: SignerIndex,
-}
-
-impl From<(VerificationKey, SignerIndex)> for VerificationKeyShare {
-    fn from(value: (VerificationKey, SignerIndex)) -> Self {
-        VerificationKeyShare {
-            key: value.0,
-            index: value.1,
-        }
-    }
-}
-
 #[derive(Debug, Serialize, Deserialize)]
 #[cfg_attr(test, derive(PartialEq, Eq, Clone))]
+#[cfg_attr(
+    feature = "key-zeroize",
+    derive(zeroize::Zeroize, zeroize::ZeroizeOnDrop)
+)]
 pub struct KeyPair {
     secret_key: SecretKey,
     verification_key: VerificationKey,
@@ -432,12 +425,6 @@ pub struct KeyPair {
     pub index: Option<SignerIndex>,
 }
 
-impl From<KeyPair> for (SecretKey, VerificationKey) {
-    fn from(value: KeyPair) -> Self {
-        (value.secret_key, value.verification_key)
-    }
-}
-
 impl PemStorableKeyPair for KeyPair {
     type PrivatePemKey = SecretKey;
     type PublicPemKey = VerificationKey;
@@ -474,13 +461,6 @@ impl KeyPair {
         &self.verification_key
     }
 
-    pub fn to_verification_key_share(&self) -> Option<VerificationKeyShare> {
-        self.index.map(|index| VerificationKeyShare {
-            key: self.verification_key.clone(),
-            index,
-        })
-    }
-
     pub fn to_bytes(&self) -> Vec<u8> {
         // Schema is coconutkeypair[14]|secret_key_len[8]|secret_key[secret_key_len]|verification_key_len[8]|verification_key[verification_key_len]|signer_index[8] - optional
         self.to_byte_vec()

common/nymcoconut/src/scheme/mod.rs

@@ -70,11 +70,6 @@ impl Signature {
         &self.1
     }
 
-    pub fn randomise_simple(&self, params: &Parameters) -> Signature {
-        let r = params.random_scalar();
-        Signature(self.0 * r, self.1 * r)
-    }
-
     pub fn randomise(&self, params: &Parameters) -> (Signature, Scalar) {
         let r = params.random_scalar();
         let r_prime = params.random_scalar();
@@ -196,7 +191,7 @@ impl BlindedSignature {
         &self,
         partial_verification_key: &VerificationKey,
         pedersen_commitments_openings: &[Scalar],
-    ) -> Signature {
+    ) -> Result<Signature> {
         // parse the signature
         let h = &self.0;
         let c = &self.1;
@@ -209,7 +204,7 @@ impl BlindedSignature {
 
         let unblinded_c = c - blinding_removers;
 
-        Signature(*h, unblinded_c)
+        Ok(Signature(*h, unblinded_c))
     }
 
     pub fn unblind_and_verify(
@@ -221,7 +216,7 @@ impl BlindedSignature {
         commitment_hash: &G1Projective,
         pedersen_commitments_openings: &[Scalar],
     ) -> Result<Signature> {
-        let unblinded = self.unblind(partial_verification_key, pedersen_commitments_openings);
+        let unblinded = self.unblind(partial_verification_key, pedersen_commitments_openings)?;
         unblinded.verify(
             params,
             partial_verification_key,
@@ -245,7 +240,6 @@ impl BlindedSignature {
 }
 
 // perhaps this should take signature by reference? we'll see how it goes
-#[derive(Clone, Copy)]
 pub struct SignatureShare {
     signature: Signature,
     index: SignerIndex,
@@ -282,9 +276,7 @@ impl SignatureShare {
 mod tests {
     use super::*;
     use crate::hash_to_scalar;
-    use crate::scheme::aggregation::{
-        aggregate_signatures_and_verify, aggregate_verification_keys,
-    };
+    use crate::scheme::aggregation::{aggregate_signatures, aggregate_verification_keys};
     use crate::scheme::issuance::{blind_sign, compute_hash, prepare_blind_sign, sign};
     use crate::scheme::keygen::{keygen, ttp_keygen};
     use crate::scheme::verification::{prove_bandwidth_credential, verify, verify_credential};
@@ -426,13 +418,13 @@ mod tests {
 
     #[test]
     fn verification_on_two_public_attributes() {
-        let params = Parameters::new(2).unwrap();
+        let mut params = Parameters::new(2).unwrap();
         random_scalars_refs!(attributes, params, 2);
 
         let keypair1 = keygen(&params);
         let keypair2 = keygen(&params);
-        let sig1 = sign(&params, keypair1.secret_key(), &attributes).unwrap();
-        let sig2 = sign(&params, keypair2.secret_key(), &attributes).unwrap();
+        let sig1 = sign(&mut params, keypair1.secret_key(), &attributes).unwrap();
+        let sig2 = sign(&mut params, keypair2.secret_key(), &attributes).unwrap();
 
         assert!(verify(
             &params,
@@ -576,14 +568,9 @@ mod tests {
         attributes.extend_from_slice(&public_attributes);
 
         let aggr_vk = aggregate_verification_keys(&vks[..2], Some(&[1, 2])).unwrap();
-        let aggr_sig = aggregate_signatures_and_verify(
-            &params,
-            &aggr_vk,
-            &attributes,
-            &sigs[..2],
-            Some(&[1, 2]),
-        )
-        .unwrap();
+        let aggr_sig =
+            aggregate_signatures(&params, &aggr_vk, &attributes, &sigs[..2], Some(&[1, 2]))
+                .unwrap();
 
         let theta = prove_bandwidth_credential(
             &params,
@@ -603,14 +590,9 @@ mod tests {
 
         // taking different subset of keys and credentials
         let aggr_vk = aggregate_verification_keys(&vks[1..], Some(&[2, 3])).unwrap();
-        let aggr_sig = aggregate_signatures_and_verify(
-            &params,
-            &aggr_vk,
-            &attributes,
-            &sigs[1..],
-            Some(&[2, 3]),
-        )
-        .unwrap();
+        let aggr_sig =
+            aggregate_signatures(&params, &aggr_vk, &attributes, &sigs[1..], Some(&[2, 3]))
+                .unwrap();
 
         let theta = prove_bandwidth_credential(
             &params,

common/nymcoconut/src/scheme/setup.rs

@@ -10,7 +10,6 @@ use crate::error::{CoconutError, Result};
 use crate::utils::hash_g1;
 
 /// System-wide parameters used for the protocol
-#[derive(Clone)]
 pub struct Parameters {
     /// Generator of the G1 group
     g1: G1Affine,

common/nymcoconut/src/scheme/verification.rs

@@ -288,6 +288,7 @@ pub fn verify_credential(
 }
 
 // Used in tests only
+#[cfg(test)]
 pub fn verify(
     params: &Parameters,
     verification_key: &VerificationKey,

common/nymcoconut/src/tests/helpers.rs

@@ -75,12 +75,8 @@ pub fn theta_from_keys_and_attributes(
     attributes.extend_from_slice(public_attributes);
 
     // Randomize credentials and generate any cryptographic material to verify them
-    let signature = aggregate_signature_shares_and_verify(
-        params,
-        &verification_key,
-        &attributes,
-        &signature_shares,
-    )?;
+    let signature =
+        aggregate_signature_shares(params, &verification_key, &attributes, &signature_shares)?;
 
     // Generate cryptographic material to verify them
     let theta = prove_bandwidth_credential(

common/nyxd-scraper/Cargo.toml

@@ -16,9 +16,7 @@ const_format = "0.2.32"
 cosmrs.workspace = true
 eyre = "0.6.9"
 futures.workspace = true
-humantime = "2.1.0"
 sha2 = "0.10.8"
-serde = { workspace = true, features = ["derive"] }
 sqlx = { workspace = true, features = ["runtime-tokio-rustls", "sqlite", "macros", "migrate", "time"] }
 tendermint.workspace = true
 tendermint-rpc = { workspace = true, features = ["websocket-client", "http-client"] }
@@ -26,13 +24,13 @@ thiserror.workspace = true
 time = { workspace = true }
 tokio = { workspace = true, features = ["full"] }
 tokio-stream = "0.1.14"
-tokio-util = { version = "0.7.10", features = ["rt"] }
+tokio-util = { version = "0.7.10", features = ["rt"]}
 tracing.workspace = true
 url.workspace = true
 
 
 # TEMP
-#nym-bin-common = { path = "../bin-common", features = ["basic_tracing"]}
+nym-bin-common = { path = "../bin-common", features = ["basic_tracing"]}
 
 
 [build-dependencies]

common/nyxd-scraper/README.md

@@ -1,23 +0,0 @@
-# Nyxd Scraper
-
-## Pruning
-
-Similarly to cosmos-sdk, we incorporate pruning into our (scraped) chain data. We attempt to follow their strategies as
-closely as possible for convenience's sake. Therefore, the following are available:
-
-### Strategies
-
-The strategies are configured in `config.toml`, with the format `pruning = "<strategy>"` where the options are:
-
-* `default`: only the last 362,880 states(approximately 3.5 weeks worth of state) are kept; pruning at 10 block
-  intervals
-* `nothing`: all historic states will be saved, nothing will be deleted (i.e. archiving node)
-* `everything`: 2 latest states will be kept; pruning at 10 block intervals.
-* `custom`: allow pruning options to be manually specified through `pruning.keep_recent`, and `pruning.interval`
-
-### Custom Pruning
-
-These are applied if and only if the pruning strategy is `custom`:
-
-* `pruning.keep_recent`: N means to keep all of the last N blocks
-* `pruning.interval`: N means to delete old block data from disk every Nth block.

common/nyxd-scraper/src/block_processor/mod.rs

@@ -8,7 +8,6 @@ use crate::error::ScraperError;
 use crate::modules::{BlockModule, MsgModule, TxModule};
 use crate::rpc_client::RpcClient;
 use crate::storage::{persist_block, ScraperStorage};
-use crate::PruningOptions;
 use futures::StreamExt;
 use std::collections::{BTreeMap, HashSet, VecDeque};
 use std::ops::{Add, Range};
@@ -19,10 +18,9 @@ use tokio::sync::Notify;
 use tokio::time::{interval_at, Instant};
 use tokio_stream::wrappers::UnboundedReceiverStream;
 use tokio_util::sync::CancellationToken;
-use tracing::{debug, error, info, instrument, trace, warn};
+use tracing::{debug, error, info, warn};
 
 mod helpers;
-pub(crate) mod pruning;
 pub(crate) mod types;
 
 const MISSING_BLOCKS_CHECK_INTERVAL: Duration = Duration::from_secs(30);
@@ -42,11 +40,9 @@ impl PendingSync {
 }
 
 pub struct BlockProcessor {
-    pruning_options: PruningOptions,
     cancel: CancellationToken,
     synced: Arc<Notify>,
     last_processed_height: u32,
-    last_pruned_height: u32,
     last_processed_at: Instant,
     pending_sync: PendingSync,
     queued_blocks: BTreeMap<u32, BlockToProcess>,
@@ -66,7 +62,6 @@ pub struct BlockProcessor {
 
 impl BlockProcessor {
     pub async fn new(
-        pruning_options: PruningOptions,
         cancel: CancellationToken,
         synced: Arc<Notify>,
         incoming: UnboundedReceiver<BlockToProcess>,
@@ -75,17 +70,11 @@ impl BlockProcessor {
         rpc_client: RpcClient,
     ) -> Result<Self, ScraperError> {
         let last_processed = storage.get_last_processed_height().await?;
-        let last_processed_height = last_processed.try_into().unwrap_or_default();
-
-        let last_pruned = storage.get_pruned_height().await?;
-        let last_pruned_height = last_pruned.try_into().unwrap_or_default();
 
         Ok(BlockProcessor {
-            pruning_options,
             cancel,
             synced,
-            last_processed_height,
-            last_pruned_height,
+            last_processed_height: last_processed.try_into().unwrap_or_default(),
             last_processed_at: Instant::now(),
             pending_sync: Default::default(),
             queued_blocks: Default::default(),
@@ -142,17 +131,12 @@ impl BlockProcessor {
             }
         }
 
-        let commit_start = Instant::now();
         tx.commit()
             .await
             .map_err(|source| ScraperError::StorageTxCommitFailure { source })?;
-        crate::storage::log_db_operation_time("committing processing tx", commit_start);
 
         self.last_processed_height = full_info.block.header.height.value() as u32;
         self.last_processed_at = Instant::now();
-        if let Err(err) = self.maybe_prune_storage().await {
-            error!("failed to prune the storage: {err}");
-        }
 
         Ok(())
     }
@@ -226,61 +210,6 @@ impl BlockProcessor {
         Ok(())
     }
 
-    #[instrument(skip(self))]
-    async fn prune_storage(&mut self) -> Result<(), ScraperError> {
-        let keep_recent = self.pruning_options.strategy_keep_recent();
-        let last_to_keep = self.last_processed_height - keep_recent;
-
-        info!(
-            keep_recent,
-            oldest_to_keep = last_to_keep,
-            "pruning the storage"
-        );
-
-        let lowest: u32 = self
-            .storage
-            .lowest_block_height()
-            .await?
-            .unwrap_or_default()
-            .try_into()
-            .unwrap_or_default();
-
-        let to_prune = last_to_keep.saturating_sub(lowest);
-        match to_prune {
-            v if v > 1000 => warn!("approximately {v} blocks worth of data will be pruned"),
-            v if v > 100 => info!("approximately {v} blocks worth of data will be pruned"),
-            0 => trace!("no blocks to prune"),
-            v => debug!("approximately {v} blocks worth of data will be pruned"),
-        }
-
-        if to_prune == 0 {
-            return Ok(());
-        }
-
-        self.storage
-            .prune_storage(last_to_keep, self.last_processed_height)
-            .await?;
-
-        self.last_pruned_height = self.last_processed_height;
-        Ok(())
-    }
-
-    async fn maybe_prune_storage(&mut self) -> Result<(), ScraperError> {
-        debug!("checking for storage pruning");
-
-        if self.pruning_options.strategy.is_nothing() {
-            trace!("the current pruning strategy is 'nothing'");
-            return Ok(());
-        }
-
-        let interval = self.pruning_options.strategy_interval();
-        if self.last_pruned_height + interval <= self.last_processed_height {
-            self.prune_storage().await?;
-        }
-
-        Ok(())
-    }
-
     async fn next_incoming(&mut self, block: BlockToProcess) {
         let height = block.height;
 
@@ -350,8 +279,6 @@ impl BlockProcessor {
     async fn startup_resync(&mut self) -> Result<(), ScraperError> {
         assert!(self.pending_sync.is_empty());
 
-        self.maybe_prune_storage().await?;
-
         let latest_block = self.rpc_client.current_block_height().await? as u32;
         if latest_block > self.last_processed_height && self.last_processed_height != 0 {
             let request_range = self.last_processed_height + 1..latest_block + 1;

common/nyxd-scraper/src/block_processor/pruning.rs

@@ -1,122 +0,0 @@
-// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use crate::error::ScraperError;
-use serde::{Deserialize, Serialize};
-
-pub const DEFAULT_PRUNING_KEEP_RECENT: u32 = 362880;
-pub const DEFAULT_PRUNING_INTERVAL: u32 = 10;
-pub const EVERYTHING_PRUNING_KEEP_RECENT: u32 = 2;
-pub const EVERYTHING_PRUNING_INTERVAL: u32 = 10;
-
-/// We follow cosmos-sdk pruning strategies for convenience’s sake.
-#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize)]
-#[serde(rename_all = "snake_case")]
-pub enum PruningStrategy {
-    /// 'Default' strategy defines a pruning strategy where the last 362880 heights are
-    /// kept where to-be pruned heights are pruned at every 10th height.
-    /// The last 362880 heights are kept(approximately 3.5 weeks worth of state) assuming the typical
-    /// block time is 6s. If these values do not match the applications' requirements, use the "custom" option.
-    #[default]
-    Default,
-
-    /// 'Everything' strategy defines a pruning strategy where all committed heights are
-    /// deleted, storing only the current height and last 2 states. To-be pruned heights are
-    /// pruned at every 10th height.
-    Everything,
-
-    /// 'Nothing' strategy defines a pruning strategy where all heights are kept on disk.
-    Nothing,
-
-    /// 'Custom' strategy defines a pruning strategy where the user specifies the pruning.
-    Custom,
-}
-
-impl PruningStrategy {
-    pub fn is_custom(&self) -> bool {
-        matches!(self, PruningStrategy::Custom)
-    }
-
-    pub fn is_nothing(&self) -> bool {
-        matches!(self, PruningStrategy::Nothing)
-    }
-
-    pub fn is_everything(&self) -> bool {
-        matches!(self, PruningStrategy::Everything)
-    }
-}
-
-#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
-pub struct PruningOptions {
-    /// keep_recent defines how many recent heights to keep on disk.
-    pub keep_recent: u32,
-
-    /// interval defines the frequency of removing the pruned heights from the disk.
-    pub interval: u32,
-
-    /// strategy defines the currently used kind of [PruningStrategy].
-    pub strategy: PruningStrategy,
-}
-
-impl PruningOptions {
-    pub fn validate(&self) -> Result<(), ScraperError> {
-        // if strategy is not set to custom, other options are meaningless since they won't be applied
-        if !self.strategy.is_custom() {
-            return Ok(());
-        }
-
-        if self.interval == 0 {
-            return Err(ScraperError::ZeroPruningInterval);
-        }
-
-        if self.interval < EVERYTHING_PRUNING_INTERVAL {
-            return Err(ScraperError::TooSmallPruningInterval {
-                interval: self.interval,
-            });
-        }
-
-        if self.keep_recent < EVERYTHING_PRUNING_KEEP_RECENT {
-            return Err(ScraperError::TooSmallKeepRecent {
-                keep_recent: self.keep_recent,
-            });
-        }
-
-        Ok(())
-    }
-
-    pub fn nothing() -> Self {
-        PruningOptions {
-            keep_recent: 0,
-            interval: 0,
-            strategy: PruningStrategy::Nothing,
-        }
-    }
-
-    pub fn strategy_interval(&self) -> u32 {
-        match self.strategy {
-            PruningStrategy::Default => DEFAULT_PRUNING_INTERVAL,
-            PruningStrategy::Everything => EVERYTHING_PRUNING_INTERVAL,
-            PruningStrategy::Nothing => 0,
-            PruningStrategy::Custom => self.interval,
-        }
-    }
-
-    pub fn strategy_keep_recent(&self) -> u32 {
-        match self.strategy {
-            PruningStrategy::Default => DEFAULT_PRUNING_KEEP_RECENT,
-            PruningStrategy::Everything => EVERYTHING_PRUNING_KEEP_RECENT,
-            PruningStrategy::Nothing => 0,
-            PruningStrategy::Custom => self.keep_recent,
-        }
-    }
-}
-
-impl Default for PruningOptions {
-    fn default() -> Self {
-        PruningOptions {
-            keep_recent: DEFAULT_PRUNING_KEEP_RECENT,
-            interval: DEFAULT_PRUNING_INTERVAL,
-            strategy: Default::default(),
-        }
-    }
-}

common/nyxd-scraper/src/error.rs

@@ -1,9 +1,6 @@
 // Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::block_processor::pruning::{
-    EVERYTHING_PRUNING_INTERVAL, EVERYTHING_PRUNING_KEEP_RECENT,
-};
 use tendermint::Hash;
 use thiserror::Error;
 use tokio::sync::mpsc::error::SendError;
@@ -125,15 +122,6 @@ pub enum ScraperError {
         "could not find validator information for {address}; the validator has signed a commit"
     )]
     MissingValidatorInfoCommitted { address: String },
-
-    #[error("pruning.interval must not be set to 0. If you want to disable pruning, select pruning.strategy = \"nothing\"")]
-    ZeroPruningInterval,
-
-    #[error("pruning.interval must not be smaller than {}. got: {interval}. for most aggressive pruning, select pruning.strategy = \"everything\"", EVERYTHING_PRUNING_INTERVAL)]
-    TooSmallPruningInterval { interval: u32 },
-
-    #[error("pruning.keep_recent must not be smaller than {}. got: {keep_recent}. for most aggressive pruning, select pruning.strategy = \"everything\"", EVERYTHING_PRUNING_KEEP_RECENT)]
-    TooSmallKeepRecent { keep_recent: u32 },
 }
 
 impl<T> From<SendError<T>> for ScraperError {

common/nyxd-scraper/src/lib.rs

@@ -14,7 +14,6 @@ pub(crate) mod rpc_client;
 pub(crate) mod scraper;
 pub mod storage;
 
-pub use block_processor::pruning::{PruningOptions, PruningStrategy};
 pub use modules::{BlockModule, MsgModule, TxModule};
 pub use scraper::{Config, NyxdScraper};
 pub use storage::models;

common/nyxd-scraper/src/scraper/mod.rs

@@ -8,7 +8,6 @@ use crate::modules::{BlockModule, MsgModule, TxModule};
 use crate::rpc_client::RpcClient;
 use crate::scraper::subscriber::ChainSubscriber;
 use crate::storage::ScraperStorage;
-use crate::PruningOptions;
 use std::path::PathBuf;
 use std::sync::Arc;
 use tokio::sync::mpsc::{channel, unbounded_channel};
@@ -28,8 +27,6 @@ pub struct Config {
     pub rpc_url: Url,
 
     pub database_path: PathBuf,
-
-    pub pruning_options: PruningOptions,
 }
 
 pub struct NyxdScraperBuilder {
@@ -57,7 +54,6 @@ impl NyxdScraperBuilder {
             processing_tx.clone(),
         );
         let mut block_processor = BlockProcessor::new(
-            scraper.config.pruning_options,
             scraper.cancel_token.clone(),
             scraper.startup_sync.clone(),
             processing_rx,
@@ -123,7 +119,6 @@ impl NyxdScraper {
     }
 
     pub async fn new(config: Config) -> Result<Self, ScraperError> {
-        config.pruning_options.validate()?;
         let storage = ScraperStorage::init(&config.database_path).await?;
 
         Ok(NyxdScraper {
@@ -165,7 +160,6 @@ impl NyxdScraper {
             processing_tx.clone(),
         );
         let block_processor = BlockProcessor::new(
-            self.config.pruning_options,
             self.cancel_token.clone(),
             self.startup_sync.clone(),
             processing_rx,

common/nyxd-scraper/src/storage/manager.rs

@@ -1,11 +1,9 @@
 // Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use crate::storage::log_db_operation_time;
 use crate::storage::models::{CommitSignature, Validator};
 use sqlx::types::time::OffsetDateTime;
 use sqlx::{Executor, Sqlite};
-use tokio::time::Instant;
 use tracing::{instrument, trace};
 
 #[derive(Clone)]
@@ -27,36 +25,10 @@ impl StorageManager {
         Ok(())
     }
 
-    pub(crate) async fn get_lowest_block(&self) -> Result<Option<i64>, sqlx::Error> {
-        trace!("get_lowest_block");
-        let start = Instant::now();
-
-        let maybe_record = sqlx::query!(
-            r#"
-                SELECT height
-                FROM block
-                ORDER BY height ASC
-                LIMIT 1
-            "#,
-        )
-        .fetch_optional(&self.connection_pool)
-        .await?;
-        log_db_operation_time("get_lowest_block", start);
-
-        if let Some(row) = maybe_record {
-            Ok(row.height)
-        } else {
-            Ok(None)
-        }
-    }
-
     pub(crate) async fn get_first_block_height_after(
         &self,
         time: OffsetDateTime,
     ) -> Result<Option<i64>, sqlx::Error> {
-        trace!("get_first_block_height_after");
-        let start = Instant::now();
-
         let maybe_record = sqlx::query!(
             r#"
                 SELECT height
@@ -69,7 +41,6 @@ impl StorageManager {
         )
         .fetch_optional(&self.connection_pool)
         .await?;
-        log_db_operation_time("get_first_block_height_after", start);
 
         if let Some(row) = maybe_record {
             Ok(row.height)
@@ -82,9 +53,6 @@ impl StorageManager {
         &self,
         time: OffsetDateTime,
     ) -> Result<Option<i64>, sqlx::Error> {
-        trace!("get_last_block_height_before");
-        let start = Instant::now();
-
         let maybe_record = sqlx::query!(
             r#"
                 SELECT height
@@ -97,7 +65,6 @@ impl StorageManager {
         )
         .fetch_optional(&self.connection_pool)
         .await?;
-        log_db_operation_time("get_last_block_height_before", start);
 
         if let Some(row) = maybe_record {
             Ok(row.height)
@@ -112,9 +79,6 @@ impl StorageManager {
         start_height: i64,
         end_height: i64,
     ) -> Result<i32, sqlx::Error> {
-        trace!("get_signed_between");
-        let start = Instant::now();
-
         let count = sqlx::query!(
             r#"
                 SELECT COUNT(*) as count FROM pre_commit
@@ -130,7 +94,6 @@ impl StorageManager {
         .fetch_one(&self.connection_pool)
         .await?
         .count;
-        log_db_operation_time("get_signed_between", start);
 
         Ok(count)
     }
@@ -140,10 +103,7 @@ impl StorageManager {
         consensus_address: &str,
         height: i64,
     ) -> Result<Option<CommitSignature>, sqlx::Error> {
-        trace!("get_precommit");
-        let start = Instant::now();
-
-        let res = sqlx::query_as(
+        sqlx::query_as(
             r#"
                 SELECT * FROM pre_commit
                 WHERE validator_address = ? 
@@ -153,20 +113,14 @@ impl StorageManager {
         .bind(consensus_address)
         .bind(height)
         .fetch_optional(&self.connection_pool)
-        .await?;
-        log_db_operation_time("get_precommit", start);
-
-        Ok(res)
+        .await
     }
 
     pub(crate) async fn get_block_validators(
         &self,
         height: i64,
     ) -> Result<Vec<Validator>, sqlx::Error> {
-        trace!("get_block_validators");
-        let start = Instant::now();
-
-        let res = sqlx::query_as!(
+        sqlx::query_as!(
             Validator,
             r#"
                 SELECT * FROM validator 
@@ -179,28 +133,16 @@ impl StorageManager {
             height
         )
         .fetch_all(&self.connection_pool)
-        .await?;
-        log_db_operation_time("get_block_validators", start);
-
-        Ok(res)
+        .await
     }
 
     pub(crate) async fn get_validators(&self) -> Result<Vec<Validator>, sqlx::Error> {
-        trace!("get_validators");
-        let start = Instant::now();
-
-        let res = sqlx::query_as("SELECT * FROM validator")
+        sqlx::query_as("SELECT * FROM validator")
             .fetch_all(&self.connection_pool)
-            .await?;
-        log_db_operation_time("get_validators", start);
-
-        Ok(res)
+            .await
     }
 
     pub(crate) async fn get_last_processed_height(&self) -> Result<i64, sqlx::Error> {
-        trace!("get_last_processed_height");
-        let start = Instant::now();
-
         let maybe_record = sqlx::query!(
             r#"
                 SELECT last_processed_height FROM metadata
@@ -208,7 +150,6 @@ impl StorageManager {
         )
         .fetch_optional(&self.connection_pool)
         .await?;
-        log_db_operation_time("get_last_processed_height", start);
 
         if let Some(row) = maybe_record {
             Ok(row.last_processed_height)
@@ -216,27 +157,6 @@ impl StorageManager {
             Ok(-1)
         }
     }
-
-    pub(crate) async fn get_pruned_height(&self) -> Result<i64, sqlx::Error> {
-        trace!("get_pruned_height");
-        let start = Instant::now();
-
-        let maybe_record = sqlx::query!(
-            r#"
-                SELECT last_pruned_height FROM pruning
-            "#
-        )
-        .fetch_optional(&self.connection_pool)
-        .await?;
-
-        log_db_operation_time("get_pruned_height", start);
-
-        if let Some(row) = maybe_record {
-            Ok(row.last_pruned_height)
-        } else {
-            Ok(-1)
-        }
-    }
 }
 
 // make those generic over executor so that they could be performed over connection pool and a tx
@@ -250,8 +170,7 @@ pub(crate) async fn insert_validator<'a, E>(
 where
     E: Executor<'a, Database = Sqlite>,
 {
-    trace!("insert_validator");
-    let start = Instant::now();
+    trace!("insert validator");
 
     sqlx::query!(
         r#"
@@ -264,7 +183,6 @@ where
     )
     .execute(executor)
     .await?;
-    log_db_operation_time("insert_validator", start);
 
     Ok(())
 }
@@ -282,8 +200,7 @@ pub(crate) async fn insert_block<'a, E>(
 where
     E: Executor<'a, Database = Sqlite>,
 {
-    trace!("insert_block");
-    let start = Instant::now();
+    trace!("insert block");
 
     sqlx::query!(
         r#"
@@ -300,7 +217,6 @@ where
     )
     .execute(executor)
     .await?;
-    log_db_operation_time("insert_block", start);
 
     Ok(())
 }
@@ -317,8 +233,7 @@ pub(crate) async fn insert_precommit<'a, E>(
 where
     E: Executor<'a, Database = Sqlite>,
 {
-    trace!("insert_precommit");
-    let start = Instant::now();
+    trace!("insert precommit");
 
     sqlx::query!(
         r#"
@@ -334,7 +249,6 @@ where
     )
     .execute(executor)
     .await?;
-    log_db_operation_time("insert_precommit", start);
 
     Ok(())
 }
@@ -356,8 +270,7 @@ pub(crate) async fn insert_transaction<'a, E>(
 where
     E: Executor<'a, Database = Sqlite>,
 {
-    trace!("insert_transaction");
-    let start = Instant::now();
+    trace!("insert transaction");
 
     sqlx::query!(
         r#"
@@ -385,7 +298,6 @@ where
     )
         .execute(executor)
         .await?;
-    log_db_operation_time("insert_transaction", start);
 
     Ok(())
 }
@@ -401,8 +313,7 @@ pub(crate) async fn insert_message<'a, E>(
 where
     E: Executor<'a, Database = Sqlite>,
 {
-    trace!("insert_message");
-    let start = Instant::now();
+    trace!("insert message");
 
     sqlx::query!(
         r#"
@@ -419,7 +330,6 @@ where
     )
     .execute(executor)
     .await?;
-    log_db_operation_time("insert_message", start);
 
     Ok(())
 }
@@ -433,100 +343,10 @@ where
     E: Executor<'a, Database = Sqlite>,
 {
     trace!("update_last_processed");
-    let start = Instant::now();
 
     sqlx::query!("UPDATE metadata SET last_processed_height = ?", height)
         .execute(executor)
         .await?;
-    log_db_operation_time("update_last_processed", start);
-
-    Ok(())
-}
-
-#[instrument(skip(executor))]
-pub(crate) async fn update_last_pruned<'a, E>(height: i64, executor: E) -> Result<(), sqlx::Error>
-where
-    E: Executor<'a, Database = Sqlite>,
-{
-    trace!("update_last_pruned");
-    let start = Instant::now();
-
-    sqlx::query!("UPDATE pruning SET last_pruned_height = ?", height)
-        .execute(executor)
-        .await?;
-    log_db_operation_time("update_last_pruned", start);
-
-    Ok(())
-}
-
-pub(crate) async fn prune_blocks<'a, E>(oldest_to_keep: i64, executor: E) -> Result<(), sqlx::Error>
-where
-    E: Executor<'a, Database = Sqlite>,
-{
-    trace!("prune_blocks");
-    let start = Instant::now();
-
-    sqlx::query!("DELETE FROM block WHERE height < ?", oldest_to_keep)
-        .execute(executor)
-        .await?;
-    log_db_operation_time("prune_blocks", start);
-
-    Ok(())
-}
-
-pub(crate) async fn prune_pre_commits<'a, E>(
-    oldest_to_keep: i64,
-    executor: E,
-) -> Result<(), sqlx::Error>
-where
-    E: Executor<'a, Database = Sqlite>,
-{
-    trace!("prune_pre_commits");
-    let start = Instant::now();
-
-    sqlx::query!("DELETE FROM pre_commit WHERE height < ?", oldest_to_keep)
-        .execute(executor)
-        .await?;
-    log_db_operation_time("prune_pre_commits", start);
-
-    Ok(())
-}
-
-pub(crate) async fn prune_transactions<'a, E>(
-    oldest_to_keep: i64,
-    executor: E,
-) -> Result<(), sqlx::Error>
-where
-    E: Executor<'a, Database = Sqlite>,
-{
-    trace!("prune_transactions");
-    let start = Instant::now();
-
-    sqlx::query!(
-        "DELETE FROM \"transaction\" WHERE height < ?",
-        oldest_to_keep
-    )
-    .execute(executor)
-    .await?;
-    log_db_operation_time("prune_transactions", start);
-
-    Ok(())
-}
-
-pub(crate) async fn prune_messages<'a, E>(
-    oldest_to_keep: i64,
-    executor: E,
-) -> Result<(), sqlx::Error>
-where
-    E: Executor<'a, Database = Sqlite>,
-{
-    trace!("prune_messages");
-    let start = Instant::now();
-
-    sqlx::query!("DELETE FROM message WHERE height < ?", oldest_to_keep)
-        .execute(executor)
-        .await?;
-    log_db_operation_time("prune_messages", start);
 
     Ok(())
 }

common/nyxd-scraper/src/storage/mod.rs

@@ -5,8 +5,7 @@ use crate::block_processor::types::{FullBlockInformation, ParsedTransactionRespo
 use crate::error::ScraperError;
 use crate::storage::manager::{
     insert_block, insert_message, insert_precommit, insert_transaction, insert_validator,
-    prune_blocks, prune_messages, prune_pre_commits, prune_transactions, update_last_processed,
-    update_last_pruned, StorageManager,
+    update_last_processed, StorageManager,
 };
 use crate::storage::models::{CommitSignature, Validator};
 use sqlx::types::time::OffsetDateTime;
@@ -16,7 +15,6 @@ use std::path::Path;
 use tendermint::block::{Commit, CommitSig};
 use tendermint::Block;
 use tendermint_rpc::endpoint::validators;
-use tokio::time::Instant;
 use tracing::{debug, error, info, instrument, trace, warn};
 
 mod helpers;
@@ -30,19 +28,6 @@ pub struct ScraperStorage {
     pub(crate) manager: StorageManager,
 }
 
-pub(crate) fn log_db_operation_time(op_name: &str, start_time: Instant) {
-    let elapsed = start_time.elapsed();
-    let formatted = humantime::format_duration(elapsed);
-
-    match elapsed.as_millis() {
-        v if v > 10000 => error!("{op_name} took {formatted} to execute"),
-        v if v > 1000 => warn!("{op_name} took {formatted} to execute"),
-        v if v > 100 => info!("{op_name} took {formatted} to execute"),
-        v if v > 10 => debug!("{op_name} took {formatted} to execute"),
-        _ => trace!("{op_name} took {formatted} to execute"),
-    }
-}
-
 impl ScraperStorage {
     #[instrument]
     pub async fn init<P: AsRef<Path> + Debug>(database_path: P) -> Result<Self, ScraperError> {
@@ -80,32 +65,6 @@ impl ScraperStorage {
         Ok(storage)
     }
 
-    #[instrument(skip(self))]
-    pub async fn prune_storage(
-        &self,
-        oldest_to_keep: u32,
-        current_height: u32,
-    ) -> Result<(), ScraperError> {
-        let start = Instant::now();
-
-        let mut tx = self.begin_processing_tx().await?;
-
-        prune_messages(oldest_to_keep.into(), &mut tx).await?;
-        prune_transactions(oldest_to_keep.into(), &mut tx).await?;
-        prune_pre_commits(oldest_to_keep.into(), &mut tx).await?;
-        prune_blocks(oldest_to_keep.into(), &mut tx).await?;
-        update_last_pruned(current_height.into(), &mut tx).await?;
-
-        let commit_start = Instant::now();
-        tx.commit()
-            .await
-            .map_err(|source| ScraperError::StorageTxCommitFailure { source })?;
-        log_db_operation_time("committing pruning tx", commit_start);
-
-        log_db_operation_time("pruning storage", start);
-        Ok(())
-    }
-
     #[instrument(skip_all)]
     pub async fn begin_processing_tx(&self) -> Result<StorageTransaction, ScraperError> {
         debug!("starting storage tx");
@@ -116,10 +75,6 @@ impl ScraperStorage {
             .map_err(|source| ScraperError::StorageTxBeginFailure { source })
     }
 
-    pub async fn lowest_block_height(&self) -> Result<Option<i64>, ScraperError> {
-        Ok(self.manager.get_lowest_block().await?)
-    }
-
     pub async fn get_first_block_height_after(
         &self,
         time: OffsetDateTime,
@@ -200,10 +155,6 @@ impl ScraperStorage {
     pub async fn get_last_processed_height(&self) -> Result<i64, ScraperError> {
         Ok(self.manager.get_last_processed_height().await?)
     }
-
-    pub async fn get_pruned_height(&self) -> Result<i64, ScraperError> {
-        Ok(self.manager.get_pruned_height().await?)
-    }
 }
 
 pub async fn persist_block(

common/types/src/gateway.rs

@@ -171,25 +171,3 @@ impl fmt::Display for GatewayIpPacketRouterDetails {
         writeln!(f, "\taddress: {}", self.address)
     }
 }
-
-#[derive(Debug, Serialize, Deserialize)]
-pub struct GatewayWireguardDetails {
-    pub enabled: bool,
-
-    pub announced_port: u16,
-    pub private_network_prefix: u8,
-}
-
-impl fmt::Display for GatewayWireguardDetails {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        writeln!(f, "wireguard:")?;
-        writeln!(f, "\tenabled: {}", self.enabled)?;
-
-        writeln!(f, "\tannounced_port: {}", self.announced_port)?;
-        writeln!(
-            f,
-            "\tprivate_network_prefix: {}",
-            self.private_network_prefix
-        )
-    }
-}

common/wireguard-types/Cargo.toml

@@ -17,9 +17,7 @@ log = { workspace = true }
 serde = { workspace = true, features = ["derive"] }
 thiserror = { workspace = true }
 
-nym-config = { path = "../config" }
 nym-crypto = { path = "../crypto", features = ["asymmetric"] }
-nym-network-defaults = { path = "../network-defaults" }
 
 # feature-specific dependencies:
 

common/wireguard-types/src/config.rs

@@ -1,23 +0,0 @@
-// Copyright 2024 - Nym Technologies SA <contact@nymtech.net>
-// SPDX-License-Identifier: Apache-2.0
-
-use std::net::{IpAddr, SocketAddr};
-
-#[derive(Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, Debug)]
-pub struct Config {
-    /// Socket address this node will use for binding its wireguard interface.
-    /// default: `0.0.0.0:51822`
-    pub bind_address: SocketAddr,
-
-    /// Private IP address of the wireguard gateway.
-    /// default: `10.1.0.1`
-    pub private_ip: IpAddr,
-
-    /// Port announced to external clients wishing to connect to the wireguard interface.
-    /// Useful in the instances where the node is behind a proxy.
-    pub announced_port: u16,
-
-    /// The prefix denoting the maximum number of the clients that can be connected via Wireguard.
-    /// The maximum value for IPv4 is 32 and for IPv6 is 128
-    pub private_network_prefix: u8,
-}

common/wireguard-types/src/lib.rs

@@ -1,51 +1,15 @@
 // Copyright 2023 - Nym Technologies SA <contact@nymtech.net>
 // SPDX-License-Identifier: Apache-2.0
 
-use dashmap::DashMap;
-use nym_crypto::asymmetric::encryption::KeyPair;
-use std::sync::Arc;
-
-pub mod config;
 pub mod error;
 pub mod public_key;
 pub mod registration;
 
-pub use config::Config;
 pub use error::Error;
 pub use public_key::PeerPublicKey;
 pub use registration::{
-    ClientMac, ClientMessage, ClientRegistrationResponse, GatewayClient, GatewayClientRegistry,
-    InitMessage, Nonce,
+    ClientMac, ClientMessage, ClientRegistrationResponse, GatewayClient, InitMessage, Nonce,
 };
 
 #[cfg(feature = "verify")]
 pub use registration::HmacSha256;
-
-#[derive(Clone)]
-pub struct WireguardGatewayData {
-    config: Config,
-    keypair: Arc<KeyPair>,
-    client_registry: Arc<GatewayClientRegistry>,
-}
-
-impl WireguardGatewayData {
-    pub fn new(config: Config, keypair: Arc<KeyPair>) -> Self {
-        WireguardGatewayData {
-            config,
-            keypair,
-            client_registry: Arc::new(DashMap::default()),
-        }
-    }
-
-    pub fn config(&self) -> Config {
-        self.config
-    }
-
-    pub fn keypair(&self) -> &Arc<KeyPair> {
-        &self.keypair
-    }
-
-    pub fn client_registry(&self) -> &Arc<GatewayClientRegistry> {
-        &self.client_registry
-    }
-}

common/wireguard-types/src/public_key.rs

@@ -24,10 +24,6 @@ impl PeerPublicKey {
     pub fn as_bytes(&self) -> &[u8] {
         self.0.as_bytes()
     }
-
-    pub fn inner(&self) -> PublicKey {
-        self.0
-    }
 }
 
 impl fmt::Display for PeerPublicKey {

common/wireguard-types/src/registration.rs

@@ -12,7 +12,7 @@ use std::{fmt, ops::Deref, str::FromStr};
 #[cfg(feature = "verify")]
 use hmac::{Hmac, Mac};
 #[cfg(feature = "verify")]
-use nym_crypto::asymmetric::encryption::PrivateKey;
+use nym_crypto::asymmetric::encryption::{PrivateKey, PublicKey};
 #[cfg(feature = "verify")]
 use sha2::Sha256;
 
@@ -87,7 +87,7 @@ impl GatewayClient {
     #[cfg(feature = "verify")]
     pub fn new(
         local_secret: &PrivateKey,
-        remote_public: x25519_dalek::PublicKey,
+        remote_public: PublicKey,
         private_ip: IpAddr,
         nonce: u64,
     ) -> Self {
@@ -96,6 +96,8 @@ impl GatewayClient {
         let static_secret = x25519_dalek::StaticSecret::from(local_secret.to_bytes());
         let local_public: x25519_dalek::PublicKey = (&static_secret).into();
 
+        let remote_public = x25519_dalek::PublicKey::from(remote_public.to_bytes());
+
         let dh = static_secret.diffie_hellman(&remote_public);
 
         // TODO: change that to use our nym_crypto::hmac module instead

common/wireguard/src/lib.rs

@@ -3,37 +3,40 @@
 // #![warn(clippy::expect_used)]
 // #![warn(clippy::unwrap_used)]
 
+pub mod setup;
+
 /// Start wireguard device
 #[cfg(target_os = "linux")]
 pub async fn start_wireguard(
     mut task_client: nym_task::TaskClient,
-    wireguard_data: std::sync::Arc<nym_wireguard_types::WireguardGatewayData>,
+    _gateway_client_registry: std::sync::Arc<
+        nym_wireguard_types::registration::GatewayClientRegistry,
+    >,
 ) -> Result<defguard_wireguard_rs::WGApi, Box<dyn std::error::Error + Send + Sync + 'static>> {
-    use base64::{prelude::BASE64_STANDARD, Engine};
+    use crate::setup::{peer_allowed_ips, peer_static_public_key, PRIVATE_KEY};
     use defguard_wireguard_rs::{
         host::Peer, key::Key, net::IpAddrMask, InterfaceConfiguration, WGApi, WireguardInterfaceApi,
     };
-
-    let mut peers = vec![];
-    for peer_client in wireguard_data.client_registry().iter() {
-        let mut peer = Peer::new(Key::new(peer_client.pub_key.to_bytes()));
-        let peer_ip_mask = IpAddrMask::new(peer_client.private_ip, 32);
-        peer.set_allowed_ips(vec![peer_ip_mask]);
-        peers.push(peer);
-    }
+    use nym_network_defaults::{WG_PORT, WG_TUN_DEVICE_ADDRESS};
 
     let ifname = String::from("wg0");
     let wgapi = WGApi::new(ifname.clone(), false)?;
     wgapi.create_interface()?;
     let interface_config = InterfaceConfiguration {
         name: ifname.clone(),
-        prvkey: BASE64_STANDARD.encode(wireguard_data.keypair().private_key().to_bytes()),
-        address: wireguard_data.config().private_ip.to_string(),
-        port: wireguard_data.config().announced_port as u32,
-        peers,
+        prvkey: PRIVATE_KEY.to_string(),
+        address: WG_TUN_DEVICE_ADDRESS.to_string(),
+        port: WG_PORT as u32,
+        peers: vec![],
     };
     wgapi.configure_interface(&interface_config)?;
-    // wgapi.configure_peer_routing(&peers)?;
+    let peer = peer_static_public_key();
+    let mut peer = Peer::new(Key::new(peer.to_bytes()));
+    let peer_ip = peer_allowed_ips();
+    let peer_ip_mask = IpAddrMask::new(peer_ip.network_address(), peer_ip.netmask());
+    peer.set_allowed_ips(vec![peer_ip_mask]);
+    wgapi.configure_peer(&peer)?;
+    wgapi.configure_peer_routing(&[peer.clone()])?;
 
     tokio::spawn(async move { task_client.recv().await });
 

common/wireguard/src/setup.rs

@@ -0,0 +1,56 @@
+use std::net::IpAddr;
+
+use base64::{engine::general_purpose, Engine as _};
+use log::info;
+
+// The wireguard UDP listener
+pub const WG_ADDRESS: &str = "0.0.0.0";
+
+// The private key of the listener
+// Corresponding public key: "WM8s8bYegwMa0TJ+xIwhk+dImk2IpDUKslDBCZPizlE="
+pub(crate) const PRIVATE_KEY: &str = "AEqXrLFT4qjYq3wmX0456iv94uM6nDj5ugp6Jedcflg=";
+
+// The AllowedIPs for the connected peer, which is one a single IP and the same as the IP that the
+// peer has configured on their side.
+const ALLOWED_IPS: &str = "10.1.0.2";
+
+fn decode_base64_key(base64_key: &str) -> [u8; 32] {
+    general_purpose::STANDARD
+        .decode(base64_key)
+        .unwrap()
+        .try_into()
+        .unwrap()
+}
+
+pub fn server_static_private_key() -> x25519_dalek::StaticSecret {
+    // TODO: this is a temporary solution for development
+    let static_private_bytes: [u8; 32] = decode_base64_key(PRIVATE_KEY);
+    let static_private = x25519_dalek::StaticSecret::from(static_private_bytes);
+    let static_public = x25519_dalek::PublicKey::from(&static_private);
+    info!(
+        "wg public key: {}",
+        general_purpose::STANDARD.encode(static_public)
+    );
+    static_private
+}
+
+pub fn peer_static_public_key() -> x25519_dalek::PublicKey {
+    // A single static public key is used during development
+
+    // Read from NYM_PEER_PUBLIC_KEY env variable
+    let peer = std::env::var("NYM_PEER_PUBLIC_KEY").expect("NYM_PEER_PUBLIC_KEY must be set");
+
+    let peer_static_public_bytes: [u8; 32] = decode_base64_key(&peer);
+    let peer_static_public = x25519_dalek::PublicKey::from(peer_static_public_bytes);
+    info!(
+        "Adding wg peer public key: {}",
+        general_purpose::STANDARD.encode(peer_static_public)
+    );
+    peer_static_public
+}
+
+pub fn peer_allowed_ips() -> ip_network::IpNetwork {
+    let key: IpAddr = ALLOWED_IPS.parse().unwrap();
+    let cidr = 32u8;
+    ip_network::IpNetwork::new_truncate(key, cidr).unwrap()
+}

documentation/dev-portal/src/SUMMARY.md

@@ -1,93 +1,96 @@
+[//]: # (TODO change the URLs in the top handlebars)
 #
-# Summary
-
+# Start Here
 - [Introduction](introduction.md)
 
-# Infrastructure
+[//]: # (this is where you pull in some stuff from the infrastructure section as well as a general approach to how to start )
+- [Development Overview](dev-overview.md)
 
-- [What is Nym?](infrastructure/nym.md)
-- [Nym vs Other Systems](infrastructure/nym-vs-others.md)
-- [Node Types](infrastructure/node-types.md)
+[//]: # (TODO see what you can take from here and put in the intro file )
+  [//]: # (# Infrastructure)
+  [//]: # ()
+  [//]: # (- [What is Nym?](infrastructure/nym.md))
+  [//]: # (- [Nym vs Other Systems](infrastructure/nym-vs-others.md))
+  [//]: # (- [Node Types](infrastructure/node-types.md))
 
-# Quickstart
+[//]: # (TODO change this to something like 'where to get started' and extensively rewrite)
+# Integrations
+- [Integration Options](integrations/integration-options.md)
+- [Payment Integration](integrations/payment-integration.md)
 
-- [Overview](quickstart/overview.md)
-- [Chat demo (webapp)](quickstart/chat-demo.md)
-- [Coconut Credential Playground (webapp)](quickstart/cred-playground.md)
-- [SOCKS Proxy (CLI)](quickstart/socks-proxy.md)
-- [NymConnect Beta (GUI)](quickstart/nymconnect-gui.md)
+# SDKs
+- [Rust SDK](sdk/rust/rust.md)
+  - [Interacting with Clients - Read First!](sdk/rust/readfirst.md)
+  - [Message Types](sdk/rust/message-types.md)
+  - [Message Helpers](sdk/rust/message-helpers.md)
+  - [Troubleshooting](sdk/rust/troubleshooting.md)
+  - [Examples](sdk/rust/examples.md)
+      - [Simple Send](sdk/rust/examples/simple.md)
+      - [Create and Store Keys](sdk/rust/examples/keys.md)
+      - [Manual Storage](sdk/rust/examples/storage.md)
+      - [Anonymous Replies](sdk/rust/examples/surbs.md)
+      - [Use Custom Network Topology](sdk/rust/examples/custom-network.md)
+      - [Socks Proxy](sdk/rust/examples/socks.md)
+      - [Split Send and Receive](sdk/rust/examples/split-send.md)
+      - [Testnet Bandwidth Cred](sdk/rust/examples/credential.md)
+      - [Example Cargo file](sdk/rust/examples/cargo.md)
+- [Typescript SDK](sdk/typescript.md)
 
+# Clients
+- [Client Binaries](clients/client-binaries.md)
+  - [Building Nym](clients/building-nym.md)
+  - [Prebuilt Binaries](clients/pre-built-binaries.md)
+- [Clients Overview](clients/overview.md)
+- [Websocket Client](clients/websocket-client.md)
+  - [Setup & Run](clients/websocket/setup.md)
+  - [Configuration](clients/websocket/config.md)
+  - [Using Your Client](clients/websocket/usage.md)
+  - [Examples](clients/websocket/examples.md)
+  - [Command Documentation (Autogenerated)](clients/websocket/nym-client-commands.md)
+- [Socks5 Client](clients/socks5-client.md)
+  - [Setup Guide](clients/socks5/setup.md)
+  - [Command Documentation (Autogenerated)](clients/socks5/nym-socks5-client-commands)
+- [Webassembly Client](clients/webassembly-client.md)
+- [Addressing System](clients/addressing-system.md)
+
+# Nyx Blockchain
+- [Interacting with Nyx Chain and Smart Contracts](nyx/interacting-with-chain.md)
+- [Smart Contracts](nyx/smart-contracts.md)
+    - [Mixnet Contract](nyx/mixnet-contract.md)
+    - [Vesting Contract](nyx/vesting-contract.md)
+- [RPC Nodes](nyx/rpc-node.md)
+- [Ledger Live Support](nyx/ledger-live.md)
+
+# Tools
+- [NymCLI](tools/nym-cli.md)
+- [Command Documentation (Autogenerated)](tools/nym-cli-commands.md)
+   
 # User Manuals
-
 - [NymVPN alpha](nymvpn/intro.md)
     - [CLI](nymvpn/cli.md)
 
-<!-- OUTDATED STUFF:
-- [NymConnect X Monero](tutorials/monero.md)
-- [NymConnect X Matrix](tutorials/matrix.md)
-- [NymConnect X Telegram](tutorials/telegram.md)
-- [NymConnect X Electrum](tutorials/electrum.md)
-- [NymConnect X Firo wallet](tutorials/firo.md)
--->
-
 # Code Examples
-
 - [Custom Service Providers](examples/custom-services.md)
 - [Apps Using Network Requesters](examples/using-nrs.md)
 - [Browser only](examples/browser-only.md)
 - [Monorepo examples](examples/monorepo-examples.md)
 
-# Integrations
-
-- [Integration Options](integrations/integration-options.md)
-[//]: # (- [Mixnet Integration]&#40;integrations/mixnet-integration.md&#41;)
-- [Payment Integration](integrations/payment-integration.md)
-
 # Tutorials
+- [Under Construction](tutorials/comingsoon.md)
 
-- [Rust SDK](tutorials/rust-sdk.md)
-	- [Blockchain Service pt1](tutorials/cosmos-service/intro.md)
-		- [Tutorial Overview](tutorials/cosmos-service/overview.md)
-		- [Preparing Your Environment](tutorials/cosmos-service/preparing-env.md)
-		- [Preparing Your Lib](tutorials/cosmos-service/lib.md)
-		- [Preparing Your Client](tutorials/cosmos-service/client.md)
-		- [Preparing Your Client pt2](tutorials/cosmos-service/client-src.md)
-		- [Preparing Your Service](tutorials/cosmos-service/service.md)
-		- [Preparing Your Service pt2](tutorials/cosmos-service/service-src.md)
-		- [Querying the Chain](tutorials/cosmos-service/querying.md)
-
-- [Typescript](tutorials/typescript.md)
-    - [Simple Service Provider](tutorials/simple-service-provider/simple-service-provider.md)
-      	- [Tutorial Overview](tutorials/simple-service-provider/overview.md)
-      	- [Preparing Your User Client Environment](tutorials/simple-service-provider/preparating-env.md)
-      	- [Building Your User Client](tutorials/simple-service-provider/user-client.md)
-      	- [Preparing Your Service Provider Environment](tutorials/simple-service-provider/preparating-env2.md)
-      	- [Building Your Service Provider](tutorials/simple-service-provider/service-provider.md)
-      	- [Sending a Message Through the Mixnet](tutorials/simple-service-provider/sending-message.md)
-
-[//]: # (TODO make generic )
-[//]: # (# Shipyard Builders Hackathon 2023 )
-[//]: # (- [General Info & Resources]&#40;shipyard/general.md&#41;)
-[//]: # (- [Hackathon Challenges]&#40;shipyard/challenges-overview.md&#41;)
-[//]: # (- [A Note on Infrastructure]&#40;shipyard/infra.md&#41;)
-[//]: # (- [Submission Guidelines]&#40;shipyard/guidelines.md&#41;)
-
-# Events
-
+# Previous Events
 - [Web3Privacy Now](./events/web3-privacy.md)
 - [HCPP23-serinko](./events/hcpp23-serinko.md)
 - [HCPP23-max](./events/hcpp23-max.md)
 
+[//]: # (Maybe we can get rid of these?)
 # FAQ
 - [General](faq/general-faq.md)
 - [Integrations](faq/integrations-faq.md)
 - [Rewards & Token](faq/rewards-faq.md)
 
 # Community Resources
-
-- [Nym DevRel AMAs](community-resources/ama.md)
 - [Community Applications and Guides](community-resources/community-applications-and-guides.md)
-- [Change Service Grantee Information](info-request.md)
 
 ---
 # Misc.

documentation/dev-portal/src/clients/building-nym.md

@@ -8,7 +8,7 @@ Nym has two main codebases:
 - the [Nym platform](https://github.com/nymtech/nym), written in Rust. This contains all of our code _except_ for the validators.
 - the [Nym validators](https://github.com/nymtech/nyxd), written in Go.
 
-> This page details how to build the main Nym platform code. **If you want to build and run a validator, [go here](../nodes/validator.md) instead.**
+> This page details how to build the main Nym platform code. **If you want to build and run a validator, [go here](https://nymtech.net/operators/nodes/validator.md) instead.**
 
 ## Prerequisites
 - Debian/Ubuntu: `pkg-config`, `build-essential`, `libssl-dev`, `curl`, `jq`, `git`
@@ -54,19 +54,18 @@ cargo build --release # build your binaries with **mainnet** configuration
 
 Quite a bit of stuff gets built. The key working parts are:
 
-* [mix node](../nodes/mixnode.md): `nym-mixnode`
-* [gateway node](../nodes/gateway.md): `nym-gateway`
+* [mix node](https://nymtech.net/operators/nodes/mixnode.md): `nym-mixnode`
+* [gateway node](https://nymtech.net/operators/nodes/gateway.md): `nym-gateway`
 * [websocket client](../clients/websocket-client.md): `nym-client`
 * [socks5 client](../clients/socks5-client.md): `nym-socks5-client`
-* [network requester](../nodes/network-requester.md): `nym-network-requester`
+* [network requester](https://nymtech.net/operators/nodes/network-requester.md): `nym-network-requester`
 * [nym-cli tool](../tools/nym-cli.md): `nym-cli`
 * [nym-api](https://nymtech.net/operators/nodes/nym-api.html): `nym-api`
+* [nymvisor](https://nymtech.net/operators/nodes/nymvisor-upgrade.html): `nymvisor`
 
-[//]: # (* [nymvisor](https://nymtech.net/operators/nodes/nymvisor-upgrade.html): `nymvisor`)
-
-The repository also contains Typescript applications which aren't built in this process. These can be built by following the instructions on their respective docs pages.
-* [Nym Wallet](../wallet/desktop-wallet.md)
-* [Nym Connect](https://nymtech.net/developers/quickstart/nymconnect-gui.html)
-* [Network Explorer UI](../explorers/mixnet-explorer.md)
+[//]: # (The repository also contains Typescript applications which aren't built in this process. These can be built by following the instructions on their respective docs pages.)
+[//]: # (* [Nym Wallet](../../../docs/src/wallet/desktop-wallet.md))
+[//]: # (* [Nym Connect](https://nymtech.net/developers/quickstart/nymconnect-gui.html))
+[//]: # (* [Network Explorer UI](../../../docs/src/explorers/mixnet-explorer.md))
 
 > You cannot build from GitHub's .zip or .tar.gz archive files on the releases page - the Nym build scripts automatically include the current git commit hash in the built binary during compilation, so the build will fail if you use the archive code (which isn't a Git repository). Check the code out from github using `git clone` instead.

documentation/dev-portal/src/clients/client-binaries.md

@@ -0,0 +1,5 @@
+# Client Binaries
+
+The Nym codebase is written primarily in Rust. There are two methods to getting access to the different client and node binaries: 
+* [build them yourself](building-nym.md)
+* [download pre-compiled binaries from github](pre-built-binaries.md)

documentation/dev-portal/src/clients/socks5-client.md

@@ -0,0 +1,66 @@
+# Socks5 Client
+
+> The Nym socks5 client was built in the [building nym](./building-nym.md) section. If you haven't yet built Nym and want to run the code on this page, go there first.
+
+## Current version
+```
+<!-- cmdrun ../../../../target/release/nym-socks5-client --version | grep "Build Version" | cut -b 21-26  -->
+```
+
+## What is this client for?
+Many existing applications are able to use either the SOCKS4, SOCKS4A, or SOCKS5 proxy protocols. If you want to send such an application's traffic through the mixnet, you can use the `nym-socks5-client` to bounce network traffic through the Nym network, like this:
+
+```
+                                                                              External Systems:
+                                                                                     +--------------------+
+                                                                             |------>| Monero blockchain  |
+                                                                             |       +--------------------+
+                                                                             |       +--------------------+
+                                                                             |------>|    Email server    |
+                                                                             |       +--------------------+
+                                                                             |       +--------------------+
+                                                                             |------>|    RPC endpoint    |
+                                                                             |       +--------------------+
+                                                                             |       +--------------------+
+                                                                             |------>|       Website      |
+                                                                             |       +--------------------+
+                                                                             |       +--------------------+
+  +----------------------------------+                                       |------>|       etc...       |
+  | Mixnet:                          |                                       |       +--------------------+
+  |       * Gateway your client is   |                                       |
+  |       connected to               |          +--------------------+       |
+  |       * Mix nodes 1 -> 3         |<-------->| Network requester  |<------+
+  |       * Gateway that network     |          +--------------------+
+  |       requester is connected to  |
+  +----------------------------------+
+           ^
+           |
+           |
+           |
+           |
+           v
+ +-------------------+
+ | +---------------+ |
+ | |  Nym client   | |
+ | +---------------+ |
+ |         ^         |
+ |         |         |
+ |         |         |
+ |         |         |
+ |         v         |
+ | +---------------+ |
+ | | Your app code | |
+ | +---------------+ |
+ +-------------------+
+  Your Local Machine
+```
+
+There are 2 pieces of software that work together to send SOCKS traffic through the mixnet: the `nym-socks5-client`, and the `nym-network-requester`.
+
+The `nym-socks5-client` allows you to do the following from your local machine:
+* Take a TCP data stream from a application that can send traffic via SOCKS5.
+* Chop up the TCP stream into multiple Sphinx packets, assigning sequence numbers to them, while leaving the TCP connection open for more data
+* Send the Sphinx packets through the mixnet to a [network requester](https://nymtech.net/operators/nodes/network-requester.md). Packets are shuffled and mixed as they transit the mixnet.
+
+The `nym-network-requester` then reassembles the original TCP stream using the packets' sequence numbers, and make the intended request. It will then chop up the response into Sphinx packets and send them back through the mixnet to your  `nym-socks5-client`. The application will then receive its data, without even noticing that it wasn't talking to a "normal" SOCKS5 proxy!
+

documentation/dev-portal/src/clients/socks5/commands.md

@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)

documentation/dev-portal/src/clients/socks5/nym-socks5-client-commands

@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)

documentation/dev-portal/src/clients/socks5/nym-socks5-client-commands.md

@@ -0,0 +1 @@
+# Command Documentation

documentation/dev-portal/src/clients/socks5/setup.md

@@ -1,69 +1,4 @@
-# Socks5 Client
-
-> The Nym socks5 client was built in the [building nym](../binaries/building-nym.md) section. If you haven't yet built Nym and want to run the code on this page, go there first.
-
-## Current version
-```
-<!-- cmdrun ../../../../target/release/nym-socks5-client --version | grep "Build Version" | cut -b 21-26  -->
-```
-
-## What is this client for?
-Many existing applications are able to use either the SOCKS4, SOCKS4A, or SOCKS5 proxy protocols. If you want to send such an application's traffic through the mixnet, you can use the `nym-socks5-client` to bounce network traffic through the Nym network, like this:
-
-```
-                                                                              External Systems:
-                                                                                     +--------------------+
-                                                                             |------>| Monero blockchain  |
-                                                                             |       +--------------------+
-                                                                             |       +--------------------+
-                                                                             |------>|    Email server    |
-                                                                             |       +--------------------+
-                                                                             |       +--------------------+
-                                                                             |------>|    RPC endpoint    |
-                                                                             |       +--------------------+
-                                                                             |       +--------------------+
-                                                                             |------>|       Website      |
-                                                                             |       +--------------------+
-                                                                             |       +--------------------+
-  +----------------------------------+                                       |------>|       etc...       |
-  | Mixnet:                          |                                       |       +--------------------+
-  |       * Gateway your client is   |                                       |
-  |       connected to               |          +--------------------+       |
-  |       * Mix nodes 1 -> 3         |<-------->| Network requester  |<------+
-  |       * Gateway that network     |          +--------------------+
-  |       requester is connected to  |
-  +----------------------------------+
-           ^
-           |
-           |
-           |
-           |
-           v
- +-------------------+
- | +---------------+ |
- | |  Nym client   | |
- | +---------------+ |
- |         ^         |
- |         |         |
- |         |         |
- |         |         |
- |         v         |
- | +---------------+ |
- | | Your app code | |
- | +---------------+ |
- +-------------------+
-  Your Local Machine
-```
-
-There are 2 pieces of software that work together to send SOCKS traffic through the mixnet: the `nym-socks5-client`, and the `nym-network-requester`.
-
-The `nym-socks5-client` allows you to do the following from your local machine:
-* Take a TCP data stream from a application that can send traffic via SOCKS5.
-* Chop up the TCP stream into multiple Sphinx packets, assigning sequence numbers to them, while leaving the TCP connection open for more data
-* Send the Sphinx packets through the mixnet to a [network requester](../nodes/network-requester.md). Packets are shuffled and mixed as they transit the mixnet.
-
-The `nym-network-requester` then reassembles the original TCP stream using the packets' sequence numbers, and make the intended request. It will then chop up the response into Sphinx packets and send them back through the mixnet to your  `nym-socks5-client`. The application will then receive its data, without even noticing that it wasn't talking to a "normal" SOCKS5 proxy!
-
+# Setup Guide
 ## Client setup
 ### Viewing command help
 
@@ -84,6 +19,7 @@ You can check the necessary parameters for the available commands by running:
 ```
 ./nym-client <COMMAND> --help
 ```
+or check the autogenerated command documentation on the [next page](./nym-socks5-client-commands). 
 
 ### Initialising a new client instance
 Before you can use the client, you need to initalise a new instance of it, which can be done with the following command:
@@ -100,11 +36,9 @@ Before you can use the client, you need to initalise a new instance of it, which
 
 The `--id` in the example above is a local identifier so that you can name your clients and keep track of them on your local system; it is **never** transmitted over the network.
 
-The `--use-reply-surbs` field denotes whether you wish to send [SURBs](../architecture/traffic-flow.md#private-replies-using-surbs) along with your request. It defaults to `false`, we are explicitly setting it as `true`. It defaults to `false` for compatibility with older versions of the [Network Requester](../nodes/network-requester.md).
+The `--use-reply-surbs` field denotes whether you wish to send [SURBs](https://nymtech.net/docs/architecture/traffic-flow.md#private-replies-using-surbs) along with your request. It defaults to `false`, we are explicitly setting it as `true`. It defaults to `false` for compatibility with older versions of the [Network Requester](https://nymtech.net/operators/nodes/network-requester.md).
 
-The `--provider` field needs to be filled with the Nym address of a Network Requester that can make network requests on your behalf. If you don't want to [run your own](../nodes/network-requester.md) you can select one from the [mixnet explorer](https://explorer.nymtech.net/network-components/service-providers) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [this list](https://harbourmaster.nymtech.net/).
-
-Since the nodes on this list are the infrastructure for [Nymconnect](https://nymtech.net/developers/quickstart/nymconnect-gui.html) they will support all apps on the [default whitelist](../nodes/network-requester.md#network-requester-whitelist): Keybase, Telegram, Electrum, Blockstream Green, and Helios.
+The `--provider` field needs to be filled with the Nym address of a Network Requester that can make network requests on your behalf. If you don't want to [run your own](https://nymtech.net/operators/nodes/network-requester.md) you can select one from the [mixnet explorer](https://explorer.nymtech.net/network-components/service-providers) by copying its `Client ID` and using this as the value of the `--provider` flag. Alternatively, you could use [this list](https://harbourmaster.nymtech.net/).
 
 #### Choosing a Gateway
 By default - as in the example above - your client will choose a random gateway to connect to.
@@ -112,9 +46,9 @@ By default - as in the example above - your client will choose a random gateway
 However, there are several options for choosing a gateway, if you do not want one that is randomly assigned to your client:
 * If you wish to connect to a specific gateway, you can specify this with the `--gateway` flag when running `init`.
 * You can also choose a gateway based on its location relative to your client. This can be done by appending the `--latency-based-selection` flag to your `init` command. This command means that to select a gateway, your client will:
-	* fetch a list of all availiable gateways
-	* send few ping messages to all of them, and measure response times.
-	* create a weighted distribution to randomly choose one, favouring ones with lower latency.
+    * fetch a list of all available gateways
+    * send few ping messages to all of them, and measure response times.
+    * create a weighted distribution to randomly choose one, favouring ones with lower latency.
 
 > Note this doesn't mean that your client will pick the closest gateway to you, but it will be far more likely to connect to gateway with a 20ms ping rather than 200ms
 
@@ -195,7 +129,7 @@ When trying to connect your app, generally the proxy settings are found in `sett
 
 Here is an example of setting the proxy connecting in Blockstream Green:
 
-![Blockstream Green settings](../images/wallet-proxy-settings/blockstream-green.gif)
+![Blockstream Green settings](../../images/blockstream-green.gif)
 
 Most wallets and other applications will work basically the same way: find the network proxy settings, enter the proxy url (host: **localhost**, port: **1080**).
 

documentation/dev-portal/src/clients/websocket-client.md

@@ -1,6 +1,6 @@
 # Websocket Client
 
-> The Nym Websocket Client was built in the [building nym](../binaries/building-nym.md) section. If you haven't yet built Nym and want to run the code on this page, go there first.
+> The Nym Websocket Client was built in the [building nym](./building-nym.md) section. If you haven't yet built Nym and want to run the code on this page, go there first.
 
 ## Current version
 ```

documentation/dev-portal/src/clients/websocket/guide.md

@@ -0,0 +1 @@
+# Setup Guide

documentation/dev-portal/src/clients/websocket/nym-client-commands.md

@@ -0,0 +1 @@
+# Command Documentation (Autogenerated)

documentation/dev-portal/src/clients/websocket/setup.md

@@ -25,6 +25,8 @@ You can check the necessary parameters for the available commands by running:
 ./nym-client <command> --help
 ```
 
+Or check the autogenerated command documentation on the [next page](./nym-client-commands.md).
+
 ## Initialising your client
 
 Before you can use the client, you need to initalise a new instance of it. Each instance of the client has its own public/private keypair, and connects to its own gateway node. Taken together, these 3 things (public/private keypair + gateway node identity key) make up an app's identity.

documentation/dev-portal/src/clients/websocket/usage.md

@@ -58,7 +58,7 @@ In some applications, e.g. where people are chatting with friends who they know,
 
 **If that fits your security model, good. However, will probably be the case that you want to send anonymous replies using Single Use Reply Blocks (SURBs)**.
 
-You can read more about SURBs [here](../../architecture/traffic-flow.md#private-replies-using-surbs) but in short they are ways for the receiver of this message to anonymously reply to you - the sender - **without them having to know your client address**.
+You can read more about SURBs [here](https://nymtech.net/docs/architecture/traffic-flow.md#private-replies-using-surbs) but in short they are ways for the receiver of this message to anonymously reply to you - the sender - **without them having to know your client address**.
 
 Your client will send along a number of `replySurbs` to the recipient of the message. These are pre-addressed Sphinx packets that the recipient can write to the payload of (i.e. write response data to), but not view the final destination of. If the recipient is unable to fit the response data into the bucket of SURBs sent to it, it will use a SURB to request more SURBs be sent to it from your client.
 

documentation/dev-portal/src/community-resources/ama.md

@@ -1,7 +0,0 @@
-# DevRel AMAs
-
-The Nym Technology Developer Relations AMA (Ask Me Anything) is an event organised by the Nym team to engage and connect with the developer community as well as answer any questions that they may have.
-
-> ⚠️ Hosted every fortnight on Wednesday @ 4pm UTC
-
-Archives of these calls can be found [here](https://www.youtube.com/watch?v=0kVXR7aNOyg&list=PLoc3wV2YJYwohgwzf5IinyebV4GGYsa9K).

documentation/dev-portal/src/community-resources/forums.md

@@ -1,6 +0,0 @@
-# Forums
-
-Welcome to our page dedicated to providing you with links to open forums discussing privacy-enhancing technologies, as well as general privacy topics. These forums are a great place to learn more about the latest developments in privacy technology, as well as to connect with other individuals who are passionate about protecting their online privacy. Whether you're new to the world of privacy or an experienced user, you're sure to find valuable information and resources on these forums.
-
-
-🚧 coming soon 🚧

documentation/dev-portal/src/dev-overview.md

@@ -0,0 +1 @@
+# Development Overview

documentation/dev-portal/src/faq/general-faq.md

@@ -1,7 +1,5 @@
 # Nym General FAQ
 
-> If you have questions which are not answered below, please share them at our [DevRel AMAs](../community-resources/ama.md) or seek support in [Nym's community](https://nymtech.net/community)
-
 ### What is Nym? 
 
 Nym is a privacy platform that secures user data and protects against surveillance at the network level. 

documentation/dev-portal/src/faq/integrations-faq.md

@@ -198,7 +198,7 @@ For the moment then yes, the mixnet is free to use. There are no limits on the a
 No, although we do recommend that apps that wish to integrate look into running some of their own infrastructure such as gateways in order to assure uptime. 
 
 ### How can I find out if an application is already supported by network requester services? 
-You can check the [default allowed list](https://nymtech.net/.wellknown/network-requester/standard-allowed-list.txt) file to see which application traffic is whitelisted by default. If the domain is present on that list, it means that existing [network requesters](https://nymtech.net/docs/nodes/network-requester.html) can be used to privacy-protect your application traffic. Simply use [NymConnect](../quickstart/nymconnect-gui.md) to connect to this service through the mixnet.
+You can check the [default allowed list](https://nymtech.net/.wellknown/network-requester/standard-allowed-list.txt) file to see which application traffic is whitelisted by default. If the domain is present on that list, it means that existing [network requesters](https://nymtech.net/docs/nodes/network-requester.html) can be used to privacy-protect your application traffic. 
 
 Currently we are undergoing changes on this policy under the name [Project Smoosh](https://nymtech.net/operators/faq/smoosh-faq.html) where a new type of node [Exit Gateway](https://nymtech.net/operators/legal/exit-gateway.html) will allow users to connect to much wider range of domains, restricted by our new [exit policy](https://nymtech.net/.wellknown/network-requester/exit-policy.txt). Follow the changes [here](https://nymtech.net/operators/faq/smoosh-faq.html#what-are-the-changes).
 

documentation/dev-portal/src/glossary.md

@@ -1,106 +0,0 @@
-# Glossary
-
-__Familiarise yourself with Nym's specific terms and jargon through our glossary, making your understanding of Nym technology more enjoyable and educational.__
-
-## A
-**[Address](https://nymtech.net/docs/stable/integrations/addresses-in-nym/)** - A unique string of characters generated from a client keypair. Used to identify clients in the mixnet.
-
-**[Ack](https://nymtech.net/docs/architecture/traffic-flow.html#acks--package-retransmission)** - Short for "acknowledgement". Whenever a hop is completed, the recieving node will send back an 'ack', so that the sending node knows that the packet was recieved.
-
-**Attacker** - A person or entity who attempts to gain unauthorised access to a computer system, network, or other information resource.
-
-## B
-**Binary** - Is a type of computer file that contains machine code, which is a set of instructions that a computer can execute directly. The file consists of a series of 1s and 0s, which are the two digits used in the binary number system.
-
-**Blockchain** - A distributed database that maintains a continuously growing list of ordered records, called blocks.
-
-## C
-**[Coconut](https://nymtech.net/docs/stable/coconut/)** - A distributed cryptographic signing scheme providing a high degree of privacy for its users.
-
-**[CLI](https://nymtech.net/docs/stable/nym-cli/)** - A command-line interface (CLI) is a text-based user interface (UI) used to run programs, manage computer files and interact with the computer.
-
-**Credentials** - Unique values that prove the legitimacy of a user or individual.
-
-**Centralisation** - Refers to the concentration of control of an activity or organisation under a single authority, or small group of authorities.
-
-**[CosmWasm](https://cosmwasm.com)** - Cosmos WebAssembly is a WebAssembly (Wasm) interpreter that is used in the Cosmos SDK, a framework for building decentralised applications (dApps) on the Cosmos network. It allows us to write smart contracts in Rust and then compile them to webassembly to be uploaded on the blockchain.
-
-## D
-**DAO** - Stands for Decentralised Autonomous Organisation. A type of organisation made up of smart contracts on a blockchain. It operates on a set of rules encoded in a computer program, and is governed by the people who use it, rather than by a central authority.
-
-**[Delegating NYM](https://medium.com/coinmonks/what-you-have-to-know-about-staking-and-delegating-458b6d2300a5)** - Similar to bonding but by non-operators and as proof of their trust in a node operator providing a good quality of service. 
-
-**Decentralisation** - Refers to the transfer of control and decision-making from a centralised entity (individual, organization, or group thereof) to a distributed network.
-
-## E
-**Encryption** - The process of encoding information.
-
-## G
-**[Gateways](https://blog.nymtech.net/gateways-to-privacy-51196005bf5)** - The entrance to the mixnet that encrypted packets must pass through before being forwarded to mix nodes. They also act as a sort of mailbox for messages.
-
-**[Gateway Bonding](https://nymtech.net/docs/stable/run-nym-nodes/nodes/gateways/#bonding-your-gateway)** - The action of node operators to bond their stake (in the form of NYM tokens) to a Gateway in order to join the network topology and begin routing traffic through.
-
-## I
-**IPFS** - Stands for InterPlanetary File System. It's a decentralised, peer-to-peer protocol for sharing and storing files. It is designed to make it easier to share and access large amounts of data in a distributed manner, without the need for a central server or authority
-
-## M
-**[Metadata](https://www.opendatasoft.com/en/blog/what-is-metadata-and-why-is-it-important-data)** - A set of data that describes and gives information about other data such as IP addresses, device types, geolocations etc.
-
-**[Mixnet](https://nymtech.net/docs/architecture/traffic-flow.html#mixnet-traffic-flow-1)** - A routing protocol which encrypts and mixes Sphinx packet traffic so that it cannot be determined who is communicating with whom. 
-
-**[Mix Nodes](https://blog.nymtech.net/nym-mixnodes-deep-dive-d2b91917f097)** - The backbone of the Nym infrastructure, that are organised in a three-layer network referred to as the mixnet that network traffic passes through. It mixes, hides and reorders traffic and are rewarded in NYM tokens for their quality of service.
-
-**[Mix node Bonding](https://nymtech.net/docs/stable/run-nym-nodes/nodes/mixnodes/#bonding-your-mix-node)** - The action of node operators bonding their stake (in the form of NYM tokens) to a Mix node in order to join the network topology and begin routing traffic through.
-
-## N
-**[Network Requester](https://nymtech.net/docs/stable/run-nym-nodes/nodes/requester)** - Is a binary that can be ran alongside a Nym Client on a VPS, which allows for private network requests to be made outside the mixnet from you local Nym client
-
-**Nym** - The in-text name of the organisation.
-
-**[Nym Typescript SDK](https://nymtech.net/docs/stable/sdk/overview)** - A Typescript software development kit which allows developers to build browser-based Mixnet application.
-
-**[NYM](https://nymtech.net/docs/stable/nym-cli/#send-tokens-to-an-account)** - Natively distributed token. 
-
-**[Nym Wallet](https://nymtech.net/docs/stable/wallet/)** - The Nym Wallet handles all things regarding handling Nym Tokens about your Nym Node. It is a GUI application that can be downloaded and run on your machine.
-
-**[Nym Technologies SA](https://nymtech.net)** - The official company name.
-
-**[Nyx](https://nymtech.net/docs/stable/integrations/payment-integration-overview/)** - A CosmWasm-enabled blockchain smart contracts platform that functions as the backbone of the Nym network, used to keep track and provide the history of the NYM token's transactions.
-
-## P
-**Payload** - The carrying capacity of a packet or other transmission data unit.
-
-**Pledge** - The number of tokens that are put up by node operators on their nodes as their commitment to provide good quality of service and insure against future bad behaviour.
-
-**Private Key** - A large numerical value that is used to decrypt data.
-
-**Proof-of-Mixing** - The reward of NYM tokens is based on the good quality of service carried out by node operators.
-
-**POC** - Stands for Proof of Concept. It's a demonstration that a proposed product, system, or service can be built and will work as intended. It is a way of testing whether an idea is feasible and likely to succeed.
-
-**Public Key** - A large numerical value that is used to encrypt data.
-
-## S
-**Sphinx** - A cryptographic message format used to relay anonymised messages within the mixnet, also used by the Lightning Network or something similar.
-
-**[Socks5](https://en.wikipedia.org/wiki/SOCKS)** - An proxy protocol that exchanges network packets between a client and server through a proxy server.
-
-**[Service Provider](https://nymtech.net/docs/stable/tutorials/nym-simple-websocket-tutorial/)** - Any type of app that can communicate with the mixnet via a Nym Client.
-
-**[SURBs](https://nymtech.net/docs/architecture/traffic-flow.html#private-replies-using-surbs)** - Stands for 'Single Use Reply Blocks'. They are a type of crytographic construct used to facilitate secure communication between parties and are designed to allow a sender to send a message to a recipient in sucha a way that the message can only be read by the intended recipient, and cannot be read by anyone else.
-
-**Sybil** - In the context of computer networks, a Sybil attach is a type of security attack in which an attacker creates multiple fake identities or "sybils" and uses them to manipulate a network thus gaining control of a network by overwhelming it.
-
-## T
-**Tokenomics** - Is the study of the economic and financial aspects of a cryptocurrency or blockchain-based project. It involves the creation, distribution, and management of tokens, which are digital assets that represent a certain value of utility whithin a particular ecosystem.
-
-## V
-**[Validators](https://nymtech.net/docs/stable/run-nym-nodes/nodes/validators/)** - Secures the Nyx blockchain with a staking token, defending the network from attacks.
-
-**[VPS](https://en.wikipedia.org/wiki/Virtual_private_server)** - Stands for Virtual Private Server. Its a virtual machine that acts as an isolated virtual environment on a physical server operated by a cloud, web or internet hosting provider.
-
-## W
-**Websocket** - A computer communications protocol that provides a full-duplex channel over a single TCP connection. It is designed to be used as a base for real-time, two-way communication between a client and a server over the web.
-
-## Z
-**Zero Knowledge Proofs** - Cryptographic techniques that make it possible to prove something to be true without having to reveal the evidence. 

documentation/dev-portal/src/info-request.md

@@ -1,14 +0,0 @@
-# Change Service Grantee Information
-
-If you wish to update any of the following information: 
- - `Email Address`
- - `NYM address`
- - `Network Requester`
- - `Gateway ID Key` 
- - `Gateway Address`
- - `Service`
- - `Payment Address` 
-
-Please reach out either in the `#service-grantees` channel on Discord or on [Matrix](https://matrix.to/#/#nym-community:nymtech.chat). 
-
-

documentation/dev-portal/src/infrastructure/node-types.md

@@ -11,4 +11,4 @@ For more in-depth information on the network architecture, head to the [Network
 If you would like to concentrate on building an application that uses the mixnet:
 * Explore the [Quickstart](../quickstart/overview.md) options.
 * Check out examples of [Community Apps](../community-resources/community-applications-and-guides.md). 
-* Run through the [Rust SDK](../tutorials/rust-sdk.md) or [Typescript](../tutorials/typescript.md) tutorials. 
+* Run through the [Rust SDK](../tutorials/archive/setups/rust-sdk.md) or [Typescript](../tutorials/archive/setups/typescript.md) tutorials. 

documentation/dev-portal/src/integrations/integration-options.md

@@ -1,13 +1,11 @@
 # Integration Options
-If you've already gone through the different [Quick Start](../quickstart/overview.md) options and had a look at the tutorials, you have seen the possibilities available to you for quickly connecting existing application code to another Nym process. 
-
 Below are a resources that will be useful for either beginning to integrate mixnet functionality into existing application code or build a new app using Nym.  
 
 - **We suggest you begin with this [integration decision tree](https://sdk.nymtech.net/integrations)**. This will give you a better idea of what pieces of software (SDKs, standalone clients, service providers) your integration might involve, and what is currently possible to do with as little custom code as possible. 
 
 - The [integrations FAQ](../faq/integrations-faq.md) has a list of common questions regarding integrating with Nym and Nyx, as well as commonly required links. 
 
-- To get an idea of what is possible / has already been built, check the [community applications and resources](../community-resources/community-applications-and-guides.md) page, as well as the [developer tutorials codebase](https://github.com/nymtech/developer-tutorials). 
+- To get an idea of what is possible / has already been built, check the [community applications and resources](../community-resources/community-applications-and-guides.md) page. 
 
 > If you wish to integrate with the Nyx blockchain to use `NYM` for payments, start with the [payment integration](./payment-integration.md) page.
 

documentation/dev-portal/src/integrations/payment-integration.md

@@ -2,7 +2,7 @@
 
 If you want to integrate with Nym in order to send `NYM` tokens (for instance, if running a `NYM` <-> `BTC` swap application, or using `NYM` for payments), then you will need to interact with the Nyx blockchain. 
 
-Nyx is the blockchain supporting the Nym network, hosting both the `NYM` and `NYX` cryptocurrencies, the CosmWasm smart contracts keeping track of the network, and (coming soon) facilitating zk-Nym credential generation. It is built with the [Cosmos SDK](https://tendermint.com/sdk/).
+Nyx is the blockchain supporting the Nym network, hosting both the `NYM` and `NYX` cryptocurrencies, the CosmWasm smart contracts keeping track of the network, and facilitating zk-Nym credential generation. It is built with the [Cosmos SDK](https://tendermint.com/sdk/).
 
 ### Interacting with the Nyx blockchain 
 Check out the integration options in the [Integration FAQ](../faq/integrations-faq.md#how-can-i-use-json-rpc-methods-to-interact-with-the-nyx-blockchain). 

documentation/dev-portal/src/nyx/smart-contracts.md

@@ -3,7 +3,7 @@
 The Nyx blockchain is based on [CosmWasm](https://cosmwasm.com/). It allows users to code smart contracts in a safe subset of the Rust programming language, easily export them to WebAssembly, and upload them to the blockchain. Information about the chain can be found on the [Nyx blockchain explorer](https://nym.explorers.guru/). 
 
 There are currently two smart contracts on the Nyx chain: 
-* the [Mixnet contract](./mixnet-contract.md) which manages the network topology of the mixnet, tracking delegations and rewarding. 
-* the [Vesting contract](./vesting-contract.md) which manages `NYM` token vesting functionality.  
+* the [Mixnet contract](mixnet-contract.md) which manages the network topology of the mixnet, tracking delegations and rewarding. 
+* the [Vesting contract](vesting-contract.md) which manages `NYM` token vesting functionality.  
 
 > Users will soon be able to create and upload their own CosmWasm smart contracts to Nyx and take advantage of applications such as the Coconut Credential Scheme - more to be announced regarding this very soon.

documentation/dev-portal/src/quickstart/chat-demo.md

@@ -1,5 +0,0 @@
-# Chat demo (webapp)
-
-You can find a browser-based 'hello world' chat app [here](https://chat-demo.nymtech.net).
-
-Either open in two browser windows and send messages to yourself, or share with a friend and send messages to each other through the mixnet.

documentation/dev-portal/src/quickstart/cred-playground.md

@@ -1,5 +0,0 @@
-# Coconut Credential Playground (webapp)
-
-There is a coconut-scheme based Credential Library playground [here](https://coco-demo.nymtech.net/). This is a WASM implementation of our Coconut libraries which generate raw Coconut credentials. Test it to create and re-randomize your own credentials.
-
-For more information on what is happening here check out the [Coconut docs](https://nymtech.net/docs/coconut.html).

documentation/dev-portal/src/quickstart/nymconnect-gui.md

@@ -1,22 +0,0 @@
-# NymConnect Beta (GUI)
-
-NymConnect is a one-button GUI application that wraps around the `nym-socks5-client` for proxying application traffic through the Mixnet. 
-
-You can watch our video on getting started with NymConnect: 
-
-<iframe width="700" height="400" src="https://www.youtube.com/embed/quj8H2qeOwY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
-
-Install NymConnect and select an application that you want to privacy-enhance from the dropdown menu. For now, NymConnect can be used with Electrum Wallet, Keybase, desktop Telegram and Blockstream Green. Configure these to run via a SOCKS5 proxy and send their data through the Nym mixnet!
-
-**Please note that NymConnect is currently released in beta. Please report bugs via Github**. 
-
-## Usage instuctions 
-* [Download](https://github.com/nymtech/nym/releases/) and install NymConnect.
-* Select your service provider from the dropdown menu.
-* Click `connect` - NymConnect will connect to a service provider and its SOCKS Proxy (IP) and Port will be displayed.
-* Click on IP or Port to copy their values to the clipboard.
-* Go to your app settings and look for the network/proxy settings. Select `running via SOCKS5 proxy` and paste the IP and Port values given by NymConnect.
-
-Your traffic from that application will now run through the mixnet for privacy and unlinkability!
-
-

documentation/dev-portal/src/quickstart/overview.md

@@ -1,7 +0,0 @@
-# Overview
-
-There are multiple options to quickly connect to Nym and play with both the mixnet and credentials on the Sandbox testnet.
-
-At most, these involve running Nym as a second process alongside an existing application in order to send traffic through the mixnet, most are either interact webpages or a standalone app.
-
-If you've already covered the information in this section, or want to jump straight into integrating/ a Nym connection into an existing application, head to the [Integrations](../integrations/integration-options.md) section.

documentation/dev-portal/src/quickstart/socks-proxy.md

@@ -1,45 +0,0 @@
-# SOCKS Proxy (CLI)
-
->The `socks5` client now also supports SOCKS4 and SOCKS4A protocols as well as SOCKS5.
-
-The Nym socks5 client allows you to proxy traffic from a desktop application through the mixnet, meaning you can send and receive information from remote application servers without leaking metadata which can be used to deanonymise you, even if you're using an encrypted application such as Signal.
-
-### Download or compile socks5 client
-
-If you are using OSX or a Debian-based operating system, you can download the `nym-socks5-client` binary from our [Github releases page](https://github.com/nymtech/nym/releases).
-
-If you are using a different operating system, head over to the [Building from Source](https://nymtech.net/docs/binaries/building-nym.html) page for instructions on how to build the repository from source.
-
-### Initialise your socks5 client
-
-Use the following command to initialise your socks5 client with the address of a Nym-operated [Network Requester](https://nymtech.net/docs/nodes/network-requester.html) as a provider (the endpoint that will be proxying your traffic out of the mixnet) for ease:
-
-```
-./nym-socks5-client init --id quickstart --provider Entztfv6Uaz2hpYHQJ6JKoaCTpDL5dja18SuQWVJAmmx.Cvhn9rBJw5Ay9wgHcbgCnVg89MPSV5s2muPV2YF1BXYu@Fo4f4SQLdoyoGkFae5TpVhRVoXCF8UiypLVGtGjujVPf
-```
-
-You can always check out the list of endpoints you can use otherwise on the [mixnet service provider explorer page](https://explorer.nymtech.net/network-components/service-providers).
-
-### Start your socks5 client
-Now your client is initialised, start it with the following:
-
-```
-./nym-socks5-client run --id quickstart
-```
-
-### Proxying traffic
-After completing the steps above, your local socks5 Client will be listening on `localhost:1080` ready to proxy traffic to the Network Requester set as the `--provider` when initialising.
-
-When trying to connect your app, generally the proxy settings are found in `settings->advanced` or `settings->connection`.
-
-Here is an example of setting the proxy connecting in Blockstream Green:
-
-![Blockstream Green settings](../images/blockstream-green.gif)
-
-Most wallets and other applications will work basically the same way: find the network proxy settings, enter the proxy url (host: **localhost**, port: **1080**).
-
-In some other applications, this might be written as **localhost:1080** if there's only one proxy entry field.
-
-## Further reading
-
-If you want to dig more into the architecture and use of the socks5 client check out its documentation [here](https://nymtech.net/docs/clients/socks5-client.html).

documentation/dev-portal/src/sdk/rust/examples/credential.md

@@ -1,9 +1,9 @@
 # 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.
+The following code shows how you can use the SDK to create and use a [credential](https://nymtech.net/docs/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](../../../coconut.md).
+You can read more about Coconut credentials (also referred to as `zk-Nym`) [here](https://nymtech.net/docs/coconut.md).
 

documentation/dev-portal/src/sdk/rust/examples/surbs.md

@@ -1,13 +1,11 @@
 # Anonymous Replies with SURBs (Single Use Reply Blocks)
 Both functions used to send messages through the mixnet (`send_message` and `send_plain_message`) send a pre-determined number of SURBs along with their messages by default.
 
-The number of SURBs is set [here](https://github.com/nymtech/nym/blob/master/sdk/rust/nym-sdk/src/mixnet/client.rs#L33).
-
 ```rust,noplayground
 {{#include ../../../../../../sdk/rust/nym-sdk/src/mixnet/client.rs:33}}
 ```
 
-You can read more about how SURBs function under the hood [here](../../../architecture/traffic-flow.md#private-replies-using-surbs).
+You can read more about how SURBs function under the hood [here](https://nymtech.net/docs/architecture/traffic-flow.md#private-replies-using-surbs).
 
 In order to reply to an incoming message using SURBs, you can construct a `recipient` from the `sender_tag` sent along with the message you wish to reply to:
 

documentation/dev-portal/src/sdk/rust/message-helpers.md

@@ -1,7 +1,7 @@
 # Message Helpers
 
 ## Handling incoming messages
-As seen in the [Chain querier tutorial](https://github.com/nymtech/developer-tutorials/blob/0130ee5a61cd6801bdcfc84608b2a520b5392714/rust/chain-query-service/) when listening out for a response to a sent message (e.g. if you have sent a request to a service, and are awaiting the response) you will want to await [non-empty messages (if you don't know why, read the info on this here)](troubleshooting.md#client-receives-empty-messages-when-listening-for-response). This can be done with something like the helper functions [here](https://github.com/nymtech/developer-tutorials/blob/0130ee5a61cd6801bdcfc84608b2a520b5392714/rust/chain-query-service/src/lib.rs#L71): 
+When listening out for a response to a sent message (e.g. if you have sent a request to a service, and are awaiting the response) you will want to await non-empty messages [(if you don't know why, read the info on this here)](troubleshooting.md#client-receives-empty-messages-when-listening-for-response). This can be done with something like the helper functions [here](https://github.com/nymtech/developer-tutorials/blob/0130ee5a61cd6801bdcfc84608b2a520b5392714/rust/chain-query-service/src/lib.rs#L71): 
 
 ```rust
 use nym_sdk::mixnet::ReconstructedMessage; 

documentation/dev-portal/src/sdk/rust/readfirst.md

@@ -0,0 +1 @@
+# Interacting with Clients - Read First!

documentation/dev-portal/src/shipyard/challenges-overview.md

@@ -1,53 +0,0 @@
-# Hackathon Challenges
-There are a few different challenges to choose from, each with different approaches. It is also recommended to check out the _**Examples**_ directory above for inspiration. 
-
-## Tooling challenge
-The tooling challenge involves creating tooling for users, operators, or developers of Nym.
-
-### Examples of user-centric tools:
-- Facilitate onboarding new users more easily to staking their Nym, and understanding the pros and cons, as well as finding a good node to stake on. Examples of tools like this:
-    - [ExploreNym dashboard](https://explorenym.net/)
-
-- Show information on a dashboard about the network. NOTE due to the amount of dashboards currently available, we expect a good justification for why / something to set this apart from existing ones e.g. it is presenting information that is not already presented, or it is presented in a different manner, such as a TUI or CLI app instead of a web dashboard - maybe an onion service, or no-JS site for those who do not wish to enable Javascript in their day-to-day browsing. Examples of tools like this:
-    - [NTV's node dashboard](https://status.notrustverify.ch/d/CW3L7dVVk/nym-mixnet?orgId=1)
-    - [IsNymUp dashboard](https://isnymup.com/)
-
-### Examples of operator-centric tooling:
-- An APY calculator for determining different financial outcomes of running a node in different situations. 
-    
-- Scripting for updating and maintaining nodes. Examples of tools like this:
-    - [ExploreNym's bash scripts](https://github.com/ExploreNYM/bash-tool) 
-
-- Scripting for packaging node binaries for different OSes.
-
-### Examples of developer-centric tooling:
-- Tooling for use in development: are there pain points you’ve found when developing apps with Nym that you have created scripts/hacks/workarounds for? Is there a pain point that you’ve thought ‘oh it would be great if I could just do X’? These are often the best places to start for building out developer tooling - if you’ve run into this issue, it's very likely someone else already has, or will!
-
-- Interacting with one of the SDKs via FFI: perhaps you’re a Go developer who would love to have the functionality of one of the Nym SDKs. Building an FFI tool might be something that would make your life easier, and can be shared with other developers in your situation. 
-
-## Integrations challenge
-Integration options for Nym are currently relatively restrictive due to the manner in which Nym handles sending and receiving traffic (as unordered Sphinx packets). This challenge will involve (most likely) implementing custom logic for handling Nym traffic for an existing application.
-
-There are several potential avenues developers can take here:
-- If your application (or the application you wish to modify) is written in either Javascript or Typescript, and relies on the `fetch` library to make API calls, then you can use its drop-in replacement: [`mixfetch`](). Perhaps you wish to interact with Coingecko, or a private search engine like Kagi without leaking your IP and metadata, or an RPC endpoint.
-    - Example with [NTV’s privacy-preserving Coingecko API](https://github.com/notrustverify/mixfetch-examples)
-    - [Mixfetch docs examples](https://github.com/nymtech/nym/tree/develop/sdk/typescript/examples)
-
-- If you instead have an application that is able to use any of the SOCKS5, 4a, or 4 protocols (a rule of thumb: if it can communicate over Tor, it will) then you can experiment with using Nym as the transport layer. 
-  - For Rustaceans, check out our [socks5 rust sdk example](https://nymtech.net/docs/sdk/rust.html#socks-client-example).  
-  - For those of you who aren’t Crustaceans, then you will have to run the [Socks Client]() alongside your application as a separate process. _NOTE If you are taking this route, please make sure to include detailed documentation on how you expect users to do this, as well as including any process management tools, scripts, and configs (e.g. if you use systemd then include the configuration file for the client, as well as initialisation logic) that may streamline this process._
-    - [NTV's PasteNym backend](https://github.com/notrustverify/pastenym) is a great example of an application with this architecture. 
-
-- Nym is not only useful for blockchain-related apps, but for anything that requires network level privacy! Email clients, messaging clients, and decentralised storage are all key elements of the privacy-enabled web. Several of these sorts of apps can be found in the [community apps page](../community-resources/community-applications-and-guides.md). 
-
-- There is currently a proof of concept using Rust Libp2p with Nym as a transport layer. Perhaps you can think of an app that uses Gossipsub for p2p communication could benefit from network-level privacy. 
-  - [GossipSub chat example](https://github.com/nymtech/nym/tree/develop/sdk/rust/nym-sdk/examples/libp2p_chat) 
-  - [Chainsafe's Lighthouse Nym PoC](https://github.com/ChainSafe/lighthouse/blob/nym/USE_NYM.md#usage)
-
-- Alternatively if you know of an app that is written in Rust or TS and could benefit from using Nym, you could fork and modify it using the SDKs. Applications such as:
-  - Magic Wormhole (has a [rust implementation](https://github.com/magic-wormhole/magic-wormhole.rs))
-  - [Qual](https://github.com/qaul/qaul.net) (uses Rust Libp2p)
-  - [Syncthing](https://github.com/syncthing/syncthing)
-
-### MiniApp challenge 
-Write an app, either using one of the SDKs or a standalone client (harder). Think of what you can ‘nymify’ e.g. a version of the [TorBirdy](https://support.torproject.org/glossary/torbirdy/) extension that uses Nym instead of Tor. This is very similar to the Integration challenge in terms of the different potential _architectures_ and approaches, but just for new applications. 

documentation/dev-portal/src/shipyard/general.md

@@ -1,16 +0,0 @@
-# General Info & Resources 
-Discussions and announcements will be taking place in the [builders channel on Matrix](https://matrix.to/#/#shipyardbuilders:nymtech.chat). This channel can be used for all discussions. 
-
-There will be daily office horse between 12-14:00 CET. 
-
-This is an open call and questions will be answered on a first come first serve basis. 
-
-The timetable can be found on the [Shipyard website](https://nymtech.net/learn/shipyard). 
-
-## Links 
-- You can find **code examples**, **tutorials**, & **quickstart** information here, on the Developer Portal. 
-- [Rust SDK docs](https://nymtech.net/docs/sdk/rust.html)
-- [Typescript SDK docs](https://sdk.nymtech.net)
-- [Platform docs](https://nymtech.net/docs)
-- [NoTrustVerify's Awesome Nym list](https://github.com/notrustverify/awesome-nym)
-- [Builders channel Matrix](https://matrix.to/#/#shipyardbuilders:nymtech.chat)

documentation/dev-portal/src/shipyard/guidelines.md

@@ -1,15 +0,0 @@
-# Submission Guidelines
-We expect to see the following for submissions: 
-- Working code demos hosted publicly (Gitlab, Github, some other git instance).
-- Quality > quantity here: we’d prefer to see a contained, working, and well documented Proof of Concept over a sprawling and messy app that does more but is poorly explained and presented. _The repo must be open source and able to be used and modified by others. The license is up to you._
-- If you already have existing apps / projects you are more than welcome to extend them, instead of starting from scratch - we will only be looking at the NEW additions to make this fair. If you are doing this, make sure to write a detailed account of what it is you;ve added to the existing project, preferably with the possibility to see the ‘old’ version as well as the new one.
-- Proper documentation:
-  - If an app / tool:
-    - How do you install and run the code? How is it to be used? 
-    - An overview of the application architecture: what is it doing? Is it relying on other services? 
-  - If a UI-based solution:
-    - How to run it locally? We are happy to also accept staging deployments as part of the submission (e.g. via Vercel) but this does not replace being able to run it locally.
-- Please make sure that your application works on commonly reproducible system environments (e.g. if you’re developing on Artix Linux please check for the necessary dependencies for more common-place OSes such as Debian, or Arch). If you are developing on Windows please make sure that it works on non-Windows machines also. Where possible please try to include build and install instructions for a variety of OSes. 
-
-## How to submit? 
-Please follow the instructions [here](https://github.com/nymtech/nym/discussions/4143).