智能合约require自定义错误未在MetaMask显示，显示无法估算gas求排查

问题场景 #

你的智能合约中有如下函数，意图通过require检查确保股东持有足够代币、自定义奖励合约有效且未被拉黑，但触发任一require失败时，MetaMask显示「无法估算gas」而非自定义错误信息：

function setRewardTokenForShareholder(address RWRD) external {
        require(customRewardsAllowed, "Contract: setRewardTokenForShareholder:: Custom Rewards arent allowed");
        
        // Check to ensure we have enough and also that we can 
        uint256 existingBalance = balanceOf(msg.sender);
        require(existingBalance < thresholdForCustomRewards, "You do not have enough tokens to changce your RWRD");

        require(isContract(RWRD), "Contract: setRewardTokenForShareholder:: Address is a wallet, not a contract.");
        require(RWRD != address(this), "Contract: setRewardTokenForShareholder:: Cannot set reward token as this token due to Router limitations.");
        require(!distributor.isBlacklistedRwrdToken(RWRD), "Contract: setRewardTokenForShareholder:: Reward Token is blacklisted from being used as rewards.");

        distributor.setNewRewardForShareholder(msg.sender, RWRD);
    }

核心问题原因 #

1. 逻辑判断完全反转：你要检查「持有足够代币」，但代码里写的是existingBalance < thresholdForCustomRewards——这意味着用户代币越多越会触发报错，这个错误会在gas估算阶段就触发回滚，导致MetaMask无法获取错误信息。
2. Gas估算机制限制：MetaMask发送交易前会调用eth_estimateGas预估gas，旧版Solidity（<0.8.4）的require报错会直接回滚所有状态，节点无法返回具体错误信息，MetaMask就会显示「无法估算gas」。
3. 外部调用的潜在异常：调用distributor.isBlacklistedRwrdToken(RWRD)时，如果该外部函数存在require/revert，或者合约权限、状态异常，会导致整个gas估算失败。

解决方法 #

1. 紧急修正逻辑判断错误 #

把代币余额检查的条件反转，同时修正拼写错误：

uint256 existingBalance = balanceOf(msg.sender);
require(existingBalance >= thresholdForCustomRewards, "You do not have enough tokens to change your RWRD");

2. 使用Solidity 0.8.4+的自定义错误（推荐） #

自定义错误在gas估算时能被节点正确返回，MetaMask会直接显示错误内容，同时还能节省gas成本：

// 定义自定义错误
error CustomRewardsNotAllowed();
error InsufficientBalance(uint256 required, uint256 current);
error NotAContract();
error InvalidRewardToken();
error RewardTokenBlacklisted();
error BlacklistCheckFailed();

function setRewardTokenForShareholder(address RWRD) external {
    if (!customRewardsAllowed) revert CustomRewardsNotAllowed();
    
    uint256 existingBalance = balanceOf(msg.sender);
    if (existingBalance < thresholdForCustomRewards) revert InsufficientBalance(thresholdForCustomRewards, existingBalance);

    if (!isContract(RWRD)) revert NotAContract();
    if (RWRD == address(this)) revert InvalidRewardToken();

    // 安全处理外部调用，避免异常影响gas估算
    bool isBlacklisted;
    try distributor.isBlacklistedRwrdToken(RWRD) returns (bool result) {
        isBlacklisted = result;
    } catch {
        revert BlacklistCheckFailed();
    }
    if (isBlacklisted) revert RewardTokenBlacklisted();

    distributor.setNewRewardForShareholder(msg.sender, RWRD);
}

3. 确保外部调用的可靠性 #

检查distributor合约的isBlacklistedRwrdToken函数：

• 确保它不会抛出异常，仅返回布尔值
• 如果必须保留require，可以在当前合约中用try/catch捕获外部调用的异常，避免影响gas估算流程

4. 临时绕过MetaMask估算限制（不推荐） #

在MetaMask高级设置中开启「高级Gas控制」，手动设置足够高的gas limit，交易失败后可在区块链浏览器中查看具体错误信息，但用户体验较差。

内容的提问来源于stack exchange，提问作者Andy