Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/ui-solana-wallet-standard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@clerk/ui': patch
'@clerk/clerk-js': patch
---

The Solana wallet picker downloads about 2 KB instead of about 306 KB, and installing `@clerk/ui` or `@clerk/clerk-js` no longer pulls in React Native, Metro, and `@solana/web3.js`. The picker now lists only wallets that can complete Sign in with Solana, so the Mobile Wallet Adapter option that appeared on Android Chrome is gone.
3 changes: 0 additions & 3 deletions packages/clerk-js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,6 @@
"@base-org/account": "catalog:module-manager",
"@clerk/shared": "workspace:^",
"@coinbase/wallet-sdk": "catalog:module-manager",
"@solana/wallet-adapter-base": "catalog:module-manager",
"@solana/wallet-adapter-react": "catalog:module-manager",
"@solana/wallet-standard": "catalog:module-manager",
"@stripe/stripe-js": "5.6.0",
"@swc/helpers": "catalog:repo",
"@tanstack/query-core": "catalog:repo",
Expand Down
4 changes: 1 addition & 3 deletions packages/ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,8 @@
"@emotion/react": "11.11.1",
"@floating-ui/react": "catalog:repo",
"@formkit/auto-animate": "^0.8.2",
"@solana/wallet-adapter-base": "catalog:module-manager",
"@solana/wallet-adapter-react": "catalog:module-manager",
"@solana/wallet-standard": "catalog:module-manager",
"@swc/helpers": "catalog:repo",
"@wallet-standard/core": "catalog:module-manager",
"copy-to-clipboard": "3.3.3",
"core-js": "catalog:repo",
"csstype": "3.1.3",
Expand Down
71 changes: 32 additions & 39 deletions packages/ui/src/elements/Web3SolanaWalletButtons.tsx
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
import { WalletReadyState } from '@solana/wallet-adapter-base';
import { ConnectionProvider, useWallet, WalletProvider } from '@solana/wallet-adapter-react';
import { MAINNET_ENDPOINT } from '@solana/wallet-standard';
import { getWallets, type Wallet } from '@wallet-standard/core';
import type { Ref } from 'react';
import React, { forwardRef, isValidElement, useMemo } from 'react';
import React, { forwardRef, isValidElement, useEffect, useMemo, useState } from 'react';

import { WalletInitialIcon } from '@/ui/common/WalletInitialIcon';
import {
Expand Down Expand Up @@ -33,26 +31,38 @@ const SOCIAL_BUTTON_BLOCK_THRESHOLD = 2;
const SOCIAL_BUTTON_PRE_TEXT_THRESHOLD = 1;
const MAX_STRATEGIES_PER_ROW = 5;

const Web3SolanaWalletButtonsInner = ({ web3AuthCallback }: Web3WalletButtonsProps) => {
const card = useCardState();
const { wallets } = useWallet();
const { t } = useLocalizations();
const isSolanaSignInWallet = (wallet: Wallet) =>
wallet.chains.some(chain => chain.startsWith('solana:')) &&
'standard:connect' in wallet.features &&
'solana:signMessage' in wallet.features;

const getRegisteredWallets = () => (typeof window === 'undefined' ? [] : getWallets().get());

const useInstalledSolanaWallets = () => {
const [wallets, setWallets] = useState<readonly Wallet[]>(getRegisteredWallets);

// Filter to only show installed wallets
const installedWallets = React.useMemo(
() =>
wallets
.filter(w => {
return w.readyState === WalletReadyState.Installed;
})
.map(wallet => {
return {
name: wallet.adapter.name,
icon: wallet.adapter.icon,
};
}),
useEffect(() => {
const registry = getWallets();
const update = () => setWallets(registry.get());
update();
const offRegister = registry.on('register', update);
const offUnregister = registry.on('unregister', update);
return () => {
offRegister();
offUnregister();
};
}, []);

return useMemo(
() => wallets.filter(isSolanaSignInWallet).map(wallet => ({ name: wallet.name, icon: wallet.icon })),
[wallets],
);
};

export const Web3SolanaWalletButtons = ({ web3AuthCallback }: Web3WalletButtonsProps) => {
const card = useCardState();
const installedWallets = useInstalledSolanaWallets();
const { t } = useLocalizations();

const startWeb3AuthFlow = (walletName: string) => async () => {
card.setLoading(walletName);
Expand Down Expand Up @@ -113,7 +123,7 @@ const Web3SolanaWalletButtonsInner = ({ web3AuthCallback }: Web3WalletButtonsPro
gridTemplateColumns: shouldForceSingleColumnOnMobile ? 'repeat(1, minmax(0, 1fr))' : undefined,
},
gridTemplateColumns:
wallets.length < 1
installedWallets.length < 1
? `repeat(1, minmax(0, 1fr))`
: `repeat(${row.length}, ${
rowIndex === 0
Expand Down Expand Up @@ -262,20 +272,3 @@ const WalletButtonBlock = forwardRef((props: WalletButtonProps, ref: Ref<HTMLBut
</SimpleButton>
);
});

export const Web3SolanaWalletButtons = (props: Web3WalletButtonsProps) => {
const network = MAINNET_ENDPOINT;
const wallets = useMemo(() => [], [network]);
return (
<ConnectionProvider endpoint={network}>
<WalletProvider
wallets={wallets}
onError={err => {
console.error(err);
}}
>
<Web3SolanaWalletButtonsInner web3AuthCallback={props.web3AuthCallback} />
</WalletProvider>
</ConnectionProvider>
);
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
import type { Wallet } from '@wallet-standard/core';
import { act } from 'react';
import { beforeEach, describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render, screen } from '@/test/utils';

import { withCardStateProvider } from '../contexts';
import { Web3SolanaWalletButtons } from '../Web3SolanaWalletButtons';

const registry = vi.hoisted(() => ({
wallets: [] as Wallet[],
listeners: { register: new Set<() => void>(), unregister: new Set<() => void>() },
}));

vi.mock('@wallet-standard/core', () => ({
getWallets: () => ({
get: () => registry.wallets,
on: (event: 'register' | 'unregister', listener: () => void) => {
registry.listeners[event].add(listener);
return () => registry.listeners[event].delete(listener);
},
}),
}));

const makeWallet = (name: string, chains: string[], features: string[]): Wallet =>
({
name,
icon: 'data:image/svg+xml;base64,',
version: '1.0.0',
chains,
accounts: [],
features: Object.fromEntries(features.map(feature => [feature, {}])),
}) as unknown as Wallet;

const SIGN_IN_FEATURES = ['standard:connect', 'solana:signMessage'];

const { createFixtures } = bindCreateFixtures('SignIn');

const Buttons = withCardStateProvider(Web3SolanaWalletButtons);

describe('Web3SolanaWalletButtons', () => {
beforeEach(() => {
registry.wallets = [];
registry.listeners.register.clear();
registry.listeners.unregister.clear();
});

it('lists only Solana wallets that can connect and sign messages', async () => {
registry.wallets = [
makeWallet('Phantom', ['solana:mainnet'], SIGN_IN_FEATURES),
makeWallet('Solana Viewer', ['solana:mainnet'], ['standard:connect']),
makeWallet('Solana Signer', ['solana:mainnet'], ['solana:signMessage']),
makeWallet('MetaMask', ['eip155:1'], SIGN_IN_FEATURES),
];
const { wrapper } = await createFixtures();

render(<Buttons web3AuthCallback={vi.fn()} />, { wrapper });

expect(await screen.findByText('Continue with Phantom')).toBeInTheDocument();
expect(screen.queryByText(/Solana Viewer/)).not.toBeInTheDocument();
expect(screen.queryByText(/Solana Signer/)).not.toBeInTheDocument();
expect(screen.queryByText(/MetaMask/)).not.toBeInTheDocument();
});

it('shows the none-available message, then picks up a wallet that registers later', async () => {
const { wrapper } = await createFixtures();

render(<Buttons web3AuthCallback={vi.fn()} />, { wrapper });

expect(await screen.findByText(/No Solana Web3 wallets detected/)).toBeInTheDocument();

act(() => {
registry.wallets = [makeWallet('Backpack', ['solana:mainnet'], SIGN_IN_FEATURES)];
registry.listeners.register.forEach(listener => listener());
});

expect(await screen.findByText('Continue with Backpack')).toBeInTheDocument();
});

it('passes the chosen wallet name to the auth callback', async () => {
registry.wallets = [makeWallet('Phantom', ['solana:mainnet'], SIGN_IN_FEATURES)];
const web3AuthCallback = vi.fn().mockResolvedValue(undefined);
const { wrapper } = await createFixtures();

const { userEvent } = render(<Buttons web3AuthCallback={web3AuthCallback} />, { wrapper });

await userEvent.click(await screen.findByText('Continue with Phantom'));

expect(web3AuthCallback).toHaveBeenCalledWith({ walletName: 'Phantom' });
});
});
21 changes: 3 additions & 18 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading