add method to getWithdrawalMessages from a transaciton (#21)

Author: wilsoncusack

src/_test/index.test.ts renamed to src/actions/public/getL2HashesForDepositTx.test.ts

@@ -1,7 +1,7 @@
 import { test, expect } from 'vitest'
 import { createPublicClient, http } from 'viem'
 import { mainnet } from '@wagmi/chains'
-import { publicOpStackActions } from '../decorators/publicOpStack'
+import { publicOpStackActions } from '../../decorators/publicOpStack'
 
 test('correctly retrieves L2 hash', async () => {
   const client = createPublicClient({

src/actions/public/getWithdrawalMessages.test.ts

@@ -0,0 +1,24 @@
+import { test, expect } from 'vitest'
+import { createPublicClient, http } from 'viem'
+import { base } from '@wagmi/chains'
+import { publicOpStackActions } from '../../decorators/publicOpStack'
+
+test('correctly retrieves L2 hash', async () => {
+  const client = createPublicClient({
+    chain: base,
+    transport: http(),
+  }).extend(publicOpStackActions)
+
+  const messages = await client.getWithdrawalMessages({
+    hash:
+      '0x999bab960dbdf600c51371ae819957063337a50cec2eb8032412739defadabe7',
+  })
+  expect(messages.length).toEqual(1)
+  expect(messages[0].nonce).toBeDefined()
+  expect(messages[0].gasLimit).toBeDefined()
+  expect(messages[0].data).toBeDefined()
+  expect(messages[0].value).toBeDefined()
+  expect(messages[0].sender).toBeDefined()
+  expect(messages[0].target).toBeDefined()
+  expect(messages[0].withdrawalHash).toBeDefined()
+})

src/actions/public/getWithdrawalMessages.ts

@@ -0,0 +1,49 @@
+import { type PublicClient, Chain, Transport, Hash, Address, Hex, decodeEventLog } from 'viem'
+import { l2ToL1MessagePasserABI } from '@eth-optimism/contracts-ts'
+
+export type MessagePassedEvent = {
+  nonce: bigint, 
+  sender: Address,
+  target: Address,
+  value: bigint,
+  gasLimit: bigint,
+  data: Hex,
+  withdrawalHash: Hex
+}
+
+export type GetWithdrawalMessagesParameters = {
+  hash: Hash
+}
+
+export type GetWithdrawalMessagesReturnType = MessagePassedEvent[]
+
+/**
+ * Retrieves all MessagePassed events from a withdrawal transaction
+ *
+ * @param client - Public client to use
+ * @param parameters - {@link GetWithdrawalMessagesParameters}
+ * @returns An array of all MessagePassed events emitted in this transaction. {@link GetWithdrawalMessagesReturnType}
+ */
+export async function getWithdrawalMessages<TChain extends Chain | undefined>(
+  client: PublicClient<Transport, TChain>,
+  { hash }: GetWithdrawalMessagesParameters,
+): Promise<GetWithdrawalMessagesReturnType> {
+  const receipt = await client.getTransactionReceipt({ hash })
+  const events: MessagePassedEvent[] = []
+  for (const log of receipt.logs) {
+    /// These transactions will contain events from several contracts
+    /// this decode will revert for events not from l2ToL1MessagePasserABI
+    /// we are OK ignoring these events
+    try {
+      const event = decodeEventLog({
+        abi: l2ToL1MessagePasserABI,
+        data: log.data,
+        topics: log.topics,
+      })
+      if (event.eventName === 'MessagePassed') {
+        events.push(event.args)
+      }
+    } catch {}
+  }
+  return events;
+}

src/decorators/publicOpStack.ts

@@ -1,9 +1,10 @@
-import { Account, Chain, Client, type PublicClient, Transport } from 'viem'
+import { Chain, type PublicClient, Transport } from 'viem'
 import {
   GetL2HashesForDepositTxParamters,
   GetL2HashesForDepositTxReturnType,
   getL2HashesForDepositTx,
 } from '../actions/public/getL2HashesForDepositTx'
+import { GetWithdrawalMessagesParameters, GetWithdrawalMessagesReturnType, getWithdrawalMessages } from '../actions/public/getWithdrawalMessages'
 
 /// NOTE We don't currently need account for exisiting actions but keeping in case
 export type PublicOpStackActions<
@@ -13,6 +14,9 @@ export type PublicOpStackActions<
   getL2HashesForDepositTx: (
     args: GetL2HashesForDepositTxParamters,
   ) => Promise<GetL2HashesForDepositTxReturnType>
+  getWithdrawalMessages: (
+    args: GetWithdrawalMessagesParameters,
+  ) => Promise<GetWithdrawalMessagesReturnType>
 }
 
 export function publicOpStackActions<
@@ -23,5 +27,6 @@ export function publicOpStackActions<
 ): PublicOpStackActions<TTransport, TChain> {
   return {
     getL2HashesForDepositTx: (args) => getL2HashesForDepositTx(client, args),
+    getWithdrawalMessages: (args) => getWithdrawalMessages(client, args),
   }
 }