Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Variable "royaltyVaultIpId" (and respective docs) unclear #202

Open
aandrewchung opened this issue May 24, 2024 · 0 comments
Open

Variable "royaltyVaultIpId" (and respective docs) unclear #202

aandrewchung opened this issue May 24, 2024 · 0 comments

Comments

@aandrewchung
Copy link

Description and context

collectRoyaltyTokens, claimableRevenue, claimRevenue, snapshot, and getRoyaltyVaultAddress should use a different variable name instead of royaltyVaultIpId. This is unclear to users because users are supposed to pass in the derivative/child ip id so that we can calculate the proxy address of the vault but this does not seem obvious by documentation or variable names.

Suggested solution

Rename variable to childIpId to be more clear and update docs

Definition of done

Code merged and documentation updated

@aandrewchung aandrewchung changed the title Rename variable "royaltyVaultIpId" (and respective docs) to childIpId Variable "royaltyVaultIpId" (and respective docs) unclear May 24, 2024
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

No branches or pull requests

1 participant