Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
St0rmBr3w committed Dec 4, 2024
1 parent 7206a9f commit d6cdf10
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions examples/oft/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,15 +385,15 @@ 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`**

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
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit d6cdf10

Please sign in to comment.