Skip to content

Refactor/v1.1#114

Merged
zkfriendly merged 43 commits intomainfrom
refactor/v1.1
Apr 9, 2025
Merged

Refactor/v1.1#114
zkfriendly merged 43 commits intomainfrom
refactor/v1.1

Conversation

@zkfriendly
Copy link
Copy Markdown
Contributor

Add deployment guide, ICP refactoring, and relayer enhancements

Changes

  • Created a new DESIGN.md file that contains the original project overview, features, and technical details

  • Transformed the main README.md into a detailed deployment guide with step-by-step instructions

  • Added instructions for:

    • Setting up the environment for contract deployment
    • Deploying all contracts with Foundry
    • Registering relayer data
    • Setting up and running the relayer service
    • Troubleshooting common issues
  • Refactored Internet Computer Protocol (ICP) integration:

    • Improved canister interaction logic
    • Optimized data flow between relayer and ICP canister

Benefits

  • Separates conceptual documentation (DESIGN.md) from operational instructions (README.md)
  • Provides clear, actionable steps for new users to deploy the system
  • Includes environment setup details, command examples, and expected outputs
  • Adds troubleshooting section to help users resolve common issues
  • More reliable ICP integration
  • Better developer experience with enhanced logging and error handling

Testing

The deployment guide has been tested on Base Sepolia network and works as expected. The ICP refactoring and relayer enhancements have been tested in development environment.

zkfriendly and others added 21 commits March 13, 2025 10:37
…rvices

- Added deployment logs for TokenRegistry and TestERC20.
- Introduced new deployment script for OauthCore.
- Created Docker Compose configuration for relayer services, including PostgreSQL setup.
- Added Dockerfiles for IMAP and SMTP services.
- Updated Rust code to include new environment variables and improve error handling in DKIM oracle.
- Enhanced ABI definitions for various contracts, including ERC20, ERC721, and token registry.

These changes facilitate the deployment and management of the relayer services and improve the overall architecture.
- Removed the 'selector' parameter from the computeSignedMsg and revokeDKIMPublicKeyHash functions in ECDSAOwnedDKIMRegistry contract.
- Updated ABI definitions to reflect the changes in function signatures.
- Enhanced deployment logs with updated contract addresses for various components, including TokenRegistry and Oauth extensions.
- Improved error handling and logging in the ChainClient implementation.

These changes streamline the contract's functionality and improve the clarity of deployment logs.
… variable adjustments

- Added Node version requirement and usage instructions to README.
- Updated .env.example to reflect changes in RPC explorer URL, database connection string, and web server address.
…d Rust for improved contract compilation and runtime environment
- Added PostgreSQL deployment and service configuration in db.yml.
- Updated ingress and managed certificate configurations to use the new domain and namespace.
- Refactored relayer configuration, including environment variables and service definitions, to align with the new namespace and improve service management.
… relayer

- Changed namespace from email-wallet to email-wallet-v11 in Kubernetes configurations.
- Updated ingress and managed certificate to reflect new domain.
- Enhanced error handling in relayer code for file operations and JSON parsing.
- Added a new function to read email templates with error handling.
- Updated cronjob to restart the relayer deployment in the new namespace.
- Removed obsolete db.yml file containing PostgreSQL configurations.
- Refactored relayer configuration, including environment variables and service definitions, to improve clarity and maintainability.
@zkfriendly zkfriendly requested a review from benceharomi March 24, 2025 07:13
Copy link
Copy Markdown
Member

@benceharomi benceharomi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion defaulting to local deployment instead of base deployment for chain id, rpc, etc. would make more sense.

Comment thread packages/relayer/Cargo.toml Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread packages/relayer/README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread kubernetes/cronjob.yml
Comment thread packages/relayer/.env.example Outdated
zkfriendly and others added 7 commits March 25, 2025 13:15
Co-authored-by: benceharomi <56651250+benceharomi@users.noreply.github.com>
Co-authored-by: benceharomi <56651250+benceharomi@users.noreply.github.com>
Co-authored-by: benceharomi <56651250+benceharomi@users.noreply.github.com>
Co-authored-by: benceharomi <56651250+benceharomi@users.noreply.github.com>
Comment thread SMTP.Dockerfile Outdated
Comment thread SMTP.Dockerfile
Comment thread README.md Outdated
Comment thread DESIGN.md
Copy link
Copy Markdown
Member

@benceharomi benceharomi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added my final comments, if these are resolved it is good to go!

Comment thread docker-compose.yaml Outdated
Comment thread packages/relayer/README.md
Copy link
Copy Markdown
Member

@benceharomi benceharomi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One other thing: can you please also run cargo fmt and cargo clippy to format and lint the code?

@zkfriendly
Copy link
Copy Markdown
Contributor Author

One other thing: can you please also run cargo fmt and cargo clippy to format and lint the code?

ran cargo fmt. But Clippy has too many warnings (150+ and no auto fix) to resolve for this PR.

@zkfriendly zkfriendly merged commit 6da619a into main Apr 9, 2025
4 checks passed
@zkfriendly zkfriendly deleted the refactor/v1.1 branch April 9, 2025 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants