deposit and call gateway zevm

zeta-chain · Jul 10, 2024 · f3c9a0b · f3c9a0b
1 parent 0e03d10
commit f3c9a0b
Show file tree

Hide file tree

Showing 8 changed files with 182 additions and 28 deletions.
diff --git a/contracts/prototypes/zevm/GatewayZEVM.sol b/contracts/prototypes/zevm/GatewayZEVM.sol
@@ -125,4 +125,22 @@ contract GatewayZEVM is IGatewayZEVMEvents, IGatewayZEVMErrors, Initializable, O
         IZRC20(zrc20).deposit(target, amount);
         zContract(target).onCrossChainCall(context, zrc20, amount, message);
     }
+
+    // Deposit zeta and call user specified contract on ZEVM
+    // TODO: Finalize access control
+    // https://github.com/zeta-chain/protocol-contracts/issues/204
+    function depositAndCall(
+        zContext calldata context,
+        uint256 amount,
+        address target,
+        bytes calldata message
+    ) external {
+        if (msg.sender != FUNGIBLE_MODULE_ADDRESS) revert CallerIsNotFungibleModule();
+        if (target == FUNGIBLE_MODULE_ADDRESS || target == address(this)) revert InvalidTarget();
+
+        if (!IWETH9(wzeta).transferFrom(msg.sender, address(this), amount)) revert WZETATransferFailed();
+        IWETH9(wzeta).withdraw(amount);
+        (bool sent, ) = target.call{value: amount}("");
+        zContract(target).onCrossChainCall(context, wzeta, amount, message);
+    }
 }
diff --git a/pkg/contracts/prototypes/test/gatewayevmzevm.t.sol/gatewayevmzevmtest.go b/pkg/contracts/prototypes/test/gatewayevmzevm.t.sol/gatewayevmzevmtest.go
diff --git a/pkg/contracts/prototypes/zevm/gatewayzevm.sol/gatewayzevm.go b/pkg/contracts/prototypes/zevm/gatewayzevm.sol/gatewayzevm.go
diff --git a/test/prototypes/GatewayIntegration.spec.ts b/test/prototypes/GatewayIntegration.spec.ts
@@ -1,6 +1,6 @@
 import { AddressZero } from "@ethersproject/constants";
 import { SignerWithAddress } from "@nomiclabs/hardhat-ethers/signers";
-import { SystemContract, ZRC20, WETH9 } from "@typechain-types";
+import { SystemContract, WETH9, ZRC20 } from "@typechain-types";
 import { expect } from "chai";
 import { Contract } from "ethers";
 import { parseEther } from "ethers/lib/utils";
@@ -143,7 +143,13 @@ describe("GatewayEVM GatewayZEVM integration", function () {
     // Encode the function call data and call on zevm
     const message = receiverEVM.interface.encodeFunctionData("receivePayable", [str, num, flag]);
     const callTx = await gatewayZEVM
-      .connect(ownerZEVM)["withdrawAndCall(bytes,uint256,address,bytes)"](receiverEVM.address, parseEther("1"), ZRC20Contract.address, message);
+      .connect(ownerZEVM)
+      ["withdrawAndCall(bytes,uint256,address,bytes)"](
+        receiverEVM.address,
+        parseEther("1"),
+        ZRC20Contract.address,
+        message
+      );
 
     await expect(callTx)
       .to.emit(gatewayZEVM, "Withdrawal")

diff --git a/test/prototypes/GatewayZEVM.spec.ts b/test/prototypes/GatewayZEVM.spec.ts
@@ -35,7 +35,7 @@ describe("GatewayZEVM", function () {
     systemContract = (await SystemContractFactory.deploy(AddressZero, AddressZero, AddressZero)) as SystemContract;
     const WZETAFactory = await ethers.getContractFactory("contracts/zevm/WZETA.sol:WETH9");
 
-    const zetaTokenContract = (await WZETAFactory.deploy());
+    const zetaTokenContract = await WZETAFactory.deploy();
     const Gateway = await ethers.getContractFactory("GatewayZEVM");
     gateway = await upgrades.deployProxy(Gateway, [zetaTokenContract.address], {
       initializer: "initialize",
@@ -69,7 +69,11 @@ describe("GatewayZEVM", function () {
     it("should withdraw zrc20 and emit event", async function () {
       const tx = await gateway
         .connect(owner)
-        ["withdraw(bytes,uint256,address)"](ethers.utils.arrayify(addrs[0].address), parseEther("1"), ZRC20Contract.address);
+        ["withdraw(bytes,uint256,address)"](
+          ethers.utils.arrayify(addrs[0].address),
+          parseEther("1"),
+          ZRC20Contract.address
+        );
 
       const balanceOfAfterWithdrawal = (await ZRC20Contract.balanceOf(owner.address)) as BigNumber;
       expect(balanceOfAfterWithdrawal).to.equal(parseEther("99"));
@@ -94,7 +98,12 @@ describe("GatewayZEVM", function () {
 
       const tx = await gateway
         .connect(owner)
-        ["withdrawAndCall(bytes,uint256,address,bytes)"](ethers.utils.arrayify(addrs[0].address), parseEther("1"), ZRC20Contract.address, message);
+        ["withdrawAndCall(bytes,uint256,address,bytes)"](
+          ethers.utils.arrayify(addrs[0].address),
+          parseEther("1"),
+          ZRC20Contract.address,
+          message
+        );
 
       const balanceOfAfterWithdrawal = (await ZRC20Contract.balanceOf(owner.address)) as BigNumber;
       expect(balanceOfAfterWithdrawal).to.equal(parseEther("99"));
@@ -165,7 +174,7 @@ describe("GatewayZEVM", function () {
       const message = ethers.utils.defaultAbiCoder.encode(["string"], ["hello"]);
       const tx = await gateway
         .connect(fungibleModuleSigner)
-        .depositAndCall(
+        ["depositAndCall((bytes,address,uint256),address,uint256,address,bytes)"](
           [gateway.address, fungibleModuleSigner.address, 1],
           ZRC20Contract.address,
           parseEther("1"),

diff --git a/typechain-types/contracts/prototypes/zevm/GatewayZEVM.ts b/typechain-types/contracts/prototypes/zevm/GatewayZEVM.ts
@@ -45,6 +45,7 @@ export interface GatewayZEVMInterface extends utils.Interface {
     "FUNGIBLE_MODULE_ADDRESS()": FunctionFragment;
     "call(bytes,bytes)": FunctionFragment;
     "deposit(address,uint256,address)": FunctionFragment;
+    "depositAndCall((bytes,address,uint256),uint256,address,bytes)": FunctionFragment;
     "depositAndCall((bytes,address,uint256),address,uint256,address,bytes)": FunctionFragment;
     "execute((bytes,address,uint256),address,uint256,address,bytes)": FunctionFragment;
     "initialize(address)": FunctionFragment;
@@ -66,7 +67,8 @@ export interface GatewayZEVMInterface extends utils.Interface {
       | "FUNGIBLE_MODULE_ADDRESS"
       | "call"
       | "deposit"
-      | "depositAndCall"
+      | "depositAndCall((bytes,address,uint256),uint256,address,bytes)"
+      | "depositAndCall((bytes,address,uint256),address,uint256,address,bytes)"
       | "execute"
       | "initialize"
       | "owner"
@@ -99,7 +101,16 @@ export interface GatewayZEVMInterface extends utils.Interface {
     ]
   ): string;
   encodeFunctionData(
-    functionFragment: "depositAndCall",
+    functionFragment: "depositAndCall((bytes,address,uint256),uint256,address,bytes)",
+    values: [
+      ZContextStruct,
+      PromiseOrValue<BigNumberish>,
+      PromiseOrValue<string>,
+      PromiseOrValue<BytesLike>
+    ]
+  ): string;
+  encodeFunctionData(
+    functionFragment: "depositAndCall((bytes,address,uint256),address,uint256,address,bytes)",
     values: [
       ZContextStruct,
       PromiseOrValue<string>,
@@ -177,7 +188,11 @@ export interface GatewayZEVMInterface extends utils.Interface {
   decodeFunctionResult(functionFragment: "call", data: BytesLike): Result;
   decodeFunctionResult(functionFragment: "deposit", data: BytesLike): Result;
   decodeFunctionResult(
-    functionFragment: "depositAndCall",
+    functionFragment: "depositAndCall((bytes,address,uint256),uint256,address,bytes)",
+    data: BytesLike
+  ): Result;
+  decodeFunctionResult(
+    functionFragment: "depositAndCall((bytes,address,uint256),address,uint256,address,bytes)",
     data: BytesLike
   ): Result;
   decodeFunctionResult(functionFragment: "execute", data: BytesLike): Result;
@@ -351,7 +366,15 @@ export interface GatewayZEVM extends BaseContract {
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<ContractTransaction>;
 
-    depositAndCall(
+    "depositAndCall((bytes,address,uint256),uint256,address,bytes)"(
+      context: ZContextStruct,
+      amount: PromiseOrValue<BigNumberish>,
+      target: PromiseOrValue<string>,
+      message: PromiseOrValue<BytesLike>,
+      overrides?: Overrides & { from?: PromiseOrValue<string> }
+    ): Promise<ContractTransaction>;
+
+    "depositAndCall((bytes,address,uint256),address,uint256,address,bytes)"(
       context: ZContextStruct,
       zrc20: PromiseOrValue<string>,
       amount: PromiseOrValue<BigNumberish>,
@@ -442,7 +465,15 @@ export interface GatewayZEVM extends BaseContract {
     overrides?: Overrides & { from?: PromiseOrValue<string> }
   ): Promise<ContractTransaction>;
 
-  depositAndCall(
+  "depositAndCall((bytes,address,uint256),uint256,address,bytes)"(
+    context: ZContextStruct,
+    amount: PromiseOrValue<BigNumberish>,
+    target: PromiseOrValue<string>,
+    message: PromiseOrValue<BytesLike>,
+    overrides?: Overrides & { from?: PromiseOrValue<string> }
+  ): Promise<ContractTransaction>;
+
+  "depositAndCall((bytes,address,uint256),address,uint256,address,bytes)"(
     context: ZContextStruct,
     zrc20: PromiseOrValue<string>,
     amount: PromiseOrValue<BigNumberish>,
@@ -533,7 +564,15 @@ export interface GatewayZEVM extends BaseContract {
       overrides?: CallOverrides
     ): Promise<void>;
 
-    depositAndCall(
+    "depositAndCall((bytes,address,uint256),uint256,address,bytes)"(
+      context: ZContextStruct,
+      amount: PromiseOrValue<BigNumberish>,
+      target: PromiseOrValue<string>,
+      message: PromiseOrValue<BytesLike>,
+      overrides?: CallOverrides
+    ): Promise<void>;
+
+    "depositAndCall((bytes,address,uint256),address,uint256,address,bytes)"(
       context: ZContextStruct,
       zrc20: PromiseOrValue<string>,
       amount: PromiseOrValue<BigNumberish>,
@@ -690,7 +729,15 @@ export interface GatewayZEVM extends BaseContract {
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<BigNumber>;
 
-    depositAndCall(
+    "depositAndCall((bytes,address,uint256),uint256,address,bytes)"(
+      context: ZContextStruct,
+      amount: PromiseOrValue<BigNumberish>,
+      target: PromiseOrValue<string>,
+      message: PromiseOrValue<BytesLike>,
+      overrides?: Overrides & { from?: PromiseOrValue<string> }
+    ): Promise<BigNumber>;
+
+    "depositAndCall((bytes,address,uint256),address,uint256,address,bytes)"(
       context: ZContextStruct,
       zrc20: PromiseOrValue<string>,
       amount: PromiseOrValue<BigNumberish>,
@@ -784,7 +831,15 @@ export interface GatewayZEVM extends BaseContract {
       overrides?: Overrides & { from?: PromiseOrValue<string> }
     ): Promise<PopulatedTransaction>;
 
-    depositAndCall(
+    "depositAndCall((bytes,address,uint256),uint256,address,bytes)"(
+      context: ZContextStruct,
+      amount: PromiseOrValue<BigNumberish>,
+      target: PromiseOrValue<string>,
+      message: PromiseOrValue<BytesLike>,
+      overrides?: Overrides & { from?: PromiseOrValue<string> }
+    ): Promise<PopulatedTransaction>;
+
+    "depositAndCall((bytes,address,uint256),address,uint256,address,bytes)"(
       context: ZContextStruct,
       zrc20: PromiseOrValue<string>,
       amount: PromiseOrValue<BigNumberish>,

diff --git a/...s/factories/contracts/prototypes/test/GatewayEVMZEVM.t.sol/GatewayEVMZEVMTest__factory.ts b/...s/factories/contracts/prototypes/test/GatewayEVMZEVM.t.sol/GatewayEVMZEVMTest__factory.ts
diff --git a/typechain-types/factories/contracts/prototypes/zevm/GatewayZEVM__factory.ts b/typechain-types/factories/contracts/prototypes/zevm/GatewayZEVM__factory.ts