@bananapus/core-v6 0.0.39 → 0.0.41

package/src/interfaces/IJBTerminalStore.sol

@@ -59,7 +59,7 @@ interface IJBTerminalStore {
 
     /// @notice Returns the reclaimable surplus for a project given a cash-out count, total supply, and surplus.
     /// @param projectId The ID of the project.
-    /// @param cashOutCount The number of tokens being cashed out.
+    /// @param cashOutCount The number of tokens to cash out.
     /// @param totalSupply The total token supply.
     /// @param surplus The project's surplus.
     /// @return The reclaimable surplus amount.
@@ -76,7 +76,7 @@ interface IJBTerminalStore {
     /// @notice Returns the reclaimable surplus for a project across multiple terminals, considering only specific
     /// tokens.
     /// @param projectId The ID of the project.
-    /// @param cashOutCount The number of tokens being cashed out.
+    /// @param cashOutCount The number of tokens to cash out.
     /// @param terminals The terminals to include in the surplus calculation. If empty, all project terminals are used.
     /// @param tokens The tokens to include in the surplus calculation.
     /// @param decimals The number of decimals to express the result with.
@@ -114,7 +114,7 @@ interface IJBTerminalStore {
 
     /// @notice Returns the reclaimable surplus for a project across all terminals using all accounting contexts.
     /// @param projectId The ID of the project.
-    /// @param cashOutCount The number of tokens being cashed out.
+    /// @param cashOutCount The number of tokens to cash out.
     /// @param decimals The number of decimals to express the result with.
     /// @param currency The currency to express the result in.
     /// @return The reclaimable surplus amount.
@@ -145,9 +145,9 @@ interface IJBTerminalStore {
     /// @notice Simulates a cash out without modifying state.
     /// @param terminal The terminal to simulate the cash out from.
     /// @param holder The address cashing out.
-    /// @param projectId The ID of the project being cashed out from.
-    /// @param cashOutCount The number of project tokens being cashed out.
-    /// @param tokenToReclaim The token being reclaimed.
+    /// @param projectId The ID of the project to cash out from.
+    /// @param cashOutCount The number of project tokens to cash out.
+    /// @param tokenToReclaim The token to reclaim.
     /// @param beneficiaryIsFeeless Whether the cash out's beneficiary is a feeless address.
     /// @param metadata Extra data to pass along to the data hook.
     /// @return ruleset The project's current ruleset.
@@ -175,8 +175,8 @@ interface IJBTerminalStore {
     /// @notice Simulates a payment without modifying state.
     /// @param terminal The terminal to simulate the payment from.
     /// @param payer The address of the payer.
-    /// @param amount The amount being paid.
-    /// @param projectId The ID of the project being paid.
+    /// @param amount The amount to pay.
+    /// @param projectId The ID of the project to pay.
     /// @param beneficiary The address to mint project tokens to.
     /// @param metadata Extra data to pass along to the data hook.
     /// @return ruleset The project's current ruleset.
@@ -237,15 +237,15 @@ interface IJBTerminalStore {
 
     /// @notice Records a balance addition for a project.
     /// @param projectId The ID of the project.
-    /// @param token The token being added.
-    /// @param amount The amount being added.
+    /// @param token The token added.
+    /// @param amount The amount added.
     function recordAddedBalanceFor(uint256 projectId, address token, uint256 amount) external;
 
     /// @notice Records a cash out from a project.
     /// @param holder The address cashing out.
-    /// @param projectId The ID of the project being cashed out from.
-    /// @param cashOutCount The number of project tokens being cashed out.
-    /// @param tokenToReclaim The token being reclaimed.
+    /// @param projectId The ID of the project to cash out from.
+    /// @param cashOutCount The number of project tokens to cash out.
+    /// @param tokenToReclaim The token to reclaim.
     /// @param beneficiaryIsFeeless Whether the cash out's beneficiary is a feeless address. Passed through to data
     /// hooks so they can skip their own fees when value stays in the protocol (e.g. project-to-project routing).
     /// @param metadata Extra data to pass along to the data hook.
@@ -271,8 +271,8 @@ interface IJBTerminalStore {
 
     /// @notice Records a payment to a project.
     /// @param payer The address of the payer.
-    /// @param amount The amount being paid.
-    /// @param projectId The ID of the project being paid.
+    /// @param amount The amount to pay.
+    /// @param projectId The ID of the project to pay.
     /// @param beneficiary The address to mint project tokens to.
     /// @param metadata Extra data to pass along to the data hook.
     /// @return ruleset The project's current ruleset.
@@ -290,8 +290,8 @@ interface IJBTerminalStore {
 
     /// @notice Records a payout from a project.
     /// @param projectId The ID of the project paying out.
-    /// @param token The token being paid out.
-    /// @param amount The amount being paid out.
+    /// @param token The token to pay out.
+    /// @param amount The amount to pay out.
     /// @param currency The currency the amount is denominated in.
     /// @return ruleset The project's current ruleset.
     /// @return amountPaidOut The amount paid out in the token's native decimals.
@@ -305,14 +305,14 @@ interface IJBTerminalStore {
         returns (JBRuleset memory ruleset, uint256 amountPaidOut);
 
     /// @notice Records a terminal migration for a project.
-    /// @param projectId The ID of the project being migrated.
-    /// @param token The token being migrated.
+    /// @param projectId The ID of the project to migrate.
+    /// @param token The token to migrate.
     /// @return balance The balance that was migrated.
     function recordTerminalMigration(uint256 projectId, address token) external returns (uint256 balance);
 
     /// @notice Records surplus allowance usage for a project.
     /// @param projectId The ID of the project using surplus allowance.
-    /// @param token The token being used.
+    /// @param token The token to use.
     /// @param amount The amount of surplus allowance to use.
     /// @param currency The currency the amount is denominated in.
     /// @return ruleset The project's current ruleset.

package/src/interfaces/IJBTokens.sol

@@ -88,7 +88,7 @@ interface IJBTokens {
     /// @return The credit balance.
     function creditBalanceOf(address holder, uint256 projectId) external view returns (uint256);
 
-    /// @notice Returns the project ID associated with a token.
+    /// @notice The project ID that a given ERC-20 token contract is associated with.
     /// @param token The token to get the project ID of.
     /// @return The project ID.
     function projectIdOf(IJBToken token) external view returns (uint256);
@@ -116,13 +116,13 @@ interface IJBTokens {
 
     /// @notice Burns tokens and/or credits from a holder's balance.
     /// @param holder The address to burn tokens from.
-    /// @param projectId The ID of the project whose tokens are being burned.
+    /// @param projectId The ID of the project to burn tokens for.
     /// @param count The number of tokens to burn.
     function burnFrom(address holder, uint256 projectId, uint256 count) external;
 
     /// @notice Claims tokens from a holder's credits into a beneficiary's account.
     /// @param holder The address to claim credits from.
-    /// @param projectId The ID of the project whose tokens are being claimed.
+    /// @param projectId The ID of the project to claim tokens for.
     /// @param count The number of tokens to claim.
     /// @param beneficiary The address to send the claimed tokens to.
     function claimTokensFor(address holder, uint256 projectId, uint256 count, address beneficiary) external;
@@ -144,7 +144,7 @@ interface IJBTokens {
 
     /// @notice Mints tokens or credits for a holder.
     /// @param holder The address to mint tokens for.
-    /// @param projectId The ID of the project whose tokens are being minted.
+    /// @param projectId The ID of the project to mint tokens for.
     /// @param count The number of tokens to mint.
     /// @return token The project's token, if one exists.
     function mintFor(address holder, uint256 projectId, uint256 count) external returns (IJBToken token);
@@ -155,14 +155,14 @@ interface IJBTokens {
     function setTokenFor(uint256 projectId, IJBToken token) external;
 
     /// @notice Sets the name and symbol of a project's token.
-    /// @param projectId The ID of the project whose token is being updated.
+    /// @param projectId The ID of the project to update the token for.
     /// @param name The new name.
     /// @param symbol The new symbol.
     function setTokenMetadataFor(uint256 projectId, string calldata name, string calldata symbol) external;
 
     /// @notice Transfers credits from one holder to another.
     /// @param holder The address to transfer credits from.
-    /// @param projectId The ID of the project whose credits are being transferred.
+    /// @param projectId The ID of the project to transfer credits for.
     /// @param recipient The address to transfer credits to.
     /// @param count The number of credits to transfer.
     function transferCreditsFrom(address holder, uint256 projectId, address recipient, uint256 count) external;

package/src/libraries/JBCashOuts.sol

@@ -16,11 +16,11 @@ library JBCashOuts {
     error JBCashOuts_DesiredOutputNotAchievable();
 
     /// @notice Returns the amount of surplus terminal tokens which can be reclaimed based on the total surplus, the
-    /// number of tokens being cashed out, the total token supply, and the ruleset's cash out tax rate.
+    /// number of tokens to cash out, the total token supply, and the ruleset's cash out tax rate.
     /// @param surplus The total amount of surplus terminal tokens.
-    /// @param cashOutCount The number of tokens being cashed out, as a fixed point number with 18 decimals.
+    /// @param cashOutCount The number of tokens to cash out, as a fixed point number with 18 decimals.
     /// @param totalSupply The total token supply, as a fixed point number with 18 decimals.
-    /// @param cashOutTaxRate The current ruleset's cash out tax rate.
+    /// @param cashOutTaxRate The current ruleset's cash out tax rate, out of `JBConstants.MAX_CASH_OUT_TAX_RATE`.
     /// @return reclaimableSurplus The amount of surplus tokens that can be reclaimed.
     function cashOutFrom(
         uint256 surplus,
@@ -64,7 +64,7 @@ library JBCashOuts {
     /// @param surplus The total amount of surplus terminal tokens.
     /// @param desiredOutput The minimum amount of surplus tokens the caller wants to receive.
     /// @param totalSupply The total token supply, as a fixed point number with 18 decimals.
-    /// @param cashOutTaxRate The current ruleset's cash out tax rate.
+    /// @param cashOutTaxRate The current ruleset's cash out tax rate, out of `JBConstants.MAX_CASH_OUT_TAX_RATE`.
     /// @return count The minimum number of tokens to cash out.
     function minCashOutCountFor(
         uint256 surplus,

package/src/libraries/JBPayoutSplitGroupLib.sol

@@ -44,9 +44,9 @@ library JBPayoutSplitGroupLib {
     /// @param splits The splits contract to read splits from.
     /// @param store The terminal store used to restore balance when a payout fails.
     /// @param projectId The ID of the project to send the payouts of.
-    /// @param token The address of the token being paid out.
-    /// @param rulesetId The ID of the ruleset of the split group being paid.
-    /// @param amount The total amount being paid out.
+    /// @param token The address of the token to pay out.
+    /// @param rulesetId The ID of the ruleset of the split group to pay.
+    /// @param amount The total amount to pay out.
     /// @param caller The original caller of the terminal payout flow.
     /// @return leftoverAmount The leftover amount after split payouts.
     /// @return amountEligibleForFees The amount of payouts that are eligible for fees.
@@ -121,8 +121,8 @@ library JBPayoutSplitGroupLib {
     /// @param store The terminal store used to restore balance when a payout fails.
     /// @param split The split to pay.
     /// @param projectId The ID of the project the split was specified by.
-    /// @param token The address of the token being paid out.
-    /// @param amount The total amount that the split is being paid.
+    /// @param token The address of the token to pay out.
+    /// @param amount The total amount that the split is paid.
     /// @param caller The original caller of the terminal payout flow.
     /// @return netPayoutAmount The amount sent to the split after subtracting fees.
     function _sendPayoutToSplit(

package/src/libraries/JBSurplus.sol

@@ -8,7 +8,7 @@ import {IJBTerminal} from "../interfaces/IJBTerminal.sol";
 /// usage. Aggregates across multiple terminals and tokens, converting to a common currency via `JBPrices`.
 library JBSurplus {
     /// @notice Gets the total current surplus amount across all of a project's terminals.
-    /// @dev This amount changes as the value of the balances changes in relation to the currency being used to measure
+    /// @dev This amount changes as the value of the balances changes in relation to the currency used to measure
     /// the project's payout limits.
     /// @param projectId The ID of the project to get the total surplus for.
     /// @param terminals The terminals to look for surplus within.

package/src/structs/JBAfterCashOutRecordedContext.sol

@@ -3,16 +3,17 @@ pragma solidity ^0.8.0;
 
 import {JBTokenAmount} from "./JBTokenAmount.sol";
 
-/// @custom:member holder The holder of the tokens being cashed out.
-/// @custom:member projectId The ID of the project being cashed out from.
-/// @custom:member rulesetId The ID of the ruleset the cash out is being made during.
-/// @custom:member cashOutCount The number of project tokens being cashed out.
-/// @custom:member cashOutTaxRate The current ruleset's cash out tax rate.
-/// @custom:member reclaimedAmount The token amount being reclaimed from the project's terminal balance. Includes the
-/// token being
+/// @custom:member holder The holder of the tokens to cash out.
+/// @custom:member projectId The ID of the project to cash out from.
+/// @custom:member rulesetId The ID of the ruleset the cash out is made during.
+/// @custom:member cashOutCount The number of project tokens to cash out.
+/// @custom:member cashOutTaxRate The current ruleset's cash out tax rate, out of
+/// `JBConstants.MAX_CASH_OUT_TAX_RATE`.
+/// @custom:member reclaimedAmount The token amount reclaimed from the project's terminal balance. Includes the
+/// token
 /// reclaimed, the value, the number of decimals included, and the currency of the amount.
-/// @custom:member forwardedAmount The token amount being forwarded to the cash out hook. Includes the token
-/// being forwarded, the value, the number of decimals included, and the currency of the amount.
+/// @custom:member forwardedAmount The token amount forwarded to the cash out hook. Includes the token
+/// forwarded, the value, the number of decimals included, and the currency of the amount.
 /// @custom:member beneficiary The address the reclaimed amount will be sent to.
 /// @custom:member hookMetadata Extra data specified by the data hook, which is sent to the cash out hook.
 /// @custom:member cashOutMetadata Extra data specified by the account cashing out, which is sent to the cash out hook.

package/src/structs/JBAfterPayRecordedContext.sol

@@ -4,12 +4,12 @@ pragma solidity ^0.8.0;
 import {JBTokenAmount} from "./JBTokenAmount.sol";
 
 /// @custom:member payer The address the payment originated from.
-/// @custom:member projectId The ID of the project being paid.
-/// @custom:member rulesetId The ID of the ruleset the payment is being made during.
-/// @custom:member amount The payment's token amount. Includes the token being paid, the value, the number of decimals
+/// @custom:member projectId The ID of the project to pay.
+/// @custom:member rulesetId The ID of the ruleset the payment is made during.
+/// @custom:member amount The payment's token amount. Includes the token paid, the value, the number of decimals
 /// included, and the currency of the amount.
-/// @custom:member forwardedAmount The token amount being forwarded to the pay hook. Includes the token
-/// being paid, the value, the number of decimals included, and the currency of the amount.
+/// @custom:member forwardedAmount The token amount forwarded to the pay hook. Includes the token
+/// paid, the value, the number of decimals included, and the currency of the amount.
 /// @custom:member weight The current ruleset's weight (used to determine how many tokens should be minted).
 /// @custom:member newlyIssuedTokenCount The number of project tokens minted for the beneficiary.
 /// @custom:member beneficiary The address which receives any tokens this payment yields.

package/src/structs/JBBeforeCashOutRecordedContext.sol

@@ -5,17 +5,18 @@ import {JBTokenAmount} from "./JBTokenAmount.sol";
 
 /// @notice Context sent from the terminal to the ruleset's data hook upon cash out.
 /// @custom:member terminal The terminal that is facilitating the cash out.
-/// @custom:member holder The holder of the tokens being cashed out.
-/// @custom:member projectId The ID of the project whose tokens are being cashed out.
-/// @custom:member rulesetId The ID of the ruleset the cash out is being made during.
-/// @custom:member cashOutCount The number of tokens being cashed out, as a fixed point number with 18 decimals.
-/// @custom:member totalSupply The total token supply being used for the calculation, as a fixed point number with 18
+/// @custom:member holder The holder of the tokens to cash out.
+/// @custom:member projectId The ID of the project cashing out tokens.
+/// @custom:member rulesetId The ID of the ruleset the cash out is made during.
+/// @custom:member cashOutCount The number of tokens to cash out, as a fixed point number with 18 decimals.
+/// @custom:member totalSupply The total token supply to use for the calculation, as a fixed point number with 18
 /// decimals.
 /// @custom:member surplus The surplus amount used for the calculation, as a fixed point number with 18 decimals.
 /// Includes the token of the surplus, the surplus value, the number of decimals
 /// included, and the currency of the surplus.
-/// @custom:member useTotalSurplus If surplus across all of a project's terminals is being used when making cash outs.
-/// @custom:member cashOutTaxRate The cash out tax rate of the ruleset the cash out is being made during.
+/// @custom:member useTotalSurplus If true, use surplus across all of a project's terminals when calculating cash outs.
+/// @custom:member cashOutTaxRate The cash out tax rate of the ruleset the cash out is made during, out of
+/// `JBConstants.MAX_CASH_OUT_TAX_RATE`.
 /// @custom:member beneficiaryIsFeeless Whether the cash out's beneficiary is a feeless address. Useful for data hooks
 /// that charge their own fees — they can skip fees when value stays in the protocol (e.g. project-to-project
 /// routing).

package/src/structs/JBBeforePayRecordedContext.sol

@@ -6,14 +6,15 @@ import {JBTokenAmount} from "./JBTokenAmount.sol";
 /// @notice Context sent from the terminal to the ruleset's data hook upon payment.
 /// @custom:member terminal The terminal that is facilitating the payment.
 /// @custom:member payer The address that the payment originated from.
-/// @custom:member amount The payment's token amount, including the token being paid, the value, the number of decimals
+/// @custom:member amount The payment's token amount, including the token paid, the value, the number of decimals
 /// included, and the currency of the amount.
-/// @custom:member projectId The ID of the project being paid.
-/// @custom:member rulesetId The ID of the ruleset the payment is being made during.
+/// @custom:member projectId The ID of the project to pay.
+/// @custom:member rulesetId The ID of the ruleset the payment is made during.
 /// @custom:member beneficiary The specified address that should be the beneficiary of anything that this payment
 /// yields.
-/// @custom:member weight The weight of the ruleset during which the payment is being made.
-/// @custom:member reservedPercent The reserved percent of the ruleset the payment is being made during.
+/// @custom:member weight The weight of the ruleset during which the payment is made.
+/// @custom:member reservedPercent The reserved percent of the ruleset the payment is made during, out of
+/// `JBConstants.MAX_RESERVED_PERCENT`.
 /// @custom:member metadata Extra data specified by the payer.
 struct JBBeforePayRecordedContext {
     address terminal;

package/src/structs/JBFee.sol

@@ -2,7 +2,7 @@
 pragma solidity ^0.8.0;
 
 /// @custom:member amount The total amount the fee was taken from, as a fixed point number with the same number of
-/// decimals as the terminal in which this struct was created.
+/// decimals as the token's accounting context.
 /// @custom:member beneficiary The address that will receive the tokens that are minted as a result of the fee payment.
 /// @custom:member unlockTimestamp The timestamp at which the fee is unlocked and can be processed.
 struct JBFee {

package/src/structs/JBPermissionsData.sol

@@ -1,11 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-/// @custom:member operator The address that permissions are being given to.
-/// @custom:member projectId The ID of the project the operator is being given permissions for. Operators only have
+/// @custom:member operator The address to give permissions to.
+/// @custom:member projectId The ID of the project to give the operator permissions for. Operators only have
 /// permissions under this project's scope. An ID of 0 is a wildcard, which gives an operator permissions across all
 /// projects.
-/// @custom:member permissionIds The IDs of the permissions being given. See the `JBPermissionIds` library.
+/// @custom:member permissionIds The IDs of the permissions to grant. See the `JBPermissionIds` library.
 struct JBPermissionsData {
     address operator;
     uint64 projectId;

package/src/structs/JBRuleset.sol

@@ -15,8 +15,9 @@ import {IJBRulesetApprovalHook} from "./../interfaces/IJBRulesetApprovalHook.sol
 /// @custom:member duration How many seconds the ruleset lasts. 0 = no auto-cycling (must be explicitly replaced).
 /// @custom:member weight Tokens minted per unit paid (18 decimals). The terminal divides payment amount by weight to
 /// determine token issuance. Higher weight = more tokens per unit of payment.
-/// @custom:member weightCutPercent How much to reduce weight each cycle (out of 1,000,000,000). 100,000,000 = 10% cut
-/// per cycle. 0 = no decay. Only applies when a cycle auto-rolls without an explicitly queued replacement.
+/// @custom:member weightCutPercent How much to reduce weight each cycle, out of
+/// `JBConstants.MAX_WEIGHT_CUT_PERCENT`. 100,000,000 = 10% cut per cycle. 0 = no decay. Only applies when a cycle
+/// auto-rolls without an explicitly queued replacement.
 /// @custom:member approvalHook A contract that gates whether queued rulesets can take effect (e.g. `JBDeadline` for
 /// minimum notice periods). If the hook rejects a queued ruleset, the current one continues.
 /// @custom:member metadata Packed 256-bit field containing reservedPercent, cashOutTaxRate, baseCurrency, boolean

package/src/structs/JBRulesetConfig.sol

@@ -14,7 +14,8 @@ import {JBSplitGroup} from "./JBSplitGroup.sol";
 /// @custom:member duration How long the ruleset lasts in seconds. 0 = stays active until explicitly replaced.
 /// @custom:member weight Tokens minted per unit of payment (18 decimals). Pass 1 to inherit decayed weight from the
 /// previous ruleset. Pass 0 for no token issuance.
-/// @custom:member weightCutPercent Decay rate per cycle (out of 1,000,000,000). 100,000,000 = 10% cut. 0 = no decay.
+/// @custom:member weightCutPercent Decay rate per cycle, out of `JBConstants.MAX_WEIGHT_CUT_PERCENT`. 100,000,000 =
+/// 10% cut. 0 = no decay.
 /// @custom:member approvalHook Contract that must approve the *next* queued ruleset for it to take effect.
 /// @custom:member metadata The ruleset's behavioral flags and parameters (see `JBRulesetMetadata`).
 /// @custom:member splitGroups How payouts and reserved tokens are distributed during this ruleset.

package/src/structs/JBRulesetMetadata.sol

@@ -3,10 +3,11 @@ pragma solidity ^0.8.0;
 
 /// @notice Human-readable configuration for a ruleset's behavioral flags and parameters. This struct is packed into
 /// 256 bits for on-chain storage (see `JBRulesetMetadataResolver` for the packing layout).
-/// @custom:member reservedPercent Percentage of newly minted tokens set aside for the reserved token split group
-/// (0–10,000 basis points). 5,000 = 50% reserved.
-/// @custom:member cashOutTaxRate Tax applied when holders cash out tokens (0–10,000 basis points). Higher rate = less
-/// reclaim per token. 0 = proportional, 10,000 = no reclaim (100% tax).
+/// @custom:member reservedPercent Percentage of newly minted tokens set aside for the reserved token split group,
+/// out of `JBConstants.MAX_RESERVED_PERCENT`. 5,000 = 50% reserved.
+/// @custom:member cashOutTaxRate Tax applied when holders cash out tokens, out of
+/// `JBConstants.MAX_CASH_OUT_TAX_RATE`. Higher rate = less reclaim per token. 0 = proportional, 10,000 = no reclaim
+/// (100% tax).
 /// @custom:member baseCurrency The currency used to interpret the ruleset's weight for token issuance. Convention:
 /// `uint32(uint160(tokenAddress))` for tokens, or `JBCurrencyIds.ETH`/`JBCurrencyIds.USD` for well-known currencies.
 /// @custom:member pausePay If `true`, the project cannot receive payments during this ruleset.
@@ -21,7 +22,7 @@ pragma solidity ^0.8.0;
 /// @custom:member ownerMustSendPayouts If `true`, only the project owner can trigger payout distribution.
 /// @custom:member holdFees If `true`, fees are accumulated but not processed until a future ruleset (or manually).
 /// @custom:member useTotalSurplusForCashOuts If `true`, cash-out calculations use surplus across all terminals (not
-/// just the one being cashed out from).
+/// just the one to cash out from).
 /// @custom:member useDataHookForPay If `true`, the data hook is called before recording payments.
 /// @custom:member useDataHookForCashOut If `true`, the data hook is called before recording cash outs.
 /// @custom:member dataHook Contract called before pay/cash-out to potentially override token counts or add hooks.

package/src/structs/JBSplitHookContext.sol

@@ -3,8 +3,8 @@ pragma solidity ^0.8.0;
 
 import {JBSplit} from "./JBSplit.sol";
 
-/// @custom:member token The token being sent to the split hook.
-/// @custom:member amount The amount being sent to the split hook, as a fixed point number.
+/// @custom:member token The token to send to the split hook.
+/// @custom:member amount The amount to send to the split hook, as a fixed point number.
 /// @custom:member decimals The number of decimals in the amount.
 /// @custom:member projectId The project the split belongs to.
 /// @custom:member groupId The group the split belongs to. By convention, this ID is `uint256(uint160(tokenAddress))`