【開發智能合約 — Solidity系列】實作篇Ep.5 - 錯誤處理的機制(Error Handling)

Require

...
contract Example {
    ...    function withdraw(uint amount) public pure {
        uint total = 100;
        /// @dev 提款的數量必須低於總額度
        /// @notice 使用require()， 當條件不滿足時將退回剩下的瓦斯費，所以通常會放在前面
        require(amount <= total, "amount must less then total");       ...
    }
}

Revert

• require表述的是「必須要滿足什麼條件」。
• revert則表述「當什麼條件未被滿足」時進行撤回。

/// @dev 自訂錯誤類型: 資金不足
/// @param requested 要求的資金
/// @param available 可用的資金
error NotEnoughFunds(uint requested, uint available);function ... {
	/// @dev 提款的金額不能大於存款
	/// @notice 若提出的金額超過存款總額，則退回撤銷並退回狀態。
	if (amount > total) {
		revert NotEnoughFunds(amount, total);
	}
}

• revert CustomError(…)
• revert(”message”)
• revert()

Assert

/// @dev 提款的額度必須是正整數
assert(amount > 0);

Try … Catch

try ...使用A合約進行什麼操作 {
   ...成功之後的處理
} catch ...什麼類型的錯誤 {
	...進行什麼處理
} catch ...什麼類型的錯誤 {
	...進行什麼處理
}

contract Example {
    ...
}contract Runner {
    Example public example;    constructor() {
        example = new Example();
    }    function exec() public view {
        uint errorCount = 0;
        try example.withdraw(101) {
            // 提款成功之後...
        }  catch Error(string memory /*reason*/) {
            // 這種錯誤類型主要是處理帶有錯誤訊息的錯誤處理函數： require(..., "錯誤訊息")、revert("撤銷訊息")
            errorCount++;
        } catch Panic(uint /*errorCode*/) {
            // 這種錯誤類型主要處理assert(...)這種內部錯誤
            errorCount++;
        } catch (bytes memory /*lowLevelData*/) {
            // 這種錯誤通常發生在更低階的處理，像是在解譯(decode)的階段
            errorCount++;
        } catch {
          // 如果不想知道錯誤訊息或者原因時，可以直接用catch { ... }進行錯誤的對應處理。
        }
    }
}

結語

資源參考

• https://docs.soliditylang.org/