Streaming and missing parameters for QuoteSwap type

Author: 0xp3gasus

packages/xchain-mayachain-amm/src/mayachain-amm.ts

@@ -73,6 +73,8 @@ export class MayachainAMM {
     affiliateAddress,
     affiliateBps,
     toleranceBps,
+    streamingInterval,
+    streamingQuantity,
   }: QuoteSwapParams): Promise<QuoteSwap> {
     const errors = await this.validateSwap({
       fromAsset,
@@ -82,6 +84,8 @@ export class MayachainAMM {
       destinationAddress,
       affiliateAddress,
       affiliateBps,
+      streamingInterval,
+      streamingQuantity,
     })
 
     if (errors.length > 0) {
@@ -94,6 +98,8 @@ export class MayachainAMM {
           asset: destinationAsset,
           affiliateFee: new CryptoAmount(baseAmount(0), destinationAsset),
           outboundFee: new CryptoAmount(baseAmount(0), destinationAsset),
+          liquidityFee: new CryptoAmount(baseAmount(0), destinationAsset),
+          totalFee: new CryptoAmount(baseAmount(0), destinationAsset),
         },
         outboundDelayBlocks: 0,
         outboundDelaySeconds: 0,
@@ -103,6 +109,7 @@ export class MayachainAMM {
         errors,
         slipBasisPoints: 0,
         totalSwapSeconds: 0,
+        expiry: 0,
         warning: '',
       }
     }
@@ -116,6 +123,8 @@ export class MayachainAMM {
       affiliateAddress,
       affiliateBps,
       toleranceBps,
+      streamingInterval,
+      streamingQuantity,
     })
   }
 
@@ -133,6 +142,8 @@ export class MayachainAMM {
     amount,
     affiliateAddress,
     affiliateBps,
+    streamingInterval,
+    streamingQuantity,
   }: QuoteSwapParams): Promise<string[]> {
     const errors: string[] = []
 
@@ -168,6 +179,14 @@ export class MayachainAMM {
       errors.push(...approveErrors)
     }
 
+    if (streamingQuantity && streamingQuantity < 0) {
+      errors.push('streaming quantity can not be lower than 0')
+    }
+
+    if (streamingInterval && streamingInterval < 0) {
+      errors.push('streaming interval can not be lower than 0')
+    }
+
     return errors
   }
 

packages/xchain-mayachain-query/src/mayachain-query.ts

@@ -128,15 +128,27 @@ export class MayachainQuery {
             baseAmount(0, toAssetString === assetToString(CacaoAsset) ? 10 : 8),
             destinationAsset,
           ),
+          liquidityFee: new CryptoAmount(
+            baseAmount(0, toAssetString === assetToString(CacaoAsset) ? 10 : 8),
+            destinationAsset,
+          ),
+          totalFee: new CryptoAmount(
+            baseAmount(0, toAssetString === assetToString(CacaoAsset) ? 10 : 8),
+            destinationAsset,
+          ),
         },
         outboundDelayBlocks: 0,
         outboundDelaySeconds: 0,
         inboundConfirmationSeconds: 0,
         inboundConfirmationBlocks: 0,
         canSwap: false,
         errors: [`Mayanode request quote: ${response.error}`],
+        expiry: 0,
         slipBasisPoints: 0,
         totalSwapSeconds: 0,
+        streamingSwapSeconds: 0,
+        streamingSwapBlocks: 0,
+        maxStreamingQuantity: 0,
         warning: '',
       }
     }
@@ -159,13 +171,26 @@ export class MayachainQuery {
         asset: feeAsset,
         affiliateFee: new CryptoAmount(baseAmount(swapQuote.fees.affiliate, isFeeAssetCacao ? 10 : 8), feeAsset),
         outboundFee: new CryptoAmount(baseAmount(swapQuote.fees.outbound, isFeeAssetCacao ? 10 : 8), feeAsset),
+        liquidityFee: new CryptoAmount(baseAmount(swapQuote.fees.liquidity, isFeeAssetCacao ? 10 : 8), feeAsset),
+        totalFee: new CryptoAmount(baseAmount(swapQuote.fees.total, isFeeAssetCacao ? 10 : 8), feeAsset),
       },
+      expiry: swapQuote.expiry,
+      recommendedMinAmountIn: new CryptoAmount(
+        baseAmount(swapQuote.recommended_min_amount_in || '0', eqAsset(fromAsset, CacaoAsset) ? 10 : 8),
+        fromAsset,
+      ),
+      router: swapQuote.router,
+      recommendedGasRate: swapQuote.recommended_gas_rate,
+      gasRateUnits: swapQuote.gas_rate_units,
       slipBasisPoints: swapQuote.fees.slippage_bps,
       outboundDelayBlocks: swapQuote.outbound_delay_blocks,
       outboundDelaySeconds: swapQuote.outbound_delay_seconds,
       inboundConfirmationSeconds: swapQuote.inbound_confirmation_seconds,
       inboundConfirmationBlocks: swapQuote.inbound_confirmation_blocks,
-      totalSwapSeconds: (swapQuote.inbound_confirmation_seconds || 0) + swapQuote.outbound_delay_seconds,
+      maxStreamingQuantity: swapQuote.max_streaming_quantity,
+      streamingSwapBlocks: swapQuote.streaming_swap_blocks,
+      streamingSwapSeconds: swapQuote.streaming_swap_seconds,
+      totalSwapSeconds: swapQuote.total_swap_seconds || 0,
       canSwap: !(!swapQuote.memo || errors.length > 0),
       errors,
       warning: '',

packages/xchain-mayachain-query/src/types.ts

@@ -9,6 +9,14 @@ export type Fees = {
   asset: Asset // The asset for which fees are calculated
   affiliateFee: CryptoAmount // The affiliate fee amount
   outboundFee: CryptoAmount // The outbound fee amount
+  /**
+   * The liquidity fees paid to pools
+   */
+  liquidityFee: CryptoAmount
+  /**
+   * Total fees
+   */
+  totalFee: CryptoAmount
 }
 
 /**
@@ -26,6 +34,38 @@ export type QuoteSwap = {
   outboundDelayBlocks: number // The outbound delay time in blocks
   totalSwapSeconds: number // The total time for the swap operation
   slipBasisPoints: number // The slip basis points for the swap
+  /**
+   * The EVM chain router contract address
+   */
+  router?: string
+  /**
+   * Expiration timestamp in unix seconds
+   */
+  expiry: number
+  /**
+   * The recommended minimum inbound amount for this transaction type & inbound asset. Sending less than this amount could result in failed refunds.
+   */
+  recommendedMinAmountIn?: CryptoAmount
+  /**
+   * The recommended gas rate to use for the inbound to ensure timely confirmation
+   */
+  recommendedGasRate?: string
+  /**
+   * The units of the recommended gas rate
+   */
+  gasRateUnits?: string
+  /**
+   * The maximum amount of trades a streaming swap can do for a trade
+   */
+  streamingSwapSeconds?: number
+  /**
+   * The number of blocks the streaming swap will execute over
+   */
+  streamingSwapBlocks?: number
+  /**
+   * Approx the number of seconds the streaming swap will execute over
+   */
+  maxStreamingQuantity?: number
   canSwap: boolean // Indicates whether the swap can be performed
   errors: string[] // Any errors encountered during the swap operation
   warning: string // Any warning messages associated with the swap