feat(cli-typescript): transfer signer native balance cmd (#235)

Author: rovilay

cli-typescript/src/cmds/createCommand.ts

@@ -32,6 +32,7 @@ import {
   setTokenURISuffixCmd,
   setUriCmd,
   transferOwnershipCmd,
+  transferSignerBalanceCmd,
   withdrawContractBalanceCmd,
 } from './general';
 import listProjectsAction from '../utils/cmdActions/listProjectsAction';
@@ -216,6 +217,7 @@ export const createEvmCommand = ({
   newCmd.addCommand(setTokenURISuffixCmd());
   newCmd.addCommand(ownerMintCmd());
   newCmd.addCommand(checkSignerBalanceCmd());
+  newCmd.addCommand(transferSignerBalanceCmd());
   newCmd.addCommand(getWalletInfoCmd());
   newCmd.addCommand(getConfigCmd());
 

cli-typescript/src/cmds/general.ts

@@ -2,8 +2,8 @@ import { Command } from 'commander';
 import {
   getCosignerOption,
   getExpiryTimestampOption,
-  getForceOption,
   getFreezeThawOption,
+  getGasLimitOption,
   getGlobalWalletLimitOption,
   getIsMintableOption,
   getMaxMintableSupplyOption,
@@ -26,14 +26,15 @@ import { setMaxMintableSupplyAction } from '../utils/cmdActions/setMaxMintableSu
 import { setCosignerAction } from '../utils/cmdActions/setCosignerAction';
 import { setTimestampExpiryAction } from '../utils/cmdActions/setTimestampExpiryAction';
 import { withdrawContractBalanceAction } from '../utils/cmdActions/withdrawContractBalanceAction';
-import { TOKEN_STANDARD } from '../utils/constants';
+import { STANDARD_GAS_LIMIT, TOKEN_STANDARD } from '../utils/constants';
 import { freezeThawContractAction } from '../utils/cmdActions/freezeThawContractAction';
 import { transferOwnershipAction } from '../utils/cmdActions/transferOwnershipAction';
 import { manageAuthorizedMintersAction } from '../utils/cmdActions/manageAuthorizedMinters';
 import { setMintableAction } from '../utils/cmdActions/setMintableAction';
 import { setTokenUriSuffixAction } from '../utils/cmdActions/setTokenUriSuffixAction';
 import { ownerMintAction } from '../utils/cmdActions/ownerMintAction';
 import { checkSignerBalanceAction } from '../utils/cmdActions/checkSignerBalanceAction';
+import { transferSignerBalanceAction } from '../utils/cmdActions/transferSignerBalanceAction';
 import getWalletInfoAction from '../utils/cmdActions/getWalletInfoAction';
 import getProjectConfigAction from '../utils/cmdActions/getProjectConfigAction';
 
@@ -195,3 +196,14 @@ export const checkSignerBalanceCmd = () =>
     .alias('csb')
     .description('Check the balance of the signer account for the collection.')
     .action(checkSignerBalanceAction);
+
+export const transferSignerBalanceCmd = () =>
+  new Command('transfer-signer-balance')
+    .command('transfer-signer-balance <symbol>')
+    .alias('tsb')
+    .description(
+      'Transfer all native balance from the signer account for the collection to the specified address.',
+    )
+    .addOption(getReceiverOption().makeOptionMandatory())
+    .addOption(getGasLimitOption().default(STANDARD_GAS_LIMIT + 6000)) // Default gas limit with buffer
+    .action(transferSignerBalanceAction);

cli-typescript/src/utils/ContractManager.ts

@@ -25,7 +25,6 @@ import {
 import { collapseAddress, isValidEthereumAddress } from './common';
 import {
   APPLY_LIST_TO_COLLECTION_ABI,
-  ERC1155M_ABIS,
   IS_SETUP_LOCKED_ABI,
   MagicDropCloneFactoryAbis,
   MagicDropTokenImplRegistryAbis,
@@ -162,6 +161,47 @@ export class ContractManager {
     console.log(`Balance: ${balance} ${symbol}`);
   }
 
+  /**
+   * Transfers native currency (ETH, MATIC, etc.) to a recipient address
+   * @param to The recipient address
+   * @param amount The amount to transfer in wei
+   * @returns Transaction hash
+   */
+  public async transferNative({
+    to,
+    amount,
+    gasLimit,
+  }: {
+    to: Hex;
+    amount: bigint;
+    gasLimit?: bigint;
+  }): Promise<Hex> {
+    const symbol = getSymbolFromChainId(this.chainId);
+    showText(
+      `Transferring ${formatEther(amount)} ${symbol} to ${collapseAddress(to)}...`,
+    );
+
+    // Check if sender has enough balance
+    const balance = await this.client.getBalance({
+      address: this.signer,
+    });
+
+    if (balance < amount) {
+      throw new Error(
+        `Insufficient balance. Available: ${formatEther(balance)} ${symbol}, Required: ${formatEther(amount)} ${symbol}`,
+      );
+    }
+
+    const txHash = await this.sendTransaction({
+      to,
+      data: '0x',
+      value: amount,
+      gasLimit,
+    });
+
+    return txHash;
+  }
+
   static getContractAddressFromLogs(logs: TransactionReceipt['logs']) {
     try {
       // Generate the event selector from the event ABI

cli-typescript/src/utils/cmdActions/transferSignerBalanceAction.ts

@@ -0,0 +1,73 @@
+import { formatEther, Hex } from 'viem';
+import { actionPresets } from './common';
+import { printTransactionHash, showError, showText } from '../display';
+import { collapseAddress } from '../common';
+import { getSymbolFromChainId, promptForConfirmation } from '../getters';
+
+export const transferSignerBalanceAction = async (
+  symbol: string,
+  params: {
+    receiver: Hex;
+    gasLimit: number;
+  },
+) => {
+  try {
+    const { cm, config } = await actionPresets(symbol, false);
+    const currencySymbol = getSymbolFromChainId(cm.chainId);
+
+    // Get current balance
+    const balance = await cm.client.getBalance({
+      address: cm.signer,
+    });
+
+    // Estimate gas for the transfer
+    const gasPrice = await cm.client.getGasPrice();
+    const gasLimit = BigInt(params.gasLimit);
+    const gasCost = gasPrice * BigInt(gasLimit);
+
+    if (balance <= gasCost) {
+      throw new Error(
+        `Insufficient balance to cover gas fees. Balance: ${formatEther(balance)} ${currencySymbol}, Gas cost: ${formatEther(gasCost)} ${currencySymbol}`,
+      );
+    }
+
+    // Transfer amount = balance - gas cost
+    const transferAmount = balance - gasCost;
+
+    const confirm = await promptForConfirmation(
+      `You are about to transfer all available balance: ${formatEther(balance)} ${currencySymbol} to ${collapseAddress(params.receiver)}. Do you want to proceed?`,
+    );
+    if (!confirm) {
+      showText('Transfer cancelled. Aborting...');
+      return;
+    }
+
+    showText(
+      `Transferring all available balance: ${formatEther(transferAmount)} ${currencySymbol} to ${collapseAddress(params.receiver)}`,
+      `(Reserving ${formatEther(gasCost)} ${currencySymbol} for gas fees)`,
+      false,
+      false,
+    );
+
+    const txHash = await cm.transferNative({
+      to: params.receiver,
+      amount: transferAmount,
+      gasLimit,
+    });
+
+    const receipt = await cm.waitForTransactionReceipt(txHash);
+
+    if (receipt.status !== 'success') {
+      throw new Error('Transaction failed');
+    }
+
+    printTransactionHash(receipt.transactionHash, config.chainId);
+    showText(
+      `Successfully transferred ${formatEther(transferAmount)} ${currencySymbol} to ${collapseAddress(params.receiver)}`,
+    );
+  } catch (error: any) {
+    showError({
+      text: `Failed to transfer all native currency: ${error.message}`,
+    });
+  }
+};

cli-typescript/src/utils/cmdOptions.ts

@@ -150,6 +150,9 @@ export const getTokenUriSuffixOption = () =>
 export const getReceiverOption = () =>
   new Option('-r --receiver <receiver>', 'the receiver address.');
 
+export const getGasLimitOption = () =>
+  new Option('-g --gasLimit <gasLimit>', 'the gas limit for the transaction.');
+
 export const getQtyOption = () => new Option('--qty <qty>', 'the token qty.');
 
 export const getConfigFileOption = () =>

cli-typescript/src/utils/constants.ts

@@ -144,3 +144,5 @@ export const DEFAULT_MINT_CURRENCY =
   '0x0000000000000000000000000000000000000000';
 export const DEFAULT_MERKLE_ROOT =
   '0x0000000000000000000000000000000000000000000000000000000000000000';
+
+export const STANDARD_GAS_LIMIT = 21000; // Standard gas limit for native transfers