@dogeos/dogeos-sdk 3.0.10 → 3.0.12

package/README.md

@@ -48,8 +48,8 @@ import { WalletConnectProvider } from "@dogeos/dogeos-sdk";
 
 const dogeConfig = {
   ...config,
-  clientId: 'your-client-id'
-}
+  clientId: "your-client-id",
+};
 
 export default function App() {
   return (
@@ -229,7 +229,7 @@ export function App() {
   }, []);
 
   return (
-    <WalletConnectProvider config={{ chains, clientId: "your-client-id", }}>
+    <WalletConnectProvider config={{ chains, clientId: "your-client-id" }}>
       <YourApp />
     </WalletConnectProvider>
   );
@@ -254,7 +254,7 @@ export function App() {
   }, []);
 
   return (
-    <WalletConnectProvider config={{ connectors , clientId: "your-client-id" }}>
+    <WalletConnectProvider config={{ connectors, clientId: "your-client-id" }}>
       <YourApp />
     </WalletConnectProvider>
   );
@@ -328,7 +328,7 @@ const config = {
       },
     },
   } as ThemeConfig,
-  clientId: "your-client-id"
+  clientId: "your-client-id",
 };
 
 export function App() {
@@ -610,6 +610,53 @@ export function SwitchChainButton() {
 }
 ```
 
+### Get Wallet Providers and Connectors
+
+Use the `useConnectors` hook to get all available connectors from the currently connected wallet. This is useful for wallets that support multiple chains (e.g., OKX Wallet supports EVM, Solana, and Aptos):
+
+```tsx
+import { useConnectors } from "@dogeos/dogeos-sdk";
+
+export function ProvidersInfo() {
+  const { connectors, currentProvider } = useConnectors();
+
+  if (!connectors) {
+    return <div>No wallet connected</div>;
+  }
+
+  // connectors is an object with chain types as keys
+  // e.g., { evm: { provider, protocol, standard }, solana: { ... }, aptos: { ... } }
+  const supportedChains = Object.keys(connectors).filter(
+    (chainType) => connectors[chainType as keyof typeof connectors] !== null,
+  );
+
+  return (
+    <div>
+      <h3>Supported Chains:</h3>
+      <ul>
+        {supportedChains.map((chainType) => (
+          <li key={chainType}>{chainType.toUpperCase()}</li>
+        ))}
+      </ul>
+      <p>Current Provider: {currentProvider ? "Connected" : "Not connected"}</p>
+    </div>
+  );
+}
+```
+
+**Returns:**
+
+```tsx
+interface useConnectors {
+  // All available providers from the current wallet, keyed by chain type
+  connectors: ConnectorProviders | null;
+  // The currently active provider
+  currentProvider: WalletProvider | null;
+}
+```
+
+**Note:** `connectors` contains all connectors supported by the current wallet. For example, if you connect OKX Wallet, `connectors` may include `evm`, `solana`, and `aptos` connectors. The `currentProvider` is the provider currently being used for the active chain.
+
 ### Integration with Wagmi
 
 Wallet Connect Kit can seamlessly integrate with Wagmi. If you're already using `WagmiProvider`, Wallet Connect Kit will automatically detect and use Wagmi's configuration:
@@ -681,7 +728,7 @@ interface WalletConnectKitConfig {
    * @default undefined
    * @example
    * ```tsx
-   * import { WalletConnectProvider } from "@tomo-inc/wallet-connect-kit";
+   * import { WalletConnectProvider } from "@dogeos/dogeos-sdk";
    * const config: WalletConnectKitConfig = {
    *   defaultConnectChain: 'evm',
    * };
@@ -735,6 +782,7 @@ type ChainType = "evm" | "solana" | "aptos" | "dogecoin";
 - `WalletConnectProvider` - Main Provider component
 - `useAccount` - Account information Hook
 - `useWalletConnect` - Connect Hook
+- `useConnectors` - Providers information Hook (get all available providers from current wallet)
 - `getChains` - Utility function to configure chains (can wrap backend API chains)
 - Types: `WalletConnectKitConfig`, `Chain`, `WalletConfig`, `UseAccount`, `ChainType`, `ModalView`, `ThemeConfig`, `UserLoginConfig`