add avoid-high-fee-routes to send command

Signed-off-by: Nitesh Balusu <[email protected]>

SERVER.md

@@ -1751,6 +1751,7 @@ http://localhost:8055/api/send
     [in_through]: <Pay In Through Peer String>
     [is_dry_run]: <Do Not Push Payment Bool>
     [is_omitting_message_from]: <Do Not Include From Key In Message Bool>
+    [is_strict_max_fee]: <Avoid High Fee Routes Boolean>
     [max_fee]: <Maximum Fee Tokens Number>
     [max_fee_rate]: <Max Fee Rate Tokens Per Million Number>
     [message]: <Message to Include With Payment String>

src/client/commands.ts

@@ -442,6 +442,7 @@ const commands: Commands = [
       in_through: 'In',
       is_dry_run: 'Dryrun',
       is_omitting_message_from: 'messageOmitFromKey',
+      is_strict_max_fee: 'AvoidHighFeeRoutes',
       max_fee: 'MaxFee',
       max_fee_rate: 'MaxFeeRate',
       message: 'Message',

src/client/pages/commands/Send.tsx

@@ -28,6 +28,7 @@ const Send = () => {
   const [destination, setDestination] = useState('');
   const [inPeer, setInPeer] = useState(undefined);
   const [isDryrun, setIsDryRun] = useState(false);
+  const [isStrictMaxFee, setIsStrictMaxFee] = useState(false);
   const [outPeer, setOutPeer] = useState(undefined);
   const [maxFee, setMaxFee] = useState('1337');
   const [maxFeeRate, setMaxFeeRate] = useState('');
@@ -62,6 +63,10 @@ const Send = () => {
     setAvoid(newFormValues);
   };
 
+  const handleAvoidHighFeeRoutes = () => {
+    setIsStrictMaxFee((previousState: boolean) => !previousState);
+  };
+
   const handleDryrunChange = () => {
     setIsDryRun((previousState: boolean) => !previousState);
   };
@@ -99,6 +104,7 @@ const Send = () => {
     in_through: inPeer,
     is_dry_run: isDryrun,
     is_omitting_message_from: isOmittingMessageFrom,
+    is_strict_max_fee: isStrictMaxFee,
     max_fee: Number(maxFee),
     max_fee_rate: Number(maxFeeRate),
     out_through: outPeer,
@@ -189,6 +195,19 @@ const Send = () => {
             onChange={handleMaxFeeRateChange}
             style={styles.textField}
           />
+
+          <FormControlLabel
+            style={styles.switch}
+            control={
+              <StandardSwitch
+                checked={isStrictMaxFee}
+                onChange={handleAvoidHighFeeRoutes}
+                id={SendCommand.flags.is_strict_max_fee}
+              />
+            }
+            label={SendCommand.flags.is_strict_max_fee}
+          />
+
           <TextField
             type="text"
             placeholder={`${SendCommand.flags.message} (Message to include with payment)`}

src/client/pages/result/SendResult.tsx

@@ -42,6 +42,7 @@ const SendResult = () => {
       in_through: router.query.in_through,
       is_dry_run: router.query.is_dry_run,
       is_omitting_message_from: router.query.is_omitting_message_from,
+      is_strict_max_fee: router.query.is_strict_max_fee,
       max_fee: router.query.max_fee,
       max_fee_rate: router.query.max_fee_rate,
       message: router.query.message,

src/server/commands/send/send_command.ts

@@ -19,6 +19,7 @@ import { readFile } from 'fs';
     [in_through]: <Pay In Through Peer String>
     [is_dry_run]: <Do Not Push Payment Bool>
     [is_omitting_message_from]: <Do Not Include From Key In Message Bool>
+    [is_strict_max_fee]: <Avoid High Fee Routes Boolean>
     lnd: <Authenticated LND API Object>
     logger: <Winston Logger Object>
     max_fee: <Maximum Fee Tokens Number>
@@ -61,6 +62,7 @@ const sendCommand = async ({ args, lnd, logger }: Args): Promise<{ result: any }
       in_through: args.in_through,
       is_dry_run: args.is_dry_run,
       is_omitting_message_from: args.is_omitting_message_from,
+      is_strict_max_fee: !!args.is_strict_max_fee,
       max_fee: args.max_fee || 1337,
       max_fee_rate: args.max_fee_rate || undefined,
       message: args.message,

src/shared/commands.dto.ts

@@ -1020,6 +1020,11 @@ export class sendDto {
   @IsBoolean()
   is_omitting_message_from: boolean;
 
+  @Transform(({ value }) => toBoolean(value))
+  @IsOptional()
+  @IsBoolean()
+  is_strict_max_fee: boolean;
+
   @Transform(({ value }) => toNumber(value))
   @IsOptional()
   @IsNumber()

src/shared/types.ts

@@ -308,6 +308,7 @@ export type commandSend = {
   in_through: string;
   is_dry_run: boolean;
   is_omitting_message_from: boolean;
+  is_strict_max_fee: boolean;
   max_fee: number;
   max_fee_rate: number;
   message: string;