Add context to generic Swap interpreter

anastasiarods · anastasiarods · commit 10083559afa4 · 2025-04-20T13:48:40.000+02:00
diff --git a/.changeset/sour-bikes-occur.md b/.changeset/sour-bikes-occur.md
@@ -0,0 +1,5 @@
+---
+'@3loop/transaction-interpreter': patch
+---
+
+Add context field to the intepreted swap transacitons
diff --git a/packages/transaction-interpreter/interpreters/1inch.ts b/packages/transaction-interpreter/interpreters/1inch.ts
@@ -1,29 +1,9 @@
-import { displayAsset, getNetTransfers, isSwap, defaultEvent } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
+import { genericSwapInterpreter } from './std.js'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
-  const newEvent = defaultEvent(event)
-
-  const netSent = getNetTransfers({
-    transfers: event.transfers,
-    fromAddresses: [event.fromAddress],
-  })
-
-  const netReceived = getNetTransfers({
-    transfers: event.transfers,
-    toAddresses: [event.fromAddress],
-  })
-
-  if (isSwap(event)) {
-    return {
-      ...newEvent,
-      type: 'swap',
-      action: 'Swapped ' + displayAsset(netSent[0]) + ' for ' + displayAsset(netReceived[0]),
-    }
-  }
-
-  return newEvent
+  return genericSwapInterpreter(event)
 }
 
 export const contracts = [
diff --git a/packages/transaction-interpreter/interpreters/aa.ts b/packages/transaction-interpreter/interpreters/aa.ts
@@ -1,16 +1,10 @@
-import {
-  assetsReceived,
-  assetsSent,
-  categorizedDefaultEvent,
-  displayAddress,
-  displayAsset,
-  toAssetTransfer,
-} from './std.js'
+import { assetsReceived, assetsSent, genericInterpreter, displayAddress, displayAsset, toAssetTransfer } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
-  const newEvent = categorizedDefaultEvent(event)
+  const newEvent = genericInterpreter(event)
+
   const userOpEvents = event.interactions.filter((e) => e.event.eventName === 'UserOperationEvent')
 
   if (newEvent.type !== 'unknown') {
diff --git a/packages/transaction-interpreter/interpreters/aerodrom.ts b/packages/transaction-interpreter/interpreters/aerodrom.ts
@@ -1,29 +1,9 @@
-import { displayAsset, getNetTransfers, isSwap, defaultEvent } from './std.js'
+import { genericSwapInterpreter } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
-  const newEvent = defaultEvent(event)
-
-  const netSent = getNetTransfers({
-    transfers: event.transfers,
-    fromAddresses: [event.fromAddress],
-  })
-
-  const netReceived = getNetTransfers({
-    transfers: event.transfers,
-    toAddresses: [event.fromAddress],
-  })
-
-  if (isSwap(event)) {
-    return {
-      ...newEvent,
-      type: 'swap',
-      action: 'Swapped ' + displayAsset(netSent[0]) + ' for ' + displayAsset(netReceived[0]),
-    }
-  }
-
-  return newEvent
+  return genericSwapInterpreter(event)
 }
 
 export const contracts = ['8453:0x6cb442acf35158d5eda88fe602221b67b400be3e']
diff --git a/packages/transaction-interpreter/interpreters/banana-gun.ts b/packages/transaction-interpreter/interpreters/banana-gun.ts
@@ -1,29 +1,9 @@
-import { displayAsset, getNetTransfers, isSwap, defaultEvent } from './std.js'
+import { genericSwapInterpreter } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
-  const newEvent = defaultEvent(event)
-
-  const netSent = getNetTransfers({
-    transfers: event.transfers,
-    fromAddresses: [event.fromAddress],
-  })
-
-  const netReceived = getNetTransfers({
-    transfers: event.transfers,
-    toAddresses: [event.fromAddress],
-  })
-
-  if (isSwap(event)) {
-    return {
-      ...newEvent,
-      type: 'swap',
-      action: 'Swapped ' + displayAsset(netSent[0]) + ' for ' + displayAsset(netReceived[0]),
-    }
-  }
-
-  return newEvent
+  return genericSwapInterpreter(event)
 }
 
 export const contracts = [
diff --git a/packages/transaction-interpreter/interpreters/erc1155.ts b/packages/transaction-interpreter/interpreters/erc1155.ts
@@ -1,10 +1,10 @@
-import { assetsReceived, assetsSent, categorizedDefaultEvent } from './std.js'
+import { assetsReceived, assetsSent, genericInterpreter } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
   const methodName = event.methodCall.name
-  const newEvent = categorizedDefaultEvent(event)
+  const newEvent = genericInterpreter(event)
 
   switch (methodName) {
     case 'setApprovalForAll': {
diff --git a/packages/transaction-interpreter/interpreters/erc20.ts b/packages/transaction-interpreter/interpreters/erc20.ts
@@ -1,10 +1,10 @@
-import { assetsReceived, assetsSent, formatNumber, categorizedDefaultEvent, displayAsset } from './std.js'
+import { assetsReceived, assetsSent, formatNumber, genericInterpreter, displayAsset } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
   const methodName = event.methodCall.name
-  const newEvent = categorizedDefaultEvent(event)
+  const newEvent = genericInterpreter(event)
 
   switch (methodName) {
     case 'approve': {
diff --git a/packages/transaction-interpreter/interpreters/erc721.ts b/packages/transaction-interpreter/interpreters/erc721.ts
@@ -1,10 +1,10 @@
-import { assetsReceived, assetsSent, categorizedDefaultEvent } from './std.js'
+import { assetsReceived, assetsSent, genericInterpreter } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
   const methodName = event.methodCall.name
-  const newEvent = categorizedDefaultEvent(event)
+  const newEvent = genericInterpreter(event)
 
   switch (methodName) {
     case 'approve': {
diff --git a/packages/transaction-interpreter/interpreters/fallback.ts b/packages/transaction-interpreter/interpreters/fallback.ts
@@ -1,9 +1,7 @@
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
-import { categorizedDefaultEvent } from './std.js'
+import { genericInterpreter } from './std.js'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
-  const newEvent = categorizedDefaultEvent(event)
-
-  return newEvent
+  return genericInterpreter(event)
 }
diff --git a/packages/transaction-interpreter/interpreters/gnosis-safe.ts b/packages/transaction-interpreter/interpreters/gnosis-safe.ts
@@ -1,9 +1,9 @@
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
-import { assetsSent, assetsReceived, categorizedDefaultEvent } from './std.js'
+import { assetsSent, assetsReceived, genericInterpreter } from './std.js'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
-  const newEvent = categorizedDefaultEvent(event)
+  const newEvent = genericInterpreter(event)
   const methodName = event.methodCall?.name
   const safeMultisigEvent = event.interactions.find((i) => i.event.eventName === 'SafeMultiSigTransaction')
   const successEvents = event.interactions.filter((i) => i.event.eventName === 'ExecutionSuccess')
diff --git a/packages/transaction-interpreter/interpreters/kyberswap.ts b/packages/transaction-interpreter/interpreters/kyberswap.ts
@@ -1,29 +1,9 @@
-import { displayAsset, getNetTransfers, isSwap, defaultEvent } from './std.js'
+import { genericSwapInterpreter } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
-  const newEvent = defaultEvent(event)
-
-  const netSent = getNetTransfers({
-    transfers: event.transfers,
-    fromAddresses: [event.fromAddress],
-  })
-
-  const netReceived = getNetTransfers({
-    transfers: event.transfers,
-    toAddresses: [event.fromAddress],
-  })
-
-  if (isSwap(event)) {
-    return {
-      ...newEvent,
-      type: 'swap',
-      action: 'Swapped ' + displayAsset(netSent[0]) + ' for ' + displayAsset(netReceived[0]),
-    }
-  }
-
-  return newEvent
+  return genericSwapInterpreter(event)
 }
 
 export const contracts = [
diff --git a/packages/transaction-interpreter/interpreters/metamaskRouter.ts b/packages/transaction-interpreter/interpreters/metamaskRouter.ts
@@ -1,29 +1,9 @@
-import { displayAsset, getNetTransfers, isSwap, defaultEvent } from './std.js'
+import { genericSwapInterpreter } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
-  const newEvent = defaultEvent(event)
-
-  const netSent = getNetTransfers({
-    transfers: event.transfers,
-    fromAddresses: [event.fromAddress],
-  })
-
-  const netReceived = getNetTransfers({
-    transfers: event.transfers,
-    toAddresses: [event.fromAddress],
-  })
-
-  if (isSwap(event)) {
-    return {
-      ...newEvent,
-      type: 'swap',
-      action: 'Swapped ' + displayAsset(netSent[0]) + ' for ' + displayAsset(netReceived[0]),
-    }
-  }
-
-  return newEvent
+  return genericSwapInterpreter(event)
 }
 
 export const contracts = ['1:0x881D40237659C251811CEC9c364ef91dC08D300C']
diff --git a/packages/transaction-interpreter/interpreters/moxie.ts b/packages/transaction-interpreter/interpreters/moxie.ts
@@ -2,7 +2,7 @@ import {
   displayAsset,
   formatNumber,
   NULL_ADDRESS,
-  categorizedDefaultEvent,
+  genericInterpreter,
   toAssetTransfer,
   assetsSent,
   assetsReceived,
@@ -22,7 +22,7 @@ import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
   const methodName = event.methodCall.name
-  const newEvent = categorizedDefaultEvent(event)
+  const newEvent = genericInterpreter(event)
   const { assetsMinted, assetsBurned } = newEvent
 
   const purchaseOrSaleEvent = event.interactions.find(
diff --git a/packages/transaction-interpreter/interpreters/okx.ts b/packages/transaction-interpreter/interpreters/okx.ts
@@ -1,29 +1,9 @@
-import { displayAsset, getNetTransfers, isSwap, defaultEvent } from './std.js'
+import { genericSwapInterpreter } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
-  const newEvent = defaultEvent(event)
-
-  const netSent = getNetTransfers({
-    transfers: event.transfers,
-    fromAddresses: [event.fromAddress],
-  })
-
-  const netReceived = getNetTransfers({
-    transfers: event.transfers,
-    toAddresses: [event.fromAddress],
-  })
-
-  if (isSwap(event)) {
-    return {
-      ...newEvent,
-      type: 'swap',
-      action: 'Swapped ' + displayAsset(netSent[0]) + ' for ' + displayAsset(netReceived[0]),
-    }
-  }
-
-  return newEvent
+  return genericSwapInterpreter(event)
 }
 
 export const contracts = [
diff --git a/packages/transaction-interpreter/interpreters/pendle.ts b/packages/transaction-interpreter/interpreters/pendle.ts
@@ -1,29 +1,9 @@
-import { displayAsset, getNetTransfers, isSwap, defaultEvent } from './std.js'
+import { genericSwapInterpreter } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
-  const newEvent = defaultEvent(event)
-
-  const netSent = getNetTransfers({
-    transfers: event.transfers,
-    fromAddresses: [event.fromAddress],
-  })
-
-  const netReceived = getNetTransfers({
-    transfers: event.transfers,
-    toAddresses: [event.fromAddress],
-  })
-
-  if (isSwap(event)) {
-    return {
-      ...newEvent,
-      type: 'swap',
-      action: 'Swapped ' + displayAsset(netSent[0]) + ' for ' + displayAsset(netReceived[0]),
-    }
-  }
-
-  return newEvent
+  return genericSwapInterpreter(event)
 }
 
 export const contracts = [
diff --git a/packages/transaction-interpreter/interpreters/rainbow.ts b/packages/transaction-interpreter/interpreters/rainbow.ts
@@ -1,28 +1,9 @@
-import { displayAsset, getNetTransfers, defaultEvent } from './std.js'
+import { genericSwapInterpreter } from './std.js'
 import type { InterpretedTransaction } from '@/types.js'
 import type { DecodedTransaction } from '@3loop/transaction-decoder'
 
 export function transformEvent(event: DecodedTransaction): InterpretedTransaction {
-  const newEvent = defaultEvent(event)
-
-  const netSent = getNetTransfers({
-    transfers: event.transfers,
-    fromAddresses: [event.fromAddress],
-  })
-
-  const netReceived = getNetTransfers({
-    transfers: event.transfers,
-    toAddresses: [event.fromAddress],
-  })
-
-  if (netSent.length === 1 && netReceived.length === 1) {
-    return {
-      ...newEvent,
-      type: 'swap',
-      action: 'Swapped ' + displayAsset(netSent[0]) + ' for ' + displayAsset(netReceived[0]),
-    }
-  }
-  return newEvent
+  return genericSwapInterpreter(event)
 }
 
 export const contracts = ['8453:0x00000000009726632680FB29d3F7A9734E3010E2']
diff --git a/packages/transaction-interpreter/interpreters/std.ts b/packages/transaction-interpreter/interpreters/std.ts
diff --git a/packages/transaction-interpreter/interpreters/uniswapv3.ts b/packages/transaction-interpreter/interpreters/uniswapv3.ts
diff --git a/packages/transaction-interpreter/interpreters/zeroEx.ts b/packages/transaction-interpreter/interpreters/zeroEx.ts
diff --git a/packages/transaction-interpreter/src/types.ts b/packages/transaction-interpreter/src/types.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@3loop/transaction-interpreter': patch
 +---
++
 +Add context field to the intepreted swap transacitons