feat @celo/viem-accounts/ledger

[nicolasbrugneaux]

PR-Codex overview

This PR introduces the @celo/viem-account-ledger library, which facilitates interactions between a ledger device and the viem framework. It includes type definitions, configuration files, and examples for usage, along with initial documentation.

Detailed summary

• Added Hex type definition in src/types.ts.
• Created initial release notes in CHANGELOG.md.
• Configured ESLint and TypeScript settings in .eslintrc.cjs and tsconfig.json.
• Exported constants and functions from src/index.ts.
• Introduced a README.md with installation and usage instructions.
• Implemented core functionality in src/ledger-to-account.ts.
• Added tests for ledgerToAccount in ledger-to-account.test.ts.
• Defined token handling functions in src/tokens.ts.
• Included utility functions in src/utils.ts.
• Established a mock ledger for testing in src/test-utils.ts.
• Updated .npmignore to exclude unnecessary files.

The following files were skipped due to too many changes: yarn.lock

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

[changeset-bot]

🦋 Changeset detected

Latest commit: 3e2e807

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@celo/viem-account-ledger	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[socket-security]

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@vitest/[email protected]	Transitive: environment, filesystem, shell	+34	9.71 MB	vitestbot
npm/[email protected]	network Transitive: environment	+6	16.4 MB	jmoxey
npm/[email protected]	Transitive: environment, filesystem, network, shell, unsafe	+76	276 MB	antfu, oreanno, patak, ...1 more

View full report↗︎

[codecov]

Codecov Report

Attention: Patch coverage is 89.41980% with 31 lines in your changes missing coverage. Please review.

Project coverage is 67.22%. Comparing base (d3b88fd) to head (3e2e807).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
packages/viem-account-ledger/src/test-utils.ts	86.41%	25 Missing ⚠️
packages/viem-account-ledger/src/utils.ts	90.74%	5 Missing ⚠️
packages/viem-account-ledger/src/index.ts	0.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #344      +/-   ##
==========================================
+ Coverage   66.62%   67.22%   +0.59%     
==========================================
  Files         285      291       +6     
  Lines       10677    10972     +295     
  Branches     1516     1561      +45     
==========================================
+ Hits         7114     7376     +262     
- Misses       3401     3441      +40     
+ Partials      162      155       -7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[aaronmgdr]

nice first draft!

[aaronmgdr]

Hey i spoke with marek yesterday. He wants us to start defaulting to the normal ETH derivation path.

[aaronmgdr]

maybe we can start that as the default here with CELO one as an option.

[socket-security]

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: npm/[email protected]

View full report↗︎

Next steps

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/[email protected] or ignore all packages with @SocketSecurity ignore-all

[nicolasbrugneaux]

@SocketSecurity ignore npm/[email protected]

[nicolasbrugneaux]

part of #318