Feat/eth-pubkey

[joon9823]

• add eth pubkey

Summary by CodeRabbit

• New Features

  • Introduced support for Ethereum public keys, enhancing the existing public key framework.
  • Added a new class, EthPublicKey, with methods for conversion and address generation.

• Tests

  • Expanded test coverage for the PublicKey suite by adding a test case for the EthPublicKey class.

• Chores

  • Updated version number from 0.2.17 to 0.2.18 in the project configuration.

[coderabbitai]

Walkthrough

The changes involve updates to the package.json and PublicKey related files in the @initia/initia.js project. The version in package.json is incremented from 0.2.17 to 0.2.18. Additionally, the PublicKey.ts file is enhanced to support Ethereum public keys, introducing the EthPublicKey class and modifying existing methods to accommodate this new functionality. A corresponding test case for the EthPublicKey class is added to ensure proper functionality.

Changes

File	Change Summary
package.json	Version updated from 0.2.17 to 0.2.18.
src/core/PublicKey.spec.ts	Added a new test case for the EthPublicKey class, asserting its address generation.
src/core/PublicKey.ts	Introduced support for Ethereum public keys with the following changes: - Added EthPublicKey class. - Extended PublicKey type to include EthPublicKey. - Updated PublicKey namespace exports. - Modified fromAmino, fromData, and fromProto methods to handle Ethereum keys. - Added methods for converting Ethereum keys to/from various formats and calculating addresses. - Removed Ed25519 methods from SimplePublicKey and LegacyAminoMultisigPublicKey.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EthPublicKey
    participant PublicKeyNamespace

    User->>EthPublicKey: Create instance with public key
    EthPublicKey->>PublicKeyNamespace: Call fromAmino()
    PublicKeyNamespace-->>EthPublicKey: Return EthPublicKey instance
    EthPublicKey->>EthPublicKey: Generate address
    EthPublicKey-->>User: Return generated address

Loading

🐇 "In the garden where keys do play,
EthPublicKey hops in today!
With a twirl and a spin,
New tests begin,
Version updated, hip-hip-hooray!
Let's celebrate in a joyful way!"
🌼

---

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>, 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 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.

[github-actions]

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

Package	Version	Score	Details

Scanned Manifest Files

[coderabbitai]

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (2)

src/core/PublicKey.spec.ts (1)

Line range hint 1-46: Summary: EthPublicKey support added successfully, consider enhancing test coverage.

The changes to add support for Ethereum public keys have been implemented correctly. The import statement and the new test case are well-integrated with the existing code. To further improve the quality of this addition:

1. Expand the test suite for EthPublicKey with additional test cases as suggested earlier.
2. Add comments or documentation explaining the source and significance of the test data used.
3. Ensure that the EthPublicKey class in src/core/PublicKey.ts is thoroughly tested, including edge cases and error handling.

As this change introduces Ethereum functionality to the project, consider reviewing the overall architecture to ensure it accommodates potential future blockchain integrations smoothly. This might involve creating a more generic interface for different blockchain public keys if not already present.

src/core/PublicKey.ts (1)

374-444: Add unit tests for EthPublicKey class

The new EthPublicKey class introduces significant functionality for handling Ethereum public keys. To ensure correctness and prevent future regressions, please add unit tests covering all its methods, including edge cases and error handling.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between f90dad3 and 823ded0.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (3)

• package.json (1 hunks)
• src/core/PublicKey.spec.ts (2 hunks)
• src/core/PublicKey.ts (6 hunks)

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

• package.json

🧰 Additional context used

🔇 Additional comments (3)

src/core/PublicKey.spec.ts (2)

2-2: LGTM: Import statement updated correctly.

The EthPublicKey import has been added appropriately alongside other public key imports. This change is necessary to support the new test case for Ethereum public keys.

---

39-46: LGTM: New test case for EthPublicKey added.

The test case for EthPublicKey has been implemented correctly, following the structure of other public key tests in the file. It verifies the basic functionality of address generation for Ethereum public keys.

Consider adding the following test cases to improve coverage:

1. Test with an invalid public key string to ensure proper error handling.
2. Test with multiple different valid public keys to ensure consistency.
3. Test the serialization and deserialization of EthPublicKey if applicable.

To verify the correctness of the public key and address used in the test, run the following script:

src/core/PublicKey.ts (1)

426-439: Ensure correct derivation of Ethereum address from public key

The method rawAddress() computes the Ethereum address by hashing the uncompressed public key and slicing the last 20 bytes. Verify that this implementation aligns with Ethereum's address derivation standards to prevent potential address mismatches.

Run the following script to confirm the address derivation:

Replace YOUR_PUBLIC_KEY_IN_BASE64 and YOUR_EXPECTED_ADDRESS with actual values to perform the verification.

[Vritra4]

LGTM