From 4c9c865b68e7c0449dcc09821ad1d8c40a91db69 Mon Sep 17 00:00:00 2001 From: fadeev Date: Sat, 5 Oct 2024 00:27:10 +0000 Subject: [PATCH] "docs: update protocol contract docs" --- .../Revert.sol/interface.Revertable.md | 2 +- .../Revert.sol/struct.RevertContext.md | 6 ++--- .../Revert.sol/struct.RevertOptions.md | 2 +- .../ERC20Custody.sol/contract.ERC20Custody.md | 17 +++++++++++- .../evm/GatewayEVM.sol/contract.GatewayEVM.md | 26 ++++++++++++++++++- .../abstract.ZetaConnectorBase.md | 26 ++++++++++++++++++- .../contract.ZetaConnectorNative.md | 2 +- .../contract.ZetaConnectorNonNative.md | 2 +- .../interface.IERC20Custody.md | 2 +- .../interface.IERC20CustodyErrors.md | 2 +- .../interface.IERC20CustodyEvents.md | 16 +++++++++++- .../IGatewayEVM.sol/interface.Callable.md | 2 +- .../IGatewayEVM.sol/interface.IGatewayEVM.md | 2 +- .../interface.IGatewayEVMErrors.md | 10 ++++++- .../interface.IGatewayEVMEvents.md | 16 +++++++++++- .../IGatewayEVM.sol/struct.MessageContext.md | 2 +- .../interface.IZetaConnectorEvents.md | 16 +++++++++++- .../interface.IZetaNonEthNew.md | 2 +- .../GatewayZEVM.sol/contract.GatewayZEVM.md | 11 +++++++- .../contract.SystemContract.md | 2 +- .../interface.SystemContractErrors.md | 2 +- .../zevm/ZRC20.sol/contract.ZRC20.md | 2 +- .../zevm/ZRC20.sol/interface.ZRC20Errors.md | 2 +- .../interface.IGatewayZEVM.md | 2 +- .../interface.IGatewayZEVMErrors.md | 16 +++++++++--- .../interface.IGatewayZEVMEvents.md | 2 +- .../IGatewayZEVM.sol/struct.CallOptions.md | 2 +- .../ISystem.sol/interface.ISystem.md | 2 +- .../interfaces/IWZETA.sol/interface.IWETH9.md | 2 +- .../interfaces/IZRC20.sol/enum.CoinType.md | 2 +- .../interfaces/IZRC20.sol/interface.IZRC20.md | 2 +- .../IZRC20.sol/interface.IZRC20Metadata.md | 2 +- .../IZRC20.sol/interface.ZRC20Events.md | 2 +- .../interface.UniversalContract.md | 2 +- .../interface.zContract.md | 2 +- .../UniversalContract.sol/struct.zContext.md | 2 +- 36 files changed, 171 insertions(+), 41 deletions(-) diff --git a/src/pages/developers/architecture/protocol/contracts/Revert.sol/interface.Revertable.md b/src/pages/developers/architecture/protocol/contracts/Revert.sol/interface.Revertable.md index 0e44e885..ce41c95b 100644 --- a/src/pages/developers/architecture/protocol/contracts/Revert.sol/interface.Revertable.md +++ b/src/pages/developers/architecture/protocol/contracts/Revert.sol/interface.Revertable.md @@ -1,5 +1,5 @@ # Revertable -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/Revert.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/Revert.sol) Interface for contracts that support revertable calls. diff --git a/src/pages/developers/architecture/protocol/contracts/Revert.sol/struct.RevertContext.md b/src/pages/developers/architecture/protocol/contracts/Revert.sol/struct.RevertContext.md index ab1ac4d2..97f155ee 100644 --- a/src/pages/developers/architecture/protocol/contracts/Revert.sol/struct.RevertContext.md +++ b/src/pages/developers/architecture/protocol/contracts/Revert.sol/struct.RevertContext.md @@ -1,5 +1,5 @@ # RevertContext -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/Revert.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/Revert.sol) Struct containing revert context passed to onRevert. @@ -8,7 +8,7 @@ Struct containing revert context passed to onRevert. struct RevertContext { address sender; address asset; - uint64 amount; + uint256 amount; bytes revertMessage; } ``` @@ -19,6 +19,6 @@ struct RevertContext { |----|----|-----------| |`sender`|`address`|Address of account that initiated smart contract call.| |`asset`|`address`|Address of asset, empty if it's gas token.| -|`amount`|`uint64`|Amount specified with the transaction.| +|`amount`|`uint256`|Amount specified with the transaction.| |`revertMessage`|`bytes`|Arbitrary data sent back in onRevert.| diff --git a/src/pages/developers/architecture/protocol/contracts/Revert.sol/struct.RevertOptions.md b/src/pages/developers/architecture/protocol/contracts/Revert.sol/struct.RevertOptions.md index 366e2410..4a1e3262 100644 --- a/src/pages/developers/architecture/protocol/contracts/Revert.sol/struct.RevertOptions.md +++ b/src/pages/developers/architecture/protocol/contracts/Revert.sol/struct.RevertOptions.md @@ -1,5 +1,5 @@ # RevertOptions -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/Revert.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/Revert.sol) Struct containing revert options diff --git a/src/pages/developers/architecture/protocol/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md b/src/pages/developers/architecture/protocol/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md index 689e5653..cba9f05f 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/ERC20Custody.sol/contract.ERC20Custody.md @@ -1,5 +1,5 @@ # ERC20Custody -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/ERC20Custody.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/ERC20Custody.sol) **Inherits:** [IERC20Custody](/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md), ReentrancyGuard, AccessControl, Pausable @@ -103,6 +103,21 @@ Unpause contract. function unpause() external onlyRole(PAUSER_ROLE); ``` +### updateTSSAddress + +Update tss address + + +```solidity +function updateTSSAddress(address newTSSAddress) external onlyRole(DEFAULT_ADMIN_ROLE); +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`newTSSAddress`|`address`|new tss address| + + ### setSupportsLegacy Unpause contract. diff --git a/src/pages/developers/architecture/protocol/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md b/src/pages/developers/architecture/protocol/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md index a5e9c818..66a12eba 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/GatewayEVM.sol/contract.GatewayEVM.md @@ -1,5 +1,5 @@ # GatewayEVM -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/GatewayEVM.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/GatewayEVM.sol) **Inherits:** Initializable, AccessControlUpgradeable, UUPSUpgradeable, [IGatewayEVM](/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md), ReentrancyGuardUpgradeable, PausableUpgradeable @@ -73,6 +73,15 @@ bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE"); ``` +### MAX_PAYLOAD_SIZE +Max size of payload + revertOptions revert message. + + +```solidity +uint256 public constant MAX_PAYLOAD_SIZE = 1024; +``` + + ## Functions ### constructor @@ -107,6 +116,21 @@ function _authorizeUpgrade(address newImplementation) internal override onlyRole |`newImplementation`|`address`|Address of the new implementation.| +### updateTSSAddress + +Update tss address + + +```solidity +function updateTSSAddress(address newTSSAddress) external onlyRole(DEFAULT_ADMIN_ROLE); +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`newTSSAddress`|`address`|new tss address| + + ### pause Pause contract. diff --git a/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md b/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md index bd21e0cc..7ebbe97a 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md @@ -1,5 +1,5 @@ # ZetaConnectorBase -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/ZetaConnectorBase.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/ZetaConnectorBase.sol) **Inherits:** [IZetaConnectorEvents](/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md), ReentrancyGuard, Pausable, AccessControl @@ -28,6 +28,15 @@ address public immutable zetaToken; ``` +### tssAddress +The address of the TSS (Threshold Signature Scheme) contract. + + +```solidity +address public tssAddress; +``` + + ### WITHDRAWER_ROLE New role identifier for withdrawer role. @@ -67,6 +76,21 @@ Constructor for ZetaConnectors. constructor(address gateway_, address zetaToken_, address tssAddress_, address admin_); ``` +### updateTSSAddress + +Update tss address + + +```solidity +function updateTSSAddress(address newTSSAddress) external onlyRole(DEFAULT_ADMIN_ROLE); +``` +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`newTSSAddress`|`address`|new tss address| + + ### pause Pause contract. diff --git a/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md b/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md index ca5dfa6b..e615bd9f 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorNative.sol/contract.ZetaConnectorNative.md @@ -1,5 +1,5 @@ # ZetaConnectorNative -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/ZetaConnectorNative.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/ZetaConnectorNative.sol) **Inherits:** [ZetaConnectorBase](/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md) diff --git a/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md b/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md index 1b484436..b7735c5e 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/ZetaConnectorNonNative.sol/contract.ZetaConnectorNonNative.md @@ -1,5 +1,5 @@ # ZetaConnectorNonNative -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/ZetaConnectorNonNative.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/ZetaConnectorNonNative.sol) **Inherits:** [ZetaConnectorBase](/contracts/evm/ZetaConnectorBase.sol/abstract.ZetaConnectorBase.md) diff --git a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md index 0e62cbc7..1b6c34e0 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20Custody.md @@ -1,5 +1,5 @@ # IERC20Custody -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/interfaces/IERC20Custody.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/interfaces/IERC20Custody.sol) **Inherits:** [IERC20CustodyEvents](/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md), [IERC20CustodyErrors](/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md) diff --git a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md index 65aa6d6e..c454b9ce 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyErrors.md @@ -1,5 +1,5 @@ # IERC20CustodyErrors -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/interfaces/IERC20Custody.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/interfaces/IERC20Custody.sol) Interface for the errors used in the ERC20 custody contract. diff --git a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md index 2433e422..a3c158aa 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IERC20Custody.sol/interface.IERC20CustodyEvents.md @@ -1,5 +1,5 @@ # IERC20CustodyEvents -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/interfaces/IERC20Custody.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/interfaces/IERC20Custody.sol) Interface for the events emitted by the ERC20 custody contract. @@ -94,3 +94,17 @@ Emitted in legacy deposit method. event Deposited(bytes recipient, IERC20 indexed asset, uint256 amount, bytes message); ``` +### UpdatedCustodyTSSAddress +Emitted when tss address is updated + + +```solidity +event UpdatedCustodyTSSAddress(address newTSSAddress); +``` + +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`newTSSAddress`|`address`|new tss address| + diff --git a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.Callable.md b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.Callable.md index 057b5550..4bd39c8d 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.Callable.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.Callable.md @@ -1,5 +1,5 @@ # Callable -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/interfaces/IGatewayEVM.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/interfaces/IGatewayEVM.sol) Interface implemented by contracts receiving authenticated calls. diff --git a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md index f72c1a06..e49256d5 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVM.md @@ -1,5 +1,5 @@ # IGatewayEVM -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/interfaces/IGatewayEVM.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/interfaces/IGatewayEVM.sol) **Inherits:** [IGatewayEVMErrors](/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md), [IGatewayEVMEvents](/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md) diff --git a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md index 1c0aeeda..9654f9df 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMErrors.md @@ -1,5 +1,5 @@ # IGatewayEVMErrors -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/interfaces/IGatewayEVM.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/interfaces/IGatewayEVM.sol) Interface for the errors used in the GatewayEVM contract. @@ -93,3 +93,11 @@ Error when trying to call onRevert method using arbitrary call. error NotAllowedToCallOnRevert(); ``` +### PayloadSizeExceeded +Error indicating payload size exceeded in external functions. + + +```solidity +error PayloadSizeExceeded(); +``` + diff --git a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md index a4a9a3a0..386d0a7a 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/interface.IGatewayEVMEvents.md @@ -1,5 +1,5 @@ # IGatewayEVMEvents -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/interfaces/IGatewayEVM.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/interfaces/IGatewayEVM.sol) Interface for the events emitted by the GatewayEVM contract. @@ -99,3 +99,17 @@ event Called(address indexed sender, address indexed receiver, bytes payload, Re |`payload`|`bytes`|The calldata passed to the call.| |`revertOptions`|`RevertOptions`|Revert options.| +### UpdatedGatewayTSSAddress +Emitted when tss address is updated + + +```solidity +event UpdatedGatewayTSSAddress(address newTSSAddress); +``` + +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`newTSSAddress`|`address`|new tss address| + diff --git a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/struct.MessageContext.md b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/struct.MessageContext.md index 13bce47a..cc683b7b 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/struct.MessageContext.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IGatewayEVM.sol/struct.MessageContext.md @@ -1,5 +1,5 @@ # MessageContext -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/interfaces/IGatewayEVM.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/interfaces/IGatewayEVM.sol) Message context passed to execute function. diff --git a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md index 4e75ea4a..09bb1a5f 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IZetaConnector.sol/interface.IZetaConnectorEvents.md @@ -1,5 +1,5 @@ # IZetaConnectorEvents -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/interfaces/IZetaConnector.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/interfaces/IZetaConnector.sol) Interface for the events emitted by the ZetaConnector contracts. @@ -53,3 +53,17 @@ event WithdrawnAndReverted(address indexed to, uint256 amount, bytes data, Rever |`data`|`bytes`|The calldata passed to the contract call.| |`revertContext`|`RevertContext`|Revert context to pass to onRevert.| +### UpdatedZetaConnectorTSSAddress +Emitted when tss address is updated + + +```solidity +event UpdatedZetaConnectorTSSAddress(address newTSSAddress); +``` + +**Parameters** + +|Name|Type|Description| +|----|----|-----------| +|`newTSSAddress`|`address`|new tss address| + diff --git a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md index ba9b4f53..e10d6d75 100644 --- a/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md +++ b/src/pages/developers/architecture/protocol/contracts/evm/interfaces/IZetaNonEthNew.sol/interface.IZetaNonEthNew.md @@ -1,5 +1,5 @@ # IZetaNonEthNew -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/evm/interfaces/IZetaNonEthNew.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/evm/interfaces/IZetaNonEthNew.sol) **Inherits:** IERC20 diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md b/src/pages/developers/architecture/protocol/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md index 70ffd85c..5f2680b7 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/GatewayZEVM.sol/contract.GatewayZEVM.md @@ -1,5 +1,5 @@ # GatewayZEVM -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/GatewayZEVM.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/GatewayZEVM.sol) **Inherits:** [IGatewayZEVM](/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md), Initializable, AccessControlUpgradeable, UUPSUpgradeable, ReentrancyGuardUpgradeable, PausableUpgradeable @@ -37,6 +37,15 @@ bytes32 public constant PAUSER_ROLE = keccak256("PAUSER_ROLE"); ``` +### MAX_MESSAGE_SIZE +Max size of message + revertOptions revert message. + + +```solidity +uint256 public constant MAX_MESSAGE_SIZE = 1024; +``` + + ## Functions ### onlyProtocol diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/SystemContract.sol/contract.SystemContract.md b/src/pages/developers/architecture/protocol/contracts/zevm/SystemContract.sol/contract.SystemContract.md index 240cbdd4..d5a75ba5 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/SystemContract.sol/contract.SystemContract.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/SystemContract.sol/contract.SystemContract.md @@ -1,5 +1,5 @@ # SystemContract -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/SystemContract.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/SystemContract.sol) **Inherits:** [SystemContractErrors](/contracts/zevm/SystemContract.sol/interface.SystemContractErrors.md) diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/SystemContract.sol/interface.SystemContractErrors.md b/src/pages/developers/architecture/protocol/contracts/zevm/SystemContract.sol/interface.SystemContractErrors.md index ee11a49d..cff85adf 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/SystemContract.sol/interface.SystemContractErrors.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/SystemContract.sol/interface.SystemContractErrors.md @@ -1,5 +1,5 @@ # SystemContractErrors -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/SystemContract.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/SystemContract.sol) *Custom errors for SystemContract* diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/ZRC20.sol/contract.ZRC20.md b/src/pages/developers/architecture/protocol/contracts/zevm/ZRC20.sol/contract.ZRC20.md index 028af2aa..2e41a934 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/ZRC20.sol/contract.ZRC20.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/ZRC20.sol/contract.ZRC20.md @@ -1,5 +1,5 @@ # ZRC20 -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/ZRC20.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/ZRC20.sol) **Inherits:** [IZRC20Metadata](/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md), [ZRC20Errors](/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md), [ZRC20Events](/contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md) diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md b/src/pages/developers/architecture/protocol/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md index 0697b96f..5c0936f3 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/ZRC20.sol/interface.ZRC20Errors.md @@ -1,5 +1,5 @@ # ZRC20Errors -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/ZRC20.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/ZRC20.sol) *Custom errors for ZRC20* diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md index 30ec1677..972441ff 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVM.md @@ -1,5 +1,5 @@ # IGatewayZEVM -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/IGatewayZEVM.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/IGatewayZEVM.sol) **Inherits:** [IGatewayZEVMErrors](/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md), [IGatewayZEVMEvents](/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md) diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md index 3c6a6819..a2102cc5 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMErrors.md @@ -1,5 +1,5 @@ # IGatewayZEVMErrors -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/IGatewayZEVM.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/IGatewayZEVM.sol) Interface for the errors used in the GatewayZEVM contract. @@ -93,11 +93,19 @@ Error indicating that only WZETA or the protocol address can call the function. error OnlyWZETAOrProtocol(); ``` -### EmptyMessage -Error indicating call method received empty message as argument. +### InsufficientGasLimit +Error indicating an insufficient gas limit. ```solidity -error EmptyMessage(); +error InsufficientGasLimit(); +``` + +### MessageSizeExceeded +Error indicating message size exceeded in external functions. + + +```solidity +error MessageSizeExceeded(); ``` diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md index aa9bf0e0..7b888d40 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/interface.IGatewayZEVMEvents.md @@ -1,5 +1,5 @@ # IGatewayZEVMEvents -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/IGatewayZEVM.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/IGatewayZEVM.sol) Interface for the events emitted by the GatewayZEVM contract. diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/struct.CallOptions.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/struct.CallOptions.md index ee90dcd7..33e8fe1f 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/struct.CallOptions.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IGatewayZEVM.sol/struct.CallOptions.md @@ -1,5 +1,5 @@ # CallOptions -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/IGatewayZEVM.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/IGatewayZEVM.sol) CallOptions struct passed to call and withdrawAndCall functions. diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md index bc60fa8f..47d45381 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/ISystem.sol/interface.ISystem.md @@ -1,5 +1,5 @@ # ISystem -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/ISystem.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/ISystem.sol) Interface for the System contract. diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md index 698ca481..21ea4976 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IWZETA.sol/interface.IWETH9.md @@ -1,5 +1,5 @@ # IWETH9 -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/IWZETA.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/IWZETA.sol) Interface for the Weth9 contract. diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md index 0020dfc6..b6867747 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/enum.CoinType.md @@ -1,5 +1,5 @@ # CoinType -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/IZRC20.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/IZRC20.sol) *Coin types for ZRC20. Zeta value should not be used.* diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md index d37b0c16..6d27f570 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md @@ -1,5 +1,5 @@ # IZRC20 -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/IZRC20.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/IZRC20.sol) Interface for the ZRC20 token contract. diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md index f503d704..33ecf326 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20Metadata.md @@ -1,5 +1,5 @@ # IZRC20Metadata -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/IZRC20.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/IZRC20.sol) **Inherits:** [IZRC20](/contracts/zevm/interfaces/IZRC20.sol/interface.IZRC20.md) diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md index fc49e913..dd7cb549 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/IZRC20.sol/interface.ZRC20Events.md @@ -1,5 +1,5 @@ # ZRC20Events -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/IZRC20.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/IZRC20.sol) Interface for the ZRC20 events. diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md index 900df737..6b96480b 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/interface.UniversalContract.md @@ -1,5 +1,5 @@ # UniversalContract -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/UniversalContract.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/UniversalContract.sol) ## Functions diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md index 3aa62bb9..fe4e3182 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/interface.zContract.md @@ -1,5 +1,5 @@ # zContract -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/UniversalContract.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/UniversalContract.sol) ## Functions diff --git a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md index f15fa3b7..9a55f9c8 100644 --- a/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md +++ b/src/pages/developers/architecture/protocol/contracts/zevm/interfaces/UniversalContract.sol/struct.zContext.md @@ -1,5 +1,5 @@ # zContext -[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/3a274ce7bad045a879c73669586611d35509cbce/contracts/zevm/interfaces/UniversalContract.sol) +[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/dedf2ca4d335fe85937fd686450fecebb5456bc9/contracts/zevm/interfaces/UniversalContract.sol) ```solidity