🗞️ foundry scripts for LayerZero (#1334)

Signed-off-by: shankar <shankar@layerzerolabs.org>
Co-authored-by: ravinagill15 <ravina@layerzerolabs.org>

Author: shankars99

.changeset/weak-ravens-exercise.md

@@ -0,0 +1,7 @@
+---
+"@layerzerolabs/script-devtools-evm-foundry": patch
+"@layerzerolabs/toolbox-foundry": patch
+"@layerzerolabs/oft-example": patch
+---
+
+Added useful forge scripts and updated forge-std to latest commit

examples/oft/foundry.toml

@@ -28,6 +28,7 @@ remappings = [
     'forge-std/=node_modules/@layerzerolabs/toolbox-foundry/lib/forge-std',
     '@layerzerolabs/=node_modules/@layerzerolabs/',
     '@openzeppelin/=node_modules/@openzeppelin/',
+    '@layerzerolabs/script-devtools-evm-foundry/=node_modules/@layerzerolabs/script-devtools-evm-foundry/'
 ]
 
 [fuzz]

examples/oft/package.json

@@ -38,6 +38,7 @@
     "@layerzerolabs/oapp-evm": "^0.3.2",
     "@layerzerolabs/oft-evm": "^3.1.3",
     "@layerzerolabs/prettier-config-next": "^2.3.39",
+    "@layerzerolabs/script-devtools-evm-foundry": "^0.0.1",
     "@layerzerolabs/solhint-config": "^3.0.12",
     "@layerzerolabs/test-devtools-evm-foundry": "~6.0.3",
     "@layerzerolabs/toolbox-foundry": "~0.1.12",

examples/oft/script/LZScript.s.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.0;
+
+import { console } from "forge-std/console.sol";
+
+import { LZScripts } from "@layerzerolabs/script-devtools-evm-foundry/scripts/LZScripts.s.sol";
+
+contract LZScript is LZScripts {
+    function run() public pure override {
+        console.log("Hello, World!");
+    }
+}

packages/script-devtools-evm-foundry/.eslintignore

@@ -0,0 +1,5 @@
+.turbo
+dist
+node_modules
+out
+cache

packages/script-devtools-evm-foundry/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../.eslintrc.json"
+}

packages/script-devtools-evm-foundry/.gitignore

@@ -0,0 +1,7 @@
+cache
+# Ignore everything in the artifacts folder
+artifacts/*
+
+# Do not ignore the directory structure up to the specific file
+!artifacts/
+!artifacts/*.s.sol/

packages/script-devtools-evm-foundry/CHANGELOG.md

@@ -0,0 +1,20 @@
+# @layerzerolabs/script-devtools-evm-foundry
+
+## 0.0.1
+
+### Minor Changes
+
+- Initial release with foundry scripts for LayerZero EVM development
+- Add SimulateReceive script for simulating message reception on EVM chains
+- Add GasProfiler script for profiling gas usage of OFT transfers on mainnet networks
+- Add LZScripts.s.sol bundle for easy importing in custom foundry scripts
+- Include foundry configuration and build artifacts for immediate use
+
+### Patch Changes
+
+- @layerzerolabs/lz-evm-messagelib-v2@3.0.12
+- @layerzerolabs/lz-evm-protocol-v2@3.0.12
+- @layerzerolabs/lz-evm-v1-0.7@3.0.12
+- @layerzerolabs/toolbox-foundry@0.1.12
+- @layerzerolabs/oapp-evm@0.3.1
+- @layerzerolabs/oft-evm@3.1.2

packages/script-devtools-evm-foundry/README.md

@@ -0,0 +1,55 @@
+<p align="center">
+  <a href="https://layerzero.network">
+    <img alt="LayerZero" style="max-width: 500px" src="https://d3a2dpnnrypp5h.cloudfront.net/bridge-app/lz.png"/>
+  </a>
+</p>
+
+<h1 align="center">@layerzerolabs/script-devtools-evm-foundry</h1>
+
+<!-- The badges section -->
+<p align="center">
+  <!-- Shields.io NPM published package version -->
+  <a href="https://www.npmjs.com/package/@layerzerolabs/script-devtools-evm-foundry"><img alt="NPM Version" src="https://img.shields.io/npm/v/@layerzerolabs/script-devtools-evm-foundry"/></a>
+  <!-- Shields.io NPM downloads -->
+  <a href="https://www.npmjs.com/package/@layerzerolabs/script-devtools-evm-foundry"><img alt="Downloads" src="https://img.shields.io/npm/dm/@layerzerolabs/script-devtools-evm-foundry"/></a>
+  <!-- Shields.io license badge -->
+  <a href="https://www.npmjs.com/package/@layerzerolabs/script-devtools-evm-foundry"><img alt="NPM License" src="https://img.shields.io/npm/l/@layerzerolabs/script-devtools-evm-foundry"/></a>
+</p>
+
+## Installation
+
+```sh
+$ npm install @layerzerolabs/script-devtools-evm-foundry
+```
+
+## Usage
+
+This package not only exports a bunch of scripts for you to use in your foundry projects. But since they compile into your `artifacts` folder, you can run them from your command line.
+
+```sh
+forge script SimulateReceive --rpc-url YOUR_DESTINATION_CHAIN_RPC_URL --ffi
+```
+
+Since all the scripts are bundled into `LZScripts.s.sol`, you can import them in your own scripts like this:
+
+```solidity
+import { LZUtils } from "@layerzerolabs/script-devtools-evm-foundry/scripts/LZScripts.s.sol";
+```
+
+## List of scripts
+
+### 1. SimulateReceive
+
+Simulate receiving a message on an EVM chain - [Read more](./script/SimulateReceive/README.md)
+Source code: [SimulateReceive.s.sol](./script/SimulateReceive/SimulateReceive.s.sol)
+Shell command:
+
+```sh
+forge script SimulateReceive --rpc-url $DESTINATION_CHAIN_RPC_URL --ffi
+```
+
+### 2. GasProfiler
+
+Profile the gas usage of OFT transfers on multiple mainnet networks - [Read more](./script/GasProfiling/README.md)
+Source code: [OFTProfilerExample.s.sol](./script/GasProfiling/OFTProfilerExample.s.sol)
+Shell command: Not available