feat(EIP712): allow string chainId for domain

[freemanzMrojo]

Description

Allows the usage of a string for chainId since currently there are some users (like veworld) using it that way.

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Using the full test suite

Test Configuration:

• Node.js Version: 20.18.0
• Yarn Version: 1.22.22

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

• Dependencies

  • Updated viem library version from ^2.21.54 to ^2.22.8 across multiple packages (aws-kms-adapter, core, network)

• Type Changes

  • Modified TypedDataDomain type to support more flexible chainId representation (number, bigint, string, or undefined)

• Improvements

  • Enhanced signTypedData method to handle chainId conversion more robustly
  • Added test cases to verify chainId handling in different formats

[coderabbitai]

Walkthrough

This pull request focuses on updating the viem library dependency across multiple packages in the VeChain SDK. The changes include upgrading the viem version from ^2.21.54 to ^2.22.8 in the package.json files of the AWS KMS adapter, core, and network packages. Additionally, modifications were made to the TypedDataDomain type definition and the signTypedData method to improve handling of the chainId parameter, allowing for more flexible type conversions.

Changes

File	Change Summary
packages/*/package.json	Updated viem dependency from ^2.21.54 to ^2.22.8 in AWS KMS adapter, core, and network packages
packages/network/src/signer/signers/types.d.ts	Modified TypedDataDomain type to allow more flexible chainId type definitions
packages/network/src/signer/signers/vechain-abstract-signer/vechain-abstract-signer.ts	Updated signTypedData method to convert chainId to BigInt when needed
packages/network/tests/signer/signers/vechain-private-key-signer/vechain-private-key-signer.unit.test.ts	Added test cases for signTypedData method to verify chainId handling

Sequence Diagram

sequenceDiagram
    participant Signer
    participant HashFunction
    Signer->>Signer: Parse domain.chainId
    Signer->>Signer: Convert chainId to BigInt if string
    Signer->>HashFunction: Pass parsed domain
    HashFunction-->>Signer: Return hashed typed data

Loading

Possibly related PRs

• feat(EIP712): deduce primaryType if not provided #1632: Adds optional primaryType parameter to signTypedData method, related to typed data signing functionality

Poem

🐰 Viem's version dance, a library's new stance,
Upgrading bits with rabbit's glance,
ChainId flexes, types now free,
In VeChain's SDK, we leap with glee!
Hop, hop, dependency delight! 🚀

---

📜 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 5b708ed and 8ed88aa.

📒 Files selected for processing (2)

• packages/network/src/signer/signers/types.d.ts (2 hunks)
• packages/network/src/signer/signers/vechain-abstract-signer/vechain-abstract-signer.ts (4 hunks)

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

• GitHub Check: unit-integration-test / Build & Lint (latest)
• 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)

🔇 Additional comments (6)

packages/network/src/signer/signers/types.d.ts (2)

3-4: LGTM! Clear import naming.

The renamed imports improve code clarity by explicitly indicating their source.

---

23-25: LGTM! Well-structured type definition.

The updated TypedDataDomain type properly extends the Viem type to support string chainId while maintaining compatibility with other types. This change aligns with the PR objective.

Also applies to: 27-27

packages/network/src/signer/signers/vechain-abstract-signer/vechain-abstract-signer.ts (4)

415-453: LGTM! Robust domain validation.

The isViemTypedDataDomain method provides comprehensive runtime validation of the domain object, which is essential since viem v2.22.8 doesn't perform these checks. The implementation:

• Validates object structure
• Checks for unexpected keys
• Verifies type constraints for each field

---

472-478: LGTM! Safe chainId conversion.

The implementation safely handles string chainId conversion to BigInt while preserving other chainId types, ensuring backward compatibility.

---

479-485: LGTM! Improved error handling.

The code now:

• Validates domain structure before use
• Provides clear error messages
• Preserves original SignerMethodError instances

Also applies to: 497-499

---

472-485: Verify test coverage for string chainId handling.

Please ensure there are tests covering:

• String chainId conversion
• Invalid chainId handling
• Edge cases (empty string, non-numeric strings)

✅ Verification successful

Test coverage for string chainId handling is verified ✅

The functionality is well-tested in vechain-private-key-signer.unit.test.ts including:

• String to BigInt chainId conversion
• Compatibility with ethers implementation
• Error cases and validation

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for relevant test cases
rg -l "signTypedData.*chainId.*string" "test" || echo "No string chainId tests found"

Length of output: 159

---

Script:

#!/bin/bash
# Find test files related to vechain-abstract-signer
fd -e ts -e js "test|spec" | grep -i "vechain.*signer"

# Search in all test files for signTypedData and chainId
fd -e ts -e js "test|spec" -x rg -l "signTypedData.*chainId|chainId.*signTypedData" {}

Length of output: 651

---

Script:

#!/bin/bash
# Check content of VeChain signer test files for signTypedData tests
rg "signTypedData" "packages/network/tests/signer/signers/vechain-private-key-signer/vechain-private-key-signer.unit.test.ts" -C 5

# Also check the implementation to understand the test requirements
ast-grep --pattern 'signTypedData($$$) { $$$ }' packages/network/tests/signer/signers/vechain-private-key-signer/vechain-private-key-signer.unit.test.ts

Length of output: 4681

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.96% (4383/4429)	97.37% (1407/1445)	99.01% (907/916)

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