Automine functionality

[antazoey]

Overview

Properly support disabling and enabling automine
(Sorry I thought there was a ticket for this already but not seeing it and it's been requested by the community)

Specification

class ChainManager:
    def set_automine(automine_active: bool): ...

class ProviderAPI:
    @raises_not_implemented
    def set_automine(automine_active: bool): ...

• Support in EthTester if possible.
• Support in geth if possible (only applies to ephemeral, local geth)
• Definitely add support to hardhat plugin next
• Definitely add support to foundry plugin next

Dependencies

Include links to any open issues that must be resolved before this feature can be implemented.

[fubuloubu]

I approve of this design

[banteg]

could it be a property with a setter?

>>> chain.automine
True
>>> chain.automine = False
# sends rpc request to disable automine if it was enabled

the description could read something like

Whether to automatically mine a new block after each transaction submitted. Disable automine to pack multiple transactions into a block by hand using chain.mine()

[fubuloubu]

could it be a property with a setter?

>>> chain.automine
True
>>> chain.automine = False
# sends rpc request to disable automine if it was enabled

the description could read something like

Whether to automatically mine a new block after each transaction submitted. Disable automine to pack multiple transactions into a block by hand using chain.mine()

That works for me!

[antazoey]

could it be a property with a setter?

I don't like hiding RPC requests behind properties. It seems like anything using HTTP should happen in a method.

However, we abuse this everywhere else in the entire framework so I am good with it for consistency's sake.

[fubuloubu]

could it be a property with a setter?

I don't like hiding RPC requests behind properties. It seems like anything using HTTP should happen in a method.

It may not be an RPC request, depending on provider. Like, one could imagine for eth-tester, it literally is just setting a property.

I think it's important to have it feel consistent, but not entirely sure it should be a property either.

[antazoey]

I think it's important to have it feel consistent, but not entirely sure it should be a property either.

Good points!

One other thing I like about methods vs. properties (in general) is that it is easier to add to them without it being as much of a breaking change. For example, adding an optional kwarg-ument.

[fubuloubu]

I'm in support of a method for this instead!