Add minReceiveAmount to EdgeSwapQuote

EdgeApp · Sep 11, 2024 · 44624fd · 44624fd
1 parent 80c0fc0
commit 44624fd
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- added: `minReceiveAmount` to `EdgeSwapQuote` - the minimum amount that can be received from the swap
+
 ## 2.15.0 (2024-09-06)
 
 - added: `EdgeContext.fetchChallenge`, to request an account-creation CAPTCHA.

diff --git a/src/core/swap/swap-api.ts b/src/core/swap/swap-api.ts
@@ -126,6 +126,7 @@ function wrapQuote(
     request: quote.request ?? request,
     swapInfo: quote.swapInfo ?? swapPlugins[quote.pluginId].swapInfo,
     toNativeAmount: quote.toNativeAmount,
+    minReceiveAmount: quote.minReceiveAmount,
 
     async approve(opts) {
       return await quote.approve(opts)

diff --git a/src/types/types.ts b/src/types/types.ts
@@ -792,7 +792,6 @@ export interface EdgeGetTransactionsOptions {
   startDate?: Date
   endDate?: Date
   searchString?: string
-  spamThreshold?: string
   tokenId: EdgeTokenId
 }
 
@@ -818,9 +817,6 @@ export interface EdgeStreamTransactionOptions {
   /** Only return transactions matching this string */
   searchString?: string
 
-  /** Filter incoming transactions with a `nativeAmount` below this */
-  spamThreshold?: string
-
   /** The token to query, or undefined for the main currency */
   tokenId: EdgeTokenId
 }
@@ -1349,6 +1345,10 @@ export interface EdgeSwapQuote {
    * Maximum amount of time this quote will take to be fulfilled (in seconds)
    */
   readonly maxFulfillmentSeconds?: number
+
+  /** Worst-case receive amount */
+  readonly minReceiveAmount?: string
+
   readonly fromNativeAmount: string
   readonly toNativeAmount: string
   readonly networkFee: EdgeNetworkFee