Merge remote-tracking branch 'hoodieshq/feat/solana-safe-staking' int…

…o feat/safer-solana

.changeset/tricky-needles-allow.md

@@ -0,0 +1,6 @@
+---
+"ledger-live-desktop": patch
+"@ledgerhq/live-common": patch
+---
+
+Safer Solana staking

apps/ledger-live-desktop/src/renderer/families/solana/DelegationFlowModal/steps/StepAmount.tsx

@@ -1,4 +1,5 @@
 import { getMainAccount } from "@ledgerhq/live-common/account/index";
+import { SOLANA_DELEGATION_RESERVE } from "@ledgerhq/live-common/families/solana/utils";
 import React, { Fragment, PureComponent } from "react";
 import { Trans } from "react-i18next";
 import TrackPage from "~/renderer/analytics/TrackPage";
@@ -7,9 +8,11 @@ import Button from "~/renderer/components/Button";
 import CurrencyDownStatusAlert from "~/renderer/components/CurrencyDownStatusAlert";
 import ErrorBanner from "~/renderer/components/ErrorBanner";
 import SpendableBanner from "~/renderer/components/SpendableBanner";
+import Alert from "~/renderer/components/Alert";
 import AccountFooter from "~/renderer/modals/Send/AccountFooter";
 import AmountField from "~/renderer/modals/Send/fields/AmountField";
 import { StepProps } from "../types";
+
 const StepAmount = ({
   t,
   account,
@@ -52,6 +55,14 @@ const StepAmount = ({
             t={t}
             withUseMaxLabel={true}
           />
+          <Alert type="warning" small>
+            <Trans
+              i18nKey="solana.delegation.flow.steps.amount.reserveWarning"
+              values={{
+                amount: SOLANA_DELEGATION_RESERVE,
+              }}
+            />
+          </Alert>
         </Fragment>
       )}
     </Box>

apps/ledger-live-desktop/static/i18n/en/app.json

@@ -3537,7 +3537,8 @@
             "title": "Validator"
           },
           "amount": {
-            "title": "Amount"
+            "title": "Amount",
+            "reserveWarning": "Please ensure you reserve at least {{amount}} SOL in your wallet to cover future network fees to deactivate and withdraw your stake"
           },
           "confirmation": {
             "success": {

apps/ledger-live-mobile/src/families/solana/DelegationFlow/SelectAmount.tsx

@@ -2,6 +2,7 @@ import { getAccountUnit } from "@ledgerhq/live-common/account/index";
 import { getAccountCurrency } from "@ledgerhq/live-common/account/helpers";
 import { getAccountBridge } from "@ledgerhq/live-common/bridge/index";
 import useBridgeTransaction from "@ledgerhq/live-common/bridge/useBridgeTransaction";
+import { SOLANA_DELEGATION_RESERVE } from "@ledgerhq/live-common/families/solana/utils";
 import { useTheme } from "@react-navigation/native";
 import { BigNumber } from "bignumber.js";
 import invariant from "invariant";
@@ -181,6 +182,17 @@ export default function DelegationSelectAmount({ navigation, route }: Props) {
                     />
                   </View>
                 </View>
+                <View>
+                  <Text color="grey">
+                    <InfoIcon size={12} color="grey" />{" "}
+                    <Trans
+                      i18nKey="solana.delegation.reserveWarning"
+                      values={{
+                        amount: SOLANA_DELEGATION_RESERVE,
+                      }}
+                    />
+                  </Text>
+                </View>
                 <View style={styles.continueWrapper}>
                   <Button
                     event="SendAmountCoinContinue"

apps/ledger-live-mobile/src/families/solana/DelegationFlow/Summary.tsx

@@ -33,6 +33,7 @@ import DelegatingContainer from "../../tezos/DelegatingContainer";
 import ValidatorImage from "../shared/ValidatorImage";
 import { StackNavigatorProps } from "~/components/RootNavigator/types/helpers";
 import { DelegationAction, SolanaDelegationFlowParamList } from "./types";
+import TranslatedError from "../../../components/TranslatedError";
 
 type Props = StackNavigatorProps<SolanaDelegationFlowParamList, ScreenName.DelegationSummary>;
 
@@ -158,6 +159,7 @@ export default function DelegationSummary({ navigation, route }: Props) {
   ]);
 
   const hasErrors = Object.keys(status.errors).length > 0;
+  const error = Object.values(status.errors)[0];
 
   return (
     <SafeAreaView style={[styles.root, { backgroundColor: colors.background }]}>
@@ -222,6 +224,7 @@ export default function DelegationSummary({ navigation, route }: Props) {
         </View>
       </View>
       <View style={styles.footer}>
+        <TranslatedError error={error} />
         <Button
           event="SummaryContinue"
           type="primary"

apps/ledger-live-mobile/src/locales/en/common.json

@@ -5739,7 +5739,8 @@
       "delegatedTo": "delegated to",
       "started": {
         "description": "You may earn rewards by delegating your SOL assets to a validator."
-      }
+      },
+      "reserveWarning": "Please ensure you reserve at least {{amount}} SOL in your wallet to cover future network fees to deactivate and withdraw your stake"
     }
   },
   "near": {

libs/ledger-live-common/src/families/solana/__snapshots__/bridge.integration.test.ts.snap

@@ -23,8 +23,9 @@ exports[`solana currency bridge scanAccounts solana seed 1 1`] = `
     "seedIdentifier": "AQbkEagmPgmsdAfS4X8V8UyJnXXjVPMvjeD15etqQ3Jh",
     "solanaResources": {
       "stakes": "[]",
+      "unstakeReserve": "0",
     },
-    "spendableBalance": "83389840",
+    "spendableBalance": "82498960",
     "starred": false,
     "swapHistory": [],
     "syncHash": undefined,
@@ -52,6 +53,7 @@ exports[`solana currency bridge scanAccounts solana seed 1 1`] = `
     "seedIdentifier": "AQbkEagmPgmsdAfS4X8V8UyJnXXjVPMvjeD15etqQ3Jh",
     "solanaResources": {
       "stakes": "[]",
+      "unstakeReserve": "0",
     },
     "spendableBalance": "0",
     "starred": false,

libs/ledger-live-common/src/families/solana/banner.test.ts

@@ -102,6 +102,7 @@ const account: SolanaAccount = {
         withdrawable: 0,
       },
     ],
+    unstakeReserve: BigNumber(0),
   },
 };
 

libs/ledger-live-common/src/families/solana/bridge.integration.test.ts

@@ -726,13 +726,14 @@ function stakingTests(): TransactionTestSpec[] {
       },
       expectedStatus: {
         amount: testOnChainData.fundedSenderBalance
-          .minus(fees(1))
+          .minus(fees(1)) // transaction fee
+          .minus(fees(1).multipliedBy(2)) // undelegate + withdraw fees reserve
           .minus(testOnChainData.fees.stakeAccountRentExempt)
           .minus(testOnChainData.fees.systemAccountRentExempt),
         estimatedFees: fees(1).plus(testOnChainData.fees.stakeAccountRentExempt),
-        totalSpent: testOnChainData.fundedSenderBalance.minus(
-          testOnChainData.fees.systemAccountRentExempt,
-        ),
+        totalSpent: testOnChainData.fundedSenderBalance
+          .minus(testOnChainData.fees.systemAccountRentExempt)
+          .minus(fees(1).multipliedBy(2)), // undelegate + withdraw fees reserve,
         errors: {},
       },
     },
@@ -1050,6 +1051,7 @@ async function runStakeTest(stakeTestSpec: StakeTestSpec) {
           },
         } as SolanaStake,
       ],
+      unstakeReserve: BigNumber(0),
     },
   };
 

libs/ledger-live-common/src/families/solana/js-buildTransaction.ts

@@ -1,4 +1,3 @@
-import type { Account } from "@ledgerhq/types-live";
 import type { Command, Transaction } from "./types";
 import {
   buildTransferInstructions,
@@ -20,15 +19,15 @@ import {
 import { ChainAPI } from "./api";
 
 export const buildTransactionWithAPI = async (
-  account: Account,
+  address: string,
   transaction: Transaction,
   api: ChainAPI,
 ): Promise<readonly [OnChainTransaction, (signature: Buffer) => OnChainTransaction]> => {
   const instructions = buildInstructions(transaction);
 
   const recentBlockhash = await api.getLatestBlockhash();
 
-  const feePayer = new PublicKey(account.freshAddress);
+  const feePayer = new PublicKey(address);
 
   const tm = new TransactionMessage({
     payerKey: feePayer,
@@ -41,7 +40,7 @@ export const buildTransactionWithAPI = async (
   return [
     tx,
     (signature: Buffer) => {
-      tx.addSignature(new PublicKey(account.freshAddress), signature);
+      tx.addSignature(new PublicKey(address), signature);
       return tx;
     },
   ];

libs/ledger-live-common/src/families/solana/js-estimateMaxSpendable.ts

@@ -1,14 +1,54 @@
-import type { AccountBridge } from "@ledgerhq/types-live";
+import type { Account, AccountBridge } from "@ledgerhq/types-live";
 import type { Transaction } from "./types";
 import BigNumber from "bignumber.js";
 import { ChainAPI } from "./api";
-import {
-  getAccountMinimumBalanceForRentExemption,
-  getStakeAccountMinimumBalanceForRentExemption,
-} from "./api/chain/web3";
+import { getStakeAccountMinimumBalanceForRentExemption } from "./api/chain/web3";
 import { getMainAccount } from "../../account";
 import { estimateTxFee } from "./tx-fees";
 
+export const estimateFeeAndSpendable = async (
+  api: ChainAPI,
+  account: Account,
+  transaction?: Transaction | undefined | null,
+): Promise<{ fee: number; spendable: BigNumber }> => {
+  const txKind = transaction?.model.kind ?? "transfer";
+  const txFee = await estimateTxFee(api, account.freshAddress, txKind);
+
+  const spendableBalance = BigNumber.max(account.spendableBalance.minus(txFee), 0);
+
+  switch (txKind) {
+    case "token.createATA": {
+      const assocAccRentExempt = await api.getAssocTokenAccMinNativeBalance();
+
+      return {
+        fee: txFee + assocAccRentExempt,
+        spendable: BigNumber.max(spendableBalance.minus(assocAccRentExempt), 0),
+      };
+    }
+    case "stake.createAccount": {
+      const stakeAccRentExempt = await getStakeAccountMinimumBalanceForRentExemption(api);
+      const unstakeReserve =
+        (await estimateTxFee(api, account.freshAddress, "stake.undelegate")) +
+        (await estimateTxFee(api, account.freshAddress, "stake.withdraw"));
+
+      return {
+        fee: txFee + stakeAccRentExempt,
+        spendable: BigNumber.max(
+          spendableBalance.minus(stakeAccRentExempt).minus(unstakeReserve),
+          0,
+        ),
+      };
+    }
+
+    default: {
+      return {
+        fee: txFee,
+        spendable: spendableBalance,
+      };
+    }
+  }
+};
+
 const estimateMaxSpendableWithAPI = async (
   {
     account,
@@ -20,24 +60,8 @@ const estimateMaxSpendableWithAPI = async (
   const mainAccount = getMainAccount(account, parentAccount);
 
   switch (account.type) {
-    case "Account": {
-      const txKind = transaction?.model.kind ?? "transfer";
-      const txFee = await estimateTxFee(api, mainAccount, txKind);
-
-      switch (txKind) {
-        case "stake.createAccount": {
-          const stakeAccRentExempt = await getStakeAccountMinimumBalanceForRentExemption(api);
-          return BigNumber.max(account.spendableBalance.minus(txFee).minus(stakeAccRentExempt), 0);
-        }
-        default: {
-          const rentExemptMin = await getAccountMinimumBalanceForRentExemption(
-            api,
-            account.freshAddress,
-          );
-          return BigNumber.max(account.spendableBalance.minus(txFee).minus(rentExemptMin), 0);
-        }
-      }
-    }
+    case "Account":
+      return (await estimateFeeAndSpendable(api, mainAccount, transaction)).spendable;
     case "TokenAccount":
       return account.spendableBalance;
   }