add comments on localnet forge scripts

zeta-chain · Jul 29, 2024 · 62d0cb5 · 62d0cb5
1 parent b4716de
commit 62d0cb5
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/v2/scripts/localnet/EvmCall.s.sol b/v2/scripts/localnet/EvmCall.s.sol
@@ -5,6 +5,8 @@ import "forge-std/Script.sol";
 import "src/evm/GatewayEVM.sol";
 import "test/utils/TestZContract.sol";
 
+// EvmCallScript executes call method on GatewayEVM and it should be used on localnet.
+// It uses anvil private key, and sets default contract addresses deployed on fresh localnet, that can be overriden with env vars.
 contract EvmCallScript is Script {
     function run() external {
         address payable gatewayEVMAddress = payable(vm.envOr("GATEWAY_EVM", 0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0));

diff --git a/v2/scripts/localnet/EvmDepositAndCall.s.sol b/v2/scripts/localnet/EvmDepositAndCall.s.sol
@@ -6,6 +6,8 @@ import "src/evm/GatewayEVM.sol";
 import "test/utils/TestZContract.sol";
 import "test/utils/TestERC20.sol";
 
+// EvmDepositAndCallScript executes depositAndCall method on GatewayEVM and it should be used on localnet.
+// It uses anvil private key, and sets default contract addresses deployed on fresh localnet, that can be overriden with env vars.
 contract EvmDepositAndCallScript is Script {
     function run() external {
         address payable gatewayEVMAddress = payable(vm.envOr("GATEWAY_EVM", 0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0));

diff --git a/v2/scripts/localnet/ZevmCall.s.sol b/v2/scripts/localnet/ZevmCall.s.sol
@@ -5,6 +5,8 @@ import "forge-std/Script.sol";
 import "src/zevm/GatewayZEVM.sol";
 import "test/utils/ReceiverEVM.sol";
 
+// ZevmCallScript executes call method on GatewayZEVM and it should be used on localnet.
+// It uses anvil private key, and sets default contract addresses deployed on fresh localnet, that can be overriden with env vars.
 contract ZevmCallScript is Script {
     function run() external {
         address payable gatewayZEVMAddress = payable(vm.envOr("GATEWAY_ZEVM", 0x610178dA211FEF7D417bC0e6FeD39F05609AD788));

diff --git a/v2/scripts/localnet/ZevmWithdrawAndCall.s.sol b/v2/scripts/localnet/ZevmWithdrawAndCall.s.sol
@@ -6,6 +6,8 @@ import "src/zevm/GatewayZEVM.sol";
 import "test/utils/ReceiverEVM.sol";
 import "test/utils/ZRC20New.sol";
 
+// ZevmWithdrawAndCallScript executes withdrawAndCall method on GatewayZEVM and it should be used on localnet.
+// It uses anvil private key, and sets default contract addresses deployed on fresh localnet, that can be overriden with env vars.
 contract ZevmWithdrawAndCallScript is Script {
     function run() external {
         address payable gatewayZEVMAddress = payable(vm.envOr("GATEWAY_ZEVM", 0x610178dA211FEF7D417bC0e6FeD39F05609AD788));