feat(ethers): init sub package for ethers

package.json

@@ -53,6 +53,7 @@
     "@ant-design/web3-icons": "workspace:*",
     "@ant-design/web3-solana": "workspace:*",
     "@ant-design/web3-wagmi": "workspace:*",
+    "@ant-design/web3-ethers": "workspace:*",
     "@biomejs/biome": "^1.6.1",
     "@changesets/changelog-git": "^0.2.0",
     "@changesets/cli": "^2.27.1",

packages/common/src/types.ts

@@ -246,3 +246,7 @@ export interface Locale {
   NFTCard?: Partial<RequiredLocale['NFTCard']>;
   Address?: Partial<RequiredLocale['Address']>;
 }
+
+export interface UniversalEIP6963Config {
+  autoAddInjectedWallets?: boolean;
+}

packages/ethers/.fatherrc.ts

@@ -0,0 +1,5 @@
+import { defineConfig } from 'father';
+
+export default defineConfig({
+  extends: '../../.fatherrc.base.ts',
+});

packages/ethers/README.md

@@ -0,0 +1,3 @@
+# @ant-design/web3-ethers
+
+[https://web3.ant.design](https://web3.ant.design)

packages/ethers/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@ant-design/web3-ethers",
+  "version": "0.0.1",
+  "type": "module",
+  "main": "dist/esm/index.js",
+  "module": "dist/esm/index.js",
+  "typings": "dist/esm/index.d.ts",
+  "exports": {
+    "import": "./dist/esm/index.js",
+    "require": "./dist/lib/index.js",
+    "types": "./dist/esm/index.d.ts"
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "keywords": [
+    "ant",
+    "component",
+    "components",
+    "design",
+    "framework",
+    "frontend",
+    "react",
+    "react-component",
+    "ui",
+    "web3",
+    "ethers",
+    "ethersjs"
+  ],
+  "homepage": "https://we3.ant.design",
+  "bugs": {
+    "url": "https://github.com/ant-design/ant-design-web3/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ant-design/ant-design-web3"
+  },
+  "scripts": {
+    "dev": "father dev",
+    "build": "father build"
+  },
+  "dependencies": {
+    "@ant-design/web3-assets": "workspace:*",
+    "@ant-design/web3-common": "workspace:*",
+    "debug": "^4.3.4",
+    "@tanstack/react-query": "^5.28.4"
+  },
+  "devDependencies": {
+    "@types/debug": "^4.1.12",
+    "ethers": "^6.11.1",
+    "father": "^4.3.8",
+    "typescript": "^5.4.2"
+  },
+  "peerDependencies": {
+    "ethers": "^6.0.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "browserslist": [
+    "last 2 versions",
+    "Firefox ESR",
+    "> 1%",
+    "ie >= 11"
+  ]
+}

packages/ethers/src/ethers-provider/config-provider.tsx

@@ -0,0 +1,43 @@
+import React from 'react';
+import { Web3ConfigProvider, type Chain, type Locale } from '@ant-design/web3-common';
+
+import type { EthersEIP6963Config } from '../interface';
+
+export interface AntDesignWeb3ConfigProviderProps {
+  chainAssets: Chain[];
+  // walletFactorys: WalletFactory[];
+  locale?: Locale;
+  ens?: boolean;
+  balance?: boolean;
+  eip6963?: EthersEIP6963Config;
+}
+
+export const AntDesignWeb3ConfigProvider: React.FC<
+  React.PropsWithChildren<AntDesignWeb3ConfigProviderProps>
+> = ({ locale, children }) => {
+  return (
+    <Web3ConfigProvider
+      locale={locale}
+      // TODO
+      account={undefined}
+      chain={undefined}
+      balance={undefined}
+      availableChains={[]}
+      availableWallets={[]}
+      connect={async () => {
+        throw new Error('Method not implemented');
+      }}
+      disconnect={async () => {
+        throw new Error('Method not implemented');
+      }}
+      switchChain={async () => {
+        throw new Error('Method not implemented');
+      }}
+      getNFTMetadata={async () => {
+        throw new Error('Method not implemented');
+      }}
+    >
+      {children}
+    </Web3ConfigProvider>
+  );
+};

packages/ethers/src/ethers-provider/index.tsx

@@ -0,0 +1,45 @@
+import React from 'react';
+import { Mainnet } from '@ant-design/web3-assets';
+import type { Chain, Locale } from '@ant-design/web3-common';
+import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
+
+import type { EthersEIP6963Config } from '../interface';
+import { AntDesignWeb3ConfigProvider } from './config-provider';
+
+export interface EthersWeb3ConfigProviderProps {
+  // config: Config;
+  // wallets?: WalletFactory[];
+  locale?: Locale;
+  chains?: Chain[];
+  ens?: boolean;
+  balance?: boolean;
+  queryClient?: QueryClient;
+  eip6963?: EthersEIP6963Config;
+}
+
+export const EthersWeb3ConfigProvider: React.FC<
+  React.PropsWithChildren<EthersWeb3ConfigProviderProps>
+> = ({ children, chains = [], ens, balance, locale, eip6963, queryClient }) => {
+  const chainAssets = [...chains, Mainnet];
+
+  const mergedQueryClient = React.useMemo(() => {
+    return queryClient ?? new QueryClient();
+  }, [queryClient]);
+
+  return (
+    <QueryClientProvider client={mergedQueryClient}>
+      <AntDesignWeb3ConfigProvider
+        locale={locale}
+        chainAssets={chainAssets}
+        // walletFactorys={wallets}
+        // availableChains={config.chains}
+        // availableConnectors={config.connectors}
+        ens={ens}
+        balance={balance}
+        eip6963={eip6963}
+      >
+        {children}
+      </AntDesignWeb3ConfigProvider>
+    </QueryClientProvider>
+  );
+};

packages/ethers/src/index.ts

@@ -0,0 +1,3 @@
+export * from './ethers-provider';
+export * from './wallets';
+export * from './interface';

packages/ethers/src/interface.ts

@@ -0,0 +1,19 @@
+import type {
+  ConnectOptions,
+  UniversalEIP6963Config,
+  Wallet,
+  WalletMetadata,
+} from '@ant-design/web3-common';
+import type { Provider } from 'ethers';
+
+export type EthersEIP6963Config = boolean | UniversalEIP6963Config;
+
+export interface EthersWallet extends Wallet {
+  getEthersProvider?: (connectOptions?: ConnectOptions) => Promise<Provider | null>;
+}
+
+export interface EthersWalletFactory {
+  create: () => EthersWallet;
+}
+
+export type EthereumWallet = (metadata?: Partial<WalletMetadata>) => EthersWalletFactory;

packages/ethers/src/wallets/index.ts

@@ -0,0 +1,2 @@
+export * from './metamask';
+export * from './universal-wallet';

packages/ethers/src/wallets/metamask.ts

@@ -0,0 +1,10 @@
+import { metadata_MetaMask } from '@ant-design/web3-assets';
+
+import type { EthereumWallet } from '../interface';
+import { UniversalWallet } from './universal-wallet';
+
+export const MetaMask: EthereumWallet = (metadata) =>
+  new UniversalWallet({
+    ...metadata_MetaMask,
+    ...metadata,
+  });

packages/ethers/src/wallets/universal-wallet.ts

@@ -0,0 +1,10 @@
+import type { WalletMetadata } from '@ant-design/web3-common';
+
+import type { EthersWallet, EthersWalletFactory } from '../interface';
+
+export class UniversalWallet implements EthersWalletFactory {
+  constructor(private readonly wallet: WalletMetadata) {}
+  create = (): EthersWallet => {
+    throw new Error('Method not implemented.');
+  };
+}

packages/ethers/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["src", "global.d.ts"]
+}

packages/wagmi/src/interface.ts

@@ -1,4 +1,9 @@
-import type { ConnectOptions, Wallet, WalletMetadata } from '@ant-design/web3-common';
+import type {
+  ConnectOptions,
+  UniversalEIP6963Config,
+  Wallet,
+  WalletMetadata,
+} from '@ant-design/web3-common';
 import type { Connector } from 'wagmi';
 
 export interface WalletUseInWagmiAdapter extends Wallet {
@@ -12,8 +17,4 @@ export interface WalletFactory {
   create: (connector?: readonly Connector[]) => WalletUseInWagmiAdapter;
 }
 
-export type EIP6963Config =
-  | boolean
-  | {
-      autoAddInjectedWallets?: boolean;
-    };
+export type WagmiEIP6963Config = boolean | UniversalEIP6963Config;

packages/wagmi/src/wagmi-provider/config-provider.tsx

@@ -18,7 +18,7 @@ import {
   type Connector as WagmiConnector,
 } from 'wagmi';
 
-import type { EIP6963Config, WalletFactory, WalletUseInWagmiAdapter } from '../interface';
+import type { WagmiEIP6963Config, WalletFactory, WalletUseInWagmiAdapter } from '../interface';
 import { isEIP6963Connector } from '../utils';
 import { EIP6963Wallet } from '../wallets/eip6963';
 import { addNameToAccount, getNFTMetadata } from './methods';
@@ -30,7 +30,7 @@ export interface AntDesignWeb3ConfigProviderProps {
   children?: React.ReactNode;
   ens?: boolean;
   balance?: boolean;
-  eip6963?: EIP6963Config;
+  eip6963?: WagmiEIP6963Config;
   readonly availableChains: readonly WagmiChain[];
   readonly availableConnectors: readonly WagmiConnector[];
 }

packages/wagmi/src/wagmi-provider/index.tsx

@@ -6,7 +6,7 @@ import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
 import { WagmiProvider } from 'wagmi';
 import type { Config } from 'wagmi';
 
-import type { EIP6963Config, WalletFactory } from '../interface';
+import type { WagmiEIP6963Config, WalletFactory } from '../interface';
 import { AntDesignWeb3ConfigProvider } from './config-provider';
 
 export type WagmiWeb3ConfigProviderProps = {
@@ -17,7 +17,7 @@ export type WagmiWeb3ConfigProviderProps = {
   ens?: boolean;
   queryClient?: QueryClient;
   balance?: boolean;
-  eip6963?: EIP6963Config;
+  eip6963?: WagmiEIP6963Config;
 };
 
 export function WagmiWeb3ConfigProvider({

packages/web3/package.json

@@ -53,6 +53,7 @@
   "devDependencies": {
     "@ant-design/web3-solana": "workspace:*",
     "@ant-design/web3-wagmi": "workspace:*",
+    "@ant-design/web3-ethers": "workspace:*",
     "@types/react": "^18.2.65",
     "@types/react-dom": "^18.2.19",
     "father": "^4.3.8",