fix: computationModule -> e3Program

[auryn-macmillan]

updates some language that was missing in #39

Summary by CodeRabbit

• Documentation

  • Updated parameter names in the sequence diagram for clarity in the README.md.
  • Enhanced clarity in the IE3 interface documentation by renaming parameters.

• New Features

  • Introduced consistent naming conventions across the Enclave contract and related interfaces, changing computationModule to e3Program.

• Bug Fixes

  • Improved error handling to reflect new naming conventions, enhancing clarity in error messages.

• Tests

  • Updated test cases to align with the new variable names, ensuring clarity and consistency in testing the Enclave functionality.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve renaming variables and parameters across multiple files in the codebase, specifically changing instances of computationModule to e3Program and computationParams to e3ProgramParams. These modifications are applied consistently in contract declarations, interfaces, and test files, enhancing clarity and maintaining the original functionality without altering the control flow.

Changes

File	Change Summary
README.md	Updated sequence diagram to reflect parameter name changes from computationParams to e3ProgramParams.
packages/evm/contracts/Enclave.sol	Renamed computationModules to e3Programs and updated related variables, functions, and error handling.
packages/evm/contracts/interfaces/IE3.sol	Changed parameter name from computationModule to e3Program in the E3 struct.
packages/evm/contracts/interfaces/IEnclave.sol	Renamed parameters in events and functions from computationModule to e3Program and computationParams to e3ProgramParams.
packages/evm/test/Enclave.spec.ts	Renamed variable computationModule to e3Program throughout the test suite for consistency.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Enclave
    participant E3Program

    User->>Enclave: requestE3(e3Program, e3ProgramParams)
    Enclave->>E3Program: validate(e3ProgramParams)
    E3Program-->>Enclave: validationResult
    Enclave-->>User: return e3Id, E3

Loading

🐇
In the meadow, I hop with glee,
Renamed my friends, can you see?
From computation to E3,
Clarity blooms, just like a tree!
Hooray for names that fit just right,
Let's dance and play, oh what a sight! 🌼

---

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.