docs(changelogs): add breaking changes for v27

[lumtis]

Breaking changes related to Solana and Bitcoin Universal Contracts

Summary by CodeRabbit

• Breaking Changes
  • Universal contract calls for Bitcoin and Solana now follow an updated execution workflow, affecting deposit and call operations while maintaining the same interfaces.
• Documentation
  • The release notes for version 27.0.0 have been updated to outline these changes.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The changelog has been updated to include a new "Breaking Changes" section for version 27.0.0. This section specifies that universal contract calls for the depositAndCall and call operations now follow the Protocol Contract V2 workflow by invoking the onCall method on the Universal Contract from the gateway. The previous behavior of triggering the onCrossChainCall method on the systemContract has been replaced. No changes were made to the public interfaces.

Changes

File	Change Summary
changelog.md	Added a "Breaking Changes" section under version 27.0.0 detailing that for universal contract calls (depositAndCall and call), the gateway now invokes the onCall method on the Universal Contract instead of triggering the onCrossChainCall method on the systemContract.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Gateway
    participant UniversalContract as "Universal Contract"
    participant SystemContract as "System Contract"

    Client->>Gateway: Request depositAndCall / call
    Gateway->>UniversalContract: Invoke onCall (Protocol Contract V2)
    Note over Gateway,UniversalContract: Replaces previous call via systemContract's onCrossChainCall

Loading

Possibly related PRs

• docs: add a guide for E2E tests to run #3285: Addresses the invocation update for depositAndCall operations and includes E2E tests for various networks.
• chore: changelogs v27 #3451: Involves changelog updates and version reorganization related to the breaking changes detailed in this PR.

Suggested labels

no-changelog

Suggested reviewers

• fbac
• skosito
• kingpinXD
• swift1337
• gartnera

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

changelog.md (1)

8-8: Refine Inline Code Formatting for Consistency.

The sentence “For depositAndCall and call operations, the onCall method is invoked on the Universal Contract from the gateway…” would be clearer if “call operations” were formatted consistently. Consider revising it to “For depositAndCall and call operations, …” so that both function names appear with proper inline code formatting.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aec7b70 and 07184ae.

📒 Files selected for processing (1)

• changelog.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: build-zetanode
• GitHub Check: lint
• GitHub Check: build-and-test
• GitHub Check: gosec
• GitHub Check: build
• GitHub Check: Analyze (go)

🔇 Additional comments (3)

changelog.md (3)

5-5: Introduce the "Breaking Changes" section clearly.

The addition of the "Breaking Changes" header for v27.0.0 is clear and fits the purpose of documenting critical updates. Ensure that the markdown syntax (header level) is consistent with the rest of the document.

---

7-7: Clear Description of Workflow Change.

The bullet point “Universal contract calls from Bitcoin and Solana now follow the Protocol Contract V2 workflow.” succinctly describes the major change. Verify that this statement accurately reflects the documented behavior in the PR summary and internal documentation.

---

9-9: Affirmation of Interface Stability.

The note “The interfaces of both functions remain the same.” effectively reassures users that, despite the workflow changes, the public interfaces are unchanged. No modifications are required for this line.