Merge pull request #739 from ethersphere/rchash-correction

Correct rchash usage and redundancy calc

Author: NoahMaizels

docs/bee/working-with-bee/bee-api.md

@@ -458,10 +458,26 @@ From the results we can see that we have a healthy neighborhood size when compar
 
 ### */rchash*
 
-Calling the /rchash endpoint triggers the generation of a reserve commitment hash, which is used in the [redistribution game](/docs/concepts/incentives/redistribution-game), and will report the amount of time it took to generate the hash. This is useful for getting a performance benchmark to ensure that your node's hardware is sufficient. 
+Calling the `/rchash` endpoint triggers the generation of a reserve commitment hash, which is used in the [redistribution game](/docs/concepts/incentives/redistribution-game), and will report the amount of time it took to generate the hash. This is useful for getting a performance benchmark to ensure that your node's hardware is sufficient. 
+
+
+
+
+The `/rchash` endpoint has 3 parameters: `depth` and `anchor_01` and `anchor_02`. For both of the anchor parameters, you should use the first 4 digits from your node's overlay address:
+
+```
+/rchash/{depth}/{anchor_01}/{anchor_02}
+```
+
+:::info anchor parameter details
+- The anchor parameters must match the prefix bits of the node's overlay address up to at least the current storage depth (with each hex digit equal to 4 bits).
+- The anchor parameters also must have an even number of digits. 
+
+Therefore you can use the first four digits of your node's overlay address since it will work for depths up to depth 16, which will not be approached unless the depth increases up to depth 17, which is not likely to happen in the near future. If it does increase to depth 17, then the first 6 overlay digits should be used. 
+:::
 
 ```bash
-sudo curl -sX GET http://localhost:1633/rchash/10/aaaa/aaaa | jq
+sudo curl -sX GET http://localhost:1633/rchash/10/1e20/1e20 | jq
 ```
 It should not take much longer than 6 minutes at most for results to be returned:
 ```bash
@@ -485,6 +501,15 @@ It should not take much longer than 6 minutes at most for results to be returned
 
 If the `Time` value is much longer than 6 minutes then it likely means that the node's hardware performance is not sufficient. Consider upgrading to use faster memory or processor.
 
+If while running the `/rchash` command there is an evictions related error such as the one below, try running the call to the `/rchash` endpoint again.
+
+```
+error: "level"="error" "logger"="node/storageincentives" "msg"="make sample" "error"="sampler: failed creating sample: sampler stopped due to ongoing evictions"
+```
+
+While evictions are a normal part of Bee's standard operation, the event of an eviction will interrupt the sampler process.
+
+
 ### */health*
        
   The `/health` endpoint provides a quick status check for your Bee node which simply indicates whether the node is operating or not. It is often used in tools like Docker and Kubernetes.

docs/bee/working-with-bee/staking.md

@@ -765,61 +765,8 @@ Confirm that `hasSufficientFunds` is `true`, and `isFullySynced` is `true` befor
 
 #### Run sampler process to benchmark performance
 
-One of the most common issues affecting staking is the `sampler` process failing. The sampler is a resource intensive process which is run by nodes which are selected to take part in redistribution. The process may fail or time out if the node's hardware specifications aren't high enough. To check a node's performance the `/rchash/{depth}/{anchor_01}/{anchor_02}` endpoint of the API may be used. The `anchor_01` and `anchor_02` must be a hex string with an even number of digits. For simplicity, you can just use `aaaa` for both anchors as we do in the example further down. 
+One of the most common issues affecting staking is the `sampler` process failing. The sampler is a resource intensive process which is run by nodes which are selected to take part in redistribution. The process may fail or time out if the node's hardware specifications aren't high enough. To check a node's performance the `/rchash` endpoint of the API may be used. See the `/rchash` section of the [Bee API page for usage details](/docs/bee/working-with-bee/bee-api/). 
 
-The `{anchor}` value can be set to any random hexadecimal string, while `{depth}` should be set to the current depth.
-
-To get the current depth, call the `/reservestate` endpoint
-
-```bash
-sudo curl -sX GET http://localhost:1633/reservestate | jq
-```
-Copy the `storageRadius` value from the output (this represents the ACTUAL depth for your node, in other words, the depth to which your node is responsible for storing files. The `radius` value is the hypothetical depth your node would be at if every postage batch was fully utilised.)
-
-```bash
-{
-  "radius": 15,
-  "storageRadius": 10,
-  "commitment": 128332464128
-}
-```
-
-Call the endpoint like so:
-
-```bash
-sudo curl -sX GET http://localhost:1633/rchash/10/aaaa/aaaa | jq
-```
-
-If the sampler runs successfully, you should see output like this:
-
-```bash
-{
-  "Sample": {
-    "Items": [
-      "000003dac2b2f75842e410474dfa4c1e6e0b9970d81b57b33564c5620667ba96",
-      "00000baace30916f7445dbcc44d9b55cb699925acfbe157e4498c63bde834f40",
-      "0000126f48fb1e99e471efc683565e4b245703c922b9956f89cbe09e1238e983",
-      "000012db04a281b7cc0e6436a49bdc5b06ff85396fcb327330ca307e409d2a04",
-      "000014f365b1a381dda85bbeabdd3040fb1395ca9e222e72a597f4cc76ecf6c2",
-      "00001869a9216b3da6814a877fdbc31f156fc2e983b52bc68ffc6d3f3cc79af0",
-      "0000198c0456230b555d5261091cf9206e75b4ad738495a60640b425ecdf408f",
-      "00001a523bd1b688472c6ea5a3c87c697db64d54744829372ac808de8ec1d427"
-    ],
-    "Hash": "7f7d93c6235855fedc34e32c6b67253e27910ca4e3b8f2d942efcd758a6d8829"
-  },
-  "Time": "2m54.087909745s"
-}
-```
-
-If the `Time` value is higher than 6 minutes, then the hardware specifications for the node may need to be upgraded. 
-
-If there is an evictions related error such as the one below, try running the call to the `/rchash/` endpoint again.
-
-```
-error: "level"="error" "logger"="node/storageincentives" "msg"="make sample" "error"="sampler: failed creating sample: sampler stopped due to ongoing evictions"
-```
-
-While evictions are a normal part of Bee's standard operation, the event of an eviction will interrupt the sampler process.
 
 If you are still experiencing problems, you can find more help in the [node-operators](https://discord.gg/kHRyMNpw7t) Discord channel (for your safety, do not accept advice from anyone sending a private message on Discord). 
 

src/components/RedundancyCalc.js

@@ -13,20 +13,17 @@ export default function UploadCostCalc() {
   const maxParities = [9, 21, 31, 90];
   const maxChunksEncrypted = [59, 53, 48, 18];
   const errorTolerances = {
-    None: "0%",
     Medium: "1%",
     Strong: "5%",
     Insane: "10%",
     Paranoid: "50%"
   };
 
+
   const formatNumberCustom = (num) => {
-    // Modify to display integers without .00 for chunks
-    if (unit === "chunks") {
-      return Math.round(num).toString();
-    }
     const isScientific = Math.abs(num) > 0 && Math.abs(num) < 0.0001;
-    return isScientific ? num.toExponential(2) : num.toFixed(2);
+    let formattedNum = isScientific ? num.toExponential(2) : num.toFixed(2);
+    return formattedNum;
   };
 
   const handleDataSizeChange = (e) => {
@@ -45,6 +42,7 @@ export default function UploadCostCalc() {
     setUnit(e.target.value);
   };
 
+
   const calculateCost = () => {
     setErrorMessage("");
     setResult([]);
@@ -54,12 +52,6 @@ export default function UploadCostCalc() {
       return;
     }
 
-    // If redundancy is None, skip erasure coding calculations
-    if (redundancy === "None") {
-      calculateNonRedundancyCost();
-      return;
-    }
-
     let parityDataInGb = 0;
     let totalChunks, sizeInKb, sizeInGb;
 
@@ -101,15 +93,17 @@ export default function UploadCostCalc() {
       : Math.ceil(totalChunks / 127); // 0.8% overhead for unencrypted files
 
     // Add PAC overhead to total chunks
-    const redundancyLevels = { None: -1, Medium: 0, Strong: 1, Insane: 2, Paranoid: 3 };
+    const totalChunksWithPac = totalChunks + pacOverheadChunks;
+  
+    const redundancyLevels = { Medium: 0, Strong: 1, Insane: 2, Paranoid: 3 };
     const redundancyLevel = redundancyLevels[redundancy];
-
+  
     const quotient = isEncrypted
-      ? Math.floor(totalChunks / maxChunksEncrypted[redundancyLevel])
-      : Math.floor(totalChunks / maxChunks[redundancyLevel]);
+      ? Math.floor(totalChunksWithPac / maxChunksEncrypted[redundancyLevel])
+      : Math.floor(totalChunksWithPac / maxChunks[redundancyLevel]);
     const remainder = isEncrypted
-      ? totalChunks % maxChunksEncrypted[redundancyLevel]
-      : totalChunks % maxChunks[redundancyLevel];
+      ? totalChunksWithPac % maxChunksEncrypted[redundancyLevel]
+      : totalChunksWithPac % maxChunks[redundancyLevel];
 
     let remainderParities = 0;
     if (remainder > 0) {
@@ -119,7 +113,6 @@ export default function UploadCostCalc() {
     }
 
     const totalParities = quotient * maxParities[redundancyLevel] + remainderParities;
-    const totalChunksWithPac = totalChunks + pacOverheadChunks;
     const totalDataWithParity = totalChunksWithPac + totalParities;
     const percentDifference = ((totalDataWithParity - totalChunks) / totalChunks) * 100;
 
@@ -183,89 +176,7 @@ export default function UploadCostCalc() {
 
     setResult(resultsArray);
   };
-
-  const calculateNonRedundancyCost = () => {
-    let totalChunks, sizeInKb, sizeInGb;
 
-    if (!dataSize || isNaN(parseFloat(dataSize))) {
-      setErrorMessage("Please enter a valid data size.");
-      return;
-    }
-    
-    if (unit === "kb") {
-      const kbValue = parseFloat(dataSize);
-      if (isNaN(kbValue) || kbValue <= 0) {
-        setErrorMessage("Please input a valid KB value above 0.");
-        return;
-      }
-      sizeInKb = kbValue;
-      totalChunks = Math.ceil((kbValue * 1024) / (2 ** 12));
-    } else if (unit === "gb") {
-      const gbValue = parseFloat(dataSize);
-      if (isNaN(gbValue) || gbValue <= 0) {
-        setErrorMessage("Please input a valid GB value above 0.");
-        return;
-      }
-      sizeInGb = gbValue;
-      sizeInKb = gbValue * 1024 * 1024; // Convert GB to KB
-      totalChunks = Math.ceil((sizeInKb * 1024) / (2 ** 12));
-    } else {
-      const chunksValue = parseFloat(dataSize);
-      if (isNaN(chunksValue) || chunksValue <= 1 || chunksValue % 1 > 0) {
-        setErrorMessage("Please input an integer greater than 1 for chunk values");
-        return;
-      }
-      totalChunks = Math.ceil(chunksValue);
-      sizeInKb = (totalChunks * (2 ** 12)) / 1024;
-    }
-
-    // Calculate PAC overhead
-    const pacOverheadChunks = isEncrypted 
-      ? Math.ceil(totalChunks / 63)  // 1.6% overhead for encrypted files
-      : Math.ceil(totalChunks / 127); // 0.8% overhead for unencrypted files
-    
-    const totalChunksWithPac = totalChunks + pacOverheadChunks;
-    const percentDifference = ((totalChunksWithPac - totalChunks) / totalChunks) * 100;
-    
-    // Calculate PAC overhead size in KB and GB
-    const pacOverheadInKb = (pacOverheadChunks * (2 ** 12)) / 1024;
-    const sizeInGbCalculated = unit === "gb" ? sizeInKb / (1024 * 1024) : null;
-  
-    const resultsArray = [
-      {
-        name: "Source data size",
-        value: unit === "gb" ? `${formatNumberCustom(sizeInGbCalculated)} GB` : `${formatNumberCustom(sizeInKb)} KB`,
-      },
-      {
-        name: "PAC overhead",
-        value: unit === "gb" 
-          ? `${formatNumberCustom(pacOverheadInKb / (1024 * 1024))} GB (${formatNumberCustom(pacOverheadChunks)} chunks)` 
-          : `${formatNumberCustom(pacOverheadInKb)} KB (${formatNumberCustom(pacOverheadChunks)} chunks)`,
-      },
-      { 
-        name: "Source data in chunks", 
-        value: formatNumberCustom(totalChunks) 
-      },
-      { 
-        name: "Source with PAC overhead", 
-        value: formatNumberCustom(totalChunksWithPac) 
-      },
-      { 
-        name: "Percent cost increase", 
-        value: `${percentDifference.toFixed(2)}%` 
-      },
-      { 
-        name: "Selected redundancy level", 
-        value: `${redundancy}` 
-      },
-      { 
-        name: "Error tolerance", 
-        value: errorTolerances[redundancy] 
-      },
-    ];
-  
-    setResult(resultsArray);
-  };
 
   const styles = {
     container: { padding: '20px', fontFamily: 'Arial', maxWidth: '650px', margin: '0 auto' }, 
@@ -314,7 +225,6 @@ export default function UploadCostCalc() {
         <div style={styles.title}>Redundancy Level:</div>
         <select value={redundancy} onChange={handleRedundancyChange} style={styles.select}>
           <option value="" disabled>Select Redundancy Level</option>
-          <option value="None">None</option>
           <option value="Medium">Medium</option>
           <option value="Strong">Strong</option>
           <option value="Insane">Insane</option>
@@ -335,10 +245,13 @@ export default function UploadCostCalc() {
           <tbody>
             {result.map((item, index) => (
               <tr key={index}>
-                <td style={{...styles.tdName, ...styles.bold}}>{item.name}</td>
+                <td style={{...styles.tdName, ...styles.bold}}>{item.name}</td> {/* Apply bold style here */}
                 <td style={styles.tdValue}>{item.value}</td>
               </tr>
             ))}
           </tbody>
         </table>
-      </div>
+      </div>
+    </div>
+  );
+}