refactor: rename cursor params/returns to actionId on public API (#128)

[thedavidmeister]

Summary

Implements #128: rename cursor → actionId on the public API, treating the value as an opaque handle (ERC721/1155 tokenId precedent). Also corrects the existing pre-existing actionIndex usage on schedule/cancel — "index" implied sequential array behavior consumers might reason about; "id" makes the opacity contract explicit.

Renames:

• nextOfType / prevOfType first param: cursor → fromId
• nextOfType return: nextCursor → nextActionId
• prevOfType return: prevCursor → prevActionId
• latestActionOfType / earliestActionOfType return: cursor → actionId
• getActionParameters param: cursor → actionId
• schedule / cancel / CorporateActionScheduled / CorporateActionCancelled: actionIndex → actionId (pre-existing misnaming)
• AccountMigrated / ReceiptAccountMigrated event fields: fromCursor → fromActionId, toCursor → toActionId
• Errors ActionAlreadyComplete / ActionDoesNotExist: param actionIndex → actionId
• LibCorporateActionNode internal fns matching the interface shape

Out of scope (per #128 carve-out — legitimately called cursor):

• accountMigrationCursor / accountIdCursor / totalSupplyLatestCursor storage
• LibRebase / LibReceiptRebase migratedBalance internal params (cursor as local walk variable)
• Caller code locals (per the issue's "free to assign into a local called cursor" rule)

Bytecode impact

Zero. Event sig keccaks use type strings, not param names. bytecode_hash = "none" + cbor_metadata = false keep param-name changes out of deployment bytecode. The pointer codehash suite (testCodehash* / testCreationCode* / testRuntimeCode*) passes without pointer regen.

Test plan

• full suite green (497/497 pass)
• pointer codehash tests confirm no bytecode change
• static analysis (CI)
• legal (CI)

🤖 Generated with Claude Code

[coderabbitai]

Warning

Rate limit exceeded

@thedavidmeister has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 29 minutes and 44 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: dc31350b-3d19-41c7-90e6-d3ba09bfd238

📥 Commits

Reviewing files that changed from the base of the PR and between 662a935 and 0f461e4.

📒 Files selected for processing (7)

• src/concrete/StoxCorporateActionsFacet.sol
• src/concrete/StoxReceipt.sol
• src/concrete/StoxReceiptVault.sol
• src/error/ErrCorporateAction.sol
• src/interface/ICorporateActionsV1.sol
• src/lib/LibCorporateAction.sol
• src/lib/LibCorporateActionNode.sol

📝 Walkthrough

Walkthrough

A refactoring PR that renames identifiers throughout the corporate actions API to replace generic cursor terminology with more descriptive actionIndex, fromActionIndex, and toActionIndex naming in interfaces, implementations, libraries, and events across five files.

Changes

Corporate Actions Naming Consolidation

Layer / File(s)	Summary
Interface Definitions src/interface/ICorporateActionsV1.sol	Event parameter names and function return variables updated from cursor/nextCursor/prevCursor to actionIndex/nextActionIndex/prevActionIndex; event migration handles renamed fromCursor/toCursor to fromActionIndex/toActionIndex.
Library Core Implementation src/lib/LibCorporateActionNode.sol	resolve helper parameter renamed cursor → actionIndex; internal traversal wrappers (latestActionOfType, earliestActionOfType, nextActionOfType, prevActionOfType) return variables renamed from cursor to actionIndex.
Facet Delegation src/concrete/StoxCorporateActionsFacet.sol	Function signatures updated: latestActionOfType and earliestActionOfType return actionIndex; nextOfType and prevOfType take fromIndex parameter and return nextActionIndex/prevActionIndex; getActionParameters parameter renamed to actionIndex.
Event Signatures src/concrete/StoxReceipt.sol, src/concrete/StoxReceiptVault.sol	ReceiptAccountMigrated and AccountMigrated event parameters renamed from fromCursor/toCursor to fromActionIndex/toActionIndex.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

Possibly related issues

• Rename cursor params/returns in ICorporateActionsV1 to actionIndex #128: Tracks the same systematic rename of cursor → actionIndex across the corporate actions traversal API and internal library helpers in the same files.

Possibly related PRs

• feat: lazy rebase migration with direct storage writes #21: Added the original AccountMigrated/ReceiptAccountMigrated event definitions with cursor-based parameters; this PR renames those parameters to actionIndex terminology.
• feat: getActionParameters getter and CorporateActionEffective event #26: Modifies the corporate-actions traversal getters and getActionParameters; this PR updates the same function signatures with consistent actionIndex naming.
• feat: doubly linked list and action lifecycle #22: Implemented LibCorporateActionNode traversal functions (nextOfType, prevOfType, resolve) that this PR renames for consistency.

Poem

🐰 A cursor once traversed the action line,
but "actionIndex" tells the tale more fine—
Through interfaces and libraries bright,
we rename with care, the API's right.
No logic changed, just clarity gained,
the naming refactor is maintained! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The PR title mentions 'actionId' but the actual changes rename to 'actionIndex', creating a mismatch with the real changeset.	Update the title to 'refactor: rename cursor params/returns to actionIndex on public API (#128)' to accurately reflect the changes made.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/issue-128-rename-cursor-to-action-index

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Review rate limit: 0/1 reviews remaining, refill in 29 minutes and 44 seconds.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}