Skip to content

Commit da5bcc9

Browse files
committed
chore(royalty workflows): update comments
1 parent 81030fe commit da5bcc9

File tree

2 files changed

+22
-12
lines changed

2 files changed

+22
-12
lines changed

contracts/interfaces/workflows/IRoyaltyWorkflows.sol

+11-6
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,13 @@ interface IRoyaltyWorkflows {
1010
/// @param ancestorIpId The address of the ancestor IP from which the revenue is being claimed.
1111
/// @param claimer The address of the claimer of the currency (revenue) tokens.
1212
/// @param childIpIds The addresses of the child IPs from which royalties are derived.
13-
/// @param royaltyPolicies The addresses of the royalty policies that govern royalty flows for each child IP.
14-
/// @param currencyTokens The addresses of the currency tokens in which the royalties will be claimed.
15-
/// @param amounts The amounts (in each currency) of royalties to be transferred to the ancestor IP's
16-
/// royalty vault and subsequently claimed by the claimer.
13+
/// @param royaltyPolicies The addresses of the royalty policies, where royaltyPolicies[i] governs
14+
/// the royalty flow for childIpIds[i].
15+
/// @param currencyTokens The addresses of the currency tokens in which royalties will be claimed,
16+
/// where currencyTokens[i] is the token used for royalties from childIpIds[i].
17+
/// @param amounts The amounts to transfer and claim, where amounts[i] represents the amount of
18+
/// royalties in currencyTokens[i] to transfer from childIpIds[i]'s royaltyPolicies[i] to the ancestor's
19+
/// royalty vault.
1720
/// @return amountsClaimed The amounts of successfully claimed revenue for each specified currency token.
1821
function transferToVaultAndClaimByTokenBatch(
1922
address ancestorIpId,
@@ -30,8 +33,10 @@ interface IRoyaltyWorkflows {
3033
/// @param ancestorIpId The address of the ancestor IP from which the revenue is being claimed.
3134
/// @param claimer The address of the claimer of the currency (revenue) tokens.
3235
/// @param childIpIds The addresses of the child IPs from which royalties are derived.
33-
/// @param royaltyPolicies The addresses of the royalty policies that govern royalty flows for each child IP.
34-
/// @param currencyTokens The addresses of the currency tokens in which the royalties will be claimed.
36+
/// @param royaltyPolicies The addresses of the royalty policies, where royaltyPolicies[i] governs
37+
/// the royalty flow for childIpIds[i].
38+
/// @param currencyTokens The addresses of the currency tokens in which royalties will be claimed,
39+
/// where currencyTokens[i] is the token used for royalties from childIpIds[i].
3540
/// @return amountsClaimed The amounts of successfully claimed revenue for each specified currency token.
3641
function claimAllRevenue(
3742
address ancestorIpId,

contracts/workflows/RoyaltyWorkflows.sol

+11-6
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,13 @@ contract RoyaltyWorkflows is IRoyaltyWorkflows, MulticallUpgradeable, AccessMana
4848
/// @param ancestorIpId The address of the ancestor IP from which the revenue is being claimed.
4949
/// @param claimer The address of the claimer of the currency (revenue) tokens.
5050
/// @param childIpIds The addresses of the child IPs from which royalties are derived.
51-
/// @param royaltyPolicies The addresses of the royalty policies that govern royalty flows for each child IP.
52-
/// @param currencyTokens The addresses of the currency tokens in which the royalties will be claimed.
53-
/// @param amounts The amounts (in each currency) of royalties to be transferred to the ancestor IP's
54-
/// royalty vault and subsequently claimed by the claimer.
51+
/// @param royaltyPolicies The addresses of the royalty policies, where royaltyPolicies[i] governs
52+
/// the royalty flow for childIpIds[i].
53+
/// @param currencyTokens The addresses of the currency tokens in which royalties will be claimed,
54+
/// where currencyTokens[i] is the token used for royalties from childIpIds[i].
55+
/// @param amounts The amounts to transfer and claim, where amounts[i] represents the amount of
56+
/// royalties in currencyTokens[i] to transfer from childIpIds[i]'s royaltyPolicies[i] to the ancestor's
57+
/// royalty vault.
5558
/// @return amountsClaimed The amounts of successfully claimed revenue for each specified currency token.
5659
function transferToVaultAndClaimByTokenBatch(
5760
address ancestorIpId,
@@ -87,8 +90,10 @@ contract RoyaltyWorkflows is IRoyaltyWorkflows, MulticallUpgradeable, AccessMana
8790
/// @param ancestorIpId The address of the ancestor IP from which the revenue is being claimed.
8891
/// @param claimer The address of the claimer of the currency (revenue) tokens.
8992
/// @param childIpIds The addresses of the child IPs from which royalties are derived.
90-
/// @param royaltyPolicies The addresses of the royalty policies that govern royalty flows for each child IP.
91-
/// @param currencyTokens The addresses of the currency tokens in which the royalties will be claimed.
93+
/// @param royaltyPolicies The addresses of the royalty policies, where royaltyPolicies[i] governs
94+
/// the royalty flow for childIpIds[i].
95+
/// @param currencyTokens The addresses of the currency tokens in which royalties will be claimed,
96+
/// where currencyTokens[i] is the token used for royalties from childIpIds[i].
9297
/// @return amountsClaimed The amounts of successfully claimed revenue for each specified currency token.
9398
function claimAllRevenue(
9499
address ancestorIpId,

0 commit comments

Comments
 (0)