fix: en_1 recommendations

[lucanicoladebiasi]

Description

Misleading documentation corrected as suggested.

Fixes # EN_1

Type of change

Please delete options that are not relevant.

• This change required a documentation update in the source code.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• yarn test
• yarn test:solo

Test Configuration:

• Node.js Version: v23.1.0
• Yarn Version: 1.22.22

Summary by CodeRabbit

Release Notes

• Documentation

  • Updated documentation for Keccak256 hash method to clarify hash type
  • Refined documentation for VeChain private key signer's transaction sending method
  • Improved transaction signature validation method documentation

• Refactor

  • Renamed transaction signature validation method to focus on signature length verification

These updates enhance code clarity and provide more precise method descriptions for developers working with the library.

[coderabbitai]

Walkthrough

This pull request introduces modifications to three files across the core and network packages. The changes primarily focus on refining method documentation and slightly adjusting signature validation logic. In the Transaction class, the method isSignatureValid is renamed to isSignatureLengthValid, shifting the focus to signature length verification. The Keccak256 class documentation is updated to clarify the hash type, and the VeChainPrivateKeySigner method documentation is enhanced for better clarity and error handling description.

Changes

File	Change Summary
packages/core/src/transaction/Transaction.ts	Renamed isSignatureValid method to isSignatureLengthValid, modifying signature validation approach
packages/core/src/vcdm/hash/Keccak256.ts	Updated documentation for of method, removing SHA-3 reference from Keccak256 hash description
packages/network/src/signer/signers/vechain-private-key-signer/vechain-private-key-signer.ts	Refined sendTransaction method documentation with clearer error handling and purpose description

Possibly related PRs

• 1595 refactor the transaction class using only the concept of sender and gas payer #1596: Refactors Transaction class terminology from "delegator" to "gas payer"
• [TransactionRequestInput] - add fields #1562: Adds new fields to TransactionRequestInput interface
• feat(EIP712): deduce primaryType if not provided #1632: Makes primaryType parameter optional in signTypedData method
• chore: update doc comment #1704: Updates documentation for getAddress method in VeChainPrivateKeySigner

Suggested reviewers

• fabiorigam

Poem

🐰 A Rabbit's Ode to Code Refinement 🔍

Signatures dance, their length now in sight,
Keccak's hash gleams with newfound light
Documentation shines, crystal clear
Transactions whisper their secrets dear
Code evolves, with each gentle stride

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8537acc and 11a9e63.

📒 Files selected for processing (3)

• packages/core/src/transaction/Transaction.ts (2 hunks)
• packages/core/src/vcdm/hash/Keccak256.ts (1 hunks)
• packages/network/src/signer/signers/vechain-private-key-signer/vechain-private-key-signer.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: rpc-proxy / test / test
• GitHub Check: unit-integration-test-browser / Build & Lint (latest)
• GitHub Check: unit-integration-test / Build & Lint (latest)
• GitHub Check: unit-integration-test-browser / Build & Lint (lts/*)
• GitHub Check: unit-integration-test / Build & Lint (lts/*)
• GitHub Check: unit-integration-test-browser / Build & Lint (18)

🔇 Additional comments (4)

packages/core/src/vcdm/hash/Keccak256.ts (1)

13-13: Documentation clarity improved.
Thank you for removing the reference to SHA-3 and focusing on KECCAK 256. It better aligns with the underlying hash function usage.

packages/network/src/signer/signers/vechain-private-key-signer/vechain-private-key-signer.ts (1)

117-124: Documentation update enhances method clarity.
These changes make the purpose, parameters, and error conditions of sendTransaction more explicit, which improves the developer experience.

packages/core/src/transaction/Transaction.ts (2)

287-290: Length-only check for signature might be insufficient.
Switching from a full signature validity check to only verifying the length can lead to false positives if the signature structure is correct in length but invalid in content. If this is intentional, consider adding a comment for clarity; otherwise, re-implement a deeper validation.

---

862-868: Good rename and documentation alignment.
Renaming the method to isSignatureLengthValid and updating the docs brings the function name in line with its actual intent.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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]

Test Coverage

Summary

Lines	Statements	Branches	Functions
	98.93% (4378/4425)	96.95% (1400/1444)	98.9% (906/916)

Title	Tests	Skipped	Failures	Errors	Time
core	836	0 💤	0 ❌	0 🔥	2m 31s ⏱️
network	731	0 💤	0 ❌	0 🔥	5m 1s ⏱️
errors	40	0 💤	0 ❌	0 🔥	17.892s ⏱️
logging	3	0 💤	0 ❌	0 🔥	19.449s ⏱️
hardhat-plugin	19	0 💤	0 ❌	0 🔥	1m 5s ⏱️
aws-kms-adapter	23	0 💤	0 ❌	0 🔥	1m 25s ⏱️
ethers-adapter	5	0 💤	0 ❌	0 🔥	1m 20s ⏱️
rpc-proxy	37	0 💤	0 ❌	0 🔥	1m 8s ⏱️