EVM Engineering: remove autogenerated invariant docs

ethereum-optimism / optimism

Optimism is Ethereum, scaled.

https://optimism.io

MIT License

5.54k stars 3.19k forks source link

EVM Engineering: remove autogenerated invariant docs #11251

Open mds1 opened 1 month ago

mds1 commented 1 month ago

I don't think our autogenerated invariant docs are referenced frequently by many people, and they are also not a comprehensive list of invariants—some invariants get tested with standard fuzz tests as opposed to invariant tests. As a result we should consider simplifying things by removing these autogenerated docs

Inspired by discussion with @smartcontracts and @tynes in https://github.com/ethereum-optimism/optimism/pull/11042#discussion_r1690575031

tynes commented 2 weeks ago

The source of truth for invariants should be the specs