feat: add onAbort interface (#450)

zeta-chain · Jan 24, 2025 · 32756f0 · 32756f0
1 parent 7232d78
commit 32756f0
Show file tree

Hide file tree

Showing 52 changed files with 535 additions and 49 deletions.
diff --git a/contracts/Revert.sol b/contracts/Revert.sol
@@ -29,10 +29,38 @@ struct RevertContext {
     bytes revertMessage;
 }
 
+/// @notice Struct containing abort context passed to onAbort.
+/// @param sender Address of account that initiated smart contract call.
+/// bytes is used as the crosschain transaction can be initiated from a non-EVM chain.
+/// @param asset Address of asset. On a connected chain, it contains the fungible
+/// token address or is empty if it's a gas token. On ZetaChain, it contains the
+/// address of the ZRC20.
+/// @param amount Amount specified with the transaction.
+/// @param outgoing Flag to indicate if the crosschain transaction was outgoing: from ZetaChain to connected chain.
+/// if false, the transaction was incoming: from connected chain to ZetaChain.
+/// @param chainID Chain ID of the connected chain.
+/// @param revertMessage Arbitrary data specified in the RevertOptions object when initating the crosschain transaction.
+struct AbortContext {
+    bytes sender;
+    address asset;
+    uint256 amount;
+    bool outgoing;
+    uint256 chainID;
+    bytes revertMessage;
+}
+
 /// @title Revertable
 /// @notice Interface for contracts that support revertable calls.
 interface Revertable {
     /// @notice Called when a revertable call is made.
     /// @param revertContext Revert context to pass to onRevert.
     function onRevert(RevertContext calldata revertContext) external;
 }
+
+/// @title Abortable
+/// @notice Interface for contracts that support abortable calls.
+interface Abortable {
+    /// @notice Called when a revertable call is aborted.
+    /// @param abortContext Abort context to pass to onAbort.
+    function onAbort(AbortContext calldata abortContext) external;
+}
diff --git a/docs/src/README.md b/docs/src/README.md
@@ -2,14 +2,14 @@
 
 Contracts of official protocol contracts deployed by the core ZetaChain team.
 
-### Learn more about ZetaChain
+## Learn more about ZetaChain
 
 * Check our [website](https://www.zetachain.com/).
 * Read our [docs](https://docs.zetachain.com/).
 
-### Codebase
+## Codebase
 
-The protocol contracts V2 codebase is separated into two sections:
+The protocol contracts codebase is separated into two sections:
 
 - `zevm`: contracts deployed on ZetaChain
 - `evm`: contracts deployed on EVM connected chains (Ethereum, Base, etc..)
@@ -31,7 +31,7 @@ The protocol contracts V2 codebase is separated into two sections:
 
 [Learn more about the Gateway contracts](https://www.zetachain.com/docs/developers/evm/gateway/)
 
-### Usage
+## Usage
 
 **Install dependencies**
 
@@ -68,6 +68,6 @@ To view detailed instructions on how to deploy the contracts, please refer to th
 
 This guide covers all steps required to deploy the contracts, including environment setup, commands, and best practices.
 
-### Community
+## Community
 
 [X](https://x.com/zetablockchain) | [Discord](https://discord.com/invite/zetachain) | [Telegram](https://t.me/zetachainofficial) | [Website](https://zetachain.com)
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -61,4 +61,6 @@
   - [INotSupportedMethods](contracts/Errors.sol/interface.INotSupportedMethods.md)
   - [RevertOptions](contracts/Revert.sol/struct.RevertOptions.md)
   - [RevertContext](contracts/Revert.sol/struct.RevertContext.md)
+  - [AbortContext](contracts/Revert.sol/struct.AbortContext.md)
   - [Revertable](contracts/Revert.sol/interface.Revertable.md)
+  - [Abortable](contracts/Revert.sol/interface.Abortable.md)
diff --git a/docs/src/contracts/README.md b/docs/src/contracts/README.md
@@ -6,4 +6,6 @@
 - [INotSupportedMethods](Errors.sol/interface.INotSupportedMethods.md)
 - [RevertOptions](Revert.sol/struct.RevertOptions.md)
 - [RevertContext](Revert.sol/struct.RevertContext.md)
+- [AbortContext](Revert.sol/struct.AbortContext.md)
 - [Revertable](Revert.sol/interface.Revertable.md)
+- [Abortable](Revert.sol/interface.Abortable.md)
diff --git a/docs/src/contracts/Revert.sol/interface.Abortable.md b/docs/src/contracts/Revert.sol/interface.Abortable.md
@@ -0,0 +1,22 @@
+# Abortable
+[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/main/v2/contracts/Revert.sol)
+
+Interface for contracts that support abortable calls.
+
+
+## Functions
+### onAbort
+
+Called when a revertable call is aborted.
+
+
+```solidity
+function onAbort(AbortContext calldata abortContext) external;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`abortContext`|`AbortContext`|Abort context to pass to onAbort.|
+
+
diff --git a/docs/src/contracts/Revert.sol/struct.AbortContext.md b/docs/src/contracts/Revert.sol/struct.AbortContext.md
@@ -0,0 +1,28 @@
+# AbortContext
+[Git Source](https://github.com/zeta-chain/protocol-contracts/blob/main/v2/contracts/Revert.sol)
+
+Struct containing abort context passed to onAbort.
+
+
+```solidity
+struct AbortContext {
+    bytes sender;
+    address asset;
+    uint256 amount;
+    bool outgoing;
+    uint256 chainID;
+    bytes revertMessage;
+}
+```
+
+**Properties**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`sender`|`bytes`|Address of account that initiated smart contract call. bytes is used as the crosschain transaction can be initiated from a non-EVM chain.|
+|`asset`|`address`|Address of asset. On a connected chain, it contains the fungible token address or is empty if it's a gas token. On ZetaChain, it contains the address of the ZRC20.|
+|`amount`|`uint256`|Amount specified with the transaction.|
+|`outgoing`|`bool`|Flag to indicate if the crosschain transaction was outgoing: from ZetaChain to connected chain. if false, the transaction was incoming: from connected chain to ZetaChain.|
+|`chainID`|`uint256`|Chain ID of the connected chain.|
+|`revertMessage`|`bytes`|Arbitrary data specified in the RevertOptions object when initating the crosschain transaction.|
+
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -6,14 +6,14 @@ title: "Protocol contracts"
 
 Contracts of official protocol contracts deployed by the core ZetaChain team.
 
-### Learn more about ZetaChain
+## Learn more about ZetaChain
 
 * Check our [website](https://www.zetachain.com/).
 * Read our [docs](https://docs.zetachain.com/).
 
-### Codebase
+## Codebase
 
-The protocol contracts V2 codebase is separated into two sections:
+The protocol contracts codebase is separated into two sections:
 
 - `zevm`: contracts deployed on ZetaChain
 - `evm`: contracts deployed on EVM connected chains (Ethereum, Base, etc..)
@@ -35,7 +35,7 @@ The protocol contracts V2 codebase is separated into two sections:
 
 [Learn more about the Gateway contracts](https://www.zetachain.com/docs/developers/evm/gateway/)
 
-### Usage
+## Usage
 
 **Install dependencies**
 
@@ -72,7 +72,7 @@ To view detailed instructions on how to deploy the contracts, please refer to th
 
 This guide covers all steps required to deploy the contracts, including environment setup, commands, and best practices.
 
-### Community
+## Community
 
 [X](https://x.com/zetablockchain) | [Discord](https://discord.com/invite/zetachain) | [Telegram](https://t.me/zetachainofficial) | [Website](https://zetachain.com)# Summary
 - [Home](README.md)
@@ -137,4 +137,6 @@ This guide covers all steps required to deploy the contracts, including environm
   - [INotSupportedMethods](protocol/contracts/Errors.sol/interface.INotSupportedMethods.md)
   - [RevertOptions](protocol/contracts/Revert.sol/struct.RevertOptions.md)
   - [RevertContext](protocol/contracts/Revert.sol/struct.RevertContext.md)
+  - [AbortContext](protocol/contracts/Revert.sol/struct.AbortContext.md)
   - [Revertable](protocol/contracts/Revert.sol/interface.Revertable.md)
+  - [Abortable](protocol/contracts/Revert.sol/interface.Abortable.md)