feat: implement dividend distribution and claim functionality for key holders#414
Open
syed-ghufran-hassan wants to merge 11 commits into
Open
feat: implement dividend distribution and claim functionality for key holders#414syed-ghufran-hassan wants to merge 11 commits into
syed-ghufran-hassan wants to merge 11 commits into
Conversation
… holders - Add distribute_dividend (callable by anyone) to deposit XLM, deduct protocol fee, and split the remainder proportionally among all current key holders of a creator. - Add claim_dividend for holders to withdraw accrued dividends; resets claimable balance to zero before transfer (reentrancy-safe). - Add get_claimable_dividend view to read unclaimed amounts for a (creator, holder) pair. - Maintain a HoldersList per creator, updated on buy/sell to efficiently iterate current holders for distributions. - Extend DataKey with HoldersList and DividendClaimable storage keys. - Append new error variants: ZeroClaimable, NoHolders, DividendAmountZero (at the end, preserving ABI). - Define and emit DividendDistributed and DividendClaimed events with stable fields. - Add corresponding error string constants in quote_view_errors. - Ensure holder list is kept in sync with key balance changes (add when balance goes 0→1, remove when 1→0).
syed-ghufran-hassan
left a comment
syed-ghufran-hassan
left a comment
Author
There was a problem hiding this comment.
Changes incorporated
syed-ghufran-hassan
left a comment
syed-ghufran-hassan
left a comment
Author
There was a problem hiding this comment.
Changes incorporated
syed-ghufran-hassan
left a comment
syed-ghufran-hassan
left a comment
Author
There was a problem hiding this comment.
Incorporaated changes
Author
|
r-contracts/pull/412/changes/88d267fca3266720369618b4ea02bd3483bab077 the event.rs file raised here as PR |
syed-ghufran-hassan
left a comment
syed-ghufran-hassan
left a comment
Author
There was a problem hiding this comment.
changes incorporated
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
1 participant
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
Add distribute_dividend (callable by anyone) to deposit XLM, deduct protocol fee, and split the remainder proportionally among all current key holders of a creator.
Add claim_dividend for holders to withdraw accrued dividends; resets claimable balance to zero before transfer (reentrancy-safe).
Add get_claimable_dividend view to read unclaimed amounts for a (creator, holder) pair.
Maintain a HoldersList per creator, updated on buy/sell to efficiently iterate current holders for distributions.
Extend DataKey with HoldersList and DividendClaimable storage keys.
Append new error variants: ZeroClaimable, NoHolders, DividendAmountZero (at the end, preserving ABI).
Define and emit DividendDistributed and DividendClaimed events with stable fields.
Add corresponding error string constants in quote_view_errors.
Ensure holder list is kept in sync with key balance changes (add when balance goes 0→1, remove when 1→0).
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