PI-9: Helper Function Bug Fix

Executed on April 18, 2025 at 18:48 UTC.

Summary

Update the _setSortedDepositIds function to properly set the Deposit ID-to-index mapping.

Links

• Implementation PR

• Implementation Commit: 452ee9638e5c86cfa73b1c25f5f1cdac80cd84ff

• Safe Transaction

• Diamond Cut Transaction

Problem

The protocol stores a list of each Farmer's Deposits on-chain, which is used to allow clients like the Pinto UI to easily query Deposit data. The protocol also stores a mapping of Deposit IDs to index in order to efficiently look up a Deposit's index. PI-8 introduced an updateSortedDepositIds function that allows anyone to submit a Deposit ordering for one token, validated in ascending Stem order, but this function did not properly update the mapping to reflect the new ordering. As a result, a later full Deposit removal could use a stale index and remove the wrong ID from the list.

Solution

Update LibSilo._setSortedDepositIds to properly update the mapping based on the new ordering. Each Deposit ID is mapped to its zero-based index before the ordered list is stored.

Rationale

Keeping the index mapping consistent with the ordered list preserves correct Deposit index lookup and removal after reordering. The existing validation requires a nonempty, complete list in strictly ascending Stem order.

Contract Changes

Initialization

No initializer was called. The upgrade did not automatically rewrite existing account mappings. A successful call to updateSortedDepositIds updates the supplied account and token’s index mapping.

Facet Changes

All six facets were replaced with unchanged external interfaces. The changed internal helper is called only by SiloFacet.updateSortedDepositIds(). The other replacements do not introduce additional function changes.

Other Contract / Parameter Changes

The externally linked libraries below were redeployed. Only LibSilo’s own source changed. LibTokenSilo, LibConvert and LibPipelineConvert retained their own source. ApprovalFacet and SiloGettersFacet have no externally linked libraries. No protocol parameters were changed.

Function Changes

• Updated LibSilo._setSortedDepositIds(), called by SiloFacet.updateSortedDepositIds(), to assign idIndex[sortedDepositIds[i]] = i for every validated Deposit ID before storing the array. This keeps the existing getIndexForDepositId() getter and index-based Deposit removal consistent with the new ordering. The external validation, return types and event interfaces were unchanged.