chore: error message update

[claytonneal]

Description

Exclude key when raising an exception

Fixes #1659

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• [] New feature (non-breaking change which adds functionality)
• [] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [] This change requires a documentation update

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

• Unit tests

Test Configuration:

• Node.js Version: 18.18.0

Checklist:

• My code follows the coding standards of this project
• I have performed a self-review of my code
• I have commented on my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• New and existing integration tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules
• I have not added any vulnerable dependencies to my code

Summary by CodeRabbit

• Security Enhancement
  • Improved error handling to prevent exposure of sensitive private key information in error messages.

[coderabbitai]

Walkthrough

The pull request introduces a security enhancement in the Address.ofPrivateKey method within the core package. The modification focuses on improving error handling by obfuscating the private key in error messages. Instead of exposing the actual private key string, the new implementation replaces it with a generic, secure message that prevents sensitive information leakage.

Changes

File	Change Summary
packages/core/src/vcdm/Address.ts	Modified error handling to obfuscate private key in error messages

Suggested Reviewers

• leszek-vechain
• saraantole

Poem

🐰 A Rabbit's Security Verse 🔒

In lines of code, a secret lies,
No more keys exposed to prying eyes,
With gentle touch, we mask the trace,
Protecting data with rabbit's grace!
Security sings its lullaby sweet

---

📜 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 ea2c1f1 and 5c4224f.

📒 Files selected for processing (1)

• packages/core/src/vcdm/Address.ts (1 hunks)

🔇 Additional comments (1)

packages/core/src/vcdm/Address.ts (1)

118-118: Great security improvement!

The change properly addresses the security concern by preventing private key exposure in error messages.

Consider standardizing error message obfuscation across the codebase.

For consistency, similar sensitive data (like private keys, mnemonics) in other error messages should also be obfuscated.

Let's check for other potential sensitive data exposure in error messages:

✅ Verification successful

Security review complete - No other sensitive data exposure found

The change to obfuscate private keys in error messages aligns well with the existing security practices in the codebase. All error handling patterns across sensitive operations (signing, KMS, contracts) properly avoid exposing sensitive information.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for potential sensitive data exposure in error messages
rg -i "private.*key|mnemonic|secret" packages/

Length of output: 77589

---

Script:

#!/bin/bash
# Search for error handling patterns in core files that might expose sensitive data
# Exclude test files, fixtures, and documentation

# Look for throw statements with potential sensitive data exposure
ast-grep --pattern 'throw new Error($MESSAGE)' packages/ | grep -v "test\|fixture\|mock\|example"

# Look for specific error construction patterns
rg "new \w*Error\(" --type ts packages/ | grep -v "test\|fixture\|mock\|example"

Length of output: 6221

---

Script:

#!/bin/bash
# Look for error message construction in sensitive areas

# Check signer error messages
rg -A 2 "new SignerMethodError\(" packages/network/src/signer/
rg -A 2 "new SignerMethodError\(" packages/aws-kms-adapter/src/

# Check KMS error messages
rg -A 2 "new ProviderMethodError\(" packages/aws-kms-adapter/src/

# Check contract error messages
rg -A 2 "new ContractCallError\(" packages/network/src/thor-client/contracts/

Length of output: 4306

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.98% (4370/4415)	97.48% (1393/1429)	99.01% (906/915)

Title	Tests	Skipped	Failures	Errors	Time
core	836	0 💤	0 ❌	0 🔥	2m 24s ⏱️
network	731	0 💤	0 ❌	0 🔥	4m 54s ⏱️
errors	40	0 💤	0 ❌	0 🔥	18.222s ⏱️
logging	3	0 💤	0 ❌	0 🔥	18.628s ⏱️
hardhat-plugin	19	0 💤	0 ❌	0 🔥	1m 5s ⏱️
aws-kms-adapter	23	0 💤	0 ❌	0 🔥	1m 29s ⏱️
ethers-adapter	5	0 💤	0 ❌	0 🔥	1m 15s ⏱️
rpc-proxy	37	0 💤	0 ❌	0 🔥	1m 5s ⏱️