feat: renterd migration surcharge multiplier

SiaFoundation · Nov 15, 2023 · 1af82db · 1af82db
1 parent f3e8cfe
commit 1af82db
Show file tree

Hide file tree

Showing 6 changed files with 45 additions and 0 deletions.
diff --git a/.changeset/sixty-suns-invite.md b/.changeset/sixty-suns-invite.md
@@ -0,0 +1,5 @@
+---
+'renterd': minor
+---
+
+The configuration now includes a setting for a migration surcharge multiplier which allows you to set a factor for increasing the max download price when trying to repair critically low health sectors.
diff --git a/apps/renterd/contexts/config/fields.tsx b/apps/renterd/contexts/config/fields.tsx
@@ -567,6 +567,32 @@ export function getFields({
           }
         : {},
     },
+    migrationSurchargeMultiplier: {
+      category: 'gouging',
+      type: 'number',
+      title: 'Migration surcharge multiplier',
+      units: '* download price',
+      placeholder: '10',
+      decimalsLimit: 1,
+      description: (
+        <>
+          Factor that gets applied on the max download price when trying to
+          download migration-critical sectors from a host that is price gouging.
+          For example, when migrating a low-health file, if the download is
+          failing but would potentially succeed with looser gouging settings, we
+          apply the migration surcharge multiplier to overpay on every sector
+          download if it means saving the file/migration.
+        </>
+      ),
+      suggestion: new BigNumber(10),
+      suggestionTip: 'The default multiplier is 10x the download price.',
+      hidden: !showAdvanced,
+      validation: showAdvanced
+        ? {
+            required: 'required',
+          }
+        : {},
+    },
 
     // Redundancy
     minShards: {

diff --git a/apps/renterd/contexts/config/transform.spec.ts b/apps/renterd/contexts/config/transform.spec.ts
@@ -55,6 +55,7 @@ describe('tansforms', () => {
             minMaxCollateral: '10000000000000000000000000',
             minMaxEphemeralAccountBalance: '1000000000000000000000000',
             minPriceTableValidity: 300000000000,
+            migrationSurchargeMultiplier: 10,
           },
           {
             minShards: 10,
@@ -90,6 +91,7 @@ describe('tansforms', () => {
         minMaxCollateral: new BigNumber('10'),
         minMaxEphemeralAccountBalance: new BigNumber('1'),
         minPriceTableValidityMinutes: new BigNumber(5),
+        migrationSurchargeMultiplier: new BigNumber(10),
         minShards: new BigNumber(10),
         totalShards: new BigNumber(30),
         includeRedundancyMaxStoragePrice: false,
@@ -134,6 +136,7 @@ describe('tansforms', () => {
             minMaxCollateral: '10000000000000000000000000',
             minMaxEphemeralAccountBalance: '1000000000000000000000000',
             minPriceTableValidity: 300000000000,
+            migrationSurchargeMultiplier: 10,
           },
           {
             minShards: 10,
@@ -169,6 +172,7 @@ describe('tansforms', () => {
         minMaxCollateral: new BigNumber('10'),
         minMaxEphemeralAccountBalance: new BigNumber('1'),
         minPriceTableValidityMinutes: new BigNumber(5),
+        migrationSurchargeMultiplier: new BigNumber(10),
         minShards: new BigNumber(10),
         totalShards: new BigNumber(30),
         includeRedundancyMaxStoragePrice: true,
@@ -327,6 +331,7 @@ describe('tansforms', () => {
             minPriceTableValidityMinutes: new BigNumber(5),
             minShards: new BigNumber(10),
             totalShards: new BigNumber(30),
+            migrationSurchargeMultiplier: new BigNumber(10),
             includeRedundancyMaxStoragePrice: false,
             includeRedundancyMaxUploadPrice: false,
           },
@@ -348,6 +353,7 @@ describe('tansforms', () => {
         minMaxCollateral: '10000000000000000000000000',
         minMaxEphemeralAccountBalance: '1000000000000000000000000',
         minPriceTableValidity: 300000000000,
+        migrationSurchargeMultiplier: 10,
       })
     })
 
@@ -379,6 +385,7 @@ describe('tansforms', () => {
             minMaxCollateral: new BigNumber('10'),
             minMaxEphemeralAccountBalance: new BigNumber('1'),
             minPriceTableValidityMinutes: new BigNumber(5),
+            migrationSurchargeMultiplier: new BigNumber(10),
             minShards: new BigNumber(10),
             totalShards: new BigNumber(30),
             includeRedundancyMaxStoragePrice: true,
@@ -402,6 +409,7 @@ describe('tansforms', () => {
         minMaxCollateral: '10000000000000000000000000',
         minMaxEphemeralAccountBalance: '1000000000000000000000000',
         minPriceTableValidity: 300000000000,
+        migrationSurchargeMultiplier: 10,
       })
     })
 
@@ -551,6 +559,7 @@ function buildAllResponses() {
       minMaxCollateral: '10000000000000000000000000',
       minMaxEphemeralAccountBalance: '1000000000000000000000000',
       minPriceTableValidity: 300000000000,
+      migrationSurchargeMultiplier: 10,
     },
     redundancy: {
       minShards: 10,

diff --git a/apps/renterd/contexts/config/transform.ts b/apps/renterd/contexts/config/transform.ts
@@ -163,6 +163,8 @@ export function transformUpGouging(
     minMaxEphemeralAccountBalance: toHastings(
       values.minMaxEphemeralAccountBalance
     ).toString(),
+    migrationSurchargeMultiplier:
+      values.migrationSurchargeMultiplier.toNumber(),
   }
 }
 
@@ -323,6 +325,7 @@ export function transformDownGouging(
       g.minMaxEphemeralAccountBalance,
       scDecimalPlaces
     ),
+    migrationSurchargeMultiplier: new BigNumber(g.migrationSurchargeMultiplier),
   }
 }
 

diff --git a/apps/renterd/contexts/config/types.ts b/apps/renterd/contexts/config/types.ts
@@ -45,6 +45,7 @@ export const defaultGouging = {
   minPriceTableValidityMinutes: undefined as BigNumber | undefined,
   minAccountExpiryDays: undefined as BigNumber | undefined,
   minMaxEphemeralAccountBalance: undefined as BigNumber | undefined,
+  migrationSurchargeMultiplier: undefined as BigNumber | undefined,
 }
 
 export const defaultRedundancy = {

diff --git a/libs/react-renterd/src/siaTypes.ts b/libs/react-renterd/src/siaTypes.ts
@@ -191,6 +191,7 @@ export type GougingSettings = {
   minPriceTableValidity: number
   minAccountExpiry: number
   minMaxEphemeralAccountBalance: string
+  migrationSurchargeMultiplier: number
 }
 
 export type UploadPackingSettings = {