Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add sender to revert context #2919

Merged
merged 46 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from 43 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
8a93aa3
e2e tests and modifications for authenticated call
skosito Sep 20, 2024
af8d86c
extend test with sender check and revert case
skosito Sep 20, 2024
0cd7cb2
separate tests into separate files
skosito Sep 20, 2024
914d151
cleanup
skosito Sep 20, 2024
9d1471f
withdraw and call support and tests
skosito Sep 20, 2024
10ea638
bump protocol contracts
skosito Sep 20, 2024
d6786dc
split tests into separate files
skosito Sep 20, 2024
6b711dc
small cleanup
skosito Sep 20, 2024
614df83
fmt
skosito Sep 20, 2024
fbb0c21
Merge branch 'develop' into authenticated-call-sc-support
skosito Sep 20, 2024
9557a57
generate
skosito Sep 20, 2024
07a83a1
lint
skosito Sep 20, 2024
3610f17
changelog
skosito Sep 20, 2024
7bd42dc
Merge branch 'develop' into authenticated-call-sc-support
skosito Sep 23, 2024
bd80fb2
PR comments
skosito Sep 23, 2024
86367b0
fix case in proto
skosito Sep 24, 2024
e850ae6
bump vote inbound gas limit in zetaclient
skosito Sep 24, 2024
4d6f363
fix test
skosito Sep 24, 2024
d5b5c11
generate
skosito Sep 24, 2024
c93142b
fixing tests
skosito Sep 24, 2024
80ca59e
call options non empty
skosito Sep 24, 2024
1692d98
generate
skosito Sep 24, 2024
5daa3ee
test fix
skosito Sep 24, 2024
e89c759
rename gateway caller
skosito Sep 24, 2024
04f432a
pr comments rename tests
skosito Sep 24, 2024
470a90e
PR comment
skosito Sep 24, 2024
5ad665d
generate
skosito Sep 24, 2024
8c96cea
tests
skosito Sep 24, 2024
3c02247
Merge branch 'develop' into authenticated-call-sc-support
skosito Sep 24, 2024
5e634a6
add sender in test contract
skosito Sep 24, 2024
f320012
extend e2e tests
skosito Sep 25, 2024
7ffda91
generate
skosito Sep 25, 2024
e4f0394
changelog
skosito Sep 25, 2024
24b1499
PR comment
skosito Sep 25, 2024
0a6b1f6
generate
skosito Sep 25, 2024
e8b32f2
Merge branch 'develop' into authenticated-call-sc-support
skosito Sep 26, 2024
b889c2f
update tests fixes
skosito Sep 26, 2024
f0f1c9a
tests fixes
skosito Sep 26, 2024
e7a6630
fix
skosito Sep 26, 2024
a4b9384
test fix
skosito Sep 26, 2024
3425be0
Merge branch 'authenticated-call-sc-support' into add-sender-to-rever…
skosito Sep 27, 2024
17d84da
gas limit fixes
skosito Sep 27, 2024
d6f4bf5
PR comment fix
skosito Sep 27, 2024
7a5dbdb
Merge branch 'develop' into add-sender-to-revert-context
skosito Sep 27, 2024
8c50bc8
fix bad merge
skosito Sep 27, 2024
e8fd5e6
Merge branch 'develop' into add-sender-to-revert-context
skosito Sep 27, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
* [2883](https://github.com/zeta-chain/node/pull/2883) - add chain static information for btc signet testnet
* [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

Expand Down
4 changes: 4 additions & 0 deletions cmd/zetae2e/local/v2.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,12 @@ func startV2Tests(eg *errgroup.Group, conf config.Config, deployerRunner *runner
e2etests.TestV2ETHDepositName,
e2etests.TestV2ETHDepositAndCallName,
e2etests.TestV2ETHWithdrawName,
e2etests.TestV2ETHWithdrawAndArbitraryCallName,
e2etests.TestV2ETHWithdrawAndCallName,
e2etests.TestV2ETHWithdrawAndCallThroughContractName,
e2etests.TestV2ZEVMToEVMArbitraryCallName,
e2etests.TestV2ZEVMToEVMCallName,
e2etests.TestV2ZEVMToEVMCallThroughContractName,
e2etests.TestV2EVMToZEVMCallName,
))

Expand Down
2 changes: 1 addition & 1 deletion docs/cli/zetacored/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -9441,7 +9441,7 @@ zetacored tx crosschain vote-gas-price [chain] [price] [priorityFee] [blockNumbe
Broadcast message to vote an inbound

```
zetacored tx crosschain vote-inbound [sender] [senderChainID] [txOrigin] [receiver] [receiverChainID] [amount] [message] [inboundHash] [inBlockHeight] [coinType] [asset] [eventIndex] [protocolContractVersion] [flags]
zetacored tx crosschain vote-inbound [sender] [senderChainID] [txOrigin] [receiver] [receiverChainID] [amount] [message] [inboundHash] [inBlockHeight] [coinType] [asset] [eventIndex] [protocolContractVersion] [isArbitraryCall] [flags]
```

### Options
Expand Down
11 changes: 11 additions & 0 deletions docs/openapi/openapi.swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57066,6 +57066,14 @@ definitions:
- ERC20: ERC20 token
- Cmd: no asset, used for admin command
- NoAssetCall: no asset, used for contract call
crosschainCallOptions:
type: object
properties:
gas_limit:
type: string
format: uint64
is_arbitrary_call:
type: boolean
crosschainCctxStatus:
type: string
enum:
Expand Down Expand Up @@ -57276,6 +57284,7 @@ definitions:
gas_limit:
type: string
format: uint64
title: Deprecated (v21), use CallOptions
gas_price:
type: string
gas_priority_fee:
Expand All @@ -57302,6 +57311,8 @@ definitions:
type: string
tx_finalization_status:
$ref: '#/definitions/crosschainTxFinalizationStatus'
call_options:
$ref: '#/definitions/crosschainCallOptions'
crosschainOutboundTracker:
type: object
properties:
Expand Down
1 change: 1 addition & 0 deletions docs/spec/crosschain/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ message MsgVoteInbound {
uint64 event_index = 15;
ProtocolContractVersion protocol_contract_version = 16;
RevertOptions revert_options = 17;
CallOptions call_options = 18;
}
```

Expand Down
34 changes: 33 additions & 1 deletion e2e/e2etests/e2etests.go
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,9 @@ const (
TestV2ETHDepositAndCallRevertName = "v2_eth_deposit_and_call_revert"
TestV2ETHDepositAndCallRevertWithCallName = "v2_eth_deposit_and_call_revert_with_call"
TestV2ETHWithdrawName = "v2_eth_withdraw"
TestV2ETHWithdrawAndArbitraryCallName = "v2_eth_withdraw_and_arbitrary_call"
TestV2ETHWithdrawAndCallName = "v2_eth_withdraw_and_call"
TestV2ETHWithdrawAndCallThroughContractName = "v2_eth_withdraw_and_call_through_contract"
TestV2ETHWithdrawAndCallRevertName = "v2_eth_withdraw_and_call_revert"
TestV2ETHWithdrawAndCallRevertWithCallName = "v2_eth_withdraw_and_call_revert_with_call"
TestV2ERC20DepositName = "v2_erc20_deposit"
Expand All @@ -142,7 +144,9 @@ const (
TestV2ERC20WithdrawAndCallName = "v2_erc20_withdraw_and_call"
TestV2ERC20WithdrawAndCallRevertName = "v2_erc20_withdraw_and_call_revert"
TestV2ERC20WithdrawAndCallRevertWithCallName = "v2_erc20_withdraw_and_call_revert_with_call"
TestV2ZEVMToEVMArbitraryCallName = "v2_zevm_to_evm_arbitrary_call"
TestV2ZEVMToEVMCallName = "v2_zevm_to_evm_call"
TestV2ZEVMToEVMCallThroughContractName = "v2_zevm_to_evm_call_through_contract"
TestV2EVMToZEVMCallName = "v2_evm_to_zevm_call"

/*
Expand Down Expand Up @@ -731,13 +735,29 @@ var AllE2ETests = []runner.E2ETest{
TestV2ETHWithdraw,
),
runner.NewE2ETest(
TestV2ETHWithdrawAndCallName,
TestV2ETHWithdrawAndArbitraryCallName,
"withdraw Ether from ZEVM and call a contract using V2 contract",
[]runner.ArgDefinition{
{Description: "amount in wei", DefaultValue: "100000"},
},
TestV2ETHWithdrawAndArbitraryCall,
),
runner.NewE2ETest(
TestV2ETHWithdrawAndCallName,
"withdraw Ether from ZEVM call a contract using V2 contract",
[]runner.ArgDefinition{
{Description: "amount in wei", DefaultValue: "100000"},
},
TestV2ETHWithdrawAndCall,
),
runner.NewE2ETest(
TestV2ETHWithdrawAndCallThroughContractName,
"withdraw Ether from ZEVM call a contract using V2 contract through intermediary contract",
[]runner.ArgDefinition{
{Description: "amount in wei", DefaultValue: "100000"},
},
TestV2ETHWithdrawAndCallThroughContract,
),
runner.NewE2ETest(
TestV2ETHWithdrawAndCallRevertName,
"withdraw Ether from ZEVM and call a contract using V2 contract that reverts",
Expand Down Expand Up @@ -818,12 +838,24 @@ var AllE2ETests = []runner.E2ETest{
},
TestV2ERC20WithdrawAndCallRevertWithCall,
),
runner.NewE2ETest(
TestV2ZEVMToEVMArbitraryCallName,
"zevm -> evm call using V2 contract",
[]runner.ArgDefinition{},
TestV2ZEVMToEVMArbitraryCall,
),
runner.NewE2ETest(
TestV2ZEVMToEVMCallName,
"zevm -> evm call using V2 contract",
[]runner.ArgDefinition{},
TestV2ZEVMToEVMCall,
),
runner.NewE2ETest(
TestV2ZEVMToEVMCallThroughContractName,
"zevm -> evm call using V2 contract through intermediary contract",
[]runner.ArgDefinition{},
TestV2ZEVMToEVMCallThroughContract,
),
runner.NewE2ETest(
TestV2EVMToZEVMCallName,
"evm -> zevm call using V2 contract",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down Expand Up @@ -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)
}
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down Expand Up @@ -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)
}
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down Expand Up @@ -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)
}
40 changes: 40 additions & 0 deletions e2e/e2etests/test_v2_eth_withdraw_and_arbitrary_call.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
package e2etests

import (
"math/big"

"github.com/stretchr/testify/require"
"github.com/zeta-chain/protocol-contracts/v2/pkg/gatewayzevm.sol"

"github.com/zeta-chain/node/e2e/runner"
"github.com/zeta-chain/node/e2e/utils"
crosschaintypes "github.com/zeta-chain/node/x/crosschain/types"
)

const payloadMessageWithdrawETH = "this is a test ETH withdraw and call payload"

func TestV2ETHWithdrawAndArbitraryCall(r *runner.E2ERunner, args []string) {
require.Len(r, args, 1)

amount, ok := big.NewInt(0).SetString(args[0], 10)
require.True(r, ok, "Invalid amount specified for TestV2ETHWithdrawAndCall")

r.AssertTestDAppEVMCalled(false, payloadMessageWithdrawETH, amount)

r.ApproveETHZRC20(r.GatewayZEVMAddr)

// perform the withdraw
tx := r.V2ETHWithdrawAndCall(
r.TestDAppV2EVMAddr,
amount,
r.EncodeGasCall(payloadMessageWithdrawETH),
gatewayzevm.RevertOptions{OnRevertGasLimit: big.NewInt(0)},
)

// wait for the cctx to be mined
cctx := utils.WaitCctxMinedByInboundHash(r.Ctx, tx.Hash().Hex(), r.CctxClient, r.Logger, r.CctxTimeout)
r.Logger.CCTX(*cctx, "withdraw")
require.Equal(r, crosschaintypes.CctxStatus_OutboundMined, cctx.CctxStatus.Status)

r.AssertTestDAppEVMCalled(true, payloadMessageWithdrawETH, amount)
}
30 changes: 25 additions & 5 deletions e2e/e2etests/test_v2_eth_withdraw_and_call.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand All @@ -11,23 +12,34 @@ import (
crosschaintypes "github.com/zeta-chain/node/x/crosschain/types"
)

const payloadMessageWithdrawETH = "this is a test ETH withdraw and call payload"
const payloadMessageAuthenticatedWithdrawETH = "this is a test ETH withdraw and authenticated call payload"

func TestV2ETHWithdrawAndCall(r *runner.E2ERunner, args []string) {
require.Len(r, args, 1)

previousGasLimit := r.ZEVMAuth.GasLimit
r.ZEVMAuth.GasLimit = 10000000
defer func() {
r.ZEVMAuth.GasLimit = previousGasLimit
}()

amount, ok := big.NewInt(0).SetString(args[0], 10)
require.True(r, ok, "Invalid amount specified for TestV2ETHWithdrawAndCall")

r.AssertTestDAppEVMCalled(false, payloadMessageWithdrawETH, amount)
r.AssertTestDAppEVMCalled(false, payloadMessageAuthenticatedWithdrawETH, amount)

r.ApproveETHZRC20(r.GatewayZEVMAddr)

// set expected sender
tx, err := r.TestDAppV2EVM.SetExpectedOnCallSender(r.EVMAuth, r.ZEVMAuth.From)
require.NoError(r, err)
utils.MustWaitForTxReceipt(r.Ctx, r.EVMClient, tx, r.Logger, r.ReceiptTimeout)

// perform the withdraw
tx := r.V2ETHWithdrawAndCall(
tx = r.V2ETHWithdrawAndAuthenticatedCall(
r.TestDAppV2EVMAddr,
amount,
r.EncodeGasCall(payloadMessageWithdrawETH),
[]byte(payloadMessageAuthenticatedWithdrawETH),
gatewayzevm.RevertOptions{OnRevertGasLimit: big.NewInt(0)},
)

Expand All @@ -36,5 +48,13 @@ func TestV2ETHWithdrawAndCall(r *runner.E2ERunner, args []string) {
r.Logger.CCTX(*cctx, "withdraw")
require.Equal(r, crosschaintypes.CctxStatus_OutboundMined, cctx.CctxStatus.Status)

r.AssertTestDAppEVMCalled(true, payloadMessageWithdrawETH, amount)
r.AssertTestDAppEVMCalled(true, payloadMessageAuthenticatedWithdrawETH, amount)

// check expected sender was used
senderForMsg, err := r.TestDAppV2EVM.SenderWithMessage(
&bind.CallOpts{},
[]byte(payloadMessageAuthenticatedWithdrawETH),
)
require.NoError(r, err)
require.Equal(r, r.ZEVMAuth.From, senderForMsg)
}
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down Expand Up @@ -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)
}
Loading
Loading