feat: check withdraw fee in Swap, callMulti example, universal NFT/FT

examples/swap/.gitignore

@@ -17,3 +17,5 @@ cache_forge
 access_token
 
 localnet.json
+
+.openzeppelin

examples/swap/contracts/Swap.sol

@@ -5,6 +5,7 @@
 import {SwapHelperLib} from "@zetachain/toolkit/contracts/SwapHelperLib.sol";
 import {BytesHelperLib} from "@zetachain/toolkit/contracts/BytesHelperLib.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import "@uniswap/v2-periphery/contracts/interfaces/IUniswapV2Router02.sol";
 
 import {RevertContext, RevertOptions} from "@zetachain/protocol-contracts/contracts/Revert.sol";
 import "@zetachain/protocol-contracts/contracts/zevm/interfaces/UniversalContract.sol";
@@ -32,6 +33,7 @@
     error Unauthorized();
     error ApprovalFailed();
     error TransferFailed();
+    error InsufficientAmount(string);
 
     event TokenSwap(
         address sender,
@@ -73,6 +75,9 @@
         bool withdraw;
     }
 
+    /**
+     * @notice Swap tokens from a connected chain to another connected chain or ZetaChain
+     */
     function onCall(
         MessageContext calldata context,
         address zrc20,
@@ -120,6 +125,9 @@
         withdraw(params, context.sender, gasFee, gasZRC20, out, zrc20);
     }
 
+    /**
+     * @notice Swap tokens from ZetaChain optionally withdrawing to a connected chain
+     */
     function swap(
         address inputToken,
         uint256 amount,
@@ -163,6 +171,9 @@
         );
     }
 
+    /**
+     * @notice Swaps enough tokens to pay gas fees, then swaps the remainder to the target token
+     */
     function handleGasAndSwap(
         address inputToken,
         uint256 amount,
@@ -175,6 +186,11 @@
 
         (gasZRC20, gasFee) = IZRC20(targetToken).withdrawGasFee();
 
+        uint256 minInput = quoteMinInput(inputToken, targetToken);
+        if (amount < minInput) {
+            revert InsufficientAmount("not enough tokens");
+        }
+
         if (gasZRC20 == inputToken) {
             swapAmount = amount - gasFee;
         } else {
@@ -198,6 +214,9 @@
         return (out, gasZRC20, gasFee);
     }
 
+    /**
+     * @notice Transfer tokens to the recipient on ZetaChain or withdraw to a connected chain
+     */
     function withdraw(
         Params memory params,
         address sender,
@@ -242,6 +261,10 @@
         }
     }
 
+    /**
+     * @notice onRevert handles an edge-case when a swap fails when the recipient
+     * on the destination chain is a contract that cannot accept tokens.
+     */
     function onRevert(RevertContext calldata context) external onlyGateway {
         (address sender, address zrc20) = abi.decode(
             context.revertMessage,
@@ -267,6 +290,39 @@
         );
     }
 
+    /**
+     * @notice Returns the minimum amount of input tokens required to cover the gas fee for withdrawal
+     */
+    function quoteMinInput(
+        address inputToken,
+        address targetToken
+    ) public view returns (uint256) {
+        (, uint256 gasFee) = IZRC20(targetToken).withdrawGasFee();
+
+        if (inputToken == targetToken) {
+            return gasFee;
+        }
+
+        address zeta = IUniswapV2Router01(uniswapRouter).WETH();
+
+        address[] memory path;
+        if (inputToken == zeta || targetToken == zeta) {
+            path = new address[](2);
+            path[0] = inputToken;
+            path[1] = targetToken;
+        } else {
+            path = new address[](3);
+            path[0] = inputToken;
+            path[1] = zeta;
+            path[2] = targetToken;
+        }
+
+        uint256[] memory amountsIn = IUniswapV2Router02(uniswapRouter)
+            .getAmountsIn(gasFee, path);
+
+        return amountsIn[0];
+    }
+
     function _authorizeUpgrade(
         address newImplementation
     ) internal override onlyOwner {}

examples/swap/package.json

@@ -58,7 +58,9 @@
     "@solana-developers/helpers": "^2.4.0",
     "@solana/spl-memo": "^0.2.5",
     "@solana/web3.js": "^1.95.8",
+    "@zetachain/networks": "10.0.0-rc3",
     "@zetachain/protocol-contracts": "11.0.0-rc3",
-    "@zetachain/toolkit": "13.0.0-rc8"
+    "@zetachain/protocol-contracts-solana": "2.0.0-rc1",
+    "@zetachain/toolkit": "13.0.0-rc11"
   }
 }

examples/swap/scripts/localnet.sh

@@ -22,16 +22,18 @@ CONTRACT_SWAP=$(npx hardhat deploy --name Swap --network localhost --gateway "$G
 COMPANION=$(npx hardhat deploy-companion --gateway "$GATEWAY_ETHEREUM" --network localhost --json | jq -r '.contractAddress')
 
 npx hardhat companion-swap \
+  --skip-checks \
   --network localhost \
   --contract "$COMPANION" \
   --universal-contract "$CONTRACT_SWAP" \
   --amount 1 \
   --target "$ZRC20_BNB" \
-  --recipient "$SENDER"
+  --recipient "$SENDER" 
 
 npx hardhat localnet-check
 
 npx hardhat companion-swap \
+  --skip-checks \
   --network localhost \
   --contract "$COMPANION" \
   --universal-contract "$CONTRACT_SWAP" \
@@ -43,6 +45,7 @@ npx hardhat companion-swap \
 npx hardhat localnet-check
 
 npx hardhat evm-swap \
+  --skip-checks \
   --network localhost \
   --receiver "$CONTRACT_SWAP" \
   --amount 1 \
@@ -52,6 +55,7 @@ npx hardhat evm-swap \
 npx hardhat localnet-check
 
 npx hardhat evm-swap \
+  --skip-checks \
   --network localhost \
   --receiver "$CONTRACT_SWAP" \
   --amount 1 \

examples/swap/tasks/companionSwap.ts

@@ -1,6 +1,8 @@
 import ERC20_ABI from "@openzeppelin/contracts/build/contracts/ERC20.json";
 import { task, types } from "hardhat/config";
 import type { HardhatRuntimeEnvironment } from "hardhat/types";
+import { isInputAmountSufficient } from "./evmSwap";
+import { ZetaChainClient } from "@zetachain/toolkit/client";
 
 const main = async (args: any, hre: HardhatRuntimeEnvironment) => {
   const { ethers } = hre;
@@ -9,6 +11,18 @@ const main = async (args: any, hre: HardhatRuntimeEnvironment) => {
   const factory = (await hre.ethers.getContractFactory("SwapCompanion")) as any;
   const contract = factory.attach(args.contract).connect(signer);
 
+  const client = new ZetaChainClient({ network: "testnet", signer });
+
+  if (!args.skipChecks) {
+    await isInputAmountSufficient({
+      hre,
+      client,
+      amount: args.amount,
+      erc20: args.erc20,
+      target: args.target,
+    });
+  }
+
   let tx;
   if (args.erc20) {
     const erc20Contract = new ethers.Contract(
@@ -58,4 +72,5 @@ task("companion-swap", "Swap native gas tokens", main)
   .addOptionalParam("erc20", "ERC-20 token address")
   .addParam("target", "ZRC-20 address of the token to swap for")
   .addParam("amount", "Amount of tokens to swap")
+  .addFlag("skipChecks", "Skip checks for minimum amount")
   .addParam("recipient", "Recipient address");

examples/swap/tasks/evmSwap.ts

@@ -3,13 +3,51 @@ import type { HardhatRuntimeEnvironment } from "hardhat/types";
 
 import { ZetaChainClient } from "@zetachain/toolkit/client";
 
+export const isInputAmountSufficient = async ({
+  hre,
+  client,
+  erc20,
+  amount,
+  target,
+}: any) => {
+  const inputZRC20 = await (erc20
+    ? client.getZRC20FromERC20(erc20)
+    : client.getZRC20GasToken(hre.network.name));
+
+  const minAmount = await client.getWithdrawFeeInInputToken(inputZRC20, target);
+
+  const minAmountFormatted = hre.ethers.utils.formatUnits(
+    minAmount.amount,
+    minAmount.decimals
+  );
+
+  const value = hre.ethers.utils.parseUnits(amount, minAmount.decimals);
+
+  if (value.lt(minAmount.amount)) {
+    throw new Error(
+      `Input amount ${amount} is less than minimum amount ${minAmountFormatted} required for a withdrawal to the destination chain`
+    );
+  }
+};
+
 export const evmDepositAndCall = async (
   args: any,
   hre: HardhatRuntimeEnvironment
 ) => {
   try {
     const [signer] = await hre.ethers.getSigners();
     const client = new ZetaChainClient({ network: "testnet", signer });
+
+    if (!args.skipChecks) {
+      await isInputAmountSufficient({
+        hre,
+        client,
+        amount: args.amount,
+        erc20: args.erc20,
+        target: args.target,
+      });
+    }
+
     const tx = await client.evmDepositAndCall({
       amount: args.amount,
       erc20: args.erc20,
@@ -72,6 +110,7 @@ task("evm-swap", "Swap tokens from EVM", evmDepositAndCall)
   .addOptionalParam("revertMessage", "Revert message", "0x")
   .addParam("amount", "amount of ETH to send with the transaction")
   .addOptionalParam("erc20", "ERC-20 token address")
+  .addFlag("skipChecks", "Skip checks for minimum amount")
   .addParam("target", "ZRC-20 address of the token to swap for")
   .addParam("recipient", "Recipient address")
   .addOptionalParam(