celo-org / celo-org/developer-tooling
Zero CELO gas balance is reported as a contract revert: "gas required exceeds allowance (0)"
- Dominant language
- TypeScript
- Stars
- 44
- Forks
- 36
- PR merge metrics
- No merged PRs in 30d
Description
### Package
- `@celo/celocli` 9.0.1
- `viem` 2.55.11 (dependency bundled by celocli)
### Environment
- Celo Mainnet via `https://forno.celo.org`
- macOS on Apple Silicon
- Ledger signer (the issue appears to be independent of the signer type)
### Command
```bash
celocli multisig:approve \
--for \
--tx \
--from \
--useLedger \
--node https://forno.celo.org
```
### Describe the bug
When the sending account has a zero native CELO balance and therefore cannot pay gas, celocli reports the gas-estimation failure as a contract execution revert:
```text
Sending Transaction: multisig: approving transaction ... failed:
Execution reverted with reason: gas required exceeds allowance (0).
ContractFunctionExecutionError: Execution reverted with reason:
gas required exceeds allowance (0).
```
This is misleading because the contract call itself does not revert. The account simply has no CELO with which to pay transaction fees.
In the observed case:
- the sender's native CELO balance was exactly `0`;
- all celocli multisig checks passed;
- `confirmations(transactionId, sender)` remained `false`, confirming that nothing was submitted;
- a read-only trace of the same `confirmTransaction` call succeeded;
- the trace estimated approximately 211,260 gas;
- funding the sender is the required remedy.
The message led us to investigate the multisig transaction and contract logic, even though neither was the source of the failure.
### Expected behavior
celocli should identify this as an insufficient gas-funds error and provide an actionable message, for example:
```text
The sender does not have enough CELO to pay transaction fees.
Sender balance: 0 CELO.
Fund the sender or select a supported --gasCurrency with sufficient balance.
```
It should not describe this condition as an execution revert.
### Actual behavior
The underlying RPC text:
```text
gas required exceeds allowance (0)
```
is wrapped as `EstimateGasExecutionError`, `ExecutionRevertedError`, `TransactionExecutionError`, and finally `ContractFunctionExecutionError`, resulting in the incorrect user-facing statement that contract execution reverted.
### Suggested fix
Before sending or estimating a transaction, celocli could:
1. retrieve the sender's native balance (or selected gas-currency balance);
2. compare it with the estimated/upfront fee requirement where possible; and
3. fail with a dedicated insufficient-gas-funds message.
Alternatively, the transaction error handler could recognize node errors matching `gas required exceeds allowance ()` during gas estimation and translate them into an insufficient-funds error rather than an execution revert.
The exact string may originate from the RPC client and the incorrect classification may occur in viem, but celocli should still present an actionable CLI error. Preserving the original nested error for debugging would be useful.
### Reproduction outline
1. Use an account that is authorized to perform a transaction but has `0` CELO.
2. Run a celocli write command using that account as `--from`.
3. Observe `Execution reverted with reason: gas required exceeds allowance (0)` during gas estimation.
4. Simulate/trace the contract call independently and observe that it succeeds.
5. Fund the sender with enough CELO for gas and retry.
Contributor guide
Research direction
Start with the celocli multisig:approve command and reproduce the failure using an authorized sender with zero CELO, then inspect how the gas-estimation error is wrapped before reaching the CLI. Done means the CLI identifies insufficient gas funds instead of reporting a contract revert, while preserving the nested error for debugging where possible.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100