Move Compute Provider validation and coordination to the E3Program contract

[auryn-macmillan]

This PR moves Compute Provider validation and coordination to the E3Program contract, allowing each E3Program to explicitly specify if and how it interacts with various compute providers.

Summary by CodeRabbit

• New Features

  • Streamlined computation management by removing explicit handling of compute providers.
  • Enhanced error reporting for computation requests, improving clarity and debugging.

• Bug Fixes

  • Improved validation process by integrating input validation and decryption verification.

• Documentation

  • Updated function signatures and event declarations to reflect the removal of compute provider references.

• Tests

  • Removed tests related to compute provider functionality to align with the updated contract design.

[coderabbitai]

Walkthrough

The changes involve significant modifications to the Enclave contract and related interfaces in the codebase. The handling of compute providers has been removed, simplifying the contract's design. This includes the elimination of mappings, functions, and event references associated with compute providers. The validation processes have been updated to enhance error reporting and efficiency, combining input validation and decryption verification. Additionally, various tests have been adjusted to reflect these changes, focusing on the core functionalities without compute provider interactions.

Changes

Files	Change Summary
packages/evm/contracts/Enclave.sol	Removed compute provider management, updated error handling, and modified computation request function.
packages/evm/contracts/interfaces/IE3.sol	Removed IComputeProvider field from E3 struct.
packages/evm/contracts/interfaces/IE3Program.sol	Updated validate function parameters and return types for enhanced validation.
packages/evm/contracts/interfaces/IEnclave.sol	Removed compute provider references from events and function signatures.
packages/evm/contracts/test/MockE3Program.sol	Updated validate function to accept new parameters and modified error handling.
packages/evm/test/Enclave.spec.ts	Removed tests related to compute provider functionality, simplifying test logic.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Enclave
    participant IE3Program

    User->>Enclave: requestE3(duration, e3Program, e3ProgramParams, computeProviderParams)
    Enclave->>IE3Program: validate(e3Id, seed, e3ProgramParams, computeProviderParams)
    IE3Program-->>Enclave: (inputValidator, decryptionVerifier)
    Enclave-->>User: return e3Id, e3

Loading

🐰 In the meadow, changes bloom,
With contracts light, there's more room.
No compute providers, just pure delight,
Validations strong, shining bright!
Hopping forward, we cheer and play,
Simplified paths lead the way! 🌼

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5a27c0e and 9e13cac.

Files selected for processing (6)

• packages/evm/contracts/Enclave.sol (4 hunks)
• packages/evm/contracts/interfaces/IE3.sol (0 hunks)
• packages/evm/contracts/interfaces/IE3Program.sol (1 hunks)
• packages/evm/contracts/interfaces/IEnclave.sol (2 hunks)
• packages/evm/contracts/test/MockE3Program.sol (1 hunks)
• packages/evm/test/Enclave.spec.ts (3 hunks)

Files not reviewed due to no reviewable changes (1)

• packages/evm/contracts/interfaces/IE3.sol

Files skipped from review due to trivial changes (1)

• packages/evm/test/Enclave.spec.ts

Additional comments not posted (13)

packages/evm/contracts/test/MockE3Program.sol (5)

4-8: LGTM!

The imports are necessary for the contract to implement the IE3Program interface and use the IInputValidator and IDecryptionVerifier types.

---

11-11: LGTM!

The custom error is used to provide informative error reporting when the validate function is called with invalid parameters.

---

16-24: LGTM!

The changes to the function signature allow the function to validate two distinct sets of parameters, each expected to have a length of 32 bytes. The addition of IDecryptionVerifier as a return type suggests that the contract may now also handle decryption verification alongside input validation.

---

26-29: LGTM!

The check ensures that the function is called with valid parameters. The use of the custom error provides informative error reporting.

---

32-33: LGTM!

The assembly block correctly loads values from the new parameters, ensuring that the function operates correctly with the updated inputs.

packages/evm/contracts/interfaces/IE3Program.sol (1)

11-25: LGTM!

The changes to the validate function signature are well-structured and align with the PR objective of relocating the validation and coordination of Compute Providers to the E3Program contract. The separation of e3ProgramParams and computeProviderParams parameters allows for a clearer distinction between E3 program parameters and compute provider parameters. The expanded return type, including both IInputValidator and IDecryptionVerifier, suggests a more comprehensive validation process that covers both input validation and decryption verification.

Overall, the changes enhance the flexibility and specificity of how E3Programs operate with compute resources, as stated in the PR summary.

packages/evm/contracts/interfaces/IEnclave.sol (2)

4-4: LGTM!

The removal of the IComputeProvider import is consistent with the other changes in the file that remove references to this type.

---

22-22: Verify the intentional removal of compute provider related events and parameters.

The changes to remove the computeProvider parameter from the E3Requested event and the complete removal of the ComputeProviderEnabled and ComputeProviderDisabled events suggest a refactoring effort to decouple the IEnclave interface from the compute provider management.

Please confirm that these removals are intentional and align with the overall goals of the refactoring. If so, the changes look good to me.

packages/evm/contracts/Enclave.sol (5)

60-63: LGTM!

The updated error provides more context about the specific components involved when an invalid computation request occurs. This change improves error reporting and debugging capabilities.

---

143-151: Looks good!

The updated validate function call retrieves the necessary IInputValidator and IDecryptionVerifier instances from the e3Program. This change aligns with the new combined validation process and provides the required context for validation.

---

153-155: Good validation check!

The require statement effectively validates the IInputValidator and IDecryptionVerifier instances returned by the e3Program.validate function. This ensures that the computation request proceeds only with valid instances, preventing potential issues down the line.

---

179-179: Event emission looks good!

The updated E3Requested event emission includes the relevant information about the requested E3, such as the e3Id, e3 details, filter, and e3Program. The removal of compute provider details from the event aligns with the overall changes in the contract.

---

4-4: Import removal is consistent!

The removal of the IComputeProvider import statement is consistent with the removal of compute provider handling from the contract. This change aligns with the overall simplification of the contract's design and responsibilities.

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 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.