GH-606-Review-4

.github/dependabot.yml

@@ -0,0 +1,106 @@
+# Basic `dependabot.yml` file with
+# minimum configuration for two package managers
+
+version: 2
+updates:
+  # Enable version updates for node
+  - package-ecosystem: "cargo"
+    directory: "/node"
+    # Check the cargo registry for updates every day (weekdays)
+    schedule:
+      interval: "daily"
+      time: '14:00'
+      timezone: 'Etc/UTC'
+    allow:
+      - dependency-name: "*"
+        dependency-type: "direct"
+    ignore:
+      - dependency-name: "automap"
+      - dependency-name: "masq_lib"
+      - dependency-name: "actix"
+      - dependency-name: "tokio"
+      - dependency-name: "clap"
+      - dependency-name: "sodiumoxide"
+      - dependency-name: "web3"
+      - dependency-name: "websocket"
+    groups:
+      patch:
+        update-types:
+        - "patch"
+      minor:
+        update-types:
+        - "minor"
+    target-branch: 'master'
+    open-pull-requests-limit: 2
+
+  # Enable version updates for masq
+  - package-ecosystem: "cargo"
+    directory: "/masq"
+    # Check the cargo registry for updates every day (weekdays)
+    schedule:
+      interval: "daily"
+      time: '14:00'
+      timezone: 'Etc/UTC'
+    allow:
+      - dependency-name: "*"
+        dependency-type: "direct"
+    ignore:
+      - dependency-name: "masq_lib"
+      - dependency-name: "clap"
+      - dependency-name: "websocket"
+    groups:
+      patch:
+        update-types:
+        - "patch"
+      minor:
+        update-types:
+        - "minor"
+    target-branch: 'master'
+    open-pull-requests-limit: 2
+
+  # Enable version updates for masq_lib
+  - package-ecosystem: "cargo"
+    directory: "/masq_lib"
+    # Check the cargo registry for updates every day (weekdays)
+    schedule:
+      interval: "daily"
+      time: '14:00'
+      timezone: 'Etc/UTC'
+    allow:
+      - dependency-name: "*"
+        dependency-type: "direct"
+    ignore:
+      - dependency-name: "clap"
+      - dependency-name: "websocket"
+    groups:
+      patch:
+        update-types:
+        - "patch"
+      minor:
+        update-types:
+        - "minor"
+    target-branch: 'master'
+    open-pull-requests-limit: 2
+
+  # Enable version updates for automap
+  - package-ecosystem: "cargo"
+    directory: "/automap"
+    # Check the cargo registry for updates every day (weekdays)
+    schedule:
+      interval: "daily"
+      time: '14:00'
+      timezone: 'Etc/UTC'
+    allow:
+      - dependency-name: "*"
+        dependency-type: "direct"
+    ignore:
+      - dependency-name: "masq_lib"
+    groups:
+      patch:
+        update-types:
+        - "patch"
+      minor:
+        update-types:
+        - "minor"
+    target-branch: 'master'
+    open-pull-requests-limit: 2

README.md

@@ -39,8 +39,7 @@ stage - MASQ Network and it's developers are not responsible for any activity, o
 ## Source
 The MASQ project was forked from Substratum's Node project in order to carry on development after Substratum ceased 
 operations in October of 2019. In 2021, Substratum's Node repositories were removed from GitHub, so the fork link
-with MASQ was broken, but all credit for the original idea, the original design, and the first two years of MASQ's
-development belongs to Substratum. 
+with MASQ was broken, but all credit for the original idea and the original design belongs to Substratum (and properly attributed through GPLv3 license) 
 
 ## Running the MASQ Node
 
@@ -452,6 +451,4 @@ recommend using a 64-bit version to build.
 
 We do plan to release binaries that will run on 32-bit Windows, but they will likely be built on 64-bit Windows.
 
-Copyright (c) 2019-2022, MASQ Network
-
-Copyright (c) 2017-2019, Substratum LLC and/or its affiliates. All rights reserved.
+Copyright (c) 2019-2024, MASQ Network

USER-INTERFACE-INTERFACE.md

@@ -1095,6 +1095,18 @@ even for parameters whose values are natively of other types.
 ##### Description:
 If the value of the respective parameter was successfully changed, this is a simple acknowledgment that the change is complete.
 
+The following commands can be configured using the `setConfiguration`:
+
+
+| Name             | Parameter       | Possible Values  |
+|------------------|-----------------|------------------|
+| Gas Price        | `--gas-price`   | > 0              |
+| Start Block      | `--start-block` | > 0              |
+| Min Hops         | `--min-hops`    | [1, 6]           |
+
+
+Note: The descriptions for the above commands can be found [here](#permitted-names).
+
 #### `setup`
 ##### Direction: Request
 ##### Correspondent: Daemon
@@ -1131,10 +1143,11 @@ be cleared.
 * `db-password` - Password to unlock the sensitive values in the database.
 * `dns-servers` - Comma-separated list of DNS servers to use.
 * `earning-wallet` - Wallet into which earnings should be deposited.
-* `gas-price` - Transaction fee to offer on the blockchain.
+* `gas-price` - The fee per unit of computational effort in blockchain transactions, measured in gwei.
 * `ip` - The public IP address of the Node.
 * `log-level` - The lowest level of logs that should be recorded. `off`, `error`, `warn`, `info`, `debug`, `trace`
 * `mapping-protocol` - The management protocol to try first with the router. `pcp`, `pmp`, `igdp`
+* `min-hops`: The minimum number of hops required for the package to reach the Exit Node.
 * `neighborhood-mode` - `zero-hop`, `originate-only`, `consume-only`, `standard`
 * `neighbors` - Comma-separated list of Node descriptors for neighbors to contact on startup
 * `real-user` - Non-Windows platforms only, only where required: <uid>:<gid>:<home directory>

automap/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "automap"
-version = "0.8.0"
+version = "0.8.2"
 authors = ["Dan Wiebe <dnwiebe@gmail.com>", "MASQ"]
 license = "GPL-3.0-only"
 description = "Library full of code to make routers map ports through firewalls"

dns_utility/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dns_utility"
-version = "0.8.0"
+version = "0.8.2"
 license = "GPL-3.0-only"
 authors = ["Dan Wiebe <dnwiebe@gmail.com>", "MASQ"]
 copyright = "Copyright (c) 2019, MASQ (https://masq.ai) and/or its affiliates. All rights reserved."

masq/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "masq"
-version = "0.8.0"
+version = "0.8.2"
 authors = ["Dan Wiebe <dnwiebe@gmail.com>", "MASQ"]
 license = "GPL-3.0-only"
 description = "Reference implementation of user interface for MASQ Node"

masq/src/commands/configuration_command.rs

@@ -131,7 +131,10 @@ impl ConfigurationCommand {
         dump_parameter_line(
             stream,
             "Start block:",
-            &configuration.start_block.to_string(),
+            &configuration
+                .start_block_opt
+                .map(|m| m.separate_with_commas())
+                .unwrap_or_else(|| "[Latest]".to_string()),
         );
         Self::dump_value_list(stream, "Past neighbors:", &configuration.past_neighbors);
         let payment_thresholds = Self::preprocess_combined_parameters({
@@ -333,7 +336,7 @@ mod tests {
                 exit_byte_rate: 129000000,
                 exit_service_rate: 160000000,
             },
-            start_block: 3456,
+            start_block_opt: None,
             scan_intervals: UiScanIntervals {
                 pending_payable_sec: 150500,
                 payable_sec: 155000,
@@ -378,7 +381,7 @@ mod tests {
 |Max block count:                  [Unlimited]\n\
 |Neighborhood mode:                standard\n\
 |Port mapping protocol:            PCP\n\
-|Start block:                      3456\n\
+|Start block:                      [Latest]\n\
 |Past neighbors:                   neighbor 1\n\
 |                                  neighbor 2\n\
 |Payment thresholds:               \n\
@@ -433,7 +436,7 @@ mod tests {
                 exit_byte_rate: 20,
                 exit_service_rate: 30,
             },
-            start_block: 3456,
+            start_block_opt: Some(1234567890u64),
             scan_intervals: UiScanIntervals {
                 pending_payable_sec: 1000,
                 payable_sec: 1000,
@@ -476,7 +479,7 @@ mod tests {
 |Max block count:                  100,000\n\
 |Neighborhood mode:                zero-hop\n\
 |Port mapping protocol:            PCP\n\
-|Start block:                      3456\n\
+|Start block:                      1,234,567,890\n\
 |Past neighbors:                   [?]\n\
 |Payment thresholds:               \n\
 |                                  Debt threshold:                   2,500 gwei\n\

masq/src/commands/set_configuration_command.rs

@@ -7,6 +7,7 @@ use masq_lib::shared_schema::gas_price_arg;
 use masq_lib::shared_schema::min_hops_arg;
 use masq_lib::short_writeln;
 use masq_lib::utils::ExpectValue;
+use std::num::IntErrorKind;
 
 #[derive(Debug, PartialEq, Eq)]
 pub struct SetConfigurationCommand {
@@ -35,9 +36,17 @@ impl SetConfigurationCommand {
 }
 
 fn validate_start_block(start_block: String) -> Result<(), String> {
-    match start_block.parse::<u64>() {
-        Ok(_) => Ok(()),
-        _ => Err(start_block),
+    if "latest".eq_ignore_ascii_case(&start_block) || "none".eq_ignore_ascii_case(&start_block) {
+        Ok(())
+    } else {
+        match start_block.parse::<u64>() {
+            Ok(_) => Ok(()),
+            Err(e) if e.kind() == &IntErrorKind::PosOverflow => Err(
+                format!("Unable to parse '{}' into a starting block number or provide 'none' or 'latest' for the latest block number: digits exceed {}.",
+                        start_block, u64::MAX),
+            ),
+            Err(e) => Err(format!("Unable to parse '{}' into a starting block number or provide 'none' or 'latest' for the latest block number: {}.", start_block, e))
+        }
     }
 }
 
@@ -59,7 +68,7 @@ impl Command for SetConfigurationCommand {
 const SET_CONFIGURATION_ABOUT: &str =
     "Sets Node configuration parameters being enabled for this operation when the Node is running.";
 const START_BLOCK_HELP: &str =
-    "Ordinal number of the Ethereum block where scanning for transactions will start.";
+    "Ordinal number of the Ethereum block where scanning for transactions will start. Use 'latest' or 'none' for Latest block.";
 
 pub fn set_configurationify<'a>(shared_schema_arg: Arg<'a, 'a>) -> Arg<'a, 'a> {
     shared_schema_arg.takes_value(true).min_values(1)
@@ -103,7 +112,7 @@ mod tests {
         );
         assert_eq!(
             START_BLOCK_HELP,
-            "Ordinal number of the Ethereum block where scanning for transactions will start."
+            "Ordinal number of the Ethereum block where scanning for transactions will start. Use 'latest' or 'none' for Latest block."
         );
     }
 
@@ -122,10 +131,28 @@ mod tests {
         assert!(result.contains("cannot be used with one or more of the other specified arguments"));
     }
 
+    #[test]
+    fn validate_start_block_catches_invalid_values() {
+        assert_eq!(validate_start_block("abc".to_string()), Err("Unable to parse 'abc' into a starting block number or provide 'none' or 'latest' for the latest block number: invalid digit found in string.".to_string()));
+        assert_eq!(validate_start_block("918446744073709551615".to_string()), Err("Unable to parse '918446744073709551615' into a starting block number or provide 'none' or 'latest' for the latest block number: digits exceed 18446744073709551615.".to_string()));
+        assert_eq!(validate_start_block("123,456,789".to_string()), Err("Unable to parse '123,456,789' into a starting block number or provide 'none' or 'latest' for the latest block number: invalid digit found in string.".to_string()));
+        assert_eq!(validate_start_block("123'456'789".to_string()), Err("Unable to parse '123'456'789' into a starting block number or provide 'none' or 'latest' for the latest block number: invalid digit found in string.".to_string()));
+    }
     #[test]
     fn validate_start_block_works() {
-        assert!(validate_start_block("abc".to_string()).is_err());
-        assert!(validate_start_block("1566".to_string()).is_ok());
+        assert_eq!(
+            validate_start_block("18446744073709551615".to_string()),
+            Ok(())
+        );
+        assert_eq!(validate_start_block("1566".to_string()), Ok(()));
+        assert_eq!(validate_start_block("none".to_string()), Ok(()));
+        assert_eq!(validate_start_block("None".to_string()), Ok(()));
+        assert_eq!(validate_start_block("NONE".to_string()), Ok(()));
+        assert_eq!(validate_start_block("nOnE".to_string()), Ok(()));
+        assert_eq!(validate_start_block("latest".to_string()), Ok(()));
+        assert_eq!(validate_start_block("LATEST".to_string()), Ok(()));
+        assert_eq!(validate_start_block("LaTeST".to_string()), Ok(()));
+        assert_eq!(validate_start_block("lATEst".to_string()), Ok(()));
     }
 
     #[test]

masq_lib/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "masq_lib"
-version = "0.8.0"
+version = "0.8.2"
 authors = ["Dan Wiebe <dnwiebe@gmail.com>", "MASQ"]
 license = "GPL-3.0-only"
 description = "Code common to Node and masq; also, temporarily, to dns_utility"