Sui withdraw and call (#254)

Author: fadeev

examples/call/scripts/localnet.sh

@@ -12,7 +12,7 @@ npx hardhat compile --force --quiet
 ZRC20_ETHEREUM=$(jq -r '.addresses[] | select(.type=="ZRC-20 ETH on 5") | .address' localnet.json)
 ERC20_ETHEREUM=$(jq -r '.addresses[] | select(.type=="ERC-20 USDC" and .chain=="ethereum") | .address' localnet.json)
 ZRC20_BNB=$(jq -r '.addresses[] | select(.type=="ZRC-20 BNB on 97") | .address' localnet.json)
-ZRC20_SOL=$(jq -r '.addresses[] | select(.type=="ZRC-20 SOL on 901") | .address' localnet.json)
+# ZRC20_SOL=$(jq -r '.addresses[] | select(.type=="ZRC-20 SOL on 901") | .address' localnet.json)
 ZRC20_SPL=$(jq -r '.addresses[] | select(.type=="ZRC-20 USDC on 901") | .address' localnet.json)
 USDC_SPL=$(jq -r '.addresses[] | select(.type=="SPL-20 USDC") | .address' localnet.json)
 GATEWAY_ETHEREUM=$(jq -r '.addresses[] | select(.type=="gatewayEVM" and .chain=="ethereum") | .address' localnet.json)
@@ -25,8 +25,8 @@ echo -e "\n🚀 Deployed contract on ZetaChain: $CONTRACT_ZETACHAIN"
 CONTRACT_ETHEREUM=$(npx hardhat deploy --name Connected --json --network localhost --gateway "$GATEWAY_ETHEREUM" | jq -r '.contractAddress')
 echo -e "🚀 Deployed contract on Ethereum: $CONTRACT_ETHEREUM"
 
-CONTRACT_SOL=9BjVGjn28E58LgSi547JYEpqpgRoo1TErkbyXiRSNDQy
-cd solana && anchor build && npx ts-node setup/main.ts "$USDC_SPL" && cd -
+# CONTRACT_SOL=9BjVGjn28E58LgSi547JYEpqpgRoo1TErkbyXiRSNDQy
+# cd solana && anchor build && npx ts-node setup/main.ts "$USDC_SPL" && cd -
 
 npx hardhat connected-deposit \
   --contract "$CONTRACT_ETHEREUM" \
@@ -208,27 +208,27 @@ npx hardhat zetachain-withdraw-and-call \
 
 npx hardhat localnet-check
 
-ENCODED_ACCOUNTS_AND_DATA=$(npx ts-node solana/setup/encodeCallArgs.ts "sol" "$USDC_SPL")
-npx hardhat zetachain-withdraw-and-call \
-  --receiver "$CONTRACT_SOL" \
-  --gateway-zeta-chain "$GATEWAY_ZETACHAIN" \
-  --zrc20 "$ZRC20_SOL" \
-  --amount 1 \
-  --network localhost \
-  --types '["bytes"]' $ENCODED_ACCOUNTS_AND_DATA
+# ENCODED_ACCOUNTS_AND_DATA=$(npx ts-node solana/setup/encodeCallArgs.ts "sol" "$USDC_SPL")
+# npx hardhat zetachain-withdraw-and-call \
+#   --receiver "$CONTRACT_SOL" \
+#   --gateway-zeta-chain "$GATEWAY_ZETACHAIN" \
+#   --zrc20 "$ZRC20_SOL" \
+#   --amount 1 \
+#   --network localhost \
+#   --types '["bytes"]' $ENCODED_ACCOUNTS_AND_DATA
 
-npx hardhat localnet-check
+# npx hardhat localnet-check
 
-ENCODED_ACCOUNTS_AND_DATA=$(npx ts-node solana/setup/encodeCallArgs.ts "spl" "$USDC_SPL")
-npx hardhat zetachain-withdraw-and-call \
-  --receiver "$CONTRACT_SOL" \
-  --gateway-zeta-chain "$GATEWAY_ZETACHAIN" \
-  --zrc20 "$ZRC20_SPL" \
-  --amount 1 \
-  --network localhost \
-  --types '["bytes"]' $ENCODED_ACCOUNTS_AND_DATA
+# ENCODED_ACCOUNTS_AND_DATA=$(npx ts-node solana/setup/encodeCallArgs.ts "spl" "$USDC_SPL")
+# npx hardhat zetachain-withdraw-and-call \
+#   --receiver "$CONTRACT_SOL" \
+#   --gateway-zeta-chain "$GATEWAY_ZETACHAIN" \
+#   --zrc20 "$ZRC20_SPL" \
+#   --amount 1 \
+#   --network localhost \
+#   --types '["bytes"]' $ENCODED_ACCOUNTS_AND_DATA
 
-npx hardhat localnet-check
+# npx hardhat localnet-check
 
 npx hardhat zetachain-withdraw-and-call \
   --receiver "$CONTRACT_ETHEREUM" \

examples/call/sui/Move.lock

@@ -2,7 +2,7 @@
 
 [move]
 version = 3
-manifest_digest = "14A2399375F938EA73D29140B8CA371887691345F38828DAEC376BDB3CF2C9A3"
+manifest_digest = "F7637F8158027D0E2F57BA42B0A909AA6391135141CFF820577A4C3F7BA9E62D"
 deps_digest = "3C4103934B1E040BB6B23F1D610B4EF9F2F1166A50A104EADCF77467C004C600"
 dependencies = [
   { id = "Sui", name = "Sui" },
@@ -30,7 +30,7 @@ dependencies = [
 ]
 
 [move.toolchain-version]
-compiler-version = "1.42.2"
+compiler-version = "1.45.0"
 edition = "2024.beta"
 flavor = "sui"
 
@@ -41,3 +41,9 @@ chain-id = "59d1348f"
 original-published-id = "0x1a4bd5ee637990fe0649d860c3ffc673d608c601dbd518d84551814c3e5902b6"
 latest-published-id = "0x1a4bd5ee637990fe0649d860c3ffc673d608c601dbd518d84551814c3e5902b6"
 published-version = "1"
+
+[env.localnet]
+chain-id = "992fdbfb"
+original-published-id = "0x723be41ba96120e33a464c7b59597a4edaf934614f7ea05349b71d2545819a4b"
+latest-published-id = "0x723be41ba96120e33a464c7b59597a4edaf934614f7ea05349b71d2545819a4b"
+published-version = "1"

examples/call/sui/Move.toml

@@ -7,5 +7,5 @@ Sui = { git = "https://github.com/MystenLabs/sui.git", subdir = "crates/sui-fram
 gateway = { local = "/usr/local/share/localnet/protocol-contracts-sui"}
 
 [addresses]
-call = "0x0"
+connected = "0x0"
 gateway = "_"

examples/call/sui/sources/call.move

@@ -0,0 +1,94 @@
+/// This module provides a mock implementation of the Cetus DEX (Decentralized Exchange) interface
+/// for the Sui blockchain. It simulates token swap functionality between two token types.
+///
+/// The mock implementation includes:
+/// - A simulated liquidity pool for token pairs
+/// - Basic swap functionality between token A and token B
+/// - Shared objects for configuration and state management
+///
+/// This is used only for testing and development purposes to simulate
+/// token swaps without interacting with the actual Cetus protocol.
+module connected::cetusmock;
+
+use sui::balance::{Self, Balance};
+use sui::coin::{Self, Coin};
+
+/// Global configuration object
+public struct GlobalConfig has key {
+    id: UID,
+}
+
+/// Partner object representing a protocol participant
+public struct Partner has key {
+    id: UID,
+}
+
+/// Clock object for time-based operations
+public struct Clock has key {
+    id: UID,
+}
+
+/// Represents a liquidity pool for a pair of tokens (CoinA and CoinB)
+/// Holds balances of both tokens that can be swapped
+public struct Pool<phantom CoinA, phantom CoinB> has key {
+    id: UID,
+    balance_a: Balance<CoinA>,
+    balance_b: Balance<CoinB>,
+}
+
+/// Initializes the mock protocol by creating and sharing all necessary objects
+/// Creates a pool for SUI and TOKEN pair
+fun init(ctx: &mut TxContext) {
+    let global_config = GlobalConfig {
+        id: object::new(ctx),
+    };
+    let pool = Pool<sui::sui::SUI, connected::token::TOKEN> {
+        id: object::new(ctx),
+        balance_a: balance::zero<sui::sui::SUI>(),
+        balance_b: balance::zero<connected::token::TOKEN>(),
+    };
+    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);
+}
+
+/// Deposits tokens into the pool to be available for swaps
+/// @param pool The liquidity pool to deposit into
+/// @param coin The coin to deposit
+public entry fun deposit<CoinA, CoinB>(pool: &mut Pool<CoinA, CoinB>, coin: Coin<CoinB>) {
+    balance::join(&mut pool.balance_b, coin.into_balance());
+}
+
+/// Simulates a token swap from CoinA to CoinB
+/// @param _config Global configuration object
+/// @param pool The liquidity pool to swap from
+/// @param _partner Partner object
+/// @param coin_a The input coin to swap
+/// @param _clock Clock object for time-based operations
+/// @param ctx Transaction context
+/// @return The swapped coins of type CoinB
+public fun swap_a2b<CoinA, CoinB>(
+    _config: &GlobalConfig,
+    pool: &mut Pool<CoinA, CoinB>,
+    _partner: &mut Partner,
+    coin_a: Coin<CoinA>,
+    _clock: &Clock,
+    ctx: &mut TxContext,
+): Coin<CoinB> {
+    // deposit all coins in
+    balance::join(&mut pool.balance_a, coin_a.into_balance());
+
+    // take all the coins out
+    let value = pool.balance_b.value();
+    let coins_out = coin::take(&mut pool.balance_b, value, ctx);
+
+    coins_out
+}

examples/call/sui/sources/cetusmock.move

@@ -0,0 +1,64 @@
+/// This module provides two main functionalities:
+/// 1. An on_call function that gets executed when a call is made from ZetaChain.
+///    This function replicates Cetus's swap functionality, maintaining the same
+///    parameter structure and behavior for seamless integration with Cetus pools.
+///
+/// 2. Examples of how to use the ZetaChain gateway to make calls from Sui to
+///    universal contracts on ZetaChain through the deposit and deposit_and_call
+///    functions.
+module connected::connected;
+
+use connected::cetusmock::{GlobalConfig, Partner, Pool, Clock, swap_a2b};
+use gateway::gateway::Gateway;
+use std::ascii::String;
+use sui::address::from_bytes;
+use sui::coin::Coin;
+use sui::event;
+use sui::tx_context;
+
+// Withdraw and Call Example
+
+public entry fun on_call<SOURCE_COIN, TARGET_COIN>(
+    in_coins: Coin<SOURCE_COIN>,
+    cetus_config: &GlobalConfig,
+    pool: &mut Pool<SOURCE_COIN, TARGET_COIN>,
+    cetus_partner: &mut Partner,
+    clock: &Clock,
+    data: vector<u8>,
+    ctx: &mut TxContext,
+) {
+    let coins_out = swap_a2b<SOURCE_COIN, TARGET_COIN>(
+        cetus_config,
+        pool,
+        cetus_partner,
+        in_coins,
+        clock,
+        ctx,
+    );
+
+    let receiver = from_bytes(data);
+
+    // transfer the coins to the provided address
+    transfer::public_transfer(coins_out, receiver)
+}
+
+// Deposit and Call Example
+
+public entry fun deposit<T>(
+    gateway: &mut Gateway,
+    coin: Coin<T>,
+    receiver: String,
+    ctx: &mut tx_context::TxContext,
+) {
+    gateway.deposit(coin, receiver, ctx);
+}
+
+public entry fun deposit_and_call<T>(
+    gateway: &mut Gateway,
+    coin: Coin<T>,
+    receiver: String,
+    payload: vector<u8>,
+    ctx: &mut tx_context::TxContext,
+) {
+    gateway.deposit_and_call(coin, receiver, payload, ctx);
+}

examples/call/sui/sources/connected.move

@@ -0,0 +1,29 @@
+module connected::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"TOKEN",
+        b"An example token",
+        option::none(), // url: no URL provided for this example token
+        ctx,
+    );
+    transfer::public_freeze_object(metadata);
+    transfer::public_transfer(treasury, ctx.sender())
+}
+
+public entry fun mint_and_transfer(
+    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)
+}