docs: add vesting wallet examples#400
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Pull request overview
Adds integration examples for the openzeppelin_finance vesting wallet, and wires those examples into the finance package documentation so downstream users have concrete patterns to follow.
Changes:
- Link
contracts/README.mdandcontracts/finance/README.mdto new vesting wallet integration examples. - Add three example Move modules demonstrating: a custom schedule curve (
vesting_quadratic), a curve-agnostic pausable wrapper (pausable_grant), and a beneficiary-as-object payout splitter (splitter). - Add unit tests validating the examples’ end-to-end composition and key invariants.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| contracts/README.md | Adds a pointer to the finance vesting wallet examples directory. |
| contracts/finance/README.md | Introduces an “Examples” section documenting the new integration patterns and links. |
| contracts/finance/examples/vesting_wallet/vesting_quadratic.move | Implements a quadratic vesting curve module intended for direct composition with vesting_wallet. |
| contracts/finance/examples/vesting_wallet/pausable_grant.move | Adds a generic, curve-agnostic pausable wrapper around VestingWallet. |
| contracts/finance/examples/vesting_wallet/splitter.move | Adds a Beneficiary splitter object that disperses received payouts by weight. |
| contracts/finance/examples/vesting_wallet/tests/vesting_quadratic_tests.move | Tests composing the quadratic schedule with the core wallet lifecycle and invariants. |
| contracts/finance/examples/vesting_wallet/tests/pausable_grant_tests.move | Tests pause/resume behavior and admin-cap binding for the wrapper pattern. |
| contracts/finance/examples/vesting_wallet/tests/splitter_tests.move | Tests weighted fan-out behavior and rounding conservation for the beneficiary-as-object pattern. |
Towards #156
Updates PR #395
PR Checklist