v6 update int

[thedavidmeister]

Motivation

Solution

Checks

By submitting this for review, I'm confirming I've done the following:

• made this PR as small as possible
• unit-tested any new functionality
• linked any relevant issues or PRs
• included screenshots (if this involves a front-end change)

Summary by CodeRabbit

• Updates
  • Updated core vault operation endpoints (deposit, withdraw, and order placement) to the latest version for enhanced stability and consistency.
  • Improved error handling with better validation checks for vault-related operations.
  • Refined documentation examples for vault collision scenarios to provide clearer guidance.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Updated the IOrderBookV6 interface by adding a new error declaration for zero vault ID scenarios, changing vault collision example references from ID 0 to ID 1 in comments, and renamed three entry point functions from version 3 to version 4 signatures.

Changes

Cohort / File(s)	Summary
Interface Updates src/interface/unstable/IOrderBookV6.sol	Added ZeroVaultId error declaration; updated vault collision example comments (ID 0 → ID 1); renamed entry points: deposit3 → deposit4, withdraw3 → withdraw4, addOrder3 → addOrder4

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'v6 update int' is vague and non-descriptive, using abbreviated terms that do not clearly convey the substantive changes made to the codebase.	Revise the title to be more specific and descriptive, such as 'Update IOrderBookV6 interface with deposit4/withdraw4/addOrder4 entry points' to clearly communicate the main changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 2025-12-22-deps

---

📜 Recent review details

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f63a086 and 9cb8da9.

📒 Files selected for processing (1)

• src/interface/unstable/IOrderBookV6.sol

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: standard-tests (ubuntu-latest, rainix-sol-test)
• GitHub Check: standard-tests (ubuntu-latest, rainix-sol-legal)
• GitHub Check: standard-tests (ubuntu-latest, rainix-sol-static)

🔇 Additional comments (6)

src/interface/unstable/IOrderBookV6.sol (6)

192-195: LGTM: New error properly documents vault ID restriction.

The ZeroVaultId error is well-defined and appropriately documented. It formalizes the vault ID 0 restriction that is referenced throughout the interface comments.

---

349-350: LGTM: Comment updated for consistency with vault ID restrictions.

The example now correctly uses vault ID 1 instead of 0, aligning with the restriction that vault ID 0 is disallowed for deposits (lines 357-358).

---

378-378: LGTM: Comment emphasis aligns with vault ID restrictions.

The uppercase emphasis on "NOT supported" clearly communicates the vault ID 0 restriction for withdrawals, consistent with the deposit documentation and the new ZeroVaultId error.

---

389-389: No action needed. The withdraw4 function in IOrderBookV6.sol and withdraw3 in IOrderBookV5.sol are part of separate, versioned interfaces. This is not a breaking change within a single interface—it's the expected progression across interface versions. Contracts implementing IOrderBookV5 retain withdraw3, while those implementing IOrderBookV6 use withdraw4. No coordinated updates are required.

Likely an incorrect or invalid review comment.

---

366-366: No action required. This repository contains interface definitions only, and the function rename from deposit3 (in IOrderBookV5) to deposit4 (in IOrderBookV6) is correctly implemented as part of the intentional versioning scheme. Implementations and callers of these interfaces exist in separate repositories and are not subject to verification within this codebase.

---

443-443: This is a versioned interface specification where V5 and V6 are separate major versions designed to coexist. The function addOrder3 remains in the stable IOrderBookV5 interface, while addOrder4 is introduced in the new unstable IOrderBookV6. This is standard API versioning, not a breaking change within this repository.

Likely an incorrect or invalid review comment.

---

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

[github-actions]

@coderabbitai assess this PR size classification for the totality of the PR with the following criterias and report it in your comment:

S/M/L PR Classification Guidelines:

This guide helps classify merged pull requests by effort and complexity rather than just line count. The goal is to assess the difficulty and scope of changes after they have been completed.

Small (S)

Characteristics:

• Simple bug fixes, typos, or minor refactoring
• Single-purpose changes affecting 1-2 files
• Documentation updates
• Configuration tweaks
• Changes that require minimal context to review

Review Effort: Would have taken 5-10 minutes

Examples:

• Fix typo in variable name
• Update README with new instructions
• Adjust configuration values
• Simple one-line bug fixes
• Import statement cleanup

Medium (M)

Characteristics:

• Feature additions or enhancements
• Refactoring that touches multiple files but maintains existing behavior
• Breaking changes with backward compatibility
• Changes requiring some domain knowledge to review

Review Effort: Would have taken 15-30 minutes

Examples:

• Add new feature or component
• Refactor common utility functions
• Update dependencies with minor breaking changes
• Add new component with tests
• Performance optimizations
• More complex bug fixes

Large (L)

Characteristics:

• Major feature implementations
• Breaking changes or API redesigns
• Complex refactoring across multiple modules
• New architectural patterns or significant design changes
• Changes requiring deep context and multiple review rounds

Review Effort: Would have taken 45+ minutes

Examples:

• Complete new feature with frontend/backend changes
• Protocol upgrades or breaking changes
• Major architectural refactoring
• Framework or technology upgrades

Additional Factors to Consider

When deciding between sizes, also consider:

• Test coverage impact: More comprehensive test changes lean toward larger classification
• Risk level: Changes to critical systems bump up a size category
• Team familiarity: Novel patterns or technologies increase complexity

Notes:

• the assessment must be for the totality of the PR, that means comparing the base branch to the last commit of the PR
• the assessment output must be exactly one of: S, M or L (single-line comment) in format of: SIZE={S/M/L}
• do not include any additional text, only the size classification
• your assessment comment must not include tips or additional sections
• do NOT tag me or anyone else on your comment

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the full diff for this PR to assess size
gh pr diff 46 --repo rainlanguage/rain.orderbook.interface

echo "---FILE COUNT---"
# Count number of files changed
gh pr diff 46 --repo rainlanguage/rain.orderbook.interface --name-only | wc -l

echo "---LINE STATS---"
# Get line statistics
gh pr view 46 --repo rainlanguage/rain.orderbook.interface --json additions,deletions,changedFiles --jq '{additions, deletions, changedFiles}'

Length of output: 4082

---

SIZE=S