ethereum / sourcify

Decentralized Solidity contract source code verification service
https://sourcify.dev
MIT License
770 stars 378 forks source link

Change code_hash type to sha256 #1454

Closed marcocastignoli closed 1 month ago

marcocastignoli commented 2 months ago

See #1453

This PR:

Summary by CodeRabbit

kuzdogan commented 2 months ago

See the points. I haven't reviewed the full code as it depends on my comment. I'll do another review after our discussion.

(Couldn't write it in the review message)

marcocastignoli commented 1 month ago

@kuzdogan Ok got your point, so now we don't calculate sha256 from javascript but we use directly postgres digest function

coderabbitai[bot] commented 1 month ago

[!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

Recent updates involve refining the lib-sourcify package, updating PostgreSQL database configurations, and migration processes, and enhancing type safety with branded types for cryptographic hashes. Additionally, new capabilities for handling code hashes at the database level were introduced, focused on ensuring integrity and improving storage.

Changes

File/Path Change Summary
packages/lib-sourcify/src/lib/types.ts Modified Match interface by removing null from the blockNumber field type.
packages/lib-sourcify/src/lib/verification.ts Updated assignment of match.blockNumber to handle undefined values.
services/database/README.md Clarified and adjusted database migration process, specifying usage of POSTGRES_HOST for production migrations, and outlined a synchronization process for transitioning to the new database setup.
services/database/database.json Added a new production configuration section specifying PostgreSQL connection details using environment variables.
services/database/migrations/20240627084509-code-hash-becomes-sha256.js Implemented hash calculation at the database level, switched to sha3-256 for reference hashes, and added a keccak column to the code table.
services/server/src/server/services/storageServices/AbstractDatabaseService.ts Added QueryResult and BytesKeccak imports, restructured getKeccak256Bytecodes method, and made modifications to handle keccak values within bytecodeHashes, including enhanced error handling.
services/server/src/server/services/utils/database-util.ts Updated types for bytecode hashes and addresses, and modified related functions to align with new types for enhanced type safety.
services/server/src/server/types.ts Introduced branded types for Bytes, BytesSha, and BytesKeccak to improve type safety.
services/server/test/integration/database.spec.ts Added new imports for crypto and Bytes, introduced sha3_256 function, and included new keccak256 hash comparisons.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Server
    participant Database

    Client->>Server: Request to verify code
    Server->>Database: Use production config with POSTGRES_HOST
    Database->>Server: Verify code hash with sha3-256
    Server->>Client: Return verification result

Poem

In the land of Sourcify's code, Where hash and byte reside and bode, A keccak twist, a blockNumber small, PostgreSQL now leads them all. Migrations smooth, integrity plans, CodeRabbit smiles and claps his hands. 🐇🎉


[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.