Skip to content

docs: add vesting wallet examples#400

Open
0xNeshi wants to merge 6 commits into
feat/vesting-walletfrom
feat/vesting-wallet-examples
Open

docs: add vesting wallet examples#400
0xNeshi wants to merge 6 commits into
feat/vesting-walletfrom
feat/vesting-wallet-examples

Conversation

@0xNeshi

@0xNeshi 0xNeshi commented Jun 19, 2026

Copy link
Copy Markdown
Collaborator

Towards #156
Updates PR #395

PR Checklist

  • Tests
  • Documentation
  • Changelog

@0xNeshi 0xNeshi self-assigned this Jun 19, 2026
Copilot AI review requested due to automatic review settings June 19, 2026 10:58
@coderabbitai

coderabbitai Bot commented Jun 19, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 604581bd-b350-4d74-9b25-9b4262761f10

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/vesting-wallet-examples

Comment @coderabbitai help to get the list of available commands and usage tips.

@0xNeshi 0xNeshi changed the title Feat/vesting wallet examples docs: add vesting wallet examples Jun 19, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md and contracts/finance/README.md to 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.

Comment thread contracts/finance/examples/vesting_wallet/splitter.move
Comment thread contracts/finance/examples/vesting_wallet/splitter.move
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants