feat(ton): TON observer 💎

changelog.md

@@ -16,6 +16,7 @@
 * [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
+* [2896](https://github.com/zeta-chain/node/pull/2896) - add TON inbound observation
 
 ### Refactor
 

cmd/zetae2e/config/config.go

@@ -68,6 +68,7 @@ func ExportContractsFromRunner(r *runner.E2ERunner, conf config.Config) config.C
 	conf.Contracts.ZEVM.ERC20ZRC20Addr = config.DoubleQuotedString(r.ERC20ZRC20Addr.Hex())
 	conf.Contracts.ZEVM.BTCZRC20Addr = config.DoubleQuotedString(r.BTCZRC20Addr.Hex())
 	conf.Contracts.ZEVM.SOLZRC20Addr = config.DoubleQuotedString(r.SOLZRC20Addr.Hex())
+	conf.Contracts.ZEVM.TONZRC20Addr = config.DoubleQuotedString(r.TONZRC20Addr.Hex())
 	conf.Contracts.ZEVM.UniswapFactoryAddr = config.DoubleQuotedString(r.UniswapV2FactoryAddr.Hex())
 	conf.Contracts.ZEVM.UniswapRouterAddr = config.DoubleQuotedString(r.UniswapV2RouterAddr.Hex())
 	conf.Contracts.ZEVM.ConnectorZEVMAddr = config.DoubleQuotedString(r.ConnectorZEVMAddr.Hex())

cmd/zetae2e/config/contracts.go

@@ -135,6 +135,17 @@ func setContractsFromConfig(r *runner.E2ERunner, conf config.Config) error {
 		}
 	}
 
+	if c := conf.Contracts.ZEVM.TONZRC20Addr; c != "" {
+		r.TONZRC20Addr, err = c.AsEVMAddress()
+		if err != nil {
+			return fmt.Errorf("invalid TONZRC20Addr: %w", err)
+		}
+		r.TONZRC20, err = zrc20.NewZRC20(r.TONZRC20Addr, r.ZEVMClient)
+		if err != nil {
+			return err
+		}
+	}
+
 	if c := conf.Contracts.ZEVM.UniswapFactoryAddr; c != "" {
 		r.UniswapV2FactoryAddr, err = c.AsEVMAddress()
 		if err != nil {

cmd/zetae2e/local/local.go

@@ -407,6 +407,7 @@ func localE2ETest(cmd *cobra.Command, _ []string) {
 
 		tonTests := []string{
 			e2etests.TestTONDepositName,
+			e2etests.TestTONDepositAndCallName,
 		}
 
 		eg.Go(tonTestRoutine(conf, deployerRunner, verbose, tonTests...))

cmd/zetae2e/local/ton.go

@@ -25,6 +25,7 @@ func tonTestRoutine(
 			deployerRunner,
 			conf.DefaultAccount,
 			runner.NewLogger(verbose, color.FgCyan, "ton"),
+			runner.WithZetaTxServer(deployerRunner.ZetaTxServer),
 		)
 		if err != nil {
 			return errors.Wrap(err, "unable to init ton test runner")

docs/openapi/openapi.swagger.yaml

@@ -56998,7 +56998,9 @@ definitions:
       - bitcoin
       - op_stack
       - solana_consensus
+      - catchain_consensus
     default: ethereum
+    description: '- catchain_consensus: ton'
     title: |-
       Consensus represents the consensus algorithm used by the chain
       this can represent the consensus of a L1
@@ -57014,6 +57016,7 @@ definitions:
       - optimism
       - base
       - solana
+      - ton
     default: eth
     title: |-
       Network represents the network of the chain
@@ -57048,6 +57051,7 @@ definitions:
       - no_vm
       - evm
       - svm
+      - tvm
     default: no_vm
     title: |-
       Vm represents the virtual machine type of the chain to support smart

e2e/config/config.go

@@ -141,6 +141,7 @@ type ZEVM struct {
 	ERC20ZRC20Addr     DoubleQuotedString `yaml:"erc20_zrc20"`
 	BTCZRC20Addr       DoubleQuotedString `yaml:"btc_zrc20"`
 	SOLZRC20Addr       DoubleQuotedString `yaml:"sol_zrc20"`
+	TONZRC20Addr       DoubleQuotedString `yaml:"ton_zrc20"`
 	UniswapFactoryAddr DoubleQuotedString `yaml:"uniswap_factory"`
 	UniswapRouterAddr  DoubleQuotedString `yaml:"uniswap_router"`
 	ConnectorZEVMAddr  DoubleQuotedString `yaml:"connector_zevm"`

e2e/e2etests/e2etests.go

@@ -65,7 +65,8 @@ const (
 	/**
 	 * TON tests
 	 */
-	TestTONDepositName = "ton_deposit"
+	TestTONDepositName        = "ton_deposit"
+	TestTONDepositAndCallName = "ton_deposit_and_call"
 
 	/*
 	 Bitcoin tests
@@ -444,10 +445,18 @@ var AllE2ETests = []runner.E2ETest{
 		TestTONDepositName,
 		"deposit TON into ZEVM",
 		[]runner.ArgDefinition{
-			{Description: "amount in nano tons", DefaultValue: "900000000"}, // 0.9 TON
+			{Description: "amount in nano tons", DefaultValue: "1000000000"}, // 1.0 TON
 		},
 		TestTONDeposit,
 	),
+	runner.NewE2ETest(
+		TestTONDepositAndCallName,
+		"deposit TON into ZEVM and call a contract",
+		[]runner.ArgDefinition{
+			{Description: "amount in nano tons", DefaultValue: "1000000000"}, // 1.0 TON
+		},
+		TestTONDepositAndCall,
+	),
 	/*
 	 Bitcoin tests
 	*/

e2e/e2etests/helpers.go

@@ -4,6 +4,7 @@ import (
 	"math/big"
 	"strconv"
 
+	"cosmossdk.io/math"
 	"github.com/btcsuite/btcd/btcjson"
 	"github.com/btcsuite/btcd/btcutil"
 	"github.com/btcsuite/btcd/chaincfg/chainhash"
@@ -144,6 +145,10 @@ func parseBigInt(t require.TestingT, s string) *big.Int {
 	return v
 }
 
+func parseUint(t require.TestingT, s string) math.Uint {
+	return math.NewUintFromBigInt(parseBigInt(t, s))
+}
+
 // bigIntFromFloat64 takes float64 (e.g. 0.001) that represents btc amount
 // and converts it to big.Int for downstream usage.
 func btcAmountFromFloat64(t require.TestingT, amount float64) *big.Int {

e2e/e2etests/test_ton_deposit.go

@@ -1,42 +1,84 @@
 package e2etests
 
 import (
+	"time"
+
 	"cosmossdk.io/math"
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
 	"github.com/stretchr/testify/require"
 
 	"github.com/zeta-chain/node/e2e/runner"
 	"github.com/zeta-chain/node/e2e/runner/ton"
+	"github.com/zeta-chain/node/pkg/chains"
+	toncontracts "github.com/zeta-chain/node/pkg/contracts/ton"
+	"github.com/zeta-chain/node/testutil/sample"
+	crosschainTypes "github.com/zeta-chain/node/x/crosschain/types"
 )
 
-// TestTONDeposit (!) This boilerplate is a demonstration of E2E capabilities for TON integration
-// Actual Deposit test is not implemented yet.
-func TestTONDeposit(r *runner.E2ERunner, _ []string) {
-	ctx, deployer := r.Ctx, r.TONDeployer
+// we need to use this send mode due to how wallet V5 works
+//
+//	https://github.com/tonkeeper/w5/blob/main/contracts/wallet_v5.fc#L82
+//	https://docs.ton.org/develop/smart-contracts/guidelines/message-modes-cookbook
+const tonDepositSendCode = toncontracts.SendFlagSeparateFees + toncontracts.SendFlagIgnoreErrors
+
+func TestTONDeposit(r *runner.E2ERunner, args []string) {
+	require.Len(r, args, 1)
 
 	// Given deployer
-	deployerBalance, err := deployer.GetBalance(ctx)
-	require.NoError(r, err, "failed to get deployer balance")
-	require.NotZero(r, deployerBalance, "deployer balance is zero")
+	ctx, deployer, chain := r.Ctx, r.TONDeployer, chains.TONLocalnet
+
+	// Given amount
+	amount := parseUint(r, args[0])
+
+	// https://github.com/zeta-chain/protocol-contracts-ton/blob/main/contracts/gateway.fc#L28
+	// (will be optimized & dynamic in the future)
+	depositFee := math.NewUint(10_000_000)
+
+	// Given TON Gateway
+	gw := toncontracts.NewGateway(r.TONGateway)
 
 	// Given sample wallet with a balance of 50 TON
 	sender, err := deployer.CreateWallet(ctx, ton.TONCoins(50))
 	require.NoError(r, err)
 
-	// That was funded (again) but the faucet
-	_, err = deployer.Fund(ctx, sender.GetAddress(), ton.TONCoins(30))
+	// Given sample EVM address
+	recipient := sample.EthAddress()
+
+	// ACT
+	r.Logger.Info(
+		"Sending deposit of %s TON from %s to zEVM %s",
+		amount.String(),
+		sender.GetAddress().ToRaw(),
+		recipient.Hex(),
+	)
+
+	err = gw.SendDeposit(ctx, sender, amount, recipient, tonDepositSendCode)
+
+	// ASSERT
 	require.NoError(r, err)
 
-	// Check sender balance
-	sb, err := sender.GetBalance(ctx)
+	// Wait for CCTX mining
+	filter := func(cctx *crosschainTypes.CrossChainTx) bool {
+		return cctx.InboundParams.SenderChainId == chain.ChainId &&
+			cctx.InboundParams.Sender == sender.GetAddress().ToRaw()
+	}
+
+	cctxs := r.WaitForSpecificCCTX(filter, time.Minute)
+	require.Len(r, cctxs, 1)
+
+	cctx := r.WaitForMinedCCTXFromIndex(cctxs[0].Index)
+
+	// Check CCTX
+	expectedDeposit := amount.Sub(depositFee)
+
+	require.Equal(r, sender.GetAddress().ToRaw(), cctx.InboundParams.Sender)
+	require.Equal(r, expectedDeposit.Uint64(), cctx.InboundParams.Amount.Uint64())
+
+	// Check sender's balance
+	balance, err := r.TONZRC20.BalanceOf(&bind.CallOpts{}, recipient)
 	require.NoError(r, err)
 
-	senderBalance := math.NewUint(sb)
+	r.Logger.Info("Recipient's zEVM TON balance after deposit: %d", balance.Uint64())
 
-	// note that it's not exactly 80 TON, but 79.99... due to gas fees
-	// We'll tackle gas math later.
-	r.Logger.Print(
-		"Balance of sender (%s): %s",
-		sender.GetAddress().ToHuman(false, true),
-		ton.FormatCoins(senderBalance),
-	)
+	require.Equal(r, expectedDeposit.Uint64(), balance.Uint64())
 }

e2e/e2etests/test_ton_deposit_and_call.go

@@ -0,0 +1,84 @@
+package e2etests
+
+import (
+	"time"
+
+	"cosmossdk.io/math"
+	"github.com/ethereum/go-ethereum/accounts/abi/bind"
+	"github.com/stretchr/testify/require"
+
+	"github.com/zeta-chain/node/e2e/runner"
+	"github.com/zeta-chain/node/e2e/runner/ton"
+	"github.com/zeta-chain/node/e2e/utils"
+	"github.com/zeta-chain/node/pkg/chains"
+	toncontracts "github.com/zeta-chain/node/pkg/contracts/ton"
+	testcontract "github.com/zeta-chain/node/testutil/contracts"
+	crosschainTypes "github.com/zeta-chain/node/x/crosschain/types"
+)
+
+func TestTONDepositAndCall(r *runner.E2ERunner, args []string) {
+	require.Len(r, args, 1)
+
+	// Given deployer
+	ctx, deployer, chain := r.Ctx, r.TONDeployer, chains.TONLocalnet
+
+	// Given amount
+	amount := parseUint(r, args[0])
+
+	// https://github.com/zeta-chain/protocol-contracts-ton/blob/main/contracts/gateway.fc#L28
+	// (will be optimized & dynamic in the future)
+	depositFee := math.NewUint(10_000_000)
+
+	// Given TON Gateway
+	gw := toncontracts.NewGateway(r.TONGateway)
+
+	// Given sample wallet with a balance of 50 TON
+	sender, err := deployer.CreateWallet(ctx, ton.TONCoins(50))
+	require.NoError(r, err)
+
+	// Given sample zEVM contract
+	contractAddr, _, contract, err := testcontract.DeployExample(r.ZEVMAuth, r.ZEVMClient)
+	require.NoError(r, err)
+	r.Logger.Info("Example zevm contract deployed at: %s", contractAddr.String())
+
+	// Given call data
+	callData := []byte("hello from TON!")
+
+	// ACT
+	r.Logger.Info(
+		"Sending deposit of %s TON from %s to zEVM %s and calling contract with %q",
+		amount.String(),
+		sender.GetAddress().ToRaw(),
+		contractAddr.Hex(),
+		string(callData),
+	)
+
+	err = gw.SendDepositAndCall(ctx, sender, amount, contractAddr, callData, tonDepositSendCode)
+
+	// ASSERT
+	require.NoError(r, err)
+
+	// Wait for CCTX mining
+	filter := func(cctx *crosschainTypes.CrossChainTx) bool {
+		return cctx.InboundParams.SenderChainId == chain.ChainId &&
+			cctx.InboundParams.Sender == sender.GetAddress().ToRaw()
+	}
+
+	cctxs := r.WaitForSpecificCCTX(filter, time.Minute)
+	require.Len(r, cctxs, 1)
+
+	r.WaitForMinedCCTXFromIndex(cctxs[0].Index)
+
+	expectedDeposit := amount.Sub(depositFee)
+
+	// check if example contract has been called, bar value should be set to amount
+	utils.MustHaveCalledExampleContract(r, contract, expectedDeposit.BigInt())
+
+	// Check sender's balance
+	balance, err := r.TONZRC20.BalanceOf(&bind.CallOpts{}, contractAddr)
+	require.NoError(r, err)
+
+	r.Logger.Info("Contract's zEVM TON balance after deposit: %d", balance.Uint64())
+
+	require.Equal(r, expectedDeposit.Uint64(), balance.Uint64())
+}

e2e/runner/runner.go

@@ -127,6 +127,8 @@ type E2ERunner struct {
 	BTCZRC20             *zrc20.ZRC20
 	SOLZRC20Addr         ethcommon.Address
 	SOLZRC20             *zrc20.ZRC20
+	TONZRC20Addr         ethcommon.Address
+	TONZRC20             *zrc20.ZRC20
 	UniswapV2FactoryAddr ethcommon.Address
 	UniswapV2Factory     *uniswapv2factory.UniswapV2Factory
 	UniswapV2RouterAddr  ethcommon.Address
@@ -230,6 +232,7 @@ func (r *E2ERunner) CopyAddressesFrom(other *E2ERunner) (err error) {
 	r.ETHZRC20Addr = other.ETHZRC20Addr
 	r.BTCZRC20Addr = other.BTCZRC20Addr
 	r.SOLZRC20Addr = other.SOLZRC20Addr
+	r.TONZRC20Addr = other.TONZRC20Addr
 	r.UniswapV2FactoryAddr = other.UniswapV2FactoryAddr
 	r.UniswapV2RouterAddr = other.UniswapV2RouterAddr
 	r.ConnectorZEVMAddr = other.ConnectorZEVMAddr
@@ -275,6 +278,10 @@ func (r *E2ERunner) CopyAddressesFrom(other *E2ERunner) (err error) {
 	if err != nil {
 		return err
 	}
+	r.TONZRC20, err = zrc20.NewZRC20(r.TONZRC20Addr, r.ZEVMClient)
+	if err != nil {
+		return err
+	}
 	r.UniswapV2Factory, err = uniswapv2factory.NewUniswapV2Factory(r.UniswapV2FactoryAddr, r.ZEVMClient)
 	if err != nil {
 		return err
@@ -359,6 +366,7 @@ func (r *E2ERunner) PrintContractAddresses() {
 	r.Logger.Print("ERC20ZRC20:     %s", r.ERC20ZRC20Addr.Hex())
 	r.Logger.Print("BTCZRC20:       %s", r.BTCZRC20Addr.Hex())
 	r.Logger.Print("SOLZRC20:       %s", r.SOLZRC20Addr.Hex())
+	r.Logger.Print("TONZRC20:       %s", r.TONZRC20Addr.Hex())
 	r.Logger.Print("UniswapFactory: %s", r.UniswapV2FactoryAddr.Hex())
 	r.Logger.Print("UniswapRouter:  %s", r.UniswapV2RouterAddr.Hex())
 	r.Logger.Print("ConnectorZEVM:  %s", r.ConnectorZEVMAddr.Hex())