Merge pull request #1764 from xchainjs/fix/oneclick-affiliate-fee

fix(aggregator): populate OneClick affiliateFee from appFees

Author: underthesun49

.changeset/oneclick-affiliate-fee.md

@@ -0,0 +1,5 @@
+---
+'@xchainjs/xchain-aggregator': patch
+---
+
+Fix OneClick estimateSwap to populate fees.affiliateFee from echoed quoteRequest.appFees (falling back to configured affiliateBps) instead of always returning 0

packages/xchain-aggregator/__tests__/oneclickProtocol.test.ts

@@ -284,6 +284,129 @@ describe('OneClick protocol', () => {
       const parsed = JSON.parse(capturedBody!)
       expect(parsed.dry).toBe(true)
     })
+
+    it('should populate affiliateFee from echoed quoteRequest.appFees matching affiliate address', async () => {
+      const affiliateAddress = 'bc1qydqk2n5wwm2ugg05tv482w8p42734gft0ssze8'
+      protocol = new OneClickProtocol({
+        affiliateAddress,
+        affiliateBps: 30,
+      })
+
+      let capturedBody: string | undefined
+      mockFetch.mockImplementation((url: string, options?: RequestInit) => {
+        if (url.includes('/v0/tokens')) {
+          return Promise.resolve({ ok: true, json: () => Promise.resolve(mockTokens) })
+        }
+        if (url.includes('/v0/quote')) {
+          capturedBody = options?.body as string
+          return Promise.resolve({
+            ok: true,
+            json: () =>
+              Promise.resolve({
+                quoteRequest: {
+                  appFees: [
+                    { recipient: affiliateAddress, fee: 15 },
+                    { recipient: '5880ad2b362620fadf759cbceb1cd5737ce8c6ed7fb8e9942881e6731f9247dd', fee: 25 },
+                  ],
+                },
+                quote: {
+                  depositAddress: 'bc1qfakedeposit',
+                  amountOut: '99000',
+                  timeEstimate: 600,
+                },
+              }),
+          })
+        }
+        return Promise.resolve({ ok: false, status: 404 })
+      })
+
+      // 1 ETH = 1e18 base units; echoed fee 15 bps → 1e18 * 15 / 10000 = 1.5e15
+      const quote = await protocol.estimateSwap({
+        fromAsset: AssetETH,
+        destinationAsset: AssetBTC,
+        amount: new CryptoAmount(assetToBase(assetAmount(1, 18)), AssetETH),
+        fromAddress: '0xSender',
+        destinationAddress: 'bc1qRecipient',
+      })
+
+      const parsed = JSON.parse(capturedBody!)
+      expect(parsed.appFees).toEqual([{ recipient: affiliateAddress, fee: 30 }])
+      expect(quote.fees.affiliateFee.baseAmount.amount().toString()).toBe('1500000000000000')
+      expect(assetToString(quote.fees.affiliateFee.asset)).toBe('ETH.ETH')
+      expect(quote.fees.affiliateFee.baseAmount.decimal).toBe(18)
+    })
+
+    it('should fall back to configured affiliateBps when quoteRequest.appFees is absent', async () => {
+      const affiliateAddress = 'bc1qydqk2n5wwm2ugg05tv482w8p42734gft0ssze8'
+      protocol = new OneClickProtocol({
+        affiliateAddress,
+        affiliateBps: 30,
+      })
+
+      mockFetch.mockImplementation((url: string) => {
+        if (url.includes('/v0/tokens')) {
+          return Promise.resolve({ ok: true, json: () => Promise.resolve(mockTokens) })
+        }
+        if (url.includes('/v0/quote')) {
+          return Promise.resolve({
+            ok: true,
+            json: () =>
+              Promise.resolve({
+                quote: {
+                  depositAddress: 'bc1qfakedeposit',
+                  amountOut: '99000',
+                  timeEstimate: 600,
+                },
+              }),
+          })
+        }
+        return Promise.resolve({ ok: false, status: 404 })
+      })
+
+      // 1 BTC = 1e8 sats; 30 bps → 1e8 * 30 / 10000 = 300000
+      const quote = await protocol.estimateSwap({
+        fromAsset: AssetBTC,
+        destinationAsset: AssetETH,
+        amount: new CryptoAmount(assetToBase(assetAmount(1, 8)), AssetBTC),
+        fromAddress: 'bc1qSender',
+        destinationAddress: '0xRecipient',
+      })
+
+      expect(quote.fees.affiliateFee.baseAmount.amount().toString()).toBe('300000')
+      expect(assetToString(quote.fees.affiliateFee.asset)).toBe('BTC.BTC')
+    })
+
+    it('should leave affiliateFee at 0 when no affiliate is configured', async () => {
+      mockFetch.mockImplementation((url: string) => {
+        if (url.includes('/v0/tokens')) {
+          return Promise.resolve({ ok: true, json: () => Promise.resolve(mockTokens) })
+        }
+        if (url.includes('/v0/quote')) {
+          return Promise.resolve({
+            ok: true,
+            json: () =>
+              Promise.resolve({
+                quote: {
+                  depositAddress: 'bc1qfakedeposit',
+                  amountOut: '99000',
+                  timeEstimate: 600,
+                },
+              }),
+          })
+        }
+        return Promise.resolve({ ok: false, status: 404 })
+      })
+
+      const quote = await protocol.estimateSwap({
+        fromAsset: AssetETH,
+        destinationAsset: AssetBTC,
+        amount: new CryptoAmount(assetToBase(assetAmount(1, 18)), AssetETH),
+        fromAddress: '0xSender',
+        destinationAddress: 'bc1qRecipient',
+      })
+
+      expect(quote.fees.affiliateFee.baseAmount.amount().toString()).toBe('0')
+    })
   })
 
   describe('doSwap', () => {

packages/xchain-aggregator/src/protocols/oneclick/oneclickProtocol.ts

@@ -23,7 +23,7 @@ import {
 } from '../../types'
 
 import { OneClickApi } from './api'
-import { CompatibleAsset, OneClickToken } from './types'
+import { CompatibleAsset, OneClickQuoteResponse, OneClickToken } from './types'
 import { findOneClickToken, oneClickBlockchainToXChain } from './utils'
 
 export class OneClickProtocol implements IProtocol {
@@ -123,7 +123,7 @@ export class OneClickProtocol implements IProtocol {
         slipBasisPoints: 0,
         fees: {
           asset: params.fromAsset,
-          affiliateFee: new CryptoAmount(baseAmount(0), params.fromAsset),
+          affiliateFee: this.buildAffiliateFee(params, resp),
           outboundFee: new CryptoAmount(baseAmount(0), params.destinationAsset),
         },
       }
@@ -132,6 +132,28 @@ export class OneClickProtocol implements IProtocol {
     }
   }
 
+  /**
+   * Resolve affiliate bps from echoed quoteRequest.appFees (matching our recipient),
+   * falling back to the configured affiliateBps when appFees were sent.
+   * Fee is charged from the input asset: amountIn * bps / 10000.
+   */
+  private resolveAffiliateFeeBps(resp: OneClickQuoteResponse): number | undefined {
+    const echoed = resp.quoteRequest?.appFees?.find((fee) => fee.recipient === this.affiliateAddress)
+    if (echoed != null && Number.isFinite(echoed.fee)) return echoed.fee
+    if (this.affiliateAddress && this.affiliateBps) return this.affiliateBps
+    return undefined
+  }
+
+  private buildAffiliateFee(params: QuoteSwapParams, resp: OneClickQuoteResponse): CryptoAmount {
+    const decimals = params.amount.baseAmount.decimal
+    const feeBps = this.resolveAffiliateFeeBps(resp)
+    if (!feeBps) {
+      return new CryptoAmount(baseAmount(0, decimals), params.fromAsset)
+    }
+    const feeAmount = params.amount.baseAmount.amount().multipliedBy(feeBps).dividedToIntegerBy(10000)
+    return new CryptoAmount(baseAmount(feeAmount, decimals), params.fromAsset)
+  }
+
   public async doSwap(params: QuoteSwapParams): Promise<TxSubmitted> {
     const quoteSwap = await this.estimateSwap(params)
     if (!quoteSwap.canSwap) {

packages/xchain-aggregator/src/protocols/oneclick/types.ts

@@ -12,6 +12,11 @@ export type OneClickToken = {
   priceUpdatedAt?: string
 }
 
+export type OneClickAppFee = {
+  recipient: string
+  fee: number
+}
+
 export type OneClickQuoteRequest = {
   dry?: boolean
   swapType: 'EXACT_INPUT'
@@ -25,7 +30,7 @@ export type OneClickQuoteRequest = {
   recipient: string
   slippageTolerance?: number
   deadline?: string
-  appFees?: { recipient: string; fee: number }[]
+  appFees?: OneClickAppFee[]
 }
 
 export type OneClickQuoteInner = {
@@ -37,6 +42,8 @@ export type OneClickQuoteInner = {
 
 export type OneClickQuoteResponse = {
   quote: OneClickQuoteInner
+  /** Echo of the request; used to resolve applied appFees after server-side splits. */
+  quoteRequest?: Pick<OneClickQuoteRequest, 'appFees'>
   error?: string
   message?: string
   statusCode?: number