diff --git a/pages/builders/app-developers/tutorials/sdk-trace-txns.mdx b/pages/builders/app-developers/tutorials/sdk-trace-txns.mdx index 637d7cb6..0dfd8da9 100644 --- a/pages/builders/app-developers/tutorials/sdk-trace-txns.mdx +++ b/pages/builders/app-developers/tutorials/sdk-trace-txns.mdx @@ -1,23 +1,16 @@ --- title: Tracing deposits and withdrawals lang: en-US -description: Learn how to use the Optimism SDK to trace deposits and withdrawals between L1 and L2. +description: Learn how to use the viem library to trace deposits and withdrawals between L1 and L2. --- import { Callout, Steps } from 'nextra/components' -import { WipCallout } from '@/components/WipCallout' - # Tracing deposits and withdrawals -In this tutorial, you'll learn how to use the [Optimism SDK](https://sdk.optimism.io) to trace a [Standard Bridge](../bridging/standard-bridge) deposit or withdrawal between L1 and L2. +In this tutorial, you'll learn how to use the [viem](https://viem.sh) library to trace a [Standard Bridge](../bridging/standard-bridge) deposit or withdrawal between L1 and L2. You'll specifically learn how to determine the status of a deposit or withdrawal and how to retrieve the transaction receipt for the executed transaction on L1 (for withdrawals) or L2 (for deposits). - -Check out the tutorial on [Bridging ERC-20 Tokens With the Optimism SDK](./cross-dom-bridge-erc20) to learn how to create deposits and withdrawals. -You can also check out the tutorial on [Viewing Deposits and Withdrawals by Address](./sdk-view-txns) to find deposits and withdrawals to trace. - - ## Dependencies * [node](https://nodejs.org/en/) @@ -25,203 +18,145 @@ You can also check out the tutorial on [Viewing Deposits and Withdrawals by Addr ## Create a demo project -You're going to use the Optimism SDK for this tutorial. -Since the Optimism SDK is a [Node.js](https://nodejs.org/en/) library, you'll need to create a Node.js project to use it. +You're going to use the viem library for this tutorial. +Since viem is a [Node.js](https://nodejs.org/en/) library, you'll need to create a Node.js project to use it. + {

Make a Project Folder

} -{

Make a Project Folder

} - -```bash -mkdir op-sample-project -cd op-sample-project -``` - -{

Initialize the Project

} - -```bash -pnpm init -``` - -{

Install the Optimism SDK

} + ```bash + mkdir trace-trx + cd trace-trx + ``` -```bash -pnpm add @eth-optimism/sdk -``` + {

Initialize the project

} -{

Install ethers.js

} + ```bash + pnpm init + ``` -```bash -pnpm add ethers@^5 -``` + {

Install viem

} + ```bash + pnpm add viem + ``` - ## Add RPC URLs to your environment -You'll be using the `getMessageReceipt` function from the Optimism SDK during this tutorial. -This function use event queries to retrieve the receipt for a deposit or withdrawal. +You'll be using the `getTransactionReceipt` function from the viem library during this tutorial. This function use event queries to retrieve the receipt for a deposit or withdrawal. Since this function uses large event queries, you'll need to use an RPC provider like [Alchemy](https://alchemy.com) that supports indexed event queries. Grab an L1 and L2 RPC URL for Sepolia and OP Sepolia, respectively. ```bash -export L1_RPC_URL=... # Sepolia RPC URL -export L2_RPC_URL=... # OP Sepolia RPC URL +export L1_RPC_URL="https://YOUR_L1_ SEPOLIA_RPC_URL_HERE" +export L2_RPC_URL="https://YOUR_L2_OP_SEPOLIA_RPC_URL_HERE" ``` - -The Optimism SDK may be updated in the future to use a different method of retrieving deposits and withdrawals under the hood that does not require indexed event queries. -This tutorial will be updated to reflect those changes if and when they occur. - - ## Start the Node REPL -You're going to use the Node REPL to interact with the Optimism SDK. -To start the Node REPL run the following command in your terminal: +You're going to use the Node REPL to interact with viem. To start the Node REPL, run the following command in your terminal: ```bash node ``` -This will bring up a Node REPL prompt that allows you to run javascript code. +This will bring up a Node REPL prompt that allows you to run JavaScript code. ## Import dependencies You need to import some dependencies into your Node REPL session. - - -{

Import the Optimism SDK

} - -```js file=/public/tutorials/sdk-trace-txns.js#L3 hash=26b2fdb17dd6c8326a54ec51f0769528 -``` - -{

Import ethers.js

} +{

Import viem

} -```js file=/public/tutorials/sdk-trace-txns.js#L4 hash=69a65ef97862612e4978b8563e6dbe3a +```js file=/public/tutorials/sdk-trace-txns.js#L3-L4 hash=57a929d665f2e5e4a7ecd085ad3d0b01 ``` - - - + ## Set session variables -You'll need a few variables throughout this tutorial. -Let's set those up now. +You'll need a few variables throughout this tutorial. Let's set those up now. + {

Import RPC URLs

} -{

Import RPC URLs

} - -```js file=/public/tutorials/sdk-trace-txns.js#L10-L11 hash=02141d8cb077764665c61fc48e18ed04 -``` - -{

Set the deposit to trace

} + ```js file=/public/tutorials/sdk-trace-txns.js#L13-L14 hash=0badc18f525e56b36406e7be8ad1104e + ``` -You'll be tracing a specific deposit in this tutorial. -Deposit tracing is generally based on the transaction hash of the transaction that triggered the deposit. -You can replace this transaction hash with your own if you'd like. + {

Set the deposit to trace

} -```js file=/public/tutorials/sdk-trace-txns.js#L14 hash=a874f1ce83255bb233539f7a188ea1d3 -``` + You'll be tracing a specific deposit in this tutorial. Deposit tracing is generally based on the transaction hash of the transaction that triggered the deposit. You can replace this transaction hash with your own if you'd like. -{

Set the withdrawal to trace

} + ```js file=/public/tutorials/sdk-trace-txns.js#L17 hash=367c797c3e9746addedf43857f789eeb + ``` -You'll also be tracing a specific withdrawal in this tutorial. -Like with deposits, withdrawal tracing is generally based on the transaction hash of the transaction that triggered the withdrawal. -You can replace this transaction hash with your own if you'd like. + {

Set the withdrawal to trace

} -```js file=/public/tutorials/sdk-trace-txns.js#L15 hash=6c5af039dfa0217810295dfaf82ef7c1 -``` + You'll also be tracing a specific withdrawal in this tutorial. Like with deposits, withdrawal tracing is generally based on the transaction hash of the transaction that triggered the withdrawal. You can replace this transaction hash with your own if you'd like. -{

Create the RPC providers

} + ```js file=/public/tutorials/sdk-trace-txns.js#L18 hash=545d1eed00ad0a235e2c79c8a87efd30 + ``` -```js file=/public/tutorials/sdk-trace-txns.js#L17-L18 hash=e86efaea1d4adde679ca66911080dc28 -``` + {

Create the RPC providers

} + ```js file=/public/tutorials/sdk-trace-txns.js#L20-L28 hash=6286672ca3163543e9d8ddeb5b1b6477 + ``` -## Create the CrossDomainMessenger - -The Optimism SDK exports a `CrossChainMessenger` class that makes it easy to interact with the Standard Bridge contracts. +## Trace a Deposit -Create an instance of the `CrossChainMessenger` class: - -```js file=/public/tutorials/sdk-trace-txns.js#L20-L25 hash=158c6888c82bdc2f07c37c3edb3a9a6a -``` - -## Trace a deposit - -You can use the `CrossChainMessenger` instance to trace a deposit. +You can use viem to trace a deposit. + {

Get the deposit status

} -{

Get the deposit status

} - -It's often useful to know the status of a deposit. -Deposits can have a number of statuses depending on where the deposit is within its lifecycle. -Refer to the [Optimism SDK documentation](https://sdk.optimism.io/enums/messagestatus) for a full list of potential deposit statuses. - -```js file=/public/tutorials/sdk-trace-txns.js#L28-L29 hash=11aa5fe48d79feea140691842bf5213c -``` - -{

Get the deposit transaction receipt

} - -You can also use the `CrossChainMessenger` instance to get the transaction receipt for the L2 transaction that executes and completes the deposit. -Note that this function will also return the message status of the deposit and is therefore an alternative to the previous function. -The result of this function is an object with a `messageStatus` property and a `transactionReceipt` property that is identical to the result of the `ethers` function `getTransactionReceipt`. + You can query for the deposit status using the transaction hash of the deposit. -```js file=/public/tutorials/sdk-trace-txns.js#L32-L33 hash=42ce77ccd7c2c7c9b447ac534c0daa4f -``` + ```js file=/public/tutorials/sdk-trace-txns.js#L30-L32 hash=b3693011e87b605cdd29baeffb080b9a + ``` -{

Parse deposit logs

} + {

Get the deposit transaction receipt

} -Like any other transaction receipt, the deposit transaction receipt contains logs that can be parsed to get additional information about the deposit. -You can iterate through these logs and parse them just as you would parse any other receipt. -For instance, you may wish to search for `Mint` events to determine the amount of tokens that were minted as a result of the deposit. + Retrieve the transaction receipt for the deposit using the viem client. -{

Get the deposit transaction

} + ```js file=/public/tutorials/sdk-trace-txns.js#L34-L36 hash=077581a56fc7b26f62589f0a6ae99e0d + ``` -Once you have the transaction receipt, you can directly query for the actual L2 transaction that executed the deposit. + {

Get the deposit transaction

} -```js file=/public/tutorials/sdk-trace-txns.js#L36-L37 hash=13bdc82e94c80eb3c29bf4430b15e456 -``` + You can directly query for the L2 transaction that executed the deposit. + ```js file=/public/tutorials/sdk-trace-txns.js#L38-L40 hash=c67f0abeef0f2f817b7fb04be8f157a6 + ``` ## Trace a withdrawal -You can also use the `CrossChainMessenger` instance to trace a withdrawal. +You can use viem's functions to trace a withdrawal. + {

Get the withdrawal status

} -{

Get the withdrawal status

} - -Like deposits, withdrawals can have a number of statuses depending on where the withdrawal is within its lifecycle. -Refer to the [Optimism SDK documentation](https://sdk.optimism.io/enums/messagestatus) for a full list of potential withdrawal statuses. + Like deposits, withdrawals can have multiple statuses depending on where they are in the process. -```js file=/public/tutorials/sdk-trace-txns.js#L40-L41 hash=24ef2259ff96107ff31bfb8f02a4150a -``` - -{

Get the withdrawal transaction receipt

} + ```js file=/public/tutorials/sdk-trace-txns.js#L42-L44 hash=55ceda3d9d2f9abf037f8b259de14f26 + ``` -You can also use the `CrossChainMessenger` instance to get the transaction receipt for the L1 transaction that executes and completes the withdrawal. -The result of this function is an object with a `messageStatus` property and a `transactionReceipt` property that is identical to the result of the `ethers` function `getTransactionReceipt`. + {

Get the withdrawal transaction receipt

} -```js file=/public/tutorials/sdk-trace-txns.js#L44-L45 hash=e2e9688e7c3cb81740c73f921808cc3e -``` + Retrieve the L1 transaction receipt for the withdrawal. -{

Parse withdrawal logs

} + ```js file=/public/tutorials/sdk-trace-txns.js#L46-L48 hash=d784970abbfd37215d33274d60173ab2 + ``` -Like any other transaction receipt, the withdrawal transaction receipt contains logs that can be parsed to get additional information about the withdrawal. -You can iterate through these logs and parse them just as you would parse any other receipt. -For instance, you may wish to search for `Burn` events to determine the amount of tokens that were burned as a result of the withdrawal. + {

Get the withdrawal transaction

} -{

Get the withdrawal transaction

} + Directly query for the L1 transaction that executed the withdrawal. -Once you have the transaction receipt, you can directly query for the actual L1 transaction that executed the withdrawal. + ```js file=/public/tutorials/sdk-trace-txns.js#L50-L52 hash=48358bc45243db4e69de6ed3d49a67f9 + ``` + -```js file=/public/tutorials/sdk-trace-txns.js#L48-L49 hash=c138a32f8c1e3c887f19d9bc7e87c73b -``` +## Next steps - +* Check out the tutorial on [bridging ERC-20 tokens with the Optimism SDK](./cross-dom-bridge-erc20) to learn how to create deposits and withdrawals. +* You can also check out the tutorial on [viewing deposits and withdrawals by address](./sdk-view-txns) to find deposits and withdrawals to trace. diff --git a/public/tutorials/sdk-trace-txns.js b/public/tutorials/sdk-trace-txns.js index aada45ea..430660c9 100644 --- a/public/tutorials/sdk-trace-txns.js +++ b/public/tutorials/sdk-trace-txns.js @@ -1,51 +1,54 @@ (async () => { -const optimism = require("@eth-optimism/sdk") -const ethers = require("ethers") + const { createPublicClient, http } = require('viem'); + const { optimismSepolia, sepolia } = require('viem/chains'); + const L1_RPC_URL= "https://rpc.ankr.com/eth_sepolia"; + const L2_RPC_URL= "https://sepolia.optimism.io"; // Need to use Alchemy or something here because the getDepositsByAddress and // getWithdrawalsByAddress functions use a large block range that the public RPC doesn't support // because it uses Ankr. Maybe the SDK should be updated to use smaller block ranges depending // on the RPC but that's a separate issue. -const l1RpcUrl = process.env.L1_RPC_URL -const l2RpcUrl = process.env.L2_RPC_URL + +const l1RpcUrl = process.env.L1_RPC_URL; +const l2RpcUrl = process.env.L2_RPC_URL; // Docs CI wallet, will have deposits and withdrawals. -const deposit = '0x5896d6e4a47b465e0d925723bab838c62ef53468139a5e9ba501efd70f90cccb' -const withdrawal = '0x18b8b4022b8d9e380fd89417a2e897adadf31e4f41ca17442870bf89ad024f42' +const depositHash = '0x5896d6e4a47b465e0d925723bab838c62ef53468139a5e9ba501efd70f90cccb' +const withdrawalHash = '0x18b8b4022b8d9e380fd89417a2e897adadf31e4f41ca17442870bf89ad024f42' -const l1Provider = new ethers.providers.StaticJsonRpcProvider(l1RpcUrl) -const l2Provider = new ethers.providers.StaticJsonRpcProvider(l2RpcUrl) +const l1Client = createPublicClient({ + chain: sepolia, + transport: http(l1RpcUrl), +}); -const messenger = new optimism.CrossChainMessenger({ - l1ChainId: 11155111, // 11155111 for Sepolia, 1 for Ethereum - l2ChainId: 11155420, // 11155420 for OP Sepolia, 10 for OP Mainnet - l1SignerOrProvider: l1Provider, - l2SignerOrProvider: l2Provider, -}) +const l2Client = createPublicClient({ + chain: optimismSepolia, + transport: http(l2RpcUrl), +}); console.log('Grabbing deposit status...') -const depositStatus = await messenger.getMessageStatus(deposit) -console.log(depositStatus) +const depositStatus = await l2Client.getTransactionReceipt({ hash: depositHash }); +console.log(depositStatus); console.log('Grabbing deposit receipt...') -const depositReceipt = await messenger.getMessageReceipt(deposit) -console.log(depositReceipt) +const depositReceipt = await l2Client.getTransaction({ hash: depositHash }); +console.log(depositReceipt); console.log('Grabbing deposit txn...') -const depositTx = await l2Provider.getTransaction(depositReceipt.transactionReceipt.transactionHash) -console.log(depositTx) +const depositTransaction = await l2Client.getTransaction({ hash: depositHash }); +console.log(depositTransaction); console.log('Grabbing withdrawal status...') -const withdrawalStatus = await messenger.getMessageStatus(withdrawal) -console.log(withdrawalStatus) +const withdrawalStatus = await l1Client.getTransactionReceipt({ hash: withdrawalHash }); +console.log(withdrawalStatus); console.log('Grabbing withdrawal receipt...') -const withdrawalReceipt = await messenger.getMessageReceipt(withdrawal) -console.log(withdrawalReceipt) +const withdrawalReceipt = await l1Client.getTransaction({ hash: withdrawalHash }); +console.log(withdrawalReceipt); console.log('Grabbing withdrawal txn...') -const withdrawalTx = await l1Provider.getTransaction(withdrawalReceipt.transactionReceipt.transactionHash) -console.log(withdrawalTx) +const withdrawalTransaction = await l1Client.getTransaction({ hash: withdrawalHash }); +console.log(withdrawalTransaction); })() diff --git a/words.txt b/words.txt index 08c53d77..c20a7a91 100644 --- a/words.txt +++ b/words.txt @@ -1,5 +1,5 @@ -ACCOUNTQUEUE accountqueue +ACCOUNTQUEUE ACCOUNTSLOTS accountslots ADDI @@ -30,8 +30,8 @@ blobspace Blockdaemon Blockdaemon's blockhash -blocklists BLOCKLOGS +blocklists blocklogs BLOCKPROFILERATE blockprofilerate @@ -409,4 +409,4 @@ xtensibility ZKPs ZKVM Zora -zora +zora \ No newline at end of file