Add options parameter to the transaction interpreter (#225)

Author: anastasiarods

.changeset/many-houses-walk.md

@@ -0,0 +1,5 @@
+---
+'@3loop/transaction-interpreter': patch
+---
+
+Add options parameter to the transaction interpreter

packages/transaction-interpreter/src/EvalInterpreter.ts

@@ -23,14 +23,28 @@ const make = Effect.succeed({
       id: `${decodedTx.chainID}:${decodedTx.toAddress}`,
     }
   },
-  interpretTx: (decodedTx: DecodedTransaction, interpreter: Interpreter) =>
+  interpretTx: (
+    decodedTx: DecodedTransaction,
+    interpreter: Interpreter,
+    options?: {
+      interpretAsUserAddress?: string
+    },
+  ) =>
     Effect.sync(() => {
       // TODO: add ability to surpress warning on acknowledge
       Effect.logWarning('Using eval in production can result in security vulnerabilities. Use at your own risk.')
 
-      const input = stringify(decodedTx)
-      const code = interpreter.schema
-      const result = localEval(code, input)
+      let input
+      if (options?.interpretAsUserAddress) {
+        input = stringify({
+          ...decodedTx,
+          fromAddress: options.interpretAsUserAddress,
+        })
+      } else {
+        input = stringify(decodedTx)
+      }
+
+      const result = localEval(interpreter.schema, input)
       return result
     }).pipe(Effect.withSpan('TransactionInterpreter.interpretTx')),
 })

packages/transaction-interpreter/src/QuickjsInterpreter.ts

@@ -22,11 +22,22 @@ const make = Effect.gen(function* () {
         id: `${decodedTx.chainID}:${decodedTx.toAddress}`,
       }
     },
-    interpretTx: (decodedTx: DecodedTransaction, interpreter: Interpreter) =>
+    interpretTx: (
+      decodedTx: DecodedTransaction,
+      interpreter: Interpreter,
+      options?: { interpretAsUserAddress?: string },
+    ) =>
       Effect.gen(function* () {
-        const input = stringify(decodedTx)
-        const code = interpreter.schema
-        const result = yield* vm.eval(code + '\n' + 'transformEvent(' + input + ')')
+        let input
+        if (options?.interpretAsUserAddress) {
+          input = stringify({
+            ...decodedTx,
+            fromAddress: options.interpretAsUserAddress,
+          })
+        } else {
+          input = stringify(decodedTx)
+        }
+        const result = yield* vm.eval(interpreter.schema + '\n' + 'transformEvent(' + input + ')')
         return result
       }).pipe(Effect.withSpan('TransactionInterpreter.interpretTx')),
   }

packages/transaction-interpreter/src/interpreter.ts

@@ -8,6 +8,9 @@ export interface TransactionInterpreter {
   readonly interpretTx: (
     decodedTx: DecodedTransaction,
     interpreter: Interpreter,
+    options?: {
+      interpretAsUserAddress?: string
+    },
   ) => Effect.Effect<InterpretedTransaction, InterpreterError, never>
 }