Feat new provider ledger #1537

jeasonstudio · 2025-10-14T08:48:55Z

[中文版模板 / Chinese template]

💡 Background and solution

🔗 Related issue link

changeset-bot · 2025-10-14T08:48:59Z

🦋 Changeset detected

Latest commit: b034777

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

This PR includes changesets to release 1 package

Name	Type
@ant-design/web3-ledger	Minor

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

vercel · 2025-10-14T08:49:00Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
ant-design-web3	Ready	Preview	Comment	Nov 24, 2025 6:21am

github-actions · 2025-10-14T08:49:03Z

coderabbitai · 2025-10-14T08:49:23Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat-new-provider-ledger

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

Provide your own instructions using the high_level_summary_instructions setting.
Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

📝 Description — Summarize the main change in 50–60 words, explaining what was done.

📓 References — List relevant issues, discussions, documentation, or related PRs.

📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.

📊 Contributor Summary — Include a Markdown table showing contributions:
| Contributor | Lines Added | Lines Removed | Files Changed |

✔️ Additional Notes — Add any extra reviewer context.
Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

socket-security · 2025-10-14T08:49:39Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@ledgerhq/device-transport-kit-web-hid@1.2.0
	@ledgerhq/device-management-kit@0.9.1
	@ledgerhq/device-signer-kit-ethereum@1.8.0

View full report

Copilot

Pull Request Overview

This PR introduces a new Ledger hardware wallet provider for Ant Design Web3, enabling integration with Ledger devices through WebHID API. The implementation provides secure hardware wallet connectivity with device management, message signing capabilities, and React hooks for device interaction.

Key changes:

Adds complete Ledger wallet adapter package with React provider and hooks
Implements device discovery, connection management, and Ethereum signing functionality
Provides comprehensive documentation and examples for Ledger integration

Reviewed Changes

Copilot reviewed 28 out of 30 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
packages/ledger/package.json	Package configuration with Ledger SDK dependencies
packages/ledger/src/ledger/*.ts	Core Ledger device management hooks and utilities
packages/ledger/src/wallets/ledger.tsx	Main Ledger wallet factory implementation
packages/ledger/src/provider/*.tsx	React providers for Ledger integration
packages/ledger/src/types.ts	TypeScript interfaces for Ledger wallet types
packages/ledger/docs/*	Documentation and usage examples
.changeset/vast-tools-poke.md	Changeset for the new feature

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

packages/ledger/src/wallets/ledger.tsx

Copilot · 2025-10-14T08:50:48Z

packages/ledger/src/wallets/ledger.tsx

+        },
+
+        signMessage: async (message: string) => {
+          console.log('Signing message:', message);


Console.log statements should be removed or replaced with proper logging mechanism. These debug logs will appear in production code.

packages/ledger/src/wallets/ledger.tsx

Copilot · 2025-10-14T08:50:49Z

packages/ledger/src/wallets/ledger.tsx

+      return {
+        name: 'Ledger',
+        adapter,
+        icon: undefined, // TODO: Add Ledger icon


TODO comment indicates incomplete implementation. The icon should be implemented or the TODO should be tracked in an issue.

packages/ledger/src/provider/index.tsx

Copilot · 2025-10-14T08:50:49Z

packages/ledger/src/ledger/useDeviceStatus.ts

+        setDeviceStatus(state.deviceStatus);
+
+        // Extract current app name if available
+        const appName = (state as any)?.currentApp?.name;


Using 'any' type defeats TypeScript's type safety. Define proper types for the state object or use more specific type assertion.

Suggested change

const appName = (state as any)?.currentApp?.name;

const appName = (typeof state === 'object' && state !== null && 'currentApp' in state && typeof (state as { currentApp?: { name?: string } }).currentApp?.name === 'string')

? (state as { currentApp: { name: string } }).currentApp.name

: undefined;

packages/ledger/src/types.ts

Copilot · 2025-10-14T08:50:50Z

packages/ledger/src/provider/index.tsx

+        selectWallet(wallet);
+      }
+    }
+  }, [wallets]);


The useEffect dependency array includes 'wallets' but the effect also depends on 'autoConnect', 'latestWalletNameRef.current', and 'adapterName'. Missing dependencies could cause stale closures.

Suggested change

}, [wallets]);

}, [wallets, autoConnect, adapterName, latestWalletNameRef]);

Co-authored-by: Copilot <[email protected]>

yutingzhao1991 · 2025-11-25T09:58:37Z

有冲突了，需要 rebase 一下

yutingzhao1991 · 2025-12-08T07:50:01Z

packages/web3/src/ledger/demos/basic.tsx

@@ -0,0 +1,14 @@
+import { ConnectButton, Connector } from '@ant-design/web3';
+import { Ledger, LedgerWeb3ConfigProvider } from '@ant-design/web3-ledger';


@ant-design/web3-ledger 只支持 Ladger 还是未来也可能支持其它硬件钱包？如果是可能支持其他硬件钱包，那命名是不是应该改一下。那如果只支持 Legder，那是不是 Ledger 也没必要配置了，默认就行。

yutingzhao1991 · 2025-12-08T07:54:02Z

packages/ledger/src/wallets/ledger.tsx

+            try {
+              devicesRef = [await discoverFn()];
+            } catch (error) {
+              message.error('Failed to discover device');


这里应该不需要显示错误，而是应该抛出异常，adapter 应该不要做任何和 UI 相关的事情

yutingzhao1991 · 2025-12-08T07:54:50Z

packages/ledger/src/provider/index.tsx

+export interface LedgerWeb3ConfigProviderProps {
+  wallet?: WalletFactory;
+  locale?: Locale;
+  // balance?: boolean;


没用的代码可以直接删除

jeasonstudio added 2 commits October 14, 2025 16:25

feat: add new provider for ledger hd wallet

be94b5b

docs: add copilot instructions

0116b2e

jeasonstudio requested a review from Copilot October 14, 2025 08:48

Copilot AI reviewed Oct 14, 2025

View reviewed changes

vercel bot deployed to Preview October 14, 2025 08:52 View deployment

jeasonstudio requested review from gin-lsl and yutingzhao1991 October 14, 2025 09:14

chore: apply suggestions from code review by github copilot

1ae0048

Co-authored-by: Copilot <[email protected]>

vercel bot deployed to Preview October 14, 2025 10:18 View deployment

chore: add agents for repo

cdff3b8

vercel bot deployed to Preview October 15, 2025 05:56 View deployment

sien75 added 2 commits November 24, 2025 11:18

feat: implement basic functionality of ledger hd wallet

4a520fa

docs: update ledger integration guide with latest fixes

b034777

vercel bot deployed to Preview November 24, 2025 06:21 View deployment

yutingzhao1991 reviewed Dec 8, 2025

View reviewed changes

-        const appName = (state as any)?.currentApp?.name;
+        const appName = (typeof state === 'object' && state !== null && 'currentApp' in state && typeof (state as { currentApp?: { name?: string } }).currentApp?.name === 'string')
+          ? (state as { currentApp: { name: string } }).currentApp.name
+          : undefined;

	}, [wallets]);
	}, [wallets, autoConnect, adapterName, latestWalletNameRef]);

		@@ -0,0 +1,14 @@
		import { ConnectButton, Connector } from '@ant-design/web3';
		import { Ledger, LedgerWeb3ConfigProvider } from '@ant-design/web3-ledger';

Feat new provider ledger #1537

Are you sure you want to change the base?

Feat new provider ledger #1537

Uh oh!

Conversation

jeasonstudio commented Oct 14, 2025

💡 Background and solution

🔗 Related issue link

Uh oh!

changeset-bot bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Other AI code review bot(s) detected

Uh oh!

socket-security bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI Oct 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI Oct 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Oct 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Oct 14, 2025

Choose a reason for hiding this comment

Uh oh!

yutingzhao1991 commented Nov 25, 2025

Uh oh!

yutingzhao1991 Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

yutingzhao1991 Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

yutingzhao1991 Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Oct 14, 2025 •

edited

Loading

vercel bot commented Oct 14, 2025 •

edited

Loading

github-actions bot commented Oct 14, 2025 •

edited

Loading

coderabbitai bot commented Oct 14, 2025 •

edited

Loading

socket-security bot commented Oct 14, 2025 •

edited

Loading