fix: 1874 Transaction.getTransactionHash(sender) rename

[lucanicoladebiasi]

Description

Class packages/core/src/transaction/Transaction.ts renamed as getTransactionHash(sender?: Address): Blake2b256 the argument previously named gasPayer.

Fixes #1874

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:solo
• yarn test:unit

Test Configuration:

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

Summary by CodeRabbit

• Refactor
  • Renamed the transaction signing parameter to more accurately describe its role, ensuring clarity for users.
• Documentation
  • Updated documentation to reflect the new naming convention while maintaining the existing functionality.

[coderabbitai]

Walkthrough

The pull request renames the parameter in the getTransactionHash method of the Transaction class. In both the documentation and the source code, the parameter is changed from gasPayer to sender. Additionally, related documentation and conditional checks within this function have been updated to use the new terminology. The underlying functionality of computing the transaction hash remains unchanged.

Changes

File(s)	Change Summary
docs/diagrams/architecture/transaction.md packages/core/src/transaction/Transaction.ts	Renamed the parameter in getTransactionHash from gasPayer to sender and updated associated documentation and conditional checks accordingly.

Possibly related PRs

• 1595 refactor the transaction class using only the concept of sender and gas payer #1596: Addresses similar renaming in the Transaction class, focusing on aligning the terminology between gasPayer and sender.

Suggested labels

Priority: Low

Suggested reviewers

• claytonneal

Poem

A small adjustment in our code's embrace,
"GasPayer" steps aside for "Sender" to take its place.
In each line and comment a subtle tune plays,
Guiding transactions through cleaner arrays.
Here's to precise code change and a brighter day! 🚀

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7de71b and 394192a.

📒 Files selected for processing (2)

• docs/diagrams/architecture/transaction.md (1 hunks)
• packages/core/src/transaction/Transaction.ts (1 hunks)

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

• GitHub Check: rpc-proxy / test / test
• GitHub Check: rpc-proxy / docker / docker
• GitHub Check: unit-integration-test / Build & Lint (latest)
• GitHub Check: unit-integration-test-browser / 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)
• GitHub Check: unit-integration-test / Build & Lint (18)
• GitHub Check: install-build / Build & Lint
• GitHub Check: test-apps / Install and test example apps
• GitHub Check: Analyze (javascript-typescript)
• GitHub Check: Execute doc examples

🔇 Additional comments (4)

docs/diagrams/architecture/transaction.md (1)

37-37: Parameter renaming looks good!

The parameter name change from gasPayer to sender in the getTransactionHash method signature is consistent with the changes in the implementation file. This improves clarity by using terminology that better reflects the parameter's purpose.

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

383-388: Documentation update is consistent with the parameter rename.

The JSDoc comments have been properly updated to reflect the parameter name change from gasPayer to sender. Good job maintaining documentation consistency.

---

392-397: Method signature and implementation correctly updated.

All references to the parameter have been consistently renamed from gasPayer to sender throughout the method body. The change maintains the original functionality while improving naming clarity.

---

392-400:

❓ Verification inconclusive

Verify impact on other parts of the codebase.

The parameter renaming looks good. Since this is a public method, it's important to ensure that all calling code has been updated to use the new parameter name in documentation or explicit named parameters.

---

🏁 Script executed:

#!/bin/bash
# Check if there are any remaining references to gasPayer in relation to getTransactionHash

echo "Searching for any remaining references to gasPayer in relation to getTransactionHash..."
rg "getTransactionHash.*gasPayer" --type ts

Length of output: 230

---

Parameter renaming verified in getTransactionHash – please double-check external references

I've confirmed that the method in packages/core/src/transaction/Transaction.ts (lines 392–400) now uses sender instead of the old gasPayer, and the search for any residual references (via rg "getTransactionHash.*gasPayer") returned no hits. Since this is a public method, please ensure that any external documentation, test cases, or client implementations that refer to this parameter are updated accordingly.

• File to review: packages/core/src/transaction/Transaction.ts (lines 392–400)
• Action item: Manually verify that any code or documentation outside the immediate codebase (if applicable) reflects the new parameter name.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.
• @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.

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.96% (4395/4441)	97.01% (1398/1441)	98.9% (906/916)

Title	Tests	Skipped	Failures	Errors	Time
core	839	0 💤	0 ❌	0 🔥	2m 35s ⏱️
network	728	0 💤	0 ❌	0 🔥	5m 2s ⏱️
errors	40	0 💤	0 ❌	0 🔥	18.344s ⏱️
logging	3	0 💤	0 ❌	0 🔥	18.204s ⏱️
hardhat-plugin	19	0 💤	0 ❌	0 🔥	1m 16s ⏱️
aws-kms-adapter	23	0 💤	0 ❌	0 🔥	1m 30s ⏱️
ethers-adapter	5	0 💤	0 ❌	0 🔥	1m 22s ⏱️
rpc-proxy	37	0 💤	0 ❌	0 🔥	1m 28s ⏱️