@ant-design/web3-wagmi 2.9.4 → 2.10.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @ant-design/web3-wagmi
 
+## 2.10.0
+
+### Minor Changes
+
+- ad278cd: feat: wagmi add siwe config
+
+### Patch Changes
+
+- 8b857d3: chore: update wagmi version
+- Updated dependencies [ad278cd]
+- Updated dependencies [8b857d3]
+  - @ant-design/web3-common@1.16.0
+  - @ant-design/web3-assets@1.11.7
+
+## 2.9.5
+
+### Patch Changes
+
+- @ant-design/web3-assets@1.11.6
+
 ## 2.9.4
 
 ### Patch Changes

package/dist/esm/interface.d.ts

@@ -1,5 +1,6 @@
 import type { Chain, ConnectOptions, UniversalEIP6963Config, Wallet, WalletMetadata } from '@ant-design/web3-common';
 import type { Chain as WagmiChain } from 'viem';
+import type { CreateSiweMessageParameters } from 'viem/siwe';
 import type { Connector, CreateConnectorFn } from 'wagmi';
 export interface WalletUseInWagmiAdapter extends Wallet {
     getWagmiConnector?: (options?: ConnectOptions) => Promise<Connector | undefined>;
@@ -18,3 +19,8 @@ export type EIP6963Config = boolean | UniversalEIP6963Config;
 export type ChainAssetWithWagmiChain = Chain & {
     wagmiChain?: WagmiChain;
 };
+export interface SIWEConfig {
+    getNonce: (address: string, chainId?: number) => Promise<string>;
+    createMessage: (args: CreateSiweMessageParameters) => string;
+    verifyMessage: (message: string, signature: string) => Promise<boolean>;
+}

package/dist/esm/wagmi-provider/__mocks__/wagmiBaseMock.d.ts

@@ -0,0 +1,73 @@
+export declare const wagmiBaseMock: {
+    useAccount: () => {
+        chain: {
+            blockExplorers: {
+                readonly default: {
+                    readonly name: "Etherscan";
+                    readonly url: "https://etherscan.io";
+                    readonly apiUrl: "https://api.etherscan.io/api";
+                };
+            };
+            contracts: {
+                readonly ensRegistry: {
+                    readonly address: "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e";
+                };
+                readonly ensUniversalResolver: {
+                    readonly address: "0xce01f8eee7E479C928F8919abD53E553a36CeF67";
+                    readonly blockCreated: 19258213;
+                };
+                readonly multicall3: {
+                    readonly address: "0xca11bde05977b3631167028862be2a173976ca11";
+                    readonly blockCreated: 14353601;
+                };
+            };
+            id: 1;
+            name: "Ethereum";
+            nativeCurrency: {
+                readonly name: "Ether";
+                readonly symbol: "ETH";
+                readonly decimals: 18;
+            };
+            rpcUrls: {
+                readonly default: {
+                    readonly http: readonly ["https://cloudflare-eth.com"];
+                };
+            };
+            sourceId?: number | undefined;
+            testnet?: boolean | undefined;
+            custom?: Record<string, unknown> | undefined;
+            fees?: import("viem").ChainFees<undefined> | undefined;
+            formatters?: undefined;
+            serializers?: import("viem").ChainSerializers<undefined, import("viem").TransactionSerializable<bigint, number>> | undefined;
+        };
+        address: string;
+        connector: {
+            name: string;
+        };
+    };
+    useConfig: () => {};
+    useBalance: () => {
+        data: {};
+    };
+    useSwitchChain: () => {
+        switchChain: () => void;
+    };
+    useConnect: () => {
+        connectors: {
+            name: string;
+        }[];
+        connectAsync: () => Promise<{}>;
+    };
+    useDisconnect: () => {
+        disconnectAsync: () => void;
+    };
+    useEnsName: () => {
+        data: null;
+    };
+    useEnsAvatar: () => {
+        data: null;
+    };
+    useSignMessage: () => {
+        signMessageAsync: () => Promise<string>;
+    };
+};

package/dist/esm/wagmi-provider/__mocks__/wagmiBaseMock.js

@@ -0,0 +1,36 @@
+import { mainnet } from 'wagmi/chains';
+const mockConnector = {
+  name: 'MetaMask'
+};
+export const wagmiBaseMock = {
+  useAccount: () => {
+    return {
+      chain: mainnet,
+      address: '0x21CDf0974d53a6e96eF05d7B324a9803735fFd3B',
+      connector: mockConnector
+    };
+  },
+  useConfig: () => ({}),
+  useBalance: () => ({
+    data: {}
+  }),
+  useSwitchChain: () => ({
+    switchChain: () => {}
+  }),
+  useConnect: () => ({
+    connectors: [mockConnector],
+    connectAsync: async () => ({})
+  }),
+  useDisconnect: () => ({
+    disconnectAsync: () => {}
+  }),
+  useEnsName: () => ({
+    data: null
+  }),
+  useEnsAvatar: () => ({
+    data: null
+  }),
+  useSignMessage: () => ({
+    signMessageAsync: async () => 'signMessage'
+  })
+};

package/dist/esm/wagmi-provider/config-provider.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { type Chain, type Locale } from '@ant-design/web3-common';
 import type { Config as WagmiConfig } from 'wagmi';
-import type { EIP6963Config, WalletFactory } from '../interface';
+import type { EIP6963Config, SIWEConfig, WalletFactory } from '../interface';
 export interface AntDesignWeb3ConfigProviderProps {
     chainAssets: Chain[];
     walletFactories: WalletFactory[];
@@ -12,5 +12,6 @@ export interface AntDesignWeb3ConfigProviderProps {
     eip6963?: EIP6963Config;
     wagimConfig: WagmiConfig;
     useWalletConnectOfficialModal?: boolean;
+    siwe?: SIWEConfig;
 }
 export declare const AntDesignWeb3ConfigProvider: React.FC<AntDesignWeb3ConfigProviderProps>;

package/dist/esm/wagmi-provider/config-provider.js

@@ -1,7 +1,8 @@
 import React from 'react';
-import { Web3ConfigProvider } from '@ant-design/web3-common';
-import { useAccount, useBalance, useConfig, useConnect, useEnsAvatar, useEnsName, useSwitchChain } from 'wagmi';
+import { ConnectStatus, Web3ConfigProvider } from '@ant-design/web3-common';
+import { useAccount, useBalance, useConfig, useConnect, useEnsAvatar, useEnsName, useSignMessage, useSwitchChain } from 'wagmi';
 import { disconnect, getAccount } from 'wagmi/actions';
+import { Mainnet } from "../chains";
 import { isEIP6963Connector } from "../utils";
 import { EIP6963Wallet } from "../wallets/eip6963";
 import { getNFTMetadata } from "./methods";
@@ -16,12 +17,14 @@ export const AntDesignWeb3ConfigProvider = props => {
     locale,
     eip6963,
     wagimConfig,
-    useWalletConnectOfficialModal
+    useWalletConnectOfficialModal,
+    siwe
   } = props;
   const {
     address,
     isDisconnected,
-    chain
+    chain,
+    addresses
   } = useAccount();
   const config = useConfig();
   const {
@@ -45,10 +48,19 @@ export const AntDesignWeb3ConfigProvider = props => {
   } = useEnsAvatar({
     name: ensName ?? undefined
   });
+  const {
+    signMessageAsync
+  } = useSignMessage();
+  const [status, setStatus] = React.useState(ConnectStatus.Disconnected);
+  React.useEffect(() => {
+    setStatus(isDisconnected ? ConnectStatus.Disconnected : ConnectStatus.Connected);
+  }, [isDisconnected]);
   const account = address && !isDisconnected ? {
     address,
     name: ensName && ens ? ensName : undefined,
-    avatar: ensAvatar ?? undefined
+    avatar: ensAvatar ?? undefined,
+    addresses,
+    status: status
   } : undefined;
   const isConnectorNameMatch = (aName, bName) => {
     // match connector name like okxWallet, Okx Wallet, OKX Wallet
@@ -134,11 +146,46 @@ export const AntDesignWeb3ConfigProvider = props => {
     address: contractAddress,
     tokenId
   }) => getNFTMetadata(config, contractAddress, tokenId, chain?.id), [chain?.id]);
+  const signIn = React.useCallback(async signAddress => {
+    const {
+      getNonce,
+      createMessage,
+      verifyMessage
+    } = siwe;
+    let msg;
+    let signature;
+    try {
+      // get nonce
+      const nonce = await getNonce(signAddress);
+      msg = createMessage({
+        domain: window?.location ? window.location.hostname : '',
+        address: signAddress,
+        uri: window?.location ? window.location.origin : '',
+        nonce,
+        // Default config
+        version: '1',
+        chainId: currentChain?.id ?? Mainnet.id
+      });
+      if (signMessageAsync) {
+        signature = await signMessageAsync?.({
+          message: msg
+        });
+        console.log('get signature', signature);
+        await verifyMessage(msg, signature);
+        setStatus(ConnectStatus.Signed);
+      }
+    } catch (error) {
+      throw new Error(error.message);
+    }
+  }, [siwe, currentChain, signMessageAsync]);
   return /*#__PURE__*/_jsx(Web3ConfigProvider, {
     locale: locale,
     availableChains: chainList,
     chain: currentChain,
     account: account,
+    sign: siwe && {
+      signIn
+    },
     balance: balance ? {
       symbol: balanceData?.symbol,
       value: balanceData?.value,

package/dist/esm/wagmi-provider/index.d.ts

@@ -4,11 +4,11 @@ import { QueryClient } from '@tanstack/react-query';
 import type { Transport } from 'viem';
 import type { Config, State } from 'wagmi';
 import type { WalletConnectParameters } from 'wagmi/connectors';
-import type { ChainAssetWithWagmiChain, EIP6963Config, WalletFactory } from '../interface';
+import type { ChainAssetWithWagmiChain, EIP6963Config, SIWEConfig, WalletFactory } from '../interface';
 export interface WalletConnectOptions extends Pick<WalletConnectParameters, 'disableProviderPing' | 'isNewChainsStale' | 'projectId' | 'metadata' | 'relayUrl' | 'storageOptions' | 'qrModalOptions'> {
     useWalletConnectOfficialModal?: boolean;
 }
-export type WagmiWeb3ConfigProviderProps = {
+export interface WagmiWeb3ConfigProviderProps {
     config?: Config;
     locale?: Locale;
     wallets?: WalletFactory[];
@@ -21,5 +21,6 @@ export type WagmiWeb3ConfigProviderProps = {
     reconnectOnMount?: boolean;
     walletConnect?: false | WalletConnectOptions;
     transports?: Record<number, Transport>;
-};
-export declare function WagmiWeb3ConfigProvider({ children, config, locale, wallets, chains, ens, queryClient, balance, eip6963, walletConnect, transports, ...restProps }: React.PropsWithChildren<WagmiWeb3ConfigProviderProps>): React.ReactElement;
+    siwe?: SIWEConfig;
+}
+export declare function WagmiWeb3ConfigProvider({ children, config, locale, wallets, chains, ens, queryClient, balance, eip6963, walletConnect, transports, siwe, ...restProps }: React.PropsWithChildren<WagmiWeb3ConfigProviderProps>): React.ReactElement;

package/dist/esm/wagmi-provider/index.js

@@ -19,6 +19,7 @@ export function WagmiWeb3ConfigProvider({
   eip6963,
   walletConnect,
   transports,
+  siwe,
   ...restProps
 }) {
   // When user custom config, add Mainnet by default
@@ -83,6 +84,7 @@ export function WagmiWeb3ConfigProvider({
       client: mergedQueryClient,
       children: /*#__PURE__*/_jsx(AntDesignWeb3ConfigProvider, {
         locale: locale,
+        siwe: siwe,
         chainAssets: chainAssets,
         walletFactories: wallets,
         ens: ens,

package/dist/lib/interface.d.ts

@@ -1,5 +1,6 @@
 import type { Chain, ConnectOptions, UniversalEIP6963Config, Wallet, WalletMetadata } from '@ant-design/web3-common';
 import type { Chain as WagmiChain } from 'viem';
+import type { CreateSiweMessageParameters } from 'viem/siwe';
 import type { Connector, CreateConnectorFn } from 'wagmi';
 export interface WalletUseInWagmiAdapter extends Wallet {
     getWagmiConnector?: (options?: ConnectOptions) => Promise<Connector | undefined>;
@@ -18,3 +19,8 @@ export type EIP6963Config = boolean | UniversalEIP6963Config;
 export type ChainAssetWithWagmiChain = Chain & {
     wagmiChain?: WagmiChain;
 };
+export interface SIWEConfig {
+    getNonce: (address: string, chainId?: number) => Promise<string>;
+    createMessage: (args: CreateSiweMessageParameters) => string;
+    verifyMessage: (message: string, signature: string) => Promise<boolean>;
+}

package/dist/lib/wagmi-provider/__mocks__/wagmiBaseMock.d.ts

@@ -0,0 +1,73 @@
+export declare const wagmiBaseMock: {
+    useAccount: () => {
+        chain: {
+            blockExplorers: {
+                readonly default: {
+                    readonly name: "Etherscan";
+                    readonly url: "https://etherscan.io";
+                    readonly apiUrl: "https://api.etherscan.io/api";
+                };
+            };
+            contracts: {
+                readonly ensRegistry: {
+                    readonly address: "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e";
+                };
+                readonly ensUniversalResolver: {
+                    readonly address: "0xce01f8eee7E479C928F8919abD53E553a36CeF67";
+                    readonly blockCreated: 19258213;
+                };
+                readonly multicall3: {
+                    readonly address: "0xca11bde05977b3631167028862be2a173976ca11";
+                    readonly blockCreated: 14353601;
+                };
+            };
+            id: 1;
+            name: "Ethereum";
+            nativeCurrency: {
+                readonly name: "Ether";
+                readonly symbol: "ETH";
+                readonly decimals: 18;
+            };
+            rpcUrls: {
+                readonly default: {
+                    readonly http: readonly ["https://cloudflare-eth.com"];
+                };
+            };
+            sourceId?: number | undefined;
+            testnet?: boolean | undefined;
+            custom?: Record<string, unknown> | undefined;
+            fees?: import("viem").ChainFees<undefined> | undefined;
+            formatters?: undefined;
+            serializers?: import("viem").ChainSerializers<undefined, import("viem").TransactionSerializable<bigint, number>> | undefined;
+        };
+        address: string;
+        connector: {
+            name: string;
+        };
+    };
+    useConfig: () => {};
+    useBalance: () => {
+        data: {};
+    };
+    useSwitchChain: () => {
+        switchChain: () => void;
+    };
+    useConnect: () => {
+        connectors: {
+            name: string;
+        }[];
+        connectAsync: () => Promise<{}>;
+    };
+    useDisconnect: () => {
+        disconnectAsync: () => void;
+    };
+    useEnsName: () => {
+        data: null;
+    };
+    useEnsAvatar: () => {
+        data: null;
+    };
+    useSignMessage: () => {
+        signMessageAsync: () => Promise<string>;
+    };
+};

package/dist/lib/wagmi-provider/__mocks__/wagmiBaseMock.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.wagmiBaseMock = void 0;
+var _chains = require("wagmi/chains");
+const mockConnector = {
+  name: 'MetaMask'
+};
+const wagmiBaseMock = exports.wagmiBaseMock = {
+  useAccount: () => {
+    return {
+      chain: _chains.mainnet,
+      address: '0x21CDf0974d53a6e96eF05d7B324a9803735fFd3B',
+      connector: mockConnector
+    };
+  },
+  useConfig: () => ({}),
+  useBalance: () => ({
+    data: {}
+  }),
+  useSwitchChain: () => ({
+    switchChain: () => {}
+  }),
+  useConnect: () => ({
+    connectors: [mockConnector],
+    connectAsync: async () => ({})
+  }),
+  useDisconnect: () => ({
+    disconnectAsync: () => {}
+  }),
+  useEnsName: () => ({
+    data: null
+  }),
+  useEnsAvatar: () => ({
+    data: null
+  }),
+  useSignMessage: () => ({
+    signMessageAsync: async () => 'signMessage'
+  })
+};

package/dist/lib/wagmi-provider/config-provider.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { type Chain, type Locale } from '@ant-design/web3-common';
 import type { Config as WagmiConfig } from 'wagmi';
-import type { EIP6963Config, WalletFactory } from '../interface';
+import type { EIP6963Config, SIWEConfig, WalletFactory } from '../interface';
 export interface AntDesignWeb3ConfigProviderProps {
     chainAssets: Chain[];
     walletFactories: WalletFactory[];
@@ -12,5 +12,6 @@ export interface AntDesignWeb3ConfigProviderProps {
     eip6963?: EIP6963Config;
     wagimConfig: WagmiConfig;
     useWalletConnectOfficialModal?: boolean;
+    siwe?: SIWEConfig;
 }
 export declare const AntDesignWeb3ConfigProvider: React.FC<AntDesignWeb3ConfigProviderProps>;

package/dist/lib/wagmi-provider/config-provider.js

@@ -8,6 +8,7 @@ var _react = _interopRequireDefault(require("react"));
 var _web3Common = require("@ant-design/web3-common");
 var _wagmi = require("wagmi");
 var _actions = require("wagmi/actions");
+var _chains = require("../chains");
 var _utils = require("../utils");
 var _eip = require("../wallets/eip6963");
 var _methods = require("./methods");
@@ -23,12 +24,14 @@ const AntDesignWeb3ConfigProvider = props => {
     locale,
     eip6963,
     wagimConfig,
-    useWalletConnectOfficialModal
+    useWalletConnectOfficialModal,
+    siwe
   } = props;
   const {
     address,
     isDisconnected,
-    chain
+    chain,
+    addresses
   } = (0, _wagmi.useAccount)();
   const config = (0, _wagmi.useConfig)();
   const {
@@ -52,10 +55,19 @@ const AntDesignWeb3ConfigProvider = props => {
   } = (0, _wagmi.useEnsAvatar)({
     name: ensName ?? undefined
   });
+  const {
+    signMessageAsync
+  } = (0, _wagmi.useSignMessage)();
+  const [status, setStatus] = _react.default.useState(_web3Common.ConnectStatus.Disconnected);
+  _react.default.useEffect(() => {
+    setStatus(isDisconnected ? _web3Common.ConnectStatus.Disconnected : _web3Common.ConnectStatus.Connected);
+  }, [isDisconnected]);
   const account = address && !isDisconnected ? {
     address,
     name: ensName && ens ? ensName : undefined,
-    avatar: ensAvatar ?? undefined
+    avatar: ensAvatar ?? undefined,
+    addresses,
+    status: status
   } : undefined;
   const isConnectorNameMatch = (aName, bName) => {
     // match connector name like okxWallet, Okx Wallet, OKX Wallet
@@ -141,11 +153,46 @@ const AntDesignWeb3ConfigProvider = props => {
     address: contractAddress,
     tokenId
   }) => (0, _methods.getNFTMetadata)(config, contractAddress, tokenId, chain?.id), [chain?.id]);
+  const signIn = _react.default.useCallback(async signAddress => {
+    const {
+      getNonce,
+      createMessage,
+      verifyMessage
+    } = siwe;
+    let msg;
+    let signature;
+    try {
+      // get nonce
+      const nonce = await getNonce(signAddress);
+      msg = createMessage({
+        domain: window?.location ? window.location.hostname : '',
+        address: signAddress,
+        uri: window?.location ? window.location.origin : '',
+        nonce,
+        // Default config
+        version: '1',
+        chainId: currentChain?.id ?? _chains.Mainnet.id
+      });
+      if (signMessageAsync) {
+        signature = await signMessageAsync?.({
+          message: msg
+        });
+        console.log('get signature', signature);
+        await verifyMessage(msg, signature);
+        setStatus(_web3Common.ConnectStatus.Signed);
+      }
+    } catch (error) {
+      throw new Error(error.message);
+    }
+  }, [siwe, currentChain, signMessageAsync]);
   return /*#__PURE__*/(0, _jsxRuntime.jsx)(_web3Common.Web3ConfigProvider, {
     locale: locale,
     availableChains: chainList,
     chain: currentChain,
     account: account,
+    sign: siwe && {
+      signIn
+    },
     balance: balance ? {
       symbol: balanceData?.symbol,
       value: balanceData?.value,

package/dist/lib/wagmi-provider/index.d.ts

@@ -4,11 +4,11 @@ import { QueryClient } from '@tanstack/react-query';
 import type { Transport } from 'viem';
 import type { Config, State } from 'wagmi';
 import type { WalletConnectParameters } from 'wagmi/connectors';
-import type { ChainAssetWithWagmiChain, EIP6963Config, WalletFactory } from '../interface';
+import type { ChainAssetWithWagmiChain, EIP6963Config, SIWEConfig, WalletFactory } from '../interface';
 export interface WalletConnectOptions extends Pick<WalletConnectParameters, 'disableProviderPing' | 'isNewChainsStale' | 'projectId' | 'metadata' | 'relayUrl' | 'storageOptions' | 'qrModalOptions'> {
     useWalletConnectOfficialModal?: boolean;
 }
-export type WagmiWeb3ConfigProviderProps = {
+export interface WagmiWeb3ConfigProviderProps {
     config?: Config;
     locale?: Locale;
     wallets?: WalletFactory[];
@@ -21,5 +21,6 @@ export type WagmiWeb3ConfigProviderProps = {
     reconnectOnMount?: boolean;
     walletConnect?: false | WalletConnectOptions;
     transports?: Record<number, Transport>;
-};
-export declare function WagmiWeb3ConfigProvider({ children, config, locale, wallets, chains, ens, queryClient, balance, eip6963, walletConnect, transports, ...restProps }: React.PropsWithChildren<WagmiWeb3ConfigProviderProps>): React.ReactElement;
+    siwe?: SIWEConfig;
+}
+export declare function WagmiWeb3ConfigProvider({ children, config, locale, wallets, chains, ens, queryClient, balance, eip6963, walletConnect, transports, siwe, ...restProps }: React.PropsWithChildren<WagmiWeb3ConfigProviderProps>): React.ReactElement;

package/dist/lib/wagmi-provider/index.js

@@ -27,6 +27,7 @@ function WagmiWeb3ConfigProvider({
   eip6963,
   walletConnect,
   transports,
+  siwe,
   ...restProps
 }) {
   // When user custom config, add Mainnet by default
@@ -91,6 +92,7 @@ function WagmiWeb3ConfigProvider({
       client: mergedQueryClient,
       children: /*#__PURE__*/(0, _jsxRuntime.jsx)(_configProvider.AntDesignWeb3ConfigProvider, {
         locale: locale,
+        siwe: siwe,
         chainAssets: chainAssets,
         walletFactories: wallets,
         ens: ens,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ant-design/web3-wagmi",
-  "version": "2.9.4",
+  "version": "2.10.0",
   "type": "module",
   "main": "dist/esm/index.js",
   "module": "dist/esm/index.js",
@@ -40,21 +40,21 @@
   },
   "dependencies": {
     "debug": "^4.3.5",
-    "@ant-design/web3-common": "1.15.1",
-    "@ant-design/web3-assets": "1.11.5"
+    "@ant-design/web3-assets": "1.11.7",
+    "@ant-design/web3-common": "1.16.0"
   },
   "devDependencies": {
+    "@tanstack/react-query": "^5.51.11",
     "@types/debug": "^4.1.12",
     "father": "^4.4.4",
     "typescript": "^5.6.2",
-    "wagmi": "^2.12.13",
-    "@tanstack/react-query": "^5.51.11",
-    "viem": "^2.21.3"
+    "viem": "^2.21.3",
+    "wagmi": "^2.14.6"
   },
   "peerDependencies": {
-    "wagmi": "^2.12.13",
     "@tanstack/react-query": "^5.51.11",
-    "viem": ">=2.0.0"
+    "viem": ">=2.0.0",
+    "wagmi": "^2.12.13"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org",