Juglipaff / fair-reward-distributor / 29344546125

100%

push

github

feat: FairRewardDistributorERC4626 wrapper + ABI export + CI hardening (#11)

* feat: remove _post hooks, add FairRewardDistributorERC4626

BREAKING CHANGE: `_postStake` / `_postWithdraw` / `_postDistribute` are
removed.

* feat: add FairRewardDistributorERC4626 wrapper with tests and snapshots

Move wrapper to src/ root and add unit + gas suites. Expand SECURITY scope to
cover the whole src/ tree so the wrapper is in-scope for reports.

* test: fix withdraw arity in gas tests, add fuzz suite

Gas tests were calling harness.withdraw with a 3-arg signature that no longer
matches the 2-arg harness API. Snapshot values shift accordingly. Adds a fuzz
suite covering stake accounting, withdraw round-trip, single/two-user reward
distribution, proportional split, conservation, multi-distribution
accumulation, and non-participant zero-reward.

* feat(abi): export contract ABIs to abi/ and ship via npm

scripts/extract-abi.sh regenerates abi/<Contract>.json for every non-mock,
non-test contract under the given input dir. package.json files array now
includes abi/**/*.json so npm consumers get the ABIs alongside the source.

* ci: replace test.yml with validate.yml, add ABI drift check

Rename the CI workflow file and inline an ABI drift check that regenerates
abi/ into a scratch dir and diffs against the committed copy. Publish now
fails if a dev forgot to run scripts/extract-abi.sh before commit.

* docs: mention ABI regeneration alongside gas snapshot workflow

CONTRIBUTING gains a paragraph mirroring the snapshot rules for the ABI
export. PR template's Breaking changes hint calls out abi/*.json diffs
explicitly. README lists the local commands devs should run when preparing a
change (test, coverage, ABI regen).

* docs: describe ERC4626 wrapper and its override surface

Adds a Usage subsection covering FairRewardDistributorERC4626 with a deploy
snippet and a note on the virtual hooks a downstream vault can customize.
Assumptions gains an entry making the sam... (continued)

17 of 17 branches covered (100.0%)

Branch coverage included in aggregate %.

72 of 72 new or added lines in 2 files covered. (100.0%)

139 of 139 relevant lines covered (100.0%)

1581.58 hits per line