Merge pull request #18 from balancer/swap-fee-breakdown

breakdown swap fee amounts
balancer · Feb 11, 2025 · ae83cfc · ae83cfc
2 parents 18b09d8 + 30b8f43
commit ae83cfc
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 3 deletions.
diff --git a/subgraphs/v3-vault/schema.graphql b/subgraphs/v3-vault/schema.graphql
@@ -153,6 +153,10 @@ type PoolToken @entity {
   volume: BigDecimal!
   "Total swap fees collected for this token"
   totalSwapFee: BigDecimal!
+  "Total base swap fees collected using static swap fee"
+  totalSwapFeeBase: BigDecimal!
+  "Total difference in swap fees collected due to dynamic fees"
+  totalSwapFeeDelta: BigDecimal!
   "Total static swap fees collected for this token"
   totalStaticSwapFee: BigDecimal!
   "Total dynamic swap fees collected for this token"
@@ -250,6 +254,10 @@ type Swap @entity(immutable: true) {
   swapFeeToken: Bytes!
   "Amount of swap fees"
   swapFeeAmount: BigDecimal!
+  "Base fee amount calculated using static swap fee"
+  swapFeeBaseAmount: BigDecimal!
+  "Difference between actual fee amount and base fee amount due to dynamic fees"
+  swapFeeDeltaAmount: BigDecimal!
   "Swap fee percentage"
   swapFeePercentage: BigDecimal!
   "Indicates whether the swap fee is dynamic"

diff --git a/subgraphs/v3-vault/src/helpers/entities.ts b/subgraphs/v3-vault/src/helpers/entities.ts
@@ -135,6 +135,8 @@ export function createPoolToken(
   poolToken.balance = ZERO_BD;
   poolToken.volume = ZERO_BD;
   poolToken.totalSwapFee = ZERO_BD;
+  poolToken.totalSwapFeeBase = ZERO_BD;
+  poolToken.totalSwapFeeDelta = ZERO_BD;
   poolToken.totalStaticSwapFee = ZERO_BD;
   poolToken.totalDynamicSwapFee = ZERO_BD;
   poolToken.totalProtocolSwapFee = ZERO_BD;

diff --git a/subgraphs/v3-vault/src/mappings/vault.ts b/subgraphs/v3-vault/src/mappings/vault.ts
@@ -310,6 +310,15 @@ export function handleSwap(event: SwapEvent): void {
     swapFeeToken.decimals
   );
 
+  let hasDynamicSwapFee = pool.swapFee != swap.swapFeePercentage;
+  let swapFeeBaseAmount = swapFeeAmount;
+  let swapFeeDeltaAmount = ZERO_BD;
+  if (hasDynamicSwapFee) {
+    let swapFeeDelta = swap.swapFeePercentage.minus(pool.swapFee);
+    swapFeeBaseAmount = tokenAmountIn.times(pool.swapFee);
+    swapFeeDeltaAmount = tokenAmountIn.times(swapFeeDelta);
+  }
+
   swap.pool = event.params.pool;
   swap.tokenIn = event.params.tokenIn;
   swap.tokenInSymbol = tokenIn.symbol;
@@ -318,11 +327,12 @@ export function handleSwap(event: SwapEvent): void {
   swap.tokenOutSymbol = tokenOut.symbol;
   swap.tokenAmountOut = tokenAmountOut;
   swap.swapFeeAmount = swapFeeAmount;
+  swap.swapFeeBaseAmount = swapFeeBaseAmount;
+  swap.swapFeeDeltaAmount = swapFeeDeltaAmount;
   swap.swapFeeToken = event.params.tokenIn;
   swap.swapFeePercentage = scaleDown(event.params.swapFeePercentage, 18);
-  swap.hasDynamicSwapFee = pool.swapFee != swap.swapFeePercentage;
+  swap.hasDynamicSwapFee = hasDynamicSwapFee;
   swap.user = event.transaction.from;
-
   swap.logIndex = event.logIndex;
   swap.blockNumber = event.block.number;
   swap.blockTimestamp = event.block.timestamp;
@@ -357,9 +367,13 @@ export function handleSwap(event: SwapEvent): void {
     aggregateSwapFeeAmount
   );
 
-  if (swap.hasDynamicSwapFee) {
+  if (hasDynamicSwapFee) {
     poolTokenIn.totalDynamicSwapFee =
       poolTokenIn.totalDynamicSwapFee.plus(swapFeeAmount);
+    poolTokenIn.totalSwapFeeBase =
+      poolTokenIn.totalSwapFeeBase.plus(swapFeeBaseAmount);
+    poolTokenIn.totalSwapFeeDelta =
+      poolTokenIn.totalSwapFeeDelta.plus(swapFeeDeltaAmount);
   } else {
     poolTokenIn.totalStaticSwapFee =
       poolTokenIn.totalStaticSwapFee.plus(swapFeeAmount);