fix: [FIND-033] exclude disabled corporate actions from pending task aggregations

[jaime-iobermudez]

This pull request fixes an issue where cancelled (disabled) corporate actions were incorrectly included in pending task aggregations, affecting coupon listings, balance adjustments, and related queries. The fix ensures that disabled tasks are now properly excluded from all internal calculations, resulting in accurate live values for functions like getCouponsOrderedList, balanceOfAt, and others. The external API remains unchanged; the changes are internal and transparent to consumers.

Bug fix: Exclude disabled corporate actions from pending task aggregations

• All internal aggregation functions (e.g., getPendingScheduledCouponListingTotalAt, getPendingScheduledBalanceAdjustmentsAt) now accept a _includeDisabled flag, allowing them to skip disabled tasks when computing live values. All internal callers that compute live values pass false, ensuring disabled tasks are excluded. (.changeset/fix-find-033-pending-task-disabled-exclusion.md, [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]

Library and function interface changes

• The _includeDisabled flag was propagated through several internal and library functions, including those in CouponStorageWrapper, ScheduledTasksStorageWrapper, and others, to ensure consistent exclusion of disabled tasks across all relevant queries and calculations. [1] [2] [3] [4] [5] [6]

New helper functions

• Added isScheduledCouponListingDisabledAtIndex to efficiently check if a scheduled coupon listing task is related to a disabled corporate action, supporting the correct filtering of tasks.

Test coverage

• Added an integration test to ensure that after a scheduled balance adjustment is cancelled, it is properly excluded from projected balances (e.g., balanceOfAt returns the unadjusted value after cancellation).

These changes collectively resolve the bug (FIND-033) and ensure that disabled corporate actions no longer affect live or projected calculations for coupons and balances.

Type of change

• Bug fix 🐞
• New feature ✨
• Breaking change 💥
• Documentation update 📖
• Refactor 🔧

Testing

Node version:

• 20
• 22
• 24

Checklist

• Style Guidelines followed ✅
• Documentation Updated 📚
• Linters - No New Warnings ⚠️
• Local Tests Pass ✅
• Effective Tests Added ✔️
• No reduction of Coverage ✅

[marcosio]

A lot of improvements related with logic reduction, gas and bytecode improvements. Review.

[marcosio]

Avoid variable of single use. Remove index and use inline.

[marcosio]

avoid 0 initializations.

[marcosio]

Remove queueLen and assign to j=ScheduledTasksStorageWrapper.getScheduledCouponListingCount(true).

[marcosio]

Not needed, couponID_ is 0 jet.

[marcosio]

Perhaps is better this:

    function getScheduledSnapshotCount(bool _includeDisabled) internal view returns (uint256 active) {
        ScheduledTasksDataStorage storage store = scheduledSnapshotStorage();
        uint256 total = ScheduledTasksLib.getScheduledTaskCount(store);
        if (_includeDisabled) return total;
        
        for (uint256 i; i < total; ) {
            unchecked {
                active += CorporateActionsStorageWrapper.isCorporateActionDisabled(
                    abi.decode(ScheduledTasksLib.getScheduledTasksByIndex(store, i).data, (bytes32))
                )
                    ? 0
                    : 1;
                ++i;
            }
        }
    }

[marcosio]

Refactor as getScheduledSnapshots

[marcosio]

Refactor as getScheduledSnapshotCount

[marcosio]

Refactor

[marcosio]

Better:

    function getPendingScheduledBalanceAdjustmentsAt(
        uint256 _timestamp,
        bool _includeDisabled
    ) internal view returns (uint256 pendingABAF_, uint8 pendingDecimals_) {
        // * Initialization
        pendingABAF_ = 1;
        ScheduledTasksDataStorage storage scheduledBalanceAdjustments = scheduledBalanceAdjustmentStorage();
        uint256 length = ScheduledTasksLib.getScheduledTaskCount(scheduledBalanceAdjustments);
        uint256 pos = length;

        for (uint256 i; i < length; ) {
            unchecked {
                --pos;
                ++i;
            }

            ScheduledTask memory scheduledTask = ScheduledTasksLib.getScheduledTasksByIndex(
                scheduledBalanceAdjustments,
                pos
            );

            if (_timestamp >= scheduledTask.scheduledTimestamp) return (pendingABAF_, pendingDecimals_);

            bytes32 actionId = abi.decode(scheduledTask.data, (bytes32));

            if (_includeDisabled || !CorporateActionsStorageWrapper.isCorporateActionDisabled(actionId)) {
                IScheduledBalanceAdjustment.ScheduledBalanceAdjustment memory balanceAdjustment = abi.decode(
                    CorporateActionsStorageWrapper.getCorporateActionData(actionId),
                    (IScheduledBalanceAdjustment.ScheduledBalanceAdjustment)
                );

                pendingABAF_ *= balanceAdjustment.factor;
                pendingDecimals_ += balanceAdjustment.decimals;
            }
        }
    }

[marcosio]

Not optimal:

• Don't use PaginationLib
• Remove final for for assembly code to reduce buffer.
• Don't create buffer, result_ is jet created.
• For very complex to follow, is possible reduce jumps.