Merge pull request #709 from BitGo/feat/xrp-account-delete-recovery

feat(xrp): add AccountDelete feature

Author: abhi-bitgo

electron/main/index.ts

@@ -1,6 +1,13 @@
 import { TrxConsolidationRecoveryOptions } from '../types';
 import EthereumCommon from '@ethereumjs/common';
 
+// Allow self-signed / intermediate-CA certs when running in dev mode.
+// This is needed for testnet rippled nodes (s.altnet.rippletest.net) whose
+// certificate chain is not in Node's default CA bundle.
+if (process.env.NODE_ENV !== 'production') {
+  process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
+}
+
 process.env.DIST_ELECTRON = join(__dirname, '../..');
 process.env.DIST = join(process.env.DIST_ELECTRON, '../dist');
 process.env.PUBLIC = app.isPackaged

src/containers/BuildUnsignedSweepCoin/BuildUnsignedSweepCoin.tsx

@@ -391,6 +391,69 @@ function Form() {
       );
     case 'xrp':
     case 'txrp':
+      return (
+        <RippleForm
+          key={coin}
+          onSubmit={async (values, { setSubmitting }) => {
+            setAlert(undefined);
+            setSubmitting(true);
+            try {
+              await window.commands.setBitGoEnvironment(bitGoEnvironment, coin);
+              const chainData = await window.queries.getChain(coin);
+              const recoverData = await window.commands.recover(coin, {
+                ...(await updateKeysFromIds(coin, values)),
+                bitgoKey: '',
+                ignoreAddressTypes: [],
+                reserveWithdrawal: values.reserveWithdrawal,
+              });
+              assert(
+                isRecoveryTransaction(recoverData),
+                'Fully-signed recovery transaction not detected.'
+              );
+
+              const showSaveDialogData = await window.commands.showSaveDialog({
+                filters: [
+                  {
+                    name: 'Custom File Type',
+                    extensions: ['json'],
+                  },
+                ],
+                defaultPath: `~/${chainData}-unsigned-sweep-${Date.now()}.json`,
+              });
+
+              if (!showSaveDialogData.filePath) {
+                throw new Error('No file path selected');
+              }
+
+              await window.commands.writeFile(
+                showSaveDialogData.filePath,
+                JSON.stringify(
+                  includePubsInUnsignedSweep
+                    ? {
+                        ...recoverData,
+                        ...(await includePubsFor(coin, values)),
+                      }
+                    : recoverData,
+                  null,
+                  2
+                ),
+                { encoding: 'utf-8' }
+              );
+
+              navigate(
+                `/${bitGoEnvironment}/build-unsigned-sweep/${coin}/success`
+              );
+            } catch (err) {
+              if (err instanceof Error) {
+                setAlert(err.message);
+              } else {
+                console.error(err);
+              }
+              setSubmitting(false);
+            }
+          }}
+        />
+      );
     case 'xlm':
     case 'txlm':
     case 'eos':

src/containers/BuildUnsignedSweepCoin/RippleForm.tsx

@@ -10,6 +10,7 @@ const validationSchema = Yup.object({
   rootAddress: Yup.string().required(),
   userKey: Yup.string().required(),
   userKeyId: Yup.string(),
+  reserveWithdrawal: Yup.boolean(),
 }).required();
 
 export type RippleFormProps = {
@@ -31,6 +32,7 @@ export function RippleForm({ onSubmit }: RippleFormProps) {
       rootAddress: '',
       userKey: '',
       userKeyId: '',
+      reserveWithdrawal: false,
     },
     validationSchema,
   });
@@ -89,6 +91,26 @@ export function RippleForm({ onSubmit }: RippleFormProps) {
             Width="fill"
           />
         </div>
+        <div className="tw-mb-4 tw-flex tw-items-start tw-gap-2">
+          <input
+            type="checkbox"
+            id="reserveWithdrawal"
+            name="reserveWithdrawal"
+            checked={formik.values.reserveWithdrawal}
+            onChange={formik.handleChange}
+            className="tw-mt-1"
+          />
+          <label htmlFor="reserveWithdrawal" className="tw-text-sm">
+            <span className="tw-font-semibold">Withdraw full balance including reserve (AccountDelete)</span>
+            <br />
+            <span className="tw-text-gray-500">
+              Permanently deletes the XRP account and sends the entire balance — including the 10 XRP
+              base reserve — to the destination. The account cannot be reused afterwards. Requires: no
+              trustlines with non-zero balances, no open offers/escrows/checks, and the account must be
+              at least 256 ledgers old. A 2 XRP deletion fee is charged by the network.
+            </span>
+          </label>
+        </div>
         <div className="tw-flex tw-flex-col-reverse sm:tw-justify-between sm:tw-flex-row tw-gap-1 tw-mt-4">
           <Button Tag={Link} to="/" Variant="secondary" Width="hug">
             Cancel

src/containers/NonBitGoRecoveryCoin/NonBitGoRecoveryCoin.tsx

@@ -699,6 +699,60 @@ function Form() {
       );
     case 'xrp':
     case 'txrp':
+      return (
+        <RippleForm
+          key={coin}
+          onSubmit={async (values, { setSubmitting }) => {
+            setAlert(undefined);
+            setSubmitting(true);
+            try {
+              await window.commands.setBitGoEnvironment(bitGoEnvironment, coin);
+              const chainData = await window.queries.getChain(coin);
+              const recoverData = await window.commands.recover(coin, {
+                ...values,
+                bitgoKey: '',
+                ignoreAddressTypes: [],
+                reserveWithdrawal: values.reserveWithdrawal,
+              });
+              assert(
+                isRecoveryTransaction(recoverData),
+                'Fully-signed recovery transaction not detected.'
+              );
+
+              const showSaveDialogData = await window.commands.showSaveDialog({
+                filters: [
+                  {
+                    name: 'Custom File Type',
+                    extensions: ['json'],
+                  },
+                ],
+                defaultPath: `~/${chainData}-recovery-${Date.now()}.json`,
+              });
+
+              if (!showSaveDialogData.filePath) {
+                throw new Error('No file path selected');
+              }
+
+              await window.commands.writeFile(
+                showSaveDialogData.filePath,
+                JSON.stringify(recoverData, null, 2),
+                { encoding: 'utf-8' }
+              );
+
+              navigate(
+                `/${bitGoEnvironment}/non-bitgo-recovery/${coin}/success`
+              );
+            } catch (err) {
+              if (err instanceof Error) {
+                setAlert(err.message);
+              } else {
+                console.error(err);
+              }
+              setSubmitting(false);
+            }
+          }}
+        />
+      );
     case 'xlm':
     case 'txlm':
     case 'eos':

src/containers/NonBitGoRecoveryCoin/RippleForm.tsx

@@ -18,6 +18,7 @@ const validationSchema = Yup.object({
   rootAddress: Yup.string().required(),
   walletPassphrase: Yup.string().required(),
   recoveryDestination: Yup.string().required(),
+  reserveWithdrawal: Yup.boolean(),
 }).required();
 
 export type RippleFormProps = {
@@ -39,6 +40,7 @@ export function RippleForm({ onSubmit }: RippleFormProps) {
       walletPassphrase: '',
       recoveryDestination: '',
       krsProvider: '',
+      reserveWithdrawal: false,
     },
     validationSchema,
   });
@@ -109,6 +111,26 @@ export function RippleForm({ onSubmit }: RippleFormProps) {
             Width="fill"
           />
         </div>
+        <div className="tw-mb-4 tw-flex tw-items-start tw-gap-2">
+          <input
+            type="checkbox"
+            id="reserveWithdrawal"
+            name="reserveWithdrawal"
+            checked={formik.values.reserveWithdrawal}
+            onChange={formik.handleChange}
+            className="tw-mt-1"
+          />
+          <label htmlFor="reserveWithdrawal" className="tw-text-sm">
+            <span className="tw-font-semibold">Withdraw full balance including reserve (AccountDelete)</span>
+            <br />
+            <span className="tw-text-gray-500">
+              Permanently deletes the XRP account and sends the entire balance — including the 10 XRP
+              base reserve — to the destination. The account cannot be reused afterwards. Requires: no
+              trustlines with non-zero balances, no open offers/escrows/checks, and the account must be
+              at least 256 ledgers old. A 2 XRP deletion fee is charged by the network.
+            </span>
+          </label>
+        </div>
         <div className="tw-flex tw-flex-col-reverse sm:tw-justify-between sm:tw-flex-row tw-gap-1 tw-mt-4">
           <Button Tag={Link} to="/" Variant="secondary" Width="hug">
             Cancel

src/preload.d.ts

@@ -125,6 +125,7 @@ type Commands = {
       isUnsignedSweep?: boolean;
       issuerAddress?: string; // eg. xrpl token
       currencyCode?: string; // eg. xrpl token
+      reserveWithdrawal?: boolean; // xrp: delete the account and recover the full balance including reserve
       tokenId?: string; // eg. hbar token
       contractId?: string; // eg. stacks sip10 token
       programId?: string; // eg. solana spl 2022 token