Skip to content

N
nebula
Switch branch/tag
Find file
BlameHistoryPermalink
  • clabby's avatar
    feat(ctb): Invariant docgen (#4574) · 0f347ab0
    clabby authored 
    * Begin simple invariant docgen script

* Support Echidna tests in invariant docgen

* Use custom natspec tags for invariant doc comments

* Handle multi-line headers for linting purposes

* Restack

* Upstack

* New doc

* New doc

* Add test file name to link in docgen script

* Relative URL path

* Use `path.join`

* Add task to `contracts-bedrock` workflow to check diff of `invariant-docs`

* Generate a table of contents for invariant docs
    0f347ab0
Burn.md 525 Bytes

Burn Invariants

eth(uint256) always burns the exact amount of eth passed.

Test: FuzzBurn.sol#L35

Asserts that when Burn.eth(uint256) is called, it always burns the exact amount of ETH passed to the function.

gas(uint256) always burns at least the amount of gas passed.

Test: FuzzBurn.sol#L77

Asserts that when Burn.gas(uint256) is called, it always burns at least the amount of gas passed to the function.