Merge pull request #407 from Once-Upon/feature/ou-2726-update-make-tr…

…ansformations-logs-and-contextualizations Update make transformations logs and contextualizations
Once-Upon · Jul 31, 2024 · 66b0d3f · 66b0d3f
2 parents d82f721 + 43b975b
commit 66b0d3f
Show file tree

Hide file tree

Showing 38 changed files with 4,668 additions and 112 deletions.
diff --git a/src/contextualizers/bridges/acrossProtocol/destination.ts b/src/contextualizers/bridges/acrossProtocol/destination.ts
@@ -10,7 +10,7 @@ import {
   ACROSS_PROTOCOL_RELAYER_ABI,
   ACROSS_PROTOCOL_RELAYERS,
 } from './constants';
-import { decodeLog } from '../../../helpers/utils';
+import { decodeLog, grabLogsFromTransaction } from '../../../helpers/utils';
 
 export function contextualize(transaction: Transaction): Transaction {
   const isAcrossProtocol = detect(transaction);
@@ -28,7 +28,7 @@ export function detect(transaction: Transaction): boolean {
    * and it also serves to decouple the logic, thereby simplifying the testing process
    */
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   const filledRelayLog = logs.find((log: Log) => {
     if (log.address !== ACROSS_PROTOCOL_RELAYERS[originChainId]) return false;
 
@@ -50,7 +50,7 @@ export function detect(transaction: Transaction): boolean {
 
 export function generate(transaction: Transaction): Transaction {
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   let filledRelayEvent;
   const filledRelayLog = logs.find((log: Log) => {
     if (log.address !== ACROSS_PROTOCOL_RELAYERS[originChainId]) return false;

diff --git a/src/contextualizers/bridges/acrossProtocol/source.ts b/src/contextualizers/bridges/acrossProtocol/source.ts
@@ -10,7 +10,7 @@ import {
   ACROSS_PROTOCOL_RELAYER_ABI,
   ACROSS_PROTOCOL_RELAYERS,
 } from './constants';
-import { decodeLog } from '../../../helpers/utils';
+import { decodeLog, grabLogsFromTransaction } from '../../../helpers/utils';
 
 export function contextualize(transaction: Transaction): Transaction {
   const isAcrossProtocol = detect(transaction);
@@ -28,7 +28,7 @@ export function detect(transaction: Transaction): boolean {
    * and it also serves to decouple the logic, thereby simplifying the testing process
    */
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   const fundsDepositedLog = logs.find((log: Log) => {
     if (log.address !== ACROSS_PROTOCOL_RELAYERS[originChainId]) return false;
 
@@ -51,7 +51,7 @@ export function detect(transaction: Transaction): boolean {
 
 export function generate(transaction: Transaction): Transaction {
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   let fundsDepositedEvent;
   const fundsDepositedLog = logs.find((log: Log) => {
     if (log.address !== ACROSS_PROTOCOL_RELAYERS[originChainId]) return false;

diff --git a/src/contextualizers/bridges/hopTransferToL1/destination.ts b/src/contextualizers/bridges/hopTransferToL1/destination.ts
@@ -6,7 +6,7 @@ import {
   Transaction,
 } from '../../../types';
 import { HOP_WITHDRAWAL_BONDED_EVENT_ABI, HOP_RELAYERS } from './constants';
-import { decodeLog } from '../../../helpers/utils';
+import { decodeLog, grabLogsFromTransaction } from '../../../helpers/utils';
 
 export function contextualize(transaction: Transaction): Transaction {
   const isHopTransferToL1 = detect(transaction);
@@ -24,7 +24,7 @@ export function detect(transaction: Transaction): boolean {
    * and it also serves to decouple the logic, thereby simplifying the testing process
    */
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   const withdrawalBondedLog = logs.find((log: any) => {
     if (log.address !== HOP_RELAYERS[originChainId]) return false;
 
@@ -49,7 +49,7 @@ export function generate(transaction: Transaction): Transaction {
   const chainId = transaction.chainId;
   if (!chainId) return transaction;
 
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   let decodedWithdrawalBondedLog;
   for (const log of logs) {
     if (log.address !== HOP_RELAYERS[originChainId]) continue;

diff --git a/src/contextualizers/bridges/hopTransferToL1/source.ts b/src/contextualizers/bridges/hopTransferToL1/source.ts
@@ -6,7 +6,7 @@ import {
   Transaction,
 } from '../../../types';
 import { HOP_TRANSFER_SENT_EVENT_ABI, HOP_RELAYERS } from './constants';
-import { decodeLog } from '../../../helpers/utils';
+import { decodeLog, grabLogsFromTransaction } from '../../../helpers/utils';
 
 export function contextualize(transaction: Transaction): Transaction {
   const isHopTransferToL1 = detect(transaction);
@@ -24,7 +24,7 @@ export function detect(transaction: Transaction): boolean {
    * and it also serves to decouple the logic, thereby simplifying the testing process
    */
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   const transferSentLog = logs.find((log: any) => {
     if (log.address !== HOP_RELAYERS[originChainId]) return false;
 
@@ -46,7 +46,7 @@ export function detect(transaction: Transaction): boolean {
 
 export function generate(transaction: Transaction): Transaction {
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   let decodedTransferSentLog;
   for (const log of logs) {
     if (log.address !== HOP_RELAYERS[originChainId]) continue;

diff --git a/src/contextualizers/bridges/hopTransferToL2/destination.ts b/src/contextualizers/bridges/hopTransferToL2/destination.ts
@@ -9,7 +9,7 @@ import {
   HOP_TRANSFER_FROM_L1_COMPLETED_EVENT_ABI,
   HOP_RELAYERS,
 } from './constants';
-import { decodeLog } from '../../../helpers/utils';
+import { decodeLog, grabLogsFromTransaction } from '../../../helpers/utils';
 
 export function contextualize(transaction: Transaction): Transaction {
   const isHopTransferToL1 = detect(transaction);
@@ -27,7 +27,7 @@ export function detect(transaction: Transaction): boolean {
    * and it also serves to decouple the logic, thereby simplifying the testing process
    */
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   const transferFromL1CompletedLog = logs.find((log: any) => {
     if (log.address !== HOP_RELAYERS[originChainId]) return false;
 
@@ -51,7 +51,7 @@ export function generate(transaction: Transaction): Transaction {
   const chainId = transaction.chainId;
   if (!chainId) return transaction;
 
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   let decodedTransferFromL1CompletedLog;
   for (const log of logs) {
     if (log.address !== HOP_RELAYERS[chainId]) continue;

diff --git a/src/contextualizers/bridges/hopTransferToL2/source.ts b/src/contextualizers/bridges/hopTransferToL2/source.ts
@@ -6,7 +6,7 @@ import {
   Transaction,
 } from '../../../types';
 import { HOP_TRANSFER_SENT_TO_L2_EVENT_ABI, HOP_RELAYERS } from './constants';
-import { decodeLog } from '../../../helpers/utils';
+import { decodeLog, grabLogsFromTransaction } from '../../../helpers/utils';
 
 export function contextualize(transaction: Transaction): Transaction {
   const isHopTransferToL1 = detect(transaction);
@@ -24,7 +24,7 @@ export function detect(transaction: Transaction): boolean {
    * and it also serves to decouple the logic, thereby simplifying the testing process
    */
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   const transferSentToL2Log = logs.find((log: any) => {
     if (log.address !== HOP_RELAYERS[originChainId]) return false;
 
@@ -46,7 +46,7 @@ export function detect(transaction: Transaction): boolean {
 
 export function generate(transaction: Transaction): Transaction {
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   let decodedTransferSentToL2Log;
   for (const log of logs) {
     if (log.address !== HOP_RELAYERS[originChainId]) continue;

diff --git a/src/contextualizers/bridges/opStack/source.ts b/src/contextualizers/bridges/opStack/source.ts
@@ -18,7 +18,7 @@ import {
   TRANSACTION_DEPOSITED_EVENT_ABI,
   TRANSACTION_DEPOSITED_EVENT_HASH,
 } from './constants';
-import { decodeLog } from '../../../helpers/utils';
+import { decodeLog, grabLogsFromTransaction } from '../../../helpers/utils';
 
 export function contextualize(transaction: Transaction): Transaction {
   const isOpStack = detect(transaction);
@@ -36,7 +36,7 @@ export function detect(transaction: Transaction): boolean {
    * and it also serves to decouple the logic, thereby simplifying the testing process
    */
   if (transaction.chainId === 1) {
-    const logs = transaction.logs ?? [];
+    const logs = grabLogsFromTransaction(transaction);
     const transactionDepositedLog = logs.find((log: any) => {
       return log.topic0 === TRANSACTION_DEPOSITED_EVENT_HASH;
     });
@@ -58,7 +58,7 @@ export function generate(transaction: Transaction): Transaction {
   }
   const assetTransfer: Asset = assetSent[0];
 
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   const transactionDepositedLog = logs.find((log: any) => {
     return log.topic0 === TRANSACTION_DEPOSITED_EVENT_HASH;
   });

diff --git a/src/contextualizers/bridges/starGate/destination.ts b/src/contextualizers/bridges/starGate/destination.ts
@@ -16,7 +16,7 @@ import {
   STAR_GATE_PACKET_RECEIVED_EVENT_ABI,
   STAR_GATE_CHAIN_IDS,
 } from './constants';
-import { decodeLog } from '../../../helpers/utils';
+import { decodeLog, grabLogsFromTransaction } from '../../../helpers/utils';
 
 export function contextualize(transaction: Transaction): Transaction {
   const isStarGate = detect(transaction);
@@ -34,7 +34,7 @@ export function detect(transaction: Transaction): boolean {
    * and it also serves to decouple the logic, thereby simplifying the testing process
    */
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
 
   const packetReceivedLog = logs.find((log: Log) => {
     if (log.address !== STAR_GATE_RELAYERS[originChainId]) return false;
@@ -58,7 +58,7 @@ export function detect(transaction: Transaction): boolean {
 
 export function generate(transaction: Transaction): Transaction {
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   let decodedPacketReceivedLog;
 
   for (const log of logs) {

diff --git a/src/contextualizers/bridges/starGate/source.ts b/src/contextualizers/bridges/starGate/source.ts
@@ -15,7 +15,7 @@ import {
   STAR_GATE_PACKET_EVENT_ABI,
   STAR_GATE_CHAIN_IDS,
 } from './constants';
-import { decodeLog } from '../../../helpers/utils';
+import { decodeLog, grabLogsFromTransaction } from '../../../helpers/utils';
 
 export function contextualize(transaction: Transaction): Transaction {
   const isStarGate = detect(transaction);
@@ -33,7 +33,7 @@ export function detect(transaction: Transaction): boolean {
    * and it also serves to decouple the logic, thereby simplifying the testing process
    */
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   const sendMsgLog = logs.find((log: Log) => {
     if (log.address !== STAR_GATE_BRIDGES[originChainId]) return false;
     const decoded = decodeLog(
@@ -79,7 +79,7 @@ export function detect(transaction: Transaction): boolean {
 
 export function generate(transaction: Transaction): Transaction {
   const originChainId = transaction.chainId ?? 1;
-  const logs = transaction.logs ?? [];
+  const logs = grabLogsFromTransaction(transaction);
   let decodedSwapLog;
 
   for (const log of logs) {

diff --git a/src/contextualizers/contextualizer.spec.ts b/src/contextualizers/contextualizer.spec.ts
@@ -48,6 +48,10 @@ import ensBulkRenew0x25add712 from './test/transactions/ensBulkRenew-0x25add712.
 import skyoneerPlotAction0x9436b659 from './test/transactions/skyoneerPlotAction-0x9436b659.json';
 import skyoneerPlotAction0x9bb5a737 from './test/transactions/skyoneerPlotAction-0x9bb5a737.json';
 import skyoneerPlotAction0x496c6309 from './test/transactions/skyoneerPlotAction-0x496c6309.json';
+// untransformed transactions
+import registrarWithConfigRaw0x5d31a49e from './test/transactions/registrarWithConfig-raw-0x5d31a49e.json';
+import ensRegistrarRaw0xb14b4771 from './test/transactions/ensRegistrar-raw-0xb14b4771.json';
+import nftMintRaw0xf264bbc2685 from './test/transactions/nft-mint-raw-0xf264bbc2685.json';
 
 describe('ContextualizerService', () => {
   describe('Detect transactions correctly', () => {
@@ -255,5 +259,22 @@ describe('ContextualizerService', () => {
       );
       expect(plotAction3.context?.summaries?.en.title).toBe('Skyoneer');
     });
+
+    it('Should detect raw transactions', () => {
+      const ens1 = contextualizer.contextualize(
+        ensRegistrarRaw0xb14b4771 as unknown as Transaction,
+      );
+      expect(ens1.context?.summaries?.en.title).toBe('ENS');
+
+      const ens2 = contextualizer.contextualize(
+        registrarWithConfigRaw0x5d31a49e as unknown as Transaction,
+      );
+      expect(ens2.context?.summaries?.en.title).toBe('ENS');
+
+      const nftMint1 = contextualizer.contextualize(
+        nftMintRaw0xf264bbc2685 as unknown as Transaction,
+      );
+      expect(nftMint1.context?.summaries?.en.title).toBe('NFT Mint');
+    });
   });
 });
diff --git a/src/contextualizers/heuristics/ethTransfer/ethTransfer.ts b/src/contextualizers/heuristics/ethTransfer/ethTransfer.ts
@@ -1,3 +1,4 @@
+import { grabLogsFromTransaction } from '../../../helpers/utils';
 import {
   AssetType,
   HeuristicContextActionEnum,
@@ -12,12 +13,13 @@ export function contextualize(transaction: Transaction): Transaction {
 }
 
 export function detect(transaction: Transaction): boolean {
+  const logs = grabLogsFromTransaction(transaction);
   // TODO; check logs from transaction
   if (
     transaction.to &&
     transaction.input === '0x' &&
     transaction.value !== BigInt(0) &&
-    transaction.logs?.length === 0
+    logs.length === 0
   ) {
     return true;
   }

diff --git a/src/contextualizers/protocol/boombox/boombox.ts b/src/contextualizers/protocol/boombox/boombox.ts
@@ -8,6 +8,7 @@ import {
 import {
   decodeEVMAddress,
   decodeTransactionInput,
+  grabLogsFromTransaction,
 } from '../../../helpers/utils';
 import { CHAIN_IDS } from '../../../helpers/constants';
 
@@ -123,12 +124,11 @@ export const generate = (transaction: Transaction): Transaction => {
     case 'distribute':
       const distributeArtistId =
         decoded.args && decoded.args.length > 0 ? decoded.args[0] : '';
+      const logs = grabLogsFromTransaction(transaction);
       // decode logs
-      const distributeLogs = transaction.logs
-        ? transaction.logs.filter(
-            (log) => log.topic0 === EVENT_DISTRIBUTE_TOPIC,
-          )
-        : [];
+      const distributeLogs = logs.filter(
+        (log) => log.topic0 === EVENT_DISTRIBUTE_TOPIC,
+      );
       const recipients = distributeLogs.map((log) =>
         decodeEVMAddress(log.topic2),
       );

diff --git a/src/contextualizers/protocol/cryptopunks/cryptopunks.ts b/src/contextualizers/protocol/cryptopunks/cryptopunks.ts
@@ -7,7 +7,10 @@ import {
   Transaction,
 } from '../../../types';
 import { CryptopunksContracts, CRYPTOPUNK_ABIS } from './constants';
-import { decodeTransactionInput } from '../../../helpers/utils';
+import {
+  decodeTransactionInput,
+  grabLogsFromTransaction,
+} from '../../../helpers/utils';
 
 export const contextualize = (transaction: Transaction): Transaction => {
   const isENS = detect(transaction);
@@ -357,7 +360,8 @@ export const generate = (transaction: Transaction): Transaction => {
         unit: 'wei',
       };
       if (transaction.receipt?.status) {
-        const transferTopic = transaction.logs?.filter(
+        const logs = grabLogsFromTransaction(transaction);
+        const transferTopic = logs.filter(
           (log) =>
             log.topic0 ===
             '0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef',

diff --git a/src/contextualizers/protocol/eas/eas.ts b/src/contextualizers/protocol/eas/eas.ts
@@ -5,7 +5,11 @@ import {
   EventLogTopics,
   EASContextActionEnum,
 } from '../../../types';
-import { decodeTransactionInput, decodeLog } from '../../../helpers/utils';
+import {
+  decodeTransactionInput,
+  decodeLog,
+  grabLogsFromTransaction,
+} from '../../../helpers/utils';
 import { ABIs, EAS_LINKS } from './constants';
 
 export const contextualize = (transaction: Transaction): Transaction => {
@@ -70,7 +74,8 @@ const getAttestationID = (transaction: Transaction): string | null => {
     return null;
   }
   // TODO: Confirm that the event matches the expected name
-  const transactionLog = transaction?.logs?.[0];
+  const logs = grabLogsFromTransaction(transaction);
+  const transactionLog = logs?.[0];
   const decoded = decodeLog(
     ABIs.EAS,
     transactionLog?.data as Hex,

diff --git a/src/contextualizers/protocol/eas/schemaRegistry.ts b/src/contextualizers/protocol/eas/schemaRegistry.ts
@@ -4,7 +4,11 @@ import {
   EventLogTopics,
   Transaction,
 } from '../../../types';
-import { decodeTransactionInput, decodeLog } from '../../../helpers/utils';
+import {
+  decodeTransactionInput,
+  decodeLog,
+  grabLogsFromTransaction,
+} from '../../../helpers/utils';
 import { ABIs, EAS_LINKS } from './constants';
 
 export const contextualize = (transaction: Transaction): Transaction => {
@@ -54,11 +58,13 @@ export const generate = (transaction: Transaction): Transaction => {
   }
   if (!transaction.chainId) return transaction;
 
+  const logs = grabLogsFromTransaction(transaction);
+
   switch (decoded.functionName) {
     case 'register': {
       let id = '';
       if (transaction.receipt?.status) {
-        const registerLog = transaction.logs?.find((log) => {
+        const registerLog = logs.find((log) => {
           const decoded = decodeLog(
             ABIs.SchemaRegistry,
             log.data as Hex,