feat: add dividend distribution and claim functionality#412
Open
syed-ghufran-hassan wants to merge 5 commits into
Open
feat: add dividend distribution and claim functionality#412syed-ghufran-hassan wants to merge 5 commits into
syed-ghufran-hassan wants to merge 5 commits into
Conversation
- Implement distribute_dividend to allow anyone to deposit XLM and split it proportionally among current key holders of a creator, after deducting a protocol fee. - Implement claim_dividend for holders to withdraw their accrued dividends; resets claimable balance to zero. - Add get_claimable_dividend view function to read unclaimed dividend balances. - Maintain a holders list per creator, updated on key buys and sells, to efficiently iterate over current holders during distribution. - Add new storage keys HoldersList and DividendClaimable to persist holder sets and claimable amounts. - Extend ContractError with ZeroClaimable, NoHolders, DividendAmountZero (appended at the end). - Add event structures and helpers (DividendDistributedEvent, DividendClaimedEvent) and publish events on distribution/claim. - Reuse existing protocol fee configuration to deduct fees from distribution amounts. - Update buy_key and sell_key to add/remove holders from the list.
syed-ghufran-hassan
left a comment
Author
There was a problem hiding this comment.
Please review as incorporated comment
syed-ghufran-hassan
left a comment
Author
There was a problem hiding this comment.
Changed incorporated
10 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Implement distribute_dividend to allow anyone to deposit XLM and split it proportionally among current key holders of a creator, after deducting a protocol fee.
Implement claim_dividend for holders to withdraw their accrued dividends; resets claimable balance to zero.
Add get_claimable_dividend view function to read unclaimed dividend balances.
Maintain a holders list per creator, updated on key buys and sells, to efficiently iterate over current holders during distribution.
Add new storage keys HoldersList and DividendClaimable to persist holder sets and claimable amounts.
Extend ContractError with ZeroClaimable, NoHolders, DividendAmountZero (appended at the end).
Add event structures and helpers (DividendDistributedEvent, DividendClaimedEvent) and publish events on distribution/claim.
Reuse existing protocol fee configuration to deduct fees from distribution amounts.
Update buy_key and sell_key to add/remove holders from the list.
Testing
cargo fmt --all -- --checkcargo clippy --workspace --all-targets -- -D warningscargo test --workspaceChecklist
creator-keysunit/integration tests for every changed contract behavior, including failure paths for new or reachableContractErrorvariantscargo fmt --all -- --check,cargo clippy --workspace --all-targets -- -D warnings, andcargo test --workspace, or explained exactly why a command was not rundocs/storage-key-invariants.md; any storage layout change includes a migration/backward-compatibility notedocs/contract-event-conventions.md, or documented the breaking change and versioning plan