feat(zetaclient): PTB building for Sui withdrawAndCall transaction

changelog.md

@@ -21,6 +21,7 @@
 * [3790](https://github.com/zeta-chain/node/pull/3790) - integrate execute revert
 * [3797](https://github.com/zeta-chain/node/pull/3797) - integrate execute SPL revert
 * [3807](https://github.com/zeta-chain/node/pull/3807) - integrate ZEVM to Solana call
+* [3793](https://github.com/zeta-chain/node/pull/3793) - support Sui withdrawAndCall using the PTB transaction
 
 ### Refactor
 

cmd/zetae2e/config/config.go

@@ -66,6 +66,7 @@ func ExportContractsFromRunner(r *runner.E2ERunner, conf config.Config) config.C
 
 	conf.Contracts.Sui.FungibleTokenCoinType = config.DoubleQuotedString(r.SuiTokenCoinType)
 	conf.Contracts.Sui.FungibleTokenTreasuryCap = config.DoubleQuotedString(r.SuiTokenTreasuryCap)
+	conf.Contracts.Sui.Example = r.SuiExample
 
 	conf.Contracts.EVM.ZetaEthAddr = config.DoubleQuotedString(r.ZetaEthAddr.Hex())
 	conf.Contracts.EVM.ConnectorEthAddr = config.DoubleQuotedString(r.ConnectorEthAddr.Hex())

cmd/zetae2e/config/contracts.go

@@ -130,14 +130,15 @@ func setContractsFromConfig(r *runner.E2ERunner, conf config.Config) error {
 	if suiPackageID != "" && suiGatewayID != "" {
 		r.SuiGateway = sui.NewGateway(suiPackageID.String(), suiGatewayID.String())
 	}
-
 	if c := conf.Contracts.Sui.FungibleTokenCoinType; c != "" {
 		r.SuiTokenCoinType = c.String()
 	}
 	if c := conf.Contracts.Sui.FungibleTokenTreasuryCap; c != "" {
 		r.SuiTokenTreasuryCap = c.String()
 	}
+	r.SuiExample = conf.Contracts.Sui.Example
 
+	// set EVM contracts
 	evmChainID, err := r.EVMClient.ChainID(r.Ctx)
 	require.NoError(r, err, "get evm chain ID")
 	evmChainParams := chainParamsByChainID(chainParams, evmChainID.Int64())

cmd/zetae2e/local/local.go

@@ -523,12 +523,11 @@ func localE2ETest(cmd *cobra.Command, _ []string) {
 			e2etests.TestSuiWithdrawName,
 			e2etests.TestSuiWithdrawRevertWithCallName,
 			e2etests.TestSuiTokenWithdrawName,
+			// https://github.com/zeta-chain/node/issues/3742
+			e2etests.TestSuiWithdrawAndCallName,
+			e2etests.TestSuiWithdrawAndCallRevertWithCallName,
 			e2etests.TestSuiDepositRestrictedName,
 			e2etests.TestSuiWithdrawRestrictedName,
-
-			// TODO: enable withdraw and call test
-			// https://github.com/zeta-chain/node/issues/3742
-			//e2etests.TestSuiWithdrawAndCallName,
 		}
 		eg.Go(suiTestRoutine(conf, deployerRunner, verbose, suiTests...))
 	}

e2e/config/config.go

@@ -144,12 +144,23 @@ type TON struct {
 	GatewayAccountID DoubleQuotedString `yaml:"gateway_account_id"`
 }
 
+// SuiExample contains the object IDs in the example package
+type SuiExample struct {
+	PackageID      DoubleQuotedString `yaml:"package_id"`
+	TokenType      DoubleQuotedString `yaml:"token_type"`
+	GlobalConfigID DoubleQuotedString `yaml:"global_config_id"`
+	PartnerID      DoubleQuotedString `yaml:"partner_id"`
+	ClockID        DoubleQuotedString `yaml:"clock_id"`
+	PoolID         DoubleQuotedString `yaml:"pool_id"`
+}
+
 // Sui contains the addresses of predeployed contracts on the Sui chain
 type Sui struct {
 	GatewayPackageID         DoubleQuotedString `yaml:"gateway_package_id"`
 	GatewayObjectID          DoubleQuotedString `yaml:"gateway_object_id"`
 	FungibleTokenCoinType    DoubleQuotedString `yaml:"fungible_token_coin_type"`
 	FungibleTokenTreasuryCap DoubleQuotedString `yaml:"fungible_token_treasury_cap"`
+	Example                  SuiExample         `yaml:"example"`
 }
 
 // EVM contains the addresses of predeployed contracts on the EVM chain

e2e/contracts/sui/bin.go

@@ -14,6 +14,12 @@ var fakeUSDC []byte
 //go:embed evm.mv
 var evmBinary []byte
 
+//go:embed token.mv
+var tokenBinary []byte
+
+//go:embed connected.mv
+var connectedBinary []byte
+
 // GatewayBytecodeBase64 gets the gateway binary encoded as base64 for deployment
 func GatewayBytecodeBase64() string {
 	return base64.StdEncoding.EncodeToString(gatewayBinary)
@@ -28,3 +34,13 @@ func FakeUSDCBytecodeBase64() string {
 func EVMBytecodeBase64() string {
 	return base64.StdEncoding.EncodeToString(evmBinary)
 }
+
+// ExampleFungibleTokenBytecodeBase64 gets the example package's fungible token binary encoded as base64 for deployment
+func ExampleFungibleTokenBytecodeBase64() string {
+	return base64.StdEncoding.EncodeToString(tokenBinary)
+}
+
+// ExampleConnectedBytecodeBase64 gets the example package's connected binary encoded as base64 for deployment
+func ExampleConnectedBytecodeBase64() string {
+	return base64.StdEncoding.EncodeToString(connectedBinary)
+}

e2e/contracts/sui/example/.gitignore

@@ -0,0 +1 @@
+build/*

e2e/contracts/sui/example/Makefile

@@ -0,0 +1,22 @@
+.PHONY: clean build all
+
+# Default target
+all: clean build
+
+# Clean build directory
+clean:
+	rm -rf build/
+
+# Build the package and generate bytecode
+build:
+	sui move build
+	cp build/example/bytecode_modules/token.mv .
+	cp build/example/bytecode_modules/connected.mv .
+
+# Help target
+help:
+	@echo "Available targets:"
+	@echo "  all    - Clean and build everything (default)"
+	@echo "  clean  - Remove build directory"
+	@echo "  build  - Build the package and generate bytecode"
+	@echo "  help   - Show this help message" 

e2e/contracts/sui/example/Move.lock

@@ -0,0 +1,58 @@
+# @generated by Move, please check-in and do not edit manually.
+
+[move]
+version = 3
+manifest_digest = "795BC4DE1AC42C1015B85547951A89D7F9AD63EA50982960E095E815C560BFCC"
+deps_digest = "397E6A9F7A624706DBDFEE056CE88391A15876868FD18A88504DA74EB458D697"
+dependencies = [
+  { id = "Bridge", name = "Bridge" },
+  { id = "DeepBook", name = "DeepBook" },
+  { id = "MoveStdlib", name = "MoveStdlib" },
+  { id = "Sui", name = "Sui" },
+  { id = "SuiSystem", name = "SuiSystem" },
+]
+
+[[move.package]]
+id = "Bridge"
+source = { git = "https://github.com/MystenLabs/sui.git", rev = "9c04e1840eb5", subdir = "crates/sui-framework/packages/bridge" }
+
+dependencies = [
+  { id = "MoveStdlib", name = "MoveStdlib" },
+  { id = "Sui", name = "Sui" },
+  { id = "SuiSystem", name = "SuiSystem" },
+]
+
+[[move.package]]
+id = "DeepBook"
+source = { git = "https://github.com/MystenLabs/sui.git", rev = "9c04e1840eb5", subdir = "crates/sui-framework/packages/deepbook" }
+
+dependencies = [
+  { id = "MoveStdlib", name = "MoveStdlib" },
+  { id = "Sui", name = "Sui" },
+]
+
+[[move.package]]
+id = "MoveStdlib"
+source = { git = "https://github.com/MystenLabs/sui.git", rev = "9c04e1840eb5", subdir = "crates/sui-framework/packages/move-stdlib" }
+
+[[move.package]]
+id = "Sui"
+source = { git = "https://github.com/MystenLabs/sui.git", rev = "9c04e1840eb5", subdir = "crates/sui-framework/packages/sui-framework" }
+
+dependencies = [
+  { id = "MoveStdlib", name = "MoveStdlib" },
+]
+
+[[move.package]]
+id = "SuiSystem"
+source = { git = "https://github.com/MystenLabs/sui.git", rev = "9c04e1840eb5", subdir = "crates/sui-framework/packages/sui-system" }
+
+dependencies = [
+  { id = "MoveStdlib", name = "MoveStdlib" },
+  { id = "Sui", name = "Sui" },
+]
+
+[move.toolchain-version]
+compiler-version = "1.45.0"
+edition = "2024.beta"
+flavor = "sui"

e2e/contracts/sui/example/Move.toml

@@ -0,0 +1,37 @@
+[package]
+name = "example"
+edition = "2024.beta" # edition = "legacy" to use legacy (pre-2024) Move
+# license = ""           # e.g., "MIT", "GPL", "Apache 2.0"
+# authors = ["..."]      # e.g., ["Joe Smith (joesmith@noemail.com)", "John Snow (johnsnow@noemail.com)"]
+
+[dependencies]
+#Sui = { git = "https://github.com/MystenLabs/sui.git", subdir = "crates/sui-framework/packages/sui-framework", rev = "mainnet-v1.41.1" }
+
+# For remote import, use the `{ git = "...", subdir = "...", rev = "..." }`.
+# Revision can be a branch, a tag, and a commit hash.
+# MyRemotePackage = { git = "https://some.xwremote/host.git", subdir = "remote/path", rev = "main" }
+
+# For local dependencies use `local = path`. Path is relative to the package root
+# Local = { local = "../path/to" }
+
+# To resolve a version conflict and force a specific version for dependency
+# override use `override = true`
+# Override = { local = "../conflicting/version", override = true }
+
+[addresses]
+example = "0x0"
+
+# Named addresses will be accessible in Move as `@name`. They're also exported:
+# for example, `std = "0x1"` is exported by the Standard Library.
+# alice = "0xA11CE"
+
+[dev-dependencies]
+# The dev-dependencies section allows overriding dependencies for `--test` and
+# `--dev` modes. You can introduce test-only dependencies here.
+# Local = { local = "../path/to/dev-build" }
+
+[dev-addresses]
+# The dev-addresses section allows overwriting named addresses for the `--test`
+# and `--dev` modes.
+# alice = "0xB0B"
+

e2e/contracts/sui/example/README.md

@@ -0,0 +1,69 @@
+# SUI WithdrawAndCall with PTB Transactions
+
+This document explains how the SUI `withdrawAndCall` functionality works using Programmable Transaction Blocks (PTB) in the ZetaChain protocol.
+
+## Overview
+
+The `withdrawAndCall` operation in ZetaChain allows users to withdraw tokens from ZEVM to the Sui blockchain and simultaneously calls a `on_call` function in the `connected` module on the Sui side.
+
+This is implemented as a single atomic transaction using Sui's Programmable Transaction Blocks (PTB).
+
+## Transaction Flow
+
+1. **User Initiates Withdrawal**: A user initiates a withdrawal from ZEVM to Sui with a `on_call` payload.
+
+2. **ZEVM Processing**: The ZEVM gateway processes the withdrawal request and prepares the transaction.
+
+3. **PTB Construction**: A Programmable Transaction Block is constructed with the following steps:
+   - **Withdraw**: The first command in the PTB is the `withdraw_impl` function call, which:
+     - Verifies the withdrawal parameters
+     - Withdraw and returns two coin objects: the main withdrawn coins and the gas budget coins
+   - **Gas Budget Transfer**: The second command transfers the gas budget coins to the TSS address to cover transaction fees.
+     - The gas budget is the SUI coin withdrawn from sui vault, together with withdrawn CCTX's coinType.
+     - The gas budget needs to be forwarded to TSS address to cover the transaction fee.
+   - **Connected Module Call**: The third command calls the `on_call` function in the connected module, passing:
+     - The withdrawn coins
+     - The call payload from the user
+     - Any additional parameters required by the connected module
+
+4. **Transaction Execution**: The entire PTB is executed atomically on the Sui blockchain.
+
+## PTB Structure
+
+The PTB for a `withdrawAndCall` transaction consists of three main commands:
+
+```
+PTB {
+    // Command 0: Withdraw Implementation
+    MoveCall {
+        package: gateway_package_id,
+        module: gateway_module,
+        function: withdraw_impl,
+        arguments: [
+            gateway_object_ref,
+            withdraw_cap_object_ref,
+            coin_type,
+            amount,
+            nonce,
+            gas_budget
+        ]
+    }
+
+    // Command 1: Gas Budget Transfer
+    TransferObjects {
+        from: withdraw_impl_result[1], // Gas budget coins
+        to: tss_address
+    }
+
+    // Command 2: Connected Module Call
+    MoveCall {
+        package: target_package_id,
+        module: connected_module,
+        function: on_call,
+        arguments: [
+            withdraw_impl_result[0], // Main withdrawn coins
+            on_call_payload
+        ]
+    }
+}
+``` 

e2e/contracts/sui/example/sources/example.move

@@ -0,0 +1,66 @@
+module example::connected;
+
+use sui::address::from_bytes;
+use sui::coin::Coin;
+
+// stub for shared objects
+public struct GlobalConfig has key {
+    id: UID,
+    called_count: u64,
+}
+
+public struct Partner has key {
+    id: UID,
+}
+
+public struct Clock has key {
+    id: UID,
+}
+
+public struct Pool<phantom CoinA, phantom CoinB> has key {
+    id: UID,
+}
+
+// share objects
+fun init(ctx: &mut TxContext) {
+    let global_config = GlobalConfig {
+        id: object::new(ctx),
+        called_count: 0,
+    };
+    let pool = Pool<sui::sui::SUI, example::token::TOKEN> {
+        id: object::new(ctx),
+    };
+    let partner = Partner {
+        id: object::new(ctx),
+    };
+    let clock = Clock {
+        id: object::new(ctx),
+    };
+
+    transfer::share_object(global_config);
+    transfer::share_object(pool);
+    transfer::share_object(partner);
+    transfer::share_object(clock);
+}
+
+public entry fun on_call<SOURCE_COIN, TARGET_COIN>(
+    in_coins: Coin<SOURCE_COIN>,
+    cetus_config: &mut GlobalConfig,
+    _pool: &mut Pool<SOURCE_COIN, TARGET_COIN>,
+    _cetus_partner: &mut Partner,
+    _clock: &Clock,
+    data: vector<u8>,
+    _ctx: &mut TxContext,
+) {
+    let receiver = decode_receiver(data);
+
+    // transfer the coins to the provided address
+    transfer::public_transfer(in_coins, receiver);
+
+    // increment the called count
+    cetus_config.called_count = cetus_config.called_count + 1;
+}
+
+fun decode_receiver(data: vector<u8>): address {
+    from_bytes(data)
+}

e2e/contracts/sui/example/sources/token.move

@@ -0,0 +1,29 @@
+module example::token;
+
+use sui::coin::{Self, TreasuryCap};
+
+public struct TOKEN has drop {}
+
+fun init(witness: TOKEN, ctx: &mut TxContext) {
+    let (treasury, metadata) = coin::create_currency(
+        witness,
+        6,
+        b"TOKEN",
+        b"",
+        b"",
+        option::none(),
+        ctx,
+    );
+    transfer::public_freeze_object(metadata);
+    transfer::public_transfer(treasury, ctx.sender())
+}
+
+public entry fun mint(
+    treasury_cap: &mut TreasuryCap<TOKEN>,
+    amount: u64,
+    recipient: address,
+    ctx: &mut TxContext,
+) {
+    let coin = coin::mint(treasury_cap, amount, ctx);
+    transfer::public_transfer(coin, recipient)
+}