@multiplatform.one/web3 6.0.4 → 6.1.0

package/src/providers/WalletProvider.tsx

@@ -6,7 +6,7 @@ import { useMemo } from "react";
 import type { Chain } from "viem";
 import { WagmiProvider, createConfig, http } from "wagmi";
 import { createMockConnector } from "./mockConnector";
-import { type Web3Config, Web3ConfigContext, defaultChains } from "./walletConfig";
+import { type Web3Config, Web3ConfigContext, resolveChains } from "./walletConfig";
 
 export interface WalletProviderProps extends PropsWithChildren {
   config: Web3Config;
@@ -34,21 +34,19 @@ export function WalletProvider({
     appDescription = "Connect your wallet",
     appUrl = isWeb && typeof window !== "undefined" ? window.location.origin : "",
     appIcon,
-    chains = defaultChains,
+    chains,
     enableTestnets = false,
+    localnet = false,
+    localnetRpcUrl,
     mockWallet = false,
   } = web3Config;
 
-  const activeChains = useMemo(() => {
-    if (enableTestnets) {
-      return chains;
-    }
-    const filtered = chains.filter((chain) => !chain.testnet);
-    if (filtered.length === 0) {
-      return chains;
-    }
-    return filtered as unknown as readonly [Chain, ...Chain[]];
-  }, [chains, enableTestnets]);
+  // Testnet filter + optional localnet dev chain (prepended -> default chain).
+  const activeChains = useMemo(
+    () => resolveChains(web3Config),
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [chains, enableTestnets, localnet, localnetRpcUrl],
+  );
 
   const wagmiConfig = useMemo(() => {
     const chainIds = activeChains.map((chain) => chain.id).join(",");
@@ -59,6 +57,7 @@ export function WalletProvider({
       appIcon,
       walletConnectProjectId,
       chainIds,
+      localnetRpcUrl,
       mockWallet,
     });
     const cached = wagmiConfigCache.get(cacheKey);

package/src/providers/walletConfig.spec.ts

@@ -0,0 +1,42 @@
+import { describe, expect, it } from "vitest";
+import { hardhat, mainnet, sepolia } from "wagmi/chains";
+import { defaultChains, resolveChains, type Web3Config } from "./walletConfig";
+
+const base: Web3Config = { walletConnectProjectId: "", appName: "test" };
+
+describe("resolveChains", () => {
+  it("filters testnets by default", () => {
+    const chains = resolveChains(base);
+    expect(chains.map((c) => c.id)).not.toContain(sepolia.id);
+    expect(chains[0].id).toBe(mainnet.id);
+  });
+
+  it("keeps testnets when enableTestnets is on", () => {
+    const chains = resolveChains({ ...base, enableTestnets: true });
+    expect(chains.map((c) => c.id)).toContain(sepolia.id);
+    expect(chains).toHaveLength(defaultChains.length);
+  });
+
+  it("prepends the hardhat dev chain as the default when localnet is on", () => {
+    const chains = resolveChains({ ...base, localnet: true });
+    expect(chains[0].id).toBe(hardhat.id);
+    expect(chains[0].rpcUrls.default.http[0]).toBe("http://127.0.0.1:8545");
+    // still exactly one localnet entry ahead of the regular chains
+    expect(chains.filter((c) => c.id === hardhat.id)).toHaveLength(1);
+    expect(chains.map((c) => c.id)).toContain(mainnet.id);
+  });
+
+  it("honours a custom localnet RPC url (emulator host addresses)", () => {
+    const chains = resolveChains({
+      ...base,
+      localnet: true,
+      localnetRpcUrl: "http://10.0.2.2:8545",
+    });
+    expect(chains[0].id).toBe(hardhat.id);
+    expect(chains[0].rpcUrls.default.http[0]).toBe("http://10.0.2.2:8545");
+  });
+
+  it("does not add the dev chain when localnet is off", () => {
+    expect(resolveChains(base).map((c) => c.id)).not.toContain(hardhat.id);
+  });
+});

package/src/providers/walletConfig.ts

@@ -1,6 +1,6 @@
 import { createContext, useContext } from "react";
 import type { Chain } from "viem";
-import { arbitrum, base, mainnet, optimism, polygon, sepolia } from "wagmi/chains";
+import { arbitrum, base, hardhat, mainnet, optimism, polygon, sepolia } from "wagmi/chains";
 
 /**
  * Shared config seam for both platform variants of WalletProvider. Keeping the
@@ -25,14 +25,51 @@ export interface Web3Config {
   appIcon?: string;
   chains?: readonly [Chain, ...Chain[]];
   enableTestnets?: boolean;
+  /**
+   * Add the local dev chain (hardhat, chain 31337, `make localnet`) and make it
+   * the DEFAULT chain, so dev builds point at the local node out of the box.
+   */
+  localnet?: boolean;
+  /**
+   * Local EVM JSON-RPC endpoint when `localnet` is on. Defaults to hardhat's
+   * http://127.0.0.1:8545 -- emulators need the host address instead (e.g.
+   * http://10.0.2.2:8545 on Android).
+   */
+  localnetRpcUrl?: string;
   /** Solana JSON-RPC endpoint (native bridge + web). */
   solanaRpcUrl?: string;
+  /** Sui JSON-RPC endpoint (native bridge + web). */
+  suiRpcUrl?: string;
   /** E2E only (native): route connect through the in-WebView mock wallet. */
   mockWallet?: boolean;
   /** Native: URL serving the wallet WebView HTML (preferred over the inline string). */
   webViewUrl?: string;
 }
 
+/**
+ * Resolve the active chain list for a Web3Config: apply the testnet filter,
+ * then (when `localnet` is on) prepend the hardhat dev chain so it becomes
+ * wagmi's default chain. Shared by the web and native WalletProviders so both
+ * platforms point at the same networks.
+ */
+export function resolveChains(config: Web3Config): readonly [Chain, ...Chain[]] {
+  const {
+    chains = defaultChains,
+    enableTestnets = false,
+    localnet = false,
+    localnetRpcUrl,
+  } = config;
+  let active: Chain[] = enableTestnets ? [...chains] : chains.filter((chain) => !chain.testnet);
+  if (active.length === 0) active = [...chains];
+  if (localnet) {
+    const local: Chain = localnetRpcUrl
+      ? { ...hardhat, rpcUrls: { default: { http: [localnetRpcUrl] } } }
+      : hardhat;
+    active = [local, ...active.filter((chain) => chain.id !== hardhat.id)];
+  }
+  return active as unknown as readonly [Chain, ...Chain[]];
+}
+
 export const Web3ConfigContext = createContext<Web3Config | null>(null);
 
 export function useWeb3Config(): Web3Config {