Deprecate changePrank

[smol-ninja]

The foundry cheatcode changePrank has been deprecated and will likely be removed in the future release.

Replacing it with vm.startPrank seems like a straightforward solution but it has introduced a new requirement that the prank must have been applied atleast once before overriding. This has also been raised by @PaulRBerg in foundry-rs/foundry#4942 but a shame that they decided to close it in favour of the suggestion to handle it using readCallers.

Since we decided to update forge-std, the tests now throw a deprecation warning. There are two solutions I can think of:

1. Carefully replace it with vm.startPrank.
2. Implement a changePrank function ourselves which calls vm.stopPrank followed by vm.startPrank.

Wdyt @PaulRBerg @andreivladbrg.

Related

• chore(StdCheats): deprecate changePrank foundry-rs/forge-std#434

[andreivladbrg]

IMO it would be better if we implement a function ourselves that replicates the changePrank (i would name it differently)

[smol-ninja]

I agree with you Andrei. On the name how about resetPrank?

[smol-ninja]

Addressed in 169947e.

[smol-ninja]

Do you like the name @andreivladbrg or want to suggest something else?

[PaulRBerg]

I agree with @andreivladbrg, let's go with the path of least resistance and re-implement changePrank ourselves.

resetPrank works!