Add ability to disable trace and decode only based on receipt and logs (

#101) * Add ability to disable trace and decode only based on receipt and logs * Update the usage of supportTraceAPI in docs and web playground
3loop · Sep 10, 2024 · 1e074ac · 1e074ac
1 parent 26ffe1f
commit 1e074ac
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 16 deletions.
diff --git a/.changeset/proud-books-boil.md b/.changeset/proud-books-boil.md
@@ -0,0 +1,5 @@
+---
+'@3loop/transaction-decoder': minor
+---
+
+Allow disabling tracer for an RPC client thus relaying only on logs and receipt
diff --git a/apps/docs/src/content/docs/recipes/fc-bot.mdx b/apps/docs/src/content/docs/recipes/fc-bot.mdx
@@ -73,7 +73,7 @@ The `constants.ts` file contains the RPC URL and configuration. The Base RPCs do
 export const RPC = {
   8453: {
     url: `wss://base-mainnet.g.alchemy.com/v2/${process.env.ALCHEMY_API_KEY}`,
-    supportTraceAPI: false,
+    traceAPI: 'none',
   },
 }
 ```
@@ -95,7 +95,7 @@ const getPublicClient = (chainId: number) => {
       transport: webSocket(rpc.url),
     }),
     config: {
-      supportTraceAPI: rpc.supportTraceAPI,
+      traceAPI: rpc.traceAPI,
     },
   }
 }

diff --git a/apps/web/src/app/data.ts b/apps/web/src/app/data.ts
@@ -85,7 +85,13 @@ export const EXAMPLE_TXS = {
   ],
 }
 
-export const supportedChains = [
+export const supportedChains: {
+  name: string
+  chainID: number
+  rpcUrl: string
+  traceAPI?: 'parity' | 'geth' | 'none'
+  batchMaxCount?: number
+}[] = [
   {
     name: 'Ethereum Mainnet',
     chainID: 1,
@@ -100,32 +106,32 @@ export const supportedChains = [
     name: 'Base mainnet',
     chainID: 8453,
     rpcUrl: process.env.BASE_RPC_URL as string,
-    supportTraceAPI: false,
+    traceAPI: 'geth',
     batchMaxCount: 1,
   },
   {
     name: 'Polygon Mainnet',
     chainID: 137,
     rpcUrl: (process.env.POLYGON_RPC_URL as string) ?? 'https://rpc.ankr.com/polygon',
-    suppurtTraceAPI: true,
+    traceAPI: 'geth',
   },
   {
     name: 'Optimism Mainnet',
     chainID: 10,
     rpcUrl: process.env.OPTIMISM_RPC_URL as string,
-    supportTraceAPI: false,
+    traceAPI: 'geth',
   },
   {
     name: 'Arbitrum One',
     chainID: 42161,
     rpcUrl: process.env.ARBITRUM_RPC_URL as string,
-    supportTraceAPI: false,
+    traceAPI: 'geth',
   },
   {
     name: 'Manta pacific',
     chainID: 169,
     rpcUrl: (process.env.MANTA_RPC_URL as string) ?? 'https://pacific-rpc.manta.network/http',
-    supportTraceAPI: false,
+    traceAPI: 'geth',
   },
 ]
 

diff --git a/apps/web/src/lib/rpc-provider.ts b/apps/web/src/lib/rpc-provider.ts
@@ -25,7 +25,7 @@ export function getProvider(chainID: number): PublicClientObject | null {
         transport: http(url),
       }),
       config: {
-        supportTraceAPI: providerConfigs[chainID]?.supportTraceAPI,
+        traceAPI: providerConfigs[chainID]?.traceAPI,
       },
     }
 

diff --git a/packages/transaction-decoder/src/public-client.ts b/packages/transaction-decoder/src/public-client.ts
@@ -12,7 +12,7 @@ export class RPCFetchError {
 }
 
 export interface PublicClientConfig {
-  readonly supportTraceAPI?: boolean
+  readonly traceAPI?: 'parity' | 'geth' | 'none'
 }
 
 export interface PublicClientObject {

diff --git a/packages/transaction-decoder/src/transaction-loader.ts b/packages/transaction-decoder/src/transaction-loader.ts
@@ -43,10 +43,10 @@ export const getTransactionReceipt = (hash: Hash, chainID: number) =>
 export const getTrace = (hash: Hash, chainID: number) =>
   Effect.gen(function* () {
     const service = yield* PublicClient
-    const { client, config } = yield* service.getPublicClient(chainID)
-    const traceAPISupport = config?.supportTraceAPI ?? true
+    const { client, config = {} } = yield* service.getPublicClient(chainID)
+    const traceAPI = config.traceAPI ?? 'parity'
 
-    if (traceAPISupport) {
+    if (traceAPI === 'parity') {
       const trace = yield* Effect.withSpan(
         Effect.tryPromise({
           try: async () => {
@@ -60,7 +60,7 @@ export const getTrace = (hash: Hash, chainID: number) =>
           catch: () => new RPCFetchError('Get trace'),
         }),
         'TransactionLoader.Trace',
-        { attributes: { hash, chainID, traceAPISupport } },
+        { attributes: { hash, chainID, traceAPI } },
       )
 
       const effects: Effect.Effect<TraceLog, ParseError>[] = trace.map((log: string) => {
@@ -73,7 +73,7 @@ export const getTrace = (hash: Hash, chainID: number) =>
       })
 
       return results
-    } else {
+    } else if (traceAPI === 'geth') {
       const trace = yield* Effect.withSpan(
         Effect.tryPromise({
           try: async () => {
@@ -87,13 +87,15 @@ export const getTrace = (hash: Hash, chainID: number) =>
           catch: (e) => new RPCFetchError(e),
         }),
         'TransactionLoader.Trace',
-        { attributes: { hash, chainID, traceAPISupport } },
+        { attributes: { hash, chainID, traceAPI } },
       )
 
       const transformedTrace = transformTraceTree(trace as unknown as TraceLogTree)
 
       return transformedTrace
     }
+
+    return []
   })
 
 export const getBlockTimestamp = (blockNumber: bigint, chainID: number) =>