feat: add sender to revert context

changelog.md

@@ -15,6 +15,7 @@
 * [2907](https://github.com/zeta-chain/node/pull/2907) - derive Bitcoin tss address by chain id and added more Signet static info
 * [2911](https://github.com/zeta-chain/node/pull/2911) - add chain static information for btc testnet4
 * [2904](https://github.com/zeta-chain/node/pull/2904) - integrate authenticated calls smart contract functionality into protocol
+* [2919](https://github.com/zeta-chain/node/pull/2919) - add inbound sender to revert context
 
 ### Refactor
 

e2e/e2etests/test_v2_erc20_deposit_and_call_revert_with_call.go

@@ -3,6 +3,7 @@ package e2etests
 import (
 	"math/big"
 
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/stretchr/testify/require"
 	"github.com/zeta-chain/protocol-contracts/v2/pkg/gatewayevm.sol"
 
@@ -38,4 +39,12 @@ func TestV2ERC20DepositAndCallRevertWithCall(r *runner.E2ERunner, args []string)
 
 	// check the payload was received on the contract
 	r.AssertTestDAppEVMCalled(true, payloadMessageDepositOnRevertERC20, big.NewInt(0))
+
+	// check expected sender was used
+	senderForMsg, err := r.TestDAppV2EVM.SenderWithMessage(
+		&bind.CallOpts{},
+		[]byte(payloadMessageDepositOnRevertERC20),
+	)
+	require.NoError(r, err)
+	require.Equal(r, r.EVMAuth.From, senderForMsg)
 }

e2e/e2etests/test_v2_erc20_withdraw_and_call_revert_with_call.go

@@ -3,6 +3,7 @@ package e2etests
 import (
 	"math/big"
 
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/stretchr/testify/require"
 	"github.com/zeta-chain/protocol-contracts/v2/pkg/gatewayzevm.sol"
 
@@ -43,4 +44,12 @@ func TestV2ERC20WithdrawAndCallRevertWithCall(r *runner.E2ERunner, args []string
 	require.Equal(r, crosschaintypes.CctxStatus_Reverted, cctx.CctxStatus.Status)
 
 	r.AssertTestDAppZEVMCalled(true, payloadMessageWithdrawOnRevertERC20, big.NewInt(0))
+
+	// check expected sender was used
+	senderForMsg, err := r.TestDAppV2ZEVM.SenderWithMessage(
+		&bind.CallOpts{},
+		[]byte(payloadMessageWithdrawOnRevertERC20),
+	)
+	require.NoError(r, err)
+	require.Equal(r, r.ZEVMAuth.From, senderForMsg)
 }

e2e/e2etests/test_v2_eth_deposit_and_call_revert_with_call.go

@@ -3,6 +3,7 @@ package e2etests
 import (
 	"math/big"
 
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/stretchr/testify/require"
 	"github.com/zeta-chain/protocol-contracts/v2/pkg/gatewayevm.sol"
 
@@ -38,4 +39,12 @@ func TestV2ETHDepositAndCallRevertWithCall(r *runner.E2ERunner, args []string) {
 
 	// check the payload was received on the contract
 	r.AssertTestDAppEVMCalled(true, payloadMessageDepositOnRevertETH, big.NewInt(0))
+
+	// check expected sender was used
+	senderForMsg, err := r.TestDAppV2EVM.SenderWithMessage(
+		&bind.CallOpts{},
+		[]byte(payloadMessageDepositOnRevertETH),
+	)
+	require.NoError(r, err)
+	require.Equal(r, r.EVMAuth.From, senderForMsg)
 }

e2e/e2etests/test_v2_eth_withdraw_and_call_revert_with_call.go

@@ -3,6 +3,7 @@ package e2etests
 import (
 	"math/big"
 
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/stretchr/testify/require"
 	"github.com/zeta-chain/protocol-contracts/v2/pkg/gatewayzevm.sol"
 
@@ -42,4 +43,12 @@ func TestV2ETHWithdrawAndCallRevertWithCall(r *runner.E2ERunner, args []string)
 	require.Equal(r, crosschaintypes.CctxStatus_Reverted, cctx.CctxStatus.Status)
 
 	r.AssertTestDAppZEVMCalled(true, payloadMessageWithdrawOnRevertETH, big.NewInt(0))
+
+	// check expected sender was used
+	senderForMsg, err := r.TestDAppV2ZEVM.SenderWithMessage(
+		&bind.CallOpts{},
+		[]byte(payloadMessageWithdrawOnRevertETH),
+	)
+	require.NoError(r, err)
+	require.Equal(r, r.ZEVMAuth.From, senderForMsg)
 }

go.mod

@@ -59,7 +59,7 @@ require (
 	github.com/stretchr/testify v1.9.0
 	github.com/zeta-chain/ethermint v0.0.0-20240909234716-2fad916e7179
 	github.com/zeta-chain/keystone/keys v0.0.0-20240826165841-3874f358c138
-	github.com/zeta-chain/protocol-contracts v1.0.2-athens3.0.20240920151810-cabe34920d52
+	github.com/zeta-chain/protocol-contracts v1.0.2-athens3.0.20240924201108-3a274ce7bad0
 	gitlab.com/thorchain/tss/go-tss v1.6.5
 	go.nhat.io/grpcmock v0.25.0
 	golang.org/x/crypto v0.23.0

go.sum

@@ -4182,8 +4182,8 @@ github.com/zeta-chain/go-tss v0.0.0-20240916173049-89fee4b0ae7f h1:XqUvw9a3EnDa2
 github.com/zeta-chain/go-tss v0.0.0-20240916173049-89fee4b0ae7f/go.mod h1:B1FDE6kHs8hozKSX1/iXgCdvlFbS6+FeAupoBHDK0Cc=
 github.com/zeta-chain/keystone/keys v0.0.0-20240826165841-3874f358c138 h1:vck/FcIIpFOvpBUm0NO17jbEtmSz/W/a5Y4jRuSJl6I=
 github.com/zeta-chain/keystone/keys v0.0.0-20240826165841-3874f358c138/go.mod h1:U494OsZTWsU75hqoriZgMdSsgSGP1mUL1jX+wN/Aez8=
-github.com/zeta-chain/protocol-contracts v1.0.2-athens3.0.20240920151810-cabe34920d52 h1:DlSY9awQteXVmvY0lPD4Or83iuL4P5KwSGky+n4mYio=
-github.com/zeta-chain/protocol-contracts v1.0.2-athens3.0.20240920151810-cabe34920d52/go.mod h1:SjT7QirtJE8stnAe1SlNOanxtfSfijJm3MGJ+Ax7w7w=
+github.com/zeta-chain/protocol-contracts v1.0.2-athens3.0.20240924201108-3a274ce7bad0 h1:GbfO2dyjSAWqBH0xDIttwPB2fE5A+zw0UUbEoW3S3wU=
+github.com/zeta-chain/protocol-contracts v1.0.2-athens3.0.20240924201108-3a274ce7bad0/go.mod h1:SjT7QirtJE8stnAe1SlNOanxtfSfijJm3MGJ+Ax7w7w=
 github.com/zeta-chain/tss-lib v0.0.0-20240916163010-2e6b438bd901 h1:9whtN5fjYHfk4yXIuAsYP2EHxImwDWDVUOnZJ2pfL3w=
 github.com/zeta-chain/tss-lib v0.0.0-20240916163010-2e6b438bd901/go.mod h1:d2iTC62s9JwKiCMPhcDDXbIZmuzAyJ4lwso0H5QyRbk=
 github.com/zondax/hid v0.9.1/go.mod h1:l5wttcP0jwtdLjqjMMWFVEE7d1zO0jvSPA9OPZxWpEM=

pkg/contracts/testdappv2/TestDAppV2.abi

@@ -204,6 +204,11 @@
     "inputs": [
       {
         "components": [
+          {
+            "internalType": "address",
+            "name": "sender",
+            "type": "address"
+          },
           {
             "internalType": "address",
             "name": "asset",

pkg/contracts/testdappv2/TestDAppV2.sol

@@ -13,10 +13,12 @@ contract TestDAppV2 {
     }
 
     /// @notice Struct containing revert context passed to onRevert.
+    /// @param sender Address of account that initiated smart contract call.
     /// @param asset Address of asset, empty if it's gas token.
     /// @param amount Amount specified with the transaction.
     /// @param revertMessage Arbitrary data sent back in onRevert.
     struct RevertContext {
+        address sender;
         address asset;
         uint64 amount;
         bytes revertMessage;
@@ -100,6 +102,7 @@ contract TestDAppV2 {
     function onRevert(RevertContext calldata revertContext) external {
         setCalledWithMessage(string(revertContext.revertMessage));
         setAmountWithMessage(string(revertContext.revertMessage), 0);
+        senderWithMessage[revertContext.revertMessage] = revertContext.sender;
     }
 
     function setExpectedOnCallSender(address _expectedOnCallSender) external {

x/crosschain/keeper/cctx_orchestrator_validate_outbound.go

@@ -341,6 +341,7 @@
 		// process the revert on ZEVM
 		if err := k.fungibleKeeper.ProcessV2RevertDeposit(
 			ctx,
+			cctx.InboundParams.Sender,
 			cctx.GetCurrentOutboundParam().Amount.BigInt(),
 			chainID,
 			cctx.InboundParams.CoinType,

x/crosschain/keeper/gas_payment.go

@@ -121,6 +121,12 @@
 		return cosmoserrors.Wrap(types.ErrCannotFindGasParams, err.Error())
 	}
 
+	// with V2 protocol, reverts on connected chains can eventually call a onRevert function which can require a higher gas limit
+	if cctx.ProtocolContractVersion == types.ProtocolContractVersion_V2 && cctx.RevertOptions.CallOnRevert &&
+		!cctx.RevertOptions.RevertGasLimit.IsZero() {
+		gas.GasLimit = cctx.RevertOptions.RevertGasLimit
+	}
+
 	// calculate the final gas fee
 	outTxGasFee := gas.GasLimit.Mul(gas.GasPrice).Add(gas.ProtocolFlatFee)
 

x/crosschain/types/expected_keepers.go

@@ -149,6 +149,7 @@ type FungibleKeeper interface {
 	) (*evmtypes.MsgEthereumTxResponse, bool, error)
 	ProcessV2RevertDeposit(
 		ctx sdk.Context,
+		inboundSender string,
 		amount *big.Int,
 		chainID int64,
 		coinType coin.CoinType,

x/fungible/keeper/v2_deposits.go

@@ -49,6 +49,7 @@
 // ProcessV2RevertDeposit handles a revert deposit from an inbound tx with protocol version 2
 func (k Keeper) ProcessV2RevertDeposit(
 	ctx sdk.Context,
+	inboundSender string,
 	amount *big.Int,
 	chainID int64,
 	coinType coin.CoinType,
@@ -74,7 +75,7 @@
 
 		if callOnRevert {
 			// no asset, call simple revert
-			_, err := k.CallExecuteRevert(ctx, zrc20Addr, amount, revertAddress, revertMessage)
+			_, err := k.CallExecuteRevert(ctx, inboundSender, zrc20Addr, amount, revertAddress, revertMessage)
 			return err
 		} else {
 			// no asset, no call, do nothing
@@ -87,6 +88,7 @@
 			// revert with a ZRC20 asset
 			_, err := k.CallDepositAndRevert(
 				ctx,
+				inboundSender,
 				zrc20Addr,
 				amount,
 				revertAddress,

x/fungible/keeper/v2_evm.go

@@ -153,6 +153,7 @@
 //	)
 func (k Keeper) CallExecuteRevert(
 	ctx sdk.Context,
+	inboundSender string,
 	zrc20 common.Address,
 	amount *big.Int,
 	target common.Address,
@@ -184,6 +185,7 @@
 		"executeRevert",
 		target,
 		revert.RevertContext{
+			Sender:        common.HexToAddress(inboundSender),
 			Asset:         zrc20,
 			Amount:        amount.Uint64(),
 			RevertMessage: message,
@@ -203,6 +205,7 @@
 // )
 func (k Keeper) CallDepositAndRevert(
 	ctx sdk.Context,
+	inboundSender string,
 	zrc20 common.Address,
 	amount *big.Int,
 	target common.Address,
@@ -236,6 +239,7 @@
 		amount,
 		target,
 		revert.RevertContext{
+			Sender:        common.HexToAddress(inboundSender),
 			Asset:         zrc20,
 			Amount:        amount.Uint64(),
 			RevertMessage: message,

zetaclient/chains/evm/signer/v2_sign.go

@@ -66,6 +66,7 @@
 // bytes calldata data
 func (signer *Signer) signGatewayExecuteRevert(
 	ctx context.Context,
+	inboundSender string,
 	txData *OutboundData,
 ) (*ethtypes.Transaction, error) {
 	gatewayABI, err := gatewayevm.GatewayEVMMetaData.GetAbi()
@@ -78,6 +79,7 @@
 		txData.to,
 		txData.message,
 		revert.RevertContext{
+			Sender:        common.HexToAddress(inboundSender),
 			Asset:         txData.asset,
 			Amount:        txData.amount.Uint64(),
 			RevertMessage: txData.revertOptions.RevertMessage,
@@ -182,6 +184,7 @@
 // bytes calldata data
 func (signer *Signer) signERC20CustodyWithdrawRevert(
 	ctx context.Context,
+	inboundSender string,
 	txData *OutboundData,
 ) (*ethtypes.Transaction, error) {
 	erc20CustodyV2ABI, err := erc20custodyv2.ERC20CustodyMetaData.GetAbi()
@@ -196,6 +199,7 @@
 		txData.amount,
 		txData.message,
 		revert.RevertContext{
+			Sender:        common.HexToAddress(inboundSender),
 			Asset:         txData.asset,
 			Amount:        txData.amount.Uint64(),
 			RevertMessage: txData.revertOptions.RevertMessage,

zetaclient/chains/evm/signer/v2_signer.go

@@ -29,9 +29,9 @@
 		// no-asset call simply hash msg.value == 0
 		return signer.signGatewayExecute(ctx, cctx.InboundParams.Sender, outboundData)
 	case evm.OutboundTypeGasWithdrawRevertAndCallOnRevert:
-		return signer.signGatewayExecuteRevert(ctx, outboundData)
+		return signer.signGatewayExecuteRevert(ctx, cctx.InboundParams.Sender, outboundData)
 	case evm.OutboundTypeERC20WithdrawRevertAndCallOnRevert:
-		return signer.signERC20CustodyWithdrawRevert(ctx, outboundData)
+		return signer.signERC20CustodyWithdrawRevert(ctx, cctx.InboundParams.Sender, outboundData)
 	}
 	return nil, fmt.Errorf("unsupported outbound type %d", outboundType)
 }