feat(forge): cheatcode for getting the current prank

[PaulRBerg]

Component

Forge

Describe the feature you would like

It would be helpful to have a cheatcode for reading the current prank. The use case is testing utilities that don't have knowledge of when the current prank was started, but which require tweaking the msg.sender to perform a particular action in the contracts.

Suggested names:

• getPrank
• currentPrank
• readPrank

[xeno097]

If no one is working on this I'd be happy to give this a try. Any tip or suggestion on how to get this done would be more than welcome

[Evalir]

Hey @xeno097, awesome. For adding a cheatcode, this article can be really useful. Be mindful that after adding a cheatcode we usually ask for a follow up PR for forge-std and the foundry book (i'll point this out again on the PR)

Before you're fully off to the races, I'd like to loop in @mds1 to see if he has any opinions about this cheatcode's design

[xeno097]

Considering that the prank cheat code allows impersonating the 0 address I think that the function signature should be something like this:

function readPrank() external returns (bool, address, address)

The first bool would indicate if a prank is active, the first address would be the new msg.sender, and the last one the new tx.origin used to set the prank. The boolean helps in removing the ambiguity of a prank being active in an edge case like calling vm.prank(address(0), address(0)).

[Evalir]

Closing—fixed by #4884

[PaulRBerg]

wicked