feat: add context to SystemContract onDepositAndCall (#64)

zeta-chain · Aug 4, 2023 · bbfea49 · bbfea49
1 parent 14a502e
commit bbfea49
Show file tree

Hide file tree

Showing 8 changed files with 136 additions and 33 deletions.
diff --git a/contracts/zevm/SystemContract.sol b/contracts/zevm/SystemContract.sol
@@ -15,6 +15,7 @@ interface SystemContractErrors {
  error ZeroAddress();
 }
 
+
 /**
  * @dev The system contract it's called by the protocol to interact with the blockchain.
  * Also includes a lot of tools to make easier to interact with ZetaChain.
@@ -65,12 +66,12 @@ contract SystemContract is SystemContractErrors {
  * @param target, contract address to make a call after deposit.
  * @param message, calldata for a call.
  */
- function depositAndCall(address zrc20, uint256 amount, address target, bytes calldata message) external {
+ function depositAndCall(Context calldata context, address zrc20, 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();
 
  IZRC20(zrc20).deposit(target, amount);
- zContract(target).onCrossChainCall(zrc20, amount, message);
+ zContract(target).onCrossChainCall(context, zrc20, amount, message);
  }
 
  /**

diff --git a/contracts/zevm/interfaces/zContract.sol b/contracts/zevm/interfaces/zContract.sol
@@ -1,6 +1,14 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.7;
 
+struct Context {
+ bytes origin;
+ address sender;
+ uint256 chainID;
+}
+
 interface zContract {
- function onCrossChainCall(address zrc20, uint256 amount, bytes calldata message) external;
+ function onCrossChainCall(Context calldata context, address zrc20, uint256 amount, bytes calldata message) external;
 }
+
+
diff --git a/pkg/contracts/zevm/interfaces/zcontract.sol/zcontract.go b/pkg/contracts/zevm/interfaces/zcontract.sol/zcontract.go
diff --git a/pkg/contracts/zevm/systemcontract.sol/systemcontract.go b/pkg/contracts/zevm/systemcontract.sol/systemcontract.go
diff --git a/typechain-types/contracts/zevm/SystemContract.sol/SystemContract.ts b/typechain-types/contracts/zevm/SystemContract.sol/SystemContract.ts
@@ -27,10 +27,22 @@ import type {
  PromiseOrValue,
 } from "../../../common";
 
+export type ContextStruct = {
+ origin: PromiseOrValue<BytesLike>;
+ sender: PromiseOrValue<string>;
+ chainID: PromiseOrValue<BigNumberish>;
+};
+
+export type ContextStructOutput = [string, string, BigNumber] & {
+ origin: string;
+ sender: string;
+ chainID: BigNumber;
+};
+
 export interface SystemContractInterface extends utils.Interface {
  functions: {
  "FUNGIBLE_MODULE_ADDRESS()": FunctionFragment;
- "depositAndCall(address,uint256,address,bytes)": FunctionFragment;
+ "depositAndCall((bytes,address,uint256),address,uint256,address,bytes)": FunctionFragment;
  "gasCoinZRC20ByChainId(uint256)": FunctionFragment;
  "gasPriceByChainId(uint256)": FunctionFragment;
  "gasZetaPoolByChainId(uint256)": FunctionFragment;
@@ -72,6 +84,7 @@ export interface SystemContractInterface extends utils.Interface {
  encodeFunctionData(
  functionFragment: "depositAndCall",
  values: [
+ ContextStruct,
  PromiseOrValue<string>,
  PromiseOrValue<BigNumberish>,
  PromiseOrValue<string>,
@@ -303,6 +316,7 @@ export interface SystemContract extends BaseContract {
  FUNGIBLE_MODULE_ADDRESS(overrides?: CallOverrides): Promise<[string]>;
 
  depositAndCall(
+ context: ContextStruct,
  zrc20: PromiseOrValue<string>,
  amount: PromiseOrValue<BigNumberish>,
  target: PromiseOrValue<string>,
@@ -372,6 +386,7 @@ export interface SystemContract extends BaseContract {
  FUNGIBLE_MODULE_ADDRESS(overrides?: CallOverrides): Promise<string>;
 
  depositAndCall(
+ context: ContextStruct,
  zrc20: PromiseOrValue<string>,
  amount: PromiseOrValue<BigNumberish>,
  target: PromiseOrValue<string>,
@@ -441,6 +456,7 @@ export interface SystemContract extends BaseContract {
  FUNGIBLE_MODULE_ADDRESS(overrides?: CallOverrides): Promise<string>;
 
  depositAndCall(
+ context: ContextStruct,
  zrc20: PromiseOrValue<string>,
  amount: PromiseOrValue<BigNumberish>,
  target: PromiseOrValue<string>,
@@ -540,6 +556,7 @@ export interface SystemContract extends BaseContract {
  FUNGIBLE_MODULE_ADDRESS(overrides?: CallOverrides): Promise<BigNumber>;
 
  depositAndCall(
+ context: ContextStruct,
  zrc20: PromiseOrValue<string>,
  amount: PromiseOrValue<BigNumberish>,
  target: PromiseOrValue<string>,
@@ -612,6 +629,7 @@ export interface SystemContract extends BaseContract {
  ): Promise<PopulatedTransaction>;
 
  depositAndCall(
+ context: ContextStruct,
  zrc20: PromiseOrValue<string>,
  amount: PromiseOrValue<BigNumberish>,
  target: PromiseOrValue<string>,

diff --git a/typechain-types/contracts/zevm/interfaces/ZContract.ts b/typechain-types/contracts/zevm/interfaces/ZContract.ts
@@ -23,16 +23,29 @@ import type {
  PromiseOrValue,
 } from "../../../common";
 
+export type ContextStruct = {
+ origin: PromiseOrValue<BytesLike>;
+ sender: PromiseOrValue<string>;
+ chainID: PromiseOrValue<BigNumberish>;
+};
+
+export type ContextStructOutput = [string, string, BigNumber] & {
+ origin: string;
+ sender: string;
+ chainID: BigNumber;
+};
+
 export interface ZContractInterface extends utils.Interface {
  functions: {
- "onCrossChainCall(address,uint256,bytes)": FunctionFragment;
+ "onCrossChainCall((bytes,address,uint256),address,uint256,bytes)": FunctionFragment;
  };
 
  getFunction(nameOrSignatureOrTopic: "onCrossChainCall"): FunctionFragment;
 
  encodeFunctionData(
  functionFragment: "onCrossChainCall",
  values: [
+ ContextStruct,
  PromiseOrValue<string>,
  PromiseOrValue<BigNumberish>,
  PromiseOrValue<BytesLike>
@@ -75,6 +88,7 @@ export interface ZContract extends BaseContract {
 
  functions: {
  onCrossChainCall(
+ context: ContextStruct,
  zrc20: PromiseOrValue<string>,
  amount: PromiseOrValue<BigNumberish>,
  message: PromiseOrValue<BytesLike>,
@@ -83,6 +97,7 @@ export interface ZContract extends BaseContract {
  };
 
  onCrossChainCall(
+ context: ContextStruct,
  zrc20: PromiseOrValue<string>,
  amount: PromiseOrValue<BigNumberish>,
  message: PromiseOrValue<BytesLike>,
@@ -91,6 +106,7 @@ export interface ZContract extends BaseContract {
 
  callStatic: {
  onCrossChainCall(
+ context: ContextStruct,
  zrc20: PromiseOrValue<string>,
  amount: PromiseOrValue<BigNumberish>,
  message: PromiseOrValue<BytesLike>,
@@ -102,6 +118,7 @@ export interface ZContract extends BaseContract {
 
  estimateGas: {
  onCrossChainCall(
+ context: ContextStruct,
  zrc20: PromiseOrValue<string>,
  amount: PromiseOrValue<BigNumberish>,
  message: PromiseOrValue<BytesLike>,
@@ -111,6 +128,7 @@ export interface ZContract extends BaseContract {
 
  populateTransaction: {
  onCrossChainCall(
+ context: ContextStruct,
  zrc20: PromiseOrValue<string>,
  amount: PromiseOrValue<BigNumberish>,
  message: PromiseOrValue<BytesLike>,