@yeying-community/web3-bs 1.0.8 → 1.0.11

package/README.md

@@ -21,9 +21,14 @@ npm install @yeying-community/web3-bs
 ### 1) Provider 与账户
 
 - `getProvider` / `requireProvider`
-- `requestAccounts` / `getAccounts` / `getPreferredAccount` / `watchAccounts`
+- `watchProvider`
+- `requestAccounts` / `focusPendingApproval` / `getAccounts` / `getPreferredAccount` / `watchAccounts`
 - `getChainId` / `getBalance`
 - `onAccountsChanged` / `onChainChanged`
+- `classifyWalletError` / `isUserRejectedWalletAction` / `isWalletReconnectError`
+
+`requestAccounts` 默认会复用同一 provider 上尚未完成的连接请求，避免用户重复点击时触发多个钱包授权弹窗。
+当钱包已经存在待确认的连接、签名或解锁窗口时，可调用 `focusPendingApproval` 将该窗口重新拉到前台，而不是再发起一次新的请求。
 
 ### 2) SIWE + JWT
 
@@ -68,7 +73,17 @@ npm install @yeying-community/web3-bs
 ### 单后端登录（SIWE + JWT）
 
 ```ts
-import { loginWithChallenge, authFetch } from '@yeying-community/web3-bs';
+import {
+  authFetch,
+  focusPendingApproval,
+  loginWithChallenge,
+  requestAccounts,
+} from '@yeying-community/web3-bs';
+
+const pending = await focusPendingApproval().catch(() => ({ focused: false }));
+if (!pending.focused) {
+  await requestAccounts();
+}
 
 await loginWithChallenge({
   baseUrl: 'http://localhost:3203/api/v1/public/auth',

package/dist/auth/provider.d.ts

@@ -1,8 +1,15 @@
-import { Eip1193Provider, ProviderDiscoveryOptions, ProviderInfo, RequestAccountsOptions, AccountSelection, PreferredAccountOptions, WatchAccountsOptions, AccountsChangedHandler } from './types';
+import { Eip1193Provider, ProviderDiscoveryOptions, ProviderInfo, RequestAccountsOptions, AccountSelection, PreferredAccountOptions, WatchAccountsOptions, AccountsChangedHandler, WatchProviderOptions, ProviderChangedHandler, WalletErrorInfo, FocusPendingApprovalResult } from './types';
 export declare function isYeYingProvider(provider?: Eip1193Provider | null, info?: ProviderInfo): boolean;
 export declare function getProvider(options?: ProviderDiscoveryOptions): Promise<Eip1193Provider | null>;
+export declare function watchProvider(handler: ProviderChangedHandler, options?: WatchProviderOptions): () => void;
+export declare function getWalletErrorMessage(error: unknown): string;
+export declare function getWalletErrorCode(error: unknown): number | null;
+export declare function classifyWalletError(error: unknown): WalletErrorInfo;
+export declare function isUserRejectedWalletAction(error: unknown): boolean;
+export declare function isWalletReconnectError(error: unknown): boolean;
 export declare function requireProvider(options?: ProviderDiscoveryOptions): Promise<Eip1193Provider>;
 export declare function requestAccounts(options?: RequestAccountsOptions): Promise<string[]>;
+export declare function focusPendingApproval(provider?: Eip1193Provider): Promise<FocusPendingApprovalResult>;
 export declare function getAccounts(provider?: Eip1193Provider): Promise<string[]>;
 export declare function getChainId(provider?: Eip1193Provider): Promise<string | null>;
 export declare function getPreferredAccount(options?: PreferredAccountOptions): Promise<AccountSelection>;

package/dist/auth/types.d.ts

@@ -16,6 +16,8 @@ export interface Eip1193Provider {
     };
     isMetaMask?: boolean;
     isYeYing?: boolean;
+    providers?: Eip1193Provider[];
+    [key: string]: unknown;
 }
 export interface ProviderInfo {
     uuid?: string;
@@ -31,9 +33,31 @@ export interface ProviderDiscoveryOptions {
     timeoutMs?: number;
     preferYeYing?: boolean;
 }
+export interface WatchProviderOptions extends ProviderDiscoveryOptions {
+    pollIntervalMs?: number;
+    maxPolls?: number;
+}
+export type ProviderChangedHandler = (payload: {
+    provider: Eip1193Provider | null;
+    present: boolean;
+}) => void;
+export type WalletErrorType = 'userRejected' | 'disconnected' | 'timeout' | 'notFound' | 'unknown';
+export type WalletErrorInfo = {
+    type: WalletErrorType;
+    code: number | null;
+    message: string;
+};
 export interface RequestAccountsOptions {
     provider?: Eip1193Provider;
+    dedupe?: boolean;
 }
+export type FocusPendingApprovalResult = {
+    focused: boolean;
+    type: string | null;
+    requestId?: string | null;
+    origin?: string;
+    tabId?: number | null;
+};
 export type AccountSelection = {
     account: string | null;
     accounts: string[];

package/dist/web3-bs.esm.js

@@ -1,10 +1,46 @@
 const YEYING_RDNS = 'io.github.yeying';
 const DEFAULT_TIMEOUT = 1000;
 const DEFAULT_ACCOUNT_STORAGE_KEY = 'yeying:last_account';
+const DEFAULT_PROVIDER_POLL_INTERVAL = 100;
+const DEFAULT_PROVIDER_MAX_POLLS = 20;
+const requestAccountsInFlight = new WeakMap();
+function isProvider(value) {
+    return !!value && typeof value.request === 'function';
+}
 function getWindowEthereum() {
     if (typeof window === 'undefined')
         return null;
-    return window.ethereum || null;
+    const ethereum = window.ethereum;
+    return isProvider(ethereum) ? ethereum : null;
+}
+function getWindowProviderCandidates() {
+    if (typeof window === 'undefined')
+        return [];
+    const source = window;
+    const candidates = [];
+    const addProvider = (provider) => {
+        if (isProvider(provider) && !candidates.includes(provider)) {
+            candidates.push(provider);
+        }
+    };
+    for (const name of [
+        'ethereum',
+        'yeeying',
+        'yeying',
+        'coinbaseWallet',
+        'bitkeep',
+        'tokenpocket',
+        '__YEYING_PROVIDER__',
+    ]) {
+        addProvider(source[name]);
+    }
+    const ethereum = getWindowEthereum();
+    if (Array.isArray(ethereum?.providers)) {
+        for (const provider of ethereum.providers) {
+            addProvider(provider);
+        }
+    }
+    return candidates;
 }
 function readStoredAccount(storageKey) {
     if (typeof localStorage === 'undefined')
@@ -48,7 +84,7 @@ function isYeYingProvider(provider, info) {
 }
 function selectBestProvider(candidates, preferYeYing) {
     if (candidates.length === 0)
-        return null;
+        return selectBestWindowProvider(preferYeYing);
     if (preferYeYing) {
         const yeying = candidates.find(c => isYeYingProvider(c.provider, c.info));
         if (yeying)
@@ -56,10 +92,21 @@ function selectBestProvider(candidates, preferYeYing) {
     }
     return candidates[0].provider;
 }
+function selectBestWindowProvider(preferYeYing) {
+    const candidates = getWindowProviderCandidates();
+    if (candidates.length === 0)
+        return null;
+    if (preferYeYing) {
+        const yeying = candidates.find(provider => isYeYingProvider(provider));
+        if (yeying)
+            return yeying;
+    }
+    return candidates[0];
+}
 async function getProvider(options = {}) {
     const preferYeYing = options.preferYeYing !== false;
     const timeoutMs = options.timeoutMs ?? DEFAULT_TIMEOUT;
-    const windowProvider = getWindowEthereum();
+    const windowProvider = selectBestWindowProvider(preferYeYing);
     if (preferYeYing && isYeYingProvider(windowProvider)) {
         return windowProvider;
     }
@@ -92,7 +139,7 @@ async function getProvider(options = {}) {
             }
         };
         const onEthereumInitialized = () => {
-            const injected = getWindowEthereum();
+            const injected = selectBestWindowProvider(preferYeYing);
             if (preferYeYing && isYeYingProvider(injected)) {
                 safeResolve(injected);
             }
@@ -104,7 +151,7 @@ async function getProvider(options = {}) {
                 return;
             const best = selectBestProvider(discovered, preferYeYing) ||
                 windowProvider ||
-                getWindowEthereum();
+                selectBestWindowProvider(preferYeYing);
             safeResolve(best || null);
         }, timeoutMs);
         try {
@@ -118,6 +165,107 @@ async function getProvider(options = {}) {
         }
     });
 }
+function watchProvider(handler, options = {}) {
+    if (typeof window === 'undefined') {
+        handler({ provider: null, present: false });
+        return () => { };
+    }
+    const preferYeYing = options.preferYeYing !== false;
+    const pollIntervalMs = options.pollIntervalMs ?? DEFAULT_PROVIDER_POLL_INTERVAL;
+    const maxPolls = options.maxPolls ?? DEFAULT_PROVIDER_MAX_POLLS;
+    let stopped = false;
+    let lastProvider;
+    let pollCount = 0;
+    let pollTimer = null;
+    const emit = () => {
+        if (stopped)
+            return;
+        const provider = selectBestWindowProvider(preferYeYing);
+        if (provider === lastProvider)
+            return;
+        lastProvider = provider;
+        handler({ provider, present: !!provider });
+    };
+    const poll = () => {
+        if (stopped)
+            return;
+        emit();
+        pollCount += 1;
+        if (lastProvider || pollCount >= maxPolls)
+            return;
+        pollTimer = setTimeout(poll, pollIntervalMs);
+    };
+    const handleProviderReady = () => {
+        emit();
+    };
+    window.addEventListener('ethereum#initialized', handleProviderReady);
+    window.addEventListener('eip6963:announceProvider', handleProviderReady);
+    try {
+        window.dispatchEvent(new Event('eip6963:requestProvider'));
+    }
+    catch {
+        // Ignore unsupported event dispatch environments.
+    }
+    poll();
+    return () => {
+        stopped = true;
+        if (pollTimer) {
+            clearTimeout(pollTimer);
+        }
+        window.removeEventListener('ethereum#initialized', handleProviderReady);
+        window.removeEventListener('eip6963:announceProvider', handleProviderReady);
+    };
+}
+function getWalletErrorMessage(error) {
+    if (!error)
+        return '';
+    if (typeof error === 'string')
+        return error;
+    if (error instanceof Error)
+        return error.message || String(error);
+    const message = error.message;
+    if (typeof message === 'string')
+        return message;
+    return String(error);
+}
+function getWalletErrorCode(error) {
+    const code = Number(error?.code);
+    if (!Number.isNaN(code))
+        return code;
+    const causeCode = Number(error?.cause?.code);
+    if (!Number.isNaN(causeCode))
+        return causeCode;
+    return null;
+}
+function classifyWalletError(error) {
+    const code = getWalletErrorCode(error);
+    const message = getWalletErrorMessage(error);
+    const lowerMessage = message.toLowerCase();
+    if (code === 4001 || lowerMessage.includes('user rejected')) {
+        return { type: 'userRejected', code, message };
+    }
+    if (code === 4900 ||
+        lowerMessage.includes('disconnected') ||
+        lowerMessage.includes('reconnect') ||
+        lowerMessage.includes('not connected')) {
+        return { type: 'disconnected', code, message };
+    }
+    if (lowerMessage.includes('timeout')) {
+        return { type: 'timeout', code, message };
+    }
+    if (lowerMessage.includes('no injected wallet provider') ||
+        lowerMessage.includes('未检测到钱包')) {
+        return { type: 'notFound', code, message };
+    }
+    return { type: 'unknown', code, message };
+}
+function isUserRejectedWalletAction(error) {
+    return classifyWalletError(error).type === 'userRejected';
+}
+function isWalletReconnectError(error) {
+    const type = classifyWalletError(error).type;
+    return type === 'disconnected' || type === 'timeout';
+}
 async function requireProvider(options = {}) {
     const provider = await getProvider(options);
     if (!provider) {
@@ -127,10 +275,43 @@ async function requireProvider(options = {}) {
 }
 async function requestAccounts(options = {}) {
     const provider = options.provider || (await requireProvider());
-    const accounts = (await provider.request({
+    const dedupe = options.dedupe !== false;
+    if (dedupe) {
+        const pending = requestAccountsInFlight.get(provider);
+        if (pending)
+            return pending;
+    }
+    const request = provider.request({
         method: 'eth_requestAccounts',
-    }));
-    return Array.isArray(accounts) ? accounts : [];
+    }).then(accounts => (Array.isArray(accounts) ? accounts : []));
+    if (!dedupe)
+        return request;
+    requestAccountsInFlight.set(provider, request);
+    try {
+        return await request;
+    }
+    finally {
+        requestAccountsInFlight.delete(provider);
+    }
+}
+async function focusPendingApproval(provider) {
+    const p = provider || (await requireProvider());
+    const result = await p.request({
+        method: 'wallet_focusPendingApproval',
+    });
+    if (!result || typeof result !== 'object') {
+        return { focused: false, type: null };
+    }
+    const payload = result;
+    return {
+        focused: Boolean(payload.focused),
+        type: typeof payload.type === 'string' ? payload.type : null,
+        requestId: typeof payload.requestId === 'string' ? payload.requestId : null,
+        origin: typeof payload.origin === 'string' ? payload.origin : '',
+        tabId: typeof payload.tabId === 'number' && Number.isFinite(payload.tabId)
+            ? payload.tabId
+            : null,
+    };
 }
 async function getAccounts(provider) {
     const p = provider || (await requireProvider());
@@ -2004,5 +2185,5 @@ async function initDappSession(options) {
     return result;
 }
 
-export { WebDavClient, authCentralUcanFetch, authFetch, authUcanFetch, clearAccessToken, clearCentralSessionToken, clearUcanSession, createAndIssueCentralUcan, createCentralSession, createDelegationUcan, createInvocationUcan, createRootUcan, createUcanSession, createWebDavClient, deriveAppIdFromHost, deriveAppIdFromLocation, getAccessToken, getAccounts, getBalance, getCapabilityAction, getCapabilityResource, getCentralIssuerInfo, getCentralSessionToken, getChainId, getOrCreateUcanRoot, getPreferredAccount, getProvider, getStoredUcanRoot, getUcanSession, initDappSession, initWebDavStorage, isYeYingProvider, issueCentralUcan, loginWithChallenge, logout, normalizeAppHostnameForAppId, normalizeUcanCapabilities, normalizeUcanCapability, onAccountsChanged, onChainChanged, refreshAccessToken, requestAccounts, requireProvider, setAccessToken, setCentralSessionToken, signMessage, storeUcanRoot, watchAccounts };
+export { WebDavClient, authCentralUcanFetch, authFetch, authUcanFetch, classifyWalletError, clearAccessToken, clearCentralSessionToken, clearUcanSession, createAndIssueCentralUcan, createCentralSession, createDelegationUcan, createInvocationUcan, createRootUcan, createUcanSession, createWebDavClient, deriveAppIdFromHost, deriveAppIdFromLocation, focusPendingApproval, getAccessToken, getAccounts, getBalance, getCapabilityAction, getCapabilityResource, getCentralIssuerInfo, getCentralSessionToken, getChainId, getOrCreateUcanRoot, getPreferredAccount, getProvider, getStoredUcanRoot, getUcanSession, getWalletErrorCode, getWalletErrorMessage, initDappSession, initWebDavStorage, isUserRejectedWalletAction, isWalletReconnectError, isYeYingProvider, issueCentralUcan, loginWithChallenge, logout, normalizeAppHostnameForAppId, normalizeUcanCapabilities, normalizeUcanCapability, onAccountsChanged, onChainChanged, refreshAccessToken, requestAccounts, requireProvider, setAccessToken, setCentralSessionToken, signMessage, storeUcanRoot, watchAccounts, watchProvider };
 //# sourceMappingURL=web3-bs.esm.js.map