Add executedSurplusFee to TwapOrders

safe-global · Jul 2, 2024 · 048e2c7 · 048e2c7
1 parent cba4fb4
commit 048e2c7
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 2 deletions.
diff --git a/src/routes/transactions/entities/confirmation-view/confirmation-view.entity.ts b/src/routes/transactions/entities/confirmation-view/confirmation-view.entity.ts
@@ -205,6 +205,13 @@ export class CowSwapTwapConfirmationView implements Baseline, TwapOrderInfo {
   })
   executedSellAmount: string | null;
 
+  @ApiPropertyOptional({
+    nullable: true,
+    description:
+      'The executed surplus fee raw amount (no decimals), or null if there are too many parts',
+  })
+  executedSurplusFee: string | null;
+
   @ApiPropertyOptional({
     nullable: true,
     description:
@@ -276,6 +283,7 @@ export class CowSwapTwapConfirmationView implements Baseline, TwapOrderInfo {
     buyAmount: string;
     executedSellAmount: string | null;
     executedBuyAmount: string | null;
+    executedSurplusFee: string | null;
     sellToken: TokenInfo;
     buyToken: TokenInfo;
     receiver: `0x${string}`;
@@ -298,6 +306,7 @@ export class CowSwapTwapConfirmationView implements Baseline, TwapOrderInfo {
     this.buyAmount = args.buyAmount;
     this.executedSellAmount = args.executedSellAmount;
     this.executedBuyAmount = args.executedBuyAmount;
+    this.executedSurplusFee = args.executedSurplusFee;
     this.sellToken = args.sellToken;
     this.buyToken = args.buyToken;
     this.receiver = args.receiver;

diff --git a/src/routes/transactions/entities/swaps/twap-order-info.entity.ts b/src/routes/transactions/entities/swaps/twap-order-info.entity.ts
@@ -41,6 +41,7 @@ export type TwapOrderInfo = {
   buyAmount: string;
   executedSellAmount: string | null;
   executedBuyAmount: string | null;
+  executedSurplusFee: string | null;
   sellToken: TokenInfo;
   buyToken: TokenInfo;
   receiver: `0x${string}`;
@@ -100,6 +101,13 @@ export class TwapOrderTransactionInfo
   })
   executedBuyAmount: string | null;
 
+  @ApiPropertyOptional({
+    nullable: true,
+    description:
+      'The executed surplus fee raw amount (no decimals), or null if there are too many parts',
+  })
+  executedSurplusFee: string | null;
+
   @ApiProperty({ description: 'The sell token of the TWAP' })
   sellToken: TokenInfo;
 
@@ -162,6 +170,7 @@ export class TwapOrderTransactionInfo
     buyAmount: string;
     executedSellAmount: string | null;
     executedBuyAmount: string | null;
+    executedSurplusFee: string | null;
     sellToken: TokenInfo;
     buyToken: TokenInfo;
     receiver: `0x${string}`;
@@ -183,6 +192,7 @@ export class TwapOrderTransactionInfo
     this.buyAmount = args.buyAmount;
     this.executedSellAmount = args.executedSellAmount;
     this.executedBuyAmount = args.executedBuyAmount;
+    this.executedSurplusFee = args.executedSurplusFee;
     this.sellToken = args.sellToken;
     this.buyToken = args.buyToken;
     this.receiver = args.receiver;

diff --git a/src/routes/transactions/mappers/common/twap-order.mapper.spec.ts b/src/routes/transactions/mappers/common/twap-order.mapper.spec.ts
@@ -140,6 +140,7 @@ describe('TwapOrderMapper', () => {
       },
       executedBuyAmount: '0',
       executedSellAmount: '0',
+      executedSurplusFee: '0',
       fullAppData,
       humanDescription: null,
       kind: 'sell',
@@ -203,7 +204,7 @@ describe('TwapOrderMapper', () => {
       executedSellAmount: '213586875483862141750',
       executedSellAmountBeforeFees: '213586875483862141750',
       executedFeeAmount: '0',
-      executedSurplusFee: '2135868754838621119',
+      executedSurplusFee: '111111111',
       invalidated: false,
       status: 'fulfilled',
       class: 'limit',
@@ -243,7 +244,7 @@ describe('TwapOrderMapper', () => {
       executedSellAmount: '213586875483862141750',
       executedSellAmountBeforeFees: '213586875483862141750',
       executedFeeAmount: '0',
-      executedSurplusFee: '2135868754838621123',
+      executedSurplusFee: '111111111',
       invalidated: false,
       status: 'fulfilled',
       class: 'limit',
@@ -320,6 +321,7 @@ describe('TwapOrderMapper', () => {
       },
       executedBuyAmount: '1379444631694674400',
       executedSellAmount: '427173750967724300000',
+      executedSurplusFee: '222222222',
       fullAppData,
       humanDescription: null,
       kind: 'sell',
@@ -455,6 +457,7 @@ describe('TwapOrderMapper', () => {
       },
       executedBuyAmount: null,
       executedSellAmount: null,
+      executedSurplusFee: null,
       fullAppData,
       humanDescription: null,
       kind: 'sell',

diff --git a/src/routes/transactions/mappers/common/twap-order.mapper.ts b/src/routes/transactions/mappers/common/twap-order.mapper.ts
@@ -119,6 +119,9 @@ export class TwapOrderMapper {
     const executedBuyAmount: TwapOrderInfo['executedBuyAmount'] =
       hasAbundantParts ? null : this.getExecutedBuyAmount(orders).toString();
 
+    const executedSurplusFee: TwapOrderInfo['executedSurplusFee'] =
+      hasAbundantParts ? null : this.getExecutedSurplusFee(orders).toString();
+
     const [sellToken, buyToken] = await Promise.all([
       this.swapOrderHelper.getToken({
         chainId,
@@ -139,6 +142,7 @@ export class TwapOrderMapper {
       buyAmount: twapOrderData.buyAmount,
       executedSellAmount,
       executedBuyAmount,
+      executedSurplusFee,
       sellToken: new TokenInfo({
         address: sellToken.address,
         decimals: sellToken.decimals,
@@ -211,6 +215,12 @@ export class TwapOrderMapper {
       return acc + Number(order.executedBuyAmount);
     }, 0);
   }
+
+  private getExecutedSurplusFee(orders: Array<KnownOrder>): number {
+    return orders.reduce((acc, order) => {
+      return acc + Number(order.executedSurplusFee);
+    }, 0);
+  }
 }
 
 @Module({

diff --git a/src/routes/transactions/transactions-view.service.ts b/src/routes/transactions/transactions-view.service.ts
@@ -198,6 +198,7 @@ export class TransactionsViewService {
       buyAmount: twapOrderData.buyAmount,
       executedSellAmount: '0',
       executedBuyAmount: '0',
+      executedSurplusFee: '0',
       sellToken: new TokenInfo({
         address: sellToken.address,
         decimals: sellToken.decimals,