From d6cdf10cd742acd5d597e7274c2e85ddf089fad1 Mon Sep 17 00:00:00 2001 From: Matthew Krak Date: Tue, 3 Dec 2024 20:38:15 -0800 Subject: [PATCH] chore: update README --- examples/oft/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/examples/oft/README.md b/examples/oft/README.md index a8192f5aa..f39204a6c 100644 --- a/examples/oft/README.md +++ b/examples/oft/README.md @@ -385,7 +385,7 @@ This guide explains how to use the `pnpm` commands to estimate gas usage for Lay This command profiles the `lzReceive` function for estimating gas usage across multiple runs. ```json - "gas:lzReceive": "forge script scripts/GasProfiler.s.sol:GasProfilerScript --via-ir --sig 'run_lzReceive(string,address,address,uint32,address,uint32,bytes,uint256,uint256)'" + "gas:lzReceive": "forge script scripts/GasProfiler.s.sol:GasProfilerScript --via-ir --sig 'run_lzReceive(string,address,uint32,address,uint32,address,bytes,uint256,uint256)'" ``` 2. **`gas:lzCompose`** @@ -393,7 +393,7 @@ This guide explains how to use the `pnpm` commands to estimate gas usage for Lay This command profiles the `lzCompose` function for estimating gas usage across multiple runs. ```json - "gas:lzCompose": "forge script scripts/GasProfiler.s.sol:GasProfilerScript --via-ir --sig 'run_lzCompose(string,address,address,address,uint32,address,uint32,bytes,uint256,uint256)'" + "gas:lzCompose": "forge script scripts/GasProfiler.s.sol:GasProfilerScript --via-ir --sig 'run_lzCompose(string,address,uint32,address,uint32,address,address,bytes,uint256,uint256)'" ``` ### Usage Examples @@ -418,10 +418,10 @@ Where: - `rpcUrl`: The RPC URL for the target blockchain (e.g., Optimism, Arbitrum, etc.). - `endpointAddress`: The deployed LayerZero EndpointV2 contract address. -- `receiver`: The address intended to receive the message (OApp). - `srcEid`: The source endpoint ID (uint32). - `sender`: The sender's address (OApp). - `dstEid`: The destination endpoint ID (uint32). +- `receiver`: The address intended to receive the message (OApp). - `payload`: The message payload as a `bytes` array. - `msgValue`: The amount of Ether sent with the message (in wei). - `numOfRuns`: The number of test runs to execute. @@ -433,11 +433,11 @@ To estimate the gas for the `lzCompose` function: ```bash pnpm gas:lzCompose "https://optimism.gateway.tenderly.co" \ "0x1a44076050125825900e736c501f859c50fE728c" \ - "0x6985884C4392D348587B19cb9eAAf157F13271cd" \ - "0x1DeAfcad438c1b0Cf0a72db9cA77864A49eA1234" \ 30184 \ "0x6985884C4392D348587B19cb9eAAf157F13271cd" \ 30111 \ + "0x6985884C4392D348587B19cb9eAAf157F13271cd" \ + "0x1DeAfcad438c1b0Cf0a72db9cA77864A49eA1234" \ "0x0000000000000000000000008039a9a134ada0639891d08b45fe3440c05dbf620000000009a7ec80" \ 0 \ 100 @@ -447,11 +447,11 @@ Where: - `rpcUrl`: The RPC URL for the target blockchain (e.g., Optimism, Arbitrum, etc.). - `endpointAddress`: The deployed LayerZero EndpointV2 contract address. +- `srcEid`: The source endpoint ID (uint32). +- `sender`: The originating OApp address. +- `dstEid`: The destination endpoint ID (uint32). - `receiver`: The address intended to receive the message (OApp). - `composer`: The LayerZero Composer contract address. -- `dstEid`: The destination endpoint ID (uint32). -- `sender`: The originating OApp address. -- `srcEid`: The source endpoint ID (uint32). - `payload`: The message payload as a `bytes` array. - `msgValue`: The amount of Ether sent with the message (in wei). - `numOfRuns`: The number of test runs to execute.