onAbort support

[fadeev]

Summary by CodeRabbit

• New Features

  • Introduced an abort event and corresponding functionality for enhanced contract response.
  • Enabled tasks and scripts to accept an optional custom abort address, giving users greater control over transaction operations.

• Chores

  • Upgraded @zetachain/localnet dependency to version 7.1.0.
  • Updated @zetachain/protocol-contracts dependency to version 12.0.0-rc1.
  • Added @zetachain/protocol-contracts dependency in the swap example.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request introduces a new abort-handling feature in the Universal contract by adding an AbortEvent and a corresponding onAbort function, which is restricted to gateway calls. The parameter name in the onRevert function has been streamlined from revertContext to context. Additionally, dependency versions for @zetachain/protocol-contracts have been upgraded or added across several package files, and multiple Hardhat task definitions along with a localnet script have been updated to accept a dynamic, user-specified abortAddress parameter instead of a hardcoded value.

Changes

File(s)	Change Summary
examples/call/contracts/Universal.sol	Added new AbortEvent and onAbort (restricted to gateway) for handling abort cases; updated onRevert parameter from revertContext to context.
examples/call/package.json, examples/hello/package.json, examples/swap/package.json, examples/nft/package.json, examples/token/package.json	Upgraded dependency @zetachain/localnet from "7.0.0" to "7.1.0"; updated or added @zetachain/protocol-contracts to version 12.0.0-rc1.
examples/call/scripts/localnet.sh	Appended --abort-address "$CONTRACT_ZETACHAIN" to various npx hardhat commands.
examples/call/tasks/*.ts (connectedCall, connectedDeposit, connectedDepositAndCall, universalCall, universalCallMulti, universalWithdraw, universalWithdrawAndCall)	Modified tasks to assign abortAddress dynamically from args and added an optional abortAddress parameter with a default value of "0x0000000000000000000000000000000000000000".

Sequence Diagram(s)

sequenceDiagram
    participant Gateway
    participant UniversalContract
    Gateway->>UniversalContract: Call onAbort(context)
    Note over UniversalContract: Verify caller is gateway
    UniversalContract-->>Gateway: Emit AbortEvent(context)

Loading

sequenceDiagram
    participant User
    participant TaskScript
    participant Contract
    User->>TaskScript: Invoke task with abortAddress argument
    TaskScript->>TaskScript: Set revertOptions.abortAddress = args.abortAddress
    TaskScript->>Contract: Execute transaction with custom abortAddress

Loading

Possibly related PRs

• Gateway localnet examples #189: The changes in the main PR, specifically the modifications to the onRevert function and the addition of the AbortEvent, are related to the onRevert function in the retrieved PR's RevertContract, which also handles revert scenarios and emits a RevertEvent.
• ERC-20 token transfer example and improvements to NFT #209: The changes in the main PR, which involve the addition of a new event and modifications to the onRevert function in the Universal.sol contract, are related to the changes in the retrieved PR, which also includes modifications to the Universal.sol contract, specifically in the onRevert function and event emissions.

Suggested Reviewers

• andresaiello

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6170488 and cc6205c.

⛔ Files ignored due to path filters (5)

• examples/call/yarn.lock is excluded by !**/yarn.lock, !**/*.lock
• examples/hello/yarn.lock is excluded by !**/yarn.lock, !**/*.lock
• examples/nft/yarn.lock is excluded by !**/yarn.lock, !**/*.lock
• examples/swap/yarn.lock is excluded by !**/yarn.lock, !**/*.lock
• examples/token/yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (5)

• examples/call/package.json (2 hunks)
• examples/hello/package.json (2 hunks)
• examples/nft/package.json (1 hunks)
• examples/swap/package.json (2 hunks)
• examples/token/package.json (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• examples/nft/package.json

🚧 Files skipped from review as they are similar to previous changes (3)

• examples/call/package.json
• examples/swap/package.json
• examples/hello/package.json

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

• GitHub Check: test (examples/token)
• GitHub Check: test (examples/swap)
• GitHub Check: test (examples/nft)
• GitHub Check: test (examples/hello)
• GitHub Check: test (examples/call)
• GitHub Check: slither (examples/swap, swap.sarif)
• GitHub Check: slither (examples/call, call.sarif)
• GitHub Check: slither (examples/hello, hello.sarif)

🔇 Additional comments (1)

examples/token/package.json (1)

31-31: Dependency Version Update Confirmed

The update of @zetachain/localnet from "7.0.0" to "7.1.0" is correct and aligns with the broader dependency update objectives stated in the PR. Please ensure that integration or unit tests verify compatibility with this updated dependency, especially given the overall changes supporting the onAbort functionality.

---

🪧 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.
• @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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[fadeev]

@zeta-chain/smart-contracts please, review.

[s2imonovic]

looks good

[fadeev]

@s2imonovic please, leave an approval if everything's ok, so I can merge. Thanks!

[s2imonovic]

Looks good