refactor: enhance readability

[IaroslavMazur]

No description provided.

[gakonst]

these seem unnecessary to me, personally

[rakita]

would agree with @gakonst, gas to change_gas is not needed

[gakonst]

Thanks @IaroslavMazur! Ideally let's try to agree on a change before implementing it, so we can make sure we do not waste your time. Appreciate it!!

[rakita]

Thanks @IaroslavMazur! Ideally let's try to agree on a change before implementing it, so we can make sure we do not waste your time. Appreciate it!!

@gakonst we are already chatting and will reopen this for the time being.

[IaroslavMazur]

@gakonst, @rakita, thank you for your feedback!

As I can understand, the apple of discord here is the gas! -> charge_gas! change. So, let me explain my reasoning for it.

The renaming was my attempt at both making the macro name more suggestive for the less experienced revm contributors/explorers (like me) - and decrease the logical discrepancy between what the macro does and how it's named.

That macro is responsible for recording the gas cost of each executed operation, by subtracting the cost from the gas amount remaining for the tx - and panicking if there's not enough gas left. This is, essentially, "charging" the tx signer "gas" as the tx is being executed. Therefore, the proposed name change.

Besides, while this macro is not a function, it, too, results in some action (which can be suggestively described with a verb) being executed where the macro is referenced in the codebase. "gas", however, is a noun - and this introduces a logical discrepancy between what the macro does - and how it's named.

This discrepancy becomes especially obvious in the context of the gas_or_fail! macro, where "gas" is inaproppriately used as a verb, alongside "fail". This name suggests that the underlying code will either "gas" or "fail", which doesn't make sense.

While the current names of the macros can undoubtedly be mapped in the minds of the revm contributors/explorers to what their underlying code actually does (which is not obvious from their names), ideally, the names should be self-explanatory, if possible (and it is possible in this case, imo).

[IaroslavMazur]

After some more talking to @rakita, I've just pushed a patch, removing the changes made to the names of the gas! and gas_or_fail! macros.

[rakita]

lgtm