Merge branch 'main' into jophish/knip-diff

valora-inc · Nov 7, 2023 · 8d70c87 · 8d70c87
2 parents ecfa755 + 41eae07
commit 8d70c87
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 2 deletions.
diff --git a/src/swap/useSwapQuote.ts b/src/swap/useSwapQuote.ts
@@ -103,6 +103,8 @@ export async function prepareSwapTransactions(
     spendTokenAmount: new BigNumber(amountToApprove.toString()),
     decreasedAmountGasFeeMultiplier: DECREASED_SWAP_AMOUNT_GAS_FEE_MULTIPLIER,
     baseTransactions,
+    // We still want to prepare the transactions even if the user doesn't have enough balance
+    throwOnSpendTokenAmountExceedsBalance: false,
   })
 }
 

diff --git a/src/viem/prepareTransactions.test.ts b/src/viem/prepareTransactions.test.ts
@@ -116,6 +116,31 @@ describe('prepareTransactions module', () => {
         })
       ).rejects.toThrowError(/Cannot prepareTransactions for amount greater than balance./)
     })
+    it('does not throw if trying to sendAmount > sendToken balance when throwOnSpendTokenAmountExceedsBalance is false', async () => {
+      mocked(estimateFeesPerGas).mockResolvedValue({
+        maxFeePerGas: BigInt(100),
+        maxPriorityFeePerGas: BigInt(2),
+      })
+      mockPublicClient.estimateGas.mockResolvedValue(BigInt(1_000))
+
+      await expect(
+        prepareTransactions({
+          feeCurrencies: mockFeeCurrencies,
+          spendToken: mockSpendToken,
+          spendTokenAmount: new BigNumber(51_000),
+          decreasedAmountGasFeeMultiplier: 1,
+          baseTransactions: [
+            {
+              from: '0xfrom' as Address,
+              to: '0xto' as Address,
+              data: '0xdata',
+              type: 'cip42',
+            },
+          ],
+          throwOnSpendTokenAmountExceedsBalance: false,
+        })
+      ).resolves.toEqual(expect.anything())
+    })
     it("returns a 'not-enough-balance-for-gas' result when the balances for feeCurrencies are too low to cover the fee", async () => {
       mocked(estimateFeesPerGas).mockResolvedValue({
         maxFeePerGas: BigInt(100),

diff --git a/src/viem/prepareTransactions.ts b/src/viem/prepareTransactions.ts
@@ -172,28 +172,34 @@ export async function tryEstimateTransactions(
  * Adds "maxFeePerGas" and "maxPriorityFeePerGas" fields to base transactions. Adds "gas" field to base
  *  transactions if they do not already include them.
  *
- * NOTE: throws if spendTokenAmount exceeds the user's balance of that token.
+ * NOTE: throws if spendTokenAmount exceeds the user's balance of that token, unless throwOnSpendTokenAmountExceedsBalance is false
  *
  * @param feeCurrencies
  * @param spendToken
  * @param spendTokenAmount
  * @param decreasedAmountGasFeeMultiplier
  * @param baseTransactions
+ * @param throwOnSpendTokenAmountExceedsBalance
  */
 export async function prepareTransactions({
   feeCurrencies,
   spendToken,
   spendTokenAmount,
   decreasedAmountGasFeeMultiplier,
   baseTransactions,
+  throwOnSpendTokenAmountExceedsBalance = true,
 }: {
   feeCurrencies: TokenBalance[]
   spendToken: TokenBalanceWithAddress
   spendTokenAmount: BigNumber
   decreasedAmountGasFeeMultiplier: number
   baseTransactions: (TransactionRequestCIP42 & { gas?: bigint })[]
+  throwOnSpendTokenAmountExceedsBalance?: boolean
 }): Promise<PreparedTransactionsResult> {
-  if (spendTokenAmount.isGreaterThan(spendToken.balance.shiftedBy(spendToken.decimals))) {
+  if (
+    throwOnSpendTokenAmountExceedsBalance &&
+    spendTokenAmount.isGreaterThan(spendToken.balance.shiftedBy(spendToken.decimals))
+  ) {
     throw new Error(
       `Cannot prepareTransactions for amount greater than balance. Amount: ${spendTokenAmount}, Balance: ${spendToken.balance}, Decimals: ${spendToken.decimals}`
     )