generate

zeta-chain · Oct 17, 2024 · 0f3b61e · 0f3b61e
1 parent 8f318f1
commit 0f3b61e
Show file tree

Hide file tree

Showing 58 changed files with 4,049 additions and 122 deletions.
diff --git a/v2/contracts/evm/interfaces/IGatewayEVM.sol b/v2/contracts/evm/interfaces/IGatewayEVM.sol
@@ -39,7 +39,7 @@ interface IGatewayEVMEvents {
         address indexed receiver,
         uint256 amount,
         address asset,
-        bytes reserved, // Previously `payload`
+        bytes reserved,
         RevertOptions revertOptions
     );
 
@@ -59,7 +59,6 @@ interface IGatewayEVMEvents {
         RevertOptions revertOptions
     );
 
-
     /// @notice Emitted when an omnichain smart contract call is made without asset transfer.
     /// @param sender The address of the sender.
     /// @param receiver The address of the receiver.

diff --git a/v2/contracts/zevm/interfaces/IGatewayZEVM.sol b/v2/contracts/zevm/interfaces/IGatewayZEVM.sol
@@ -42,7 +42,7 @@ interface IGatewayZEVMEvents {
         uint256 value,
         uint256 gasfee,
         uint256 protocolFlatFee,
-        bytes reserved, // Previously `message`
+        bytes reserved,
         CallOptions callOptions,
         RevertOptions revertOptions
     );

diff --git a/v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md b/v2/docs/src/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md
@@ -264,6 +264,9 @@ function withdrawAndRevert(
 
 Deposits asset to custody and pay fee in zeta erc20.
 
+**Note:**
+This method is deprecated.
+
 
 ```solidity
 function deposit(

diff --git a/v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md b/v2/docs/src/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md
@@ -85,6 +85,9 @@ uint256 public constant MAX_PAYLOAD_SIZE = 1024;
 ## Functions
 ### constructor
 
+**Note:**
+constructor
+
 
 ```solidity
 constructor();

diff --git a/...ocs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md b/...ocs/src/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md
@@ -62,6 +62,32 @@ Emitted when a deposit is made.
 
 ```solidity
 event Deposited(
+    address indexed sender,
+    address indexed receiver,
+    uint256 amount,
+    address asset,
+    bytes reserved,
+    RevertOptions revertOptions
+);
+```
+
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`sender`|`address`|The address of the sender.|
+|`receiver`|`address`|The address of the receiver.|
+|`amount`|`uint256`|The amount of ETH or tokens deposited.|
+|`asset`|`address`|The address of the ERC20 token (zero address if ETH).|
+|`reserved`|`bytes`|Reserved for future use; previously used as `payload`.|
+|`revertOptions`|`RevertOptions`|Revert options.|
+
+### DepositedAndCalled
+Emitted when a deposit and call is made.
+
+
+```solidity
+event DepositedAndCalled(
     address indexed sender,
     address indexed receiver,
     uint256 amount,

diff --git a/v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md b/v2/docs/src/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md
@@ -58,6 +58,9 @@ modifier onlyProtocol();
 
 ### constructor
 
+**Note:**
+constructor
+
 
 ```solidity
 constructor();

diff --git a/.../src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md b/.../src/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md
@@ -37,6 +37,40 @@ Emitted when a withdrawal is made.
 
 ```solidity
 event Withdrawn(
+    address indexed sender,
+    uint256 indexed chainId,
+    bytes receiver,
+    address zrc20,
+    uint256 value,
+    uint256 gasfee,
+    uint256 protocolFlatFee,
+    bytes reserved,
+    CallOptions callOptions,
+    RevertOptions revertOptions
+);
+```
+
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`sender`|`address`|The address from which the tokens are withdrawn.|
+|`chainId`|`uint256`|Chain id of external chain.|
+|`receiver`|`bytes`|The receiver address on the external chain.|
+|`zrc20`|`address`|The address of the ZRC20 token.|
+|`value`|`uint256`|The amount of tokens withdrawn.|
+|`gasfee`|`uint256`|The gas fee for the withdrawal.|
+|`protocolFlatFee`|`uint256`|The protocol flat fee for the withdrawal.|
+|`reserved`|`bytes`|Reserved for future use; previously used as `message`.|
+|`callOptions`|`CallOptions`|Call options including gas limit and arbirtrary call flag.|
+|`revertOptions`|`RevertOptions`|Revert options.|
+
+### WithdrawnAndCalled
+Emitted when a withdraw and call is made.
+
+
+```solidity
+event WithdrawnAndCalled(
     address indexed sender,
     uint256 indexed chainId,
     bytes receiver,

diff --git a/v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md b/v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md
@@ -1,6 +1,10 @@
 # zContract
 [Git Source](https://github.com/zeta-chain/protocol-contracts/blob/main/v2/contracts/zevm/interfaces/UniversalContract.sol)
 
+**Note:**
+should be removed once v2 SystemContract is not used anymore.
+UniversalContract should be used
+
 
 ## Functions
 ### onCrossChainCall

diff --git a/v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md b/v2/docs/src/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md
@@ -1,6 +1,10 @@
 # zContext
 [Git Source](https://github.com/zeta-chain/protocol-contracts/blob/main/v2/contracts/zevm/interfaces/UniversalContract.sol)
 
+**Note:**
+should be removed once v2 SystemContract is not used anymore.
+MessageContext should be used
+
 
 ```solidity
 struct zContext {

diff --git a/v2/pkg/erc20custody.sol/erc20custody.go b/v2/pkg/erc20custody.sol/erc20custody.go
diff --git a/v2/pkg/erc20custody.t.sol/erc20custodytest.go b/v2/pkg/erc20custody.t.sol/erc20custodytest.go
diff --git a/v2/pkg/erc20custodyupgradetest.sol/erc20custodyupgradetest.go b/v2/pkg/erc20custodyupgradetest.sol/erc20custodyupgradetest.go
diff --git a/v2/pkg/gatewayevm.sol/gatewayevm.go b/v2/pkg/gatewayevm.sol/gatewayevm.go
diff --git a/v2/pkg/gatewayevm.t.sol/gatewayevminboundtest.go b/v2/pkg/gatewayevm.t.sol/gatewayevminboundtest.go
diff --git a/v2/pkg/gatewayevm.t.sol/gatewayevmtest.go b/v2/pkg/gatewayevm.t.sol/gatewayevmtest.go
diff --git a/v2/pkg/gatewayevmupgradetest.sol/gatewayevmupgradetest.go b/v2/pkg/gatewayevmupgradetest.sol/gatewayevmupgradetest.go
diff --git a/v2/pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.go b/v2/pkg/gatewayevmzevm.t.sol/gatewayevmzevmtest.go
diff --git a/v2/pkg/gatewayzevm.sol/gatewayzevm.go b/v2/pkg/gatewayzevm.sol/gatewayzevm.go
diff --git a/v2/pkg/gatewayzevm.t.sol/gatewayzevminboundtest.go b/v2/pkg/gatewayzevm.t.sol/gatewayzevminboundtest.go
diff --git a/v2/pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.go b/v2/pkg/gatewayzevm.t.sol/gatewayzevmoutboundtest.go
diff --git a/v2/pkg/gatewayzevmupgradetest.sol/gatewayzevmupgradetest.go b/v2/pkg/gatewayzevmupgradetest.sol/gatewayzevmupgradetest.go
diff --git a/v2/pkg/igatewayevm.sol/igatewayevm.go b/v2/pkg/igatewayevm.sol/igatewayevm.go
diff --git a/v2/pkg/igatewayevm.sol/igatewayevmevents.go b/v2/pkg/igatewayevm.sol/igatewayevmevents.go
diff --git a/v2/pkg/igatewayzevm.sol/igatewayzevm.go b/v2/pkg/igatewayzevm.sol/igatewayzevm.go
diff --git a/v2/pkg/igatewayzevm.sol/igatewayzevmevents.go b/v2/pkg/igatewayzevm.sol/igatewayzevmevents.go
diff --git a/v2/pkg/receiverevm.sol/receiverevm.go b/v2/pkg/receiverevm.sol/receiverevm.go
diff --git a/v2/pkg/senderzevm.sol/senderzevm.go b/v2/pkg/senderzevm.sol/senderzevm.go