@multiplatform.one/web3 7.25.0 → 7.28.0

package/types/providers/walletConfig.d.ts

@@ -1,5 +1,7 @@
-import type { Chain } from "viem";
+import type { Ecosystem } from "@multiplatform.one/connectkit";
+import { type Chain, type Transport } from "viem";
 import type { AuthKeycloakConfig, AuthOnboardingConfig } from "../bridge/authTypes";
+import { type SignerFamily } from "../message/buildWalletMessage";
 /**
  * Shared config seam for both platform variants of WalletProvider. Keeping the
  * type + context here (rather than in either variant) means web and native share
@@ -7,6 +9,8 @@ import type { AuthKeycloakConfig, AuthOnboardingConfig } from "../bridge/authTyp
  * bundler resolved.
  */
 export declare const defaultChains: readonly [Chain, ...Chain[]];
+/** A family the connect modal can list: `eth` (or `evm`), `sol` (`solana`), `sui`, `btc` (`bitcoin`). */
+export type ConnectorFamily = Exclude<SignerFamily, "gpg">;
 export interface Web3Config {
     /** @deprecated Ignored: no connector needs a project id. Removed in the next major. */
     walletConnectProjectId?: string;
@@ -27,6 +31,12 @@ export interface Web3Config {
      * http://10.0.2.2:8545 on Android).
      */
     localnetRpcUrl?: string;
+    /**
+     * Web: the wallet families the connect modal lists, e.g. `["eth"]` on a page
+     * that can only use an EVM wallet. Defaults to every family, which lists the
+     * EVM wallets and any Solana, Sui or Bitcoin wallet found on the page.
+     */
+    families?: readonly ConnectorFamily[];
     /** Solana JSON-RPC endpoint (native bridge + web). */
     solanaRpcUrl?: string;
     /** Sui JSON-RPC endpoint (native bridge + web). */
@@ -52,13 +62,33 @@ export interface Web3Config {
         onboarding?: AuthOnboardingConfig;
     };
 }
+/** The part of a Web3Config that picks the EVM chains and where they are read. */
+export type Web3ChainConfig = Pick<Web3Config, "chains" | "enableTestnets" | "localnet" | "localnetRpcUrl">;
 /**
  * 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 declare function resolveChains(config: Web3Config): readonly [Chain, ...Chain[]];
+export declare function resolveChains(config: Web3ChainConfig): readonly [Chain, ...Chain[]];
+/**
+ * The transport each chain is read over: http on the chain's default RPC,
+ * which resolveChains points at localnetRpcUrl for the dev chain. The
+ * WalletProviders and evmReadClients share it, so reads before a wallet
+ * connects go where the wallet side's do.
+ */
+export declare function chainTransports(chains: readonly Chain[]): Record<number, Transport>;
+type WalletEcosystem = Exclude<Ecosystem, "evm">;
+/**
+ * Resolve `families` to whether the EVM wallets are listed and which non-EVM
+ * ecosystems are. Throws on `gpg`, which has no wallet connector, on a name it
+ * does not know, and on an empty list.
+ */
+export declare function resolveFamilies(config: Pick<Web3Config, "families">): {
+    evm: boolean;
+    ecosystems: WalletEcosystem[];
+};
 export declare const Web3ConfigContext: import("react").Context<Web3Config | null>;
 export declare function useWeb3Config(): Web3Config;
+export {};
 //# sourceMappingURL=walletConfig.d.ts.map

package/types/providers/walletConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"walletConfig.d.ts","sourceRoot":"","sources":["../../src/providers/walletConfig.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAElC,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEpF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE,SAAS,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAOtD,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,uFAAuF;IACvF,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,SAAS,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;IACtC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,sDAAsD;IACtD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2EAA2E;IAC3E,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iGAAiG;IACjG,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,kBAAkB,CAAC;QAAC,UAAU,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;CAC7E;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC,CAgB9E;AAED,eAAO,MAAM,iBAAiB,4CAAyC,CAAC;AAExE,wBAAgB,aAAa,IAAI,UAAU,CAM1C"}
+{"version":3,"file":"walletConfig.d.ts","sourceRoot":"","sources":["../../src/providers/walletConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAE/D,OAAO,EAAQ,KAAK,KAAK,EAAE,KAAK,SAAS,EAAE,MAAM,MAAM,CAAC;AAExD,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAyB,KAAK,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAEzF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE,SAAS,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAOtD,CAAC;AAEF,yGAAyG;AACzG,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;AAE3D,MAAM,WAAW,UAAU;IACzB,uFAAuF;IACvF,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,SAAS,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;IACtC,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,SAAS,eAAe,EAAE,CAAC;IACtC,sDAAsD;IACtD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2EAA2E;IAC3E,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iGAAiG;IACjG,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,kBAAkB,CAAC;QAAC,UAAU,CAAC,EAAE,oBAAoB,CAAA;KAAE,CAAC;CAC7E;AAED,kFAAkF;AAClF,MAAM,MAAM,eAAe,GAAG,IAAI,CAChC,UAAU,EACV,QAAQ,GAAG,gBAAgB,GAAG,UAAU,GAAG,gBAAgB,CAC5D,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,eAAe,GAAG,SAAS,CAAC,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC,CAgBnF;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAEnF;AAED,KAAK,eAAe,GAAG,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AAmBjD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,GAAG;IACrE,GAAG,EAAE,OAAO,CAAC;IACb,UAAU,EAAE,eAAe,EAAE,CAAC;CAC/B,CAsBA;AAED,eAAO,MAAM,iBAAiB,4CAAyC,CAAC;AAExE,wBAAgB,aAAa,IAAI,UAAU,CAM1C"}

package/types/wagmi/driver.d.ts

@@ -0,0 +1,44 @@
+import { type Config, type Connector } from "@wagmi/core";
+import type { ChainClient } from "../clients/types";
+import type { ConnectionDriver, DriverState } from "../core/types";
+export interface WagmiDriverOptions {
+    /**
+     * Which of the config's connectors the driver offers. Defaults to the EVM
+     * ones: the Solana, Sui and Bitcoin shims the legacy config adds belong to
+     * their own families.
+     */
+    filter?: (connector: Connector) => boolean;
+    /**
+     * The chain id every connection reports, in place of wagmi's. A Solana,
+     * Sui or Bitcoin shim sits on a synthetic EVM chain id; its family reports
+     * its own (`solana:mainnet`).
+     */
+    chainId?: number | string;
+    /**
+     * The per-chain client for a connection, in place of the mpo EVM client.
+     * A shim's family builds its client over the adapter the shim carries.
+     */
+    client?: (connector: Connector, state: DriverState) => ChainClient | null | Promise<ChainClient | null>;
+}
+/**
+ * The EVM connection driver: wagmi and viem underneath, the core's
+ * ConnectionDriver on top. It works on the config the app already built
+ * (WalletProvider's, or `useConfig()`), so wagmi keeps its connectors,
+ * EIP-6963 discovery and storage.
+ *
+ * Two wagmi actions are avoided on purpose. `reconnect` replaces every open
+ * connection with the one it restores and returns nothing while another
+ * reconnect runs, so a restore is `connect` with `isReconnecting`.
+ * `disconnect` writes back the connections it read before awaiting the
+ * wallet, dropping one that landed meanwhile, and moves `current` off a
+ * connector it did not close, so a close updates wagmi's state itself. It
+ * lets go before asking the wallet, since MetaMask Connect emits its own
+ * "disconnect" while closing and a wallet may fail or never answer. The legacy `useDisconnect` still runs wagmi's action, so on a shared
+ * config an overlapping close there can restore a connection this one removed.
+ *
+ * A wallet that reports no authorised account, a locked MetaMask included,
+ * restores to null as it does under wagmi's own reconnect, which makes the
+ * store forget it.
+ */
+export declare function wagmiDriver(config: Config, options?: WagmiDriverOptions): ConnectionDriver;
+//# sourceMappingURL=driver.d.ts.map

package/types/wagmi/driver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"driver.d.ts","sourceRoot":"","sources":["../../src/wagmi/driver.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,KAAK,MAAM,EAEX,KAAK,SAAS,EACf,MAAM,aAAa,CAAC;AAIrB,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,KAAK,EACV,gBAAgB,EAGhB,WAAW,EAEZ,MAAM,eAAe,CAAC;AAEvB,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC;IAC3C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B;;;OAGG;IACH,MAAM,CAAC,EAAE,CACP,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,WAAW,KACf,WAAW,GAAG,IAAI,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;CACvD;AAkCD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,gBAAgB,CA6M9F"}

package/types/wagmi/host.d.ts

@@ -0,0 +1,31 @@
+import { type ReactNode } from "react";
+import { type Config } from "wagmi";
+import { type WalletFamily } from "../core/family";
+/**
+ * Puts the built-in families on one wagmi config: eth over its EVM
+ * connectors, sol, sui and btc over the Solana, Sui and Bitcoin shims the
+ * config lists, each reporting its own chain id and signing through its
+ * shim's adapter. GPG and a family of the app's own keep what they have.
+ * While the ConnectKit modal connects every wallet through wagmi, this makes
+ * the connection store and the modal see one connection (MPO-385 step 5).
+ */
+export declare function hostFamiliesOnWagmi(families: readonly WalletFamily[], config: Config): WalletFamily[];
+export interface WagmiConnectionHostProps {
+    /**
+     * The families to register, in the connect list's order. Kept by identity:
+     * pass a stable array. Left out, the host reuses the store of a host above
+     * on the same wagmi config, or any ConnectionProvider the app mounted, and
+     * otherwise registers every built-in family.
+     */
+    families?: readonly WalletFamily[];
+    children?: ReactNode;
+}
+/**
+ * Mounts a connection store over the WagmiProvider above it, so
+ * `useConnection()` reports what the ConnectKit modal and wagmi's hooks
+ * connect, and `useConnectionStore().connect()` goes through wagmi where the
+ * modal sees it. Web3Provider mounts one; so does ConnectKitProvider when no
+ * store is above it.
+ */
+export declare function WagmiConnectionHost({ families, children }: WagmiConnectionHostProps): import("react/jsx-runtime").JSX.Element;
+//# sourceMappingURL=host.d.ts.map

package/types/wagmi/host.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"host.d.ts","sourceRoot":"","sources":["../../src/wagmi/host.tsx"],"names":[],"mappings":"AACA,OAAO,EAAkD,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AACvF,OAAO,EAAE,KAAK,MAAM,EAAa,MAAM,OAAO,CAAC;AAG/C,OAAO,EAAsB,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAavE;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,EAAE,SAAS,YAAY,EAAE,EACjC,MAAM,EAAE,MAAM,GACb,YAAY,EAAE,CAiBhB;AAsLD,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;IACnC,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,wBAAwB,2CAanF"}

package/types/wagmi/index.d.ts

@@ -0,0 +1,2 @@
+export { wagmiDriver, type WagmiDriverOptions } from "./driver";
+//# sourceMappingURL=index.d.ts.map

package/types/wagmi/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/wagmi/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,UAAU,CAAC"}

package/types/web.d.ts

@@ -0,0 +1,13 @@
+export { WalletProvider, Web3Provider, useWeb3Config, defaultChains, useWalletBridge, type ConnectorFamily, type WalletBridgeContextValue, type WalletProviderProps, type Web3Config, type Web3ProviderProps, } from "./providers";
+export { useWallet, type UseWalletResult, type WalletActions, type WalletState, useContractRead, useContractWrite, type ContractReadConfig, type ContractReadResult, type ContractWriteConfig, type ContractWriteResult, type TransactionStatus, useAccount, useBalance, useChainId, useChains, useConnect, useDisconnect, useEnsAvatar, useEnsName, useSignMessage, useSwitchChain, useBlockNumber, useReadContract, useWriteContract, useSimulateContract, useWaitForTransactionReceipt, } from "./hooks";
+export { ConnectKitButton } from "./components/ConnectKitButton";
+export type { Address, Chain } from "viem";
+export { mainnet, polygon, optimism, arbitrum, base, sepolia, bsc, baseSepolia, bscTestnet, polygonAmoy, optimismSepolia, arbitrumSepolia, } from "wagmi/chains";
+export * from "./bridge";
+export * from "./message";
+export * from "./clients";
+export * from "./core";
+export { wagmiDriver, type WagmiDriverOptions } from "./wagmi";
+export { bitcoinDriver, solanaDriver, suiDriver, type SolanaDriverOptions } from "./light";
+export { btc, eth, gpg, sol, sui, walletFamilies, type EthFamilyOptions, type SolFamilyOptions, } from "./families";
+//# sourceMappingURL=web.d.ts.map

package/types/web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../src/web.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,cAAc,EACd,YAAY,EACZ,aAAa,EACb,aAAa,EACb,eAAe,EACf,KAAK,eAAe,EACpB,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,UAAU,EACf,KAAK,iBAAiB,GACvB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,SAAS,EACT,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,eAAe,EACf,gBAAgB,EAChB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,UAAU,EACV,UAAU,EACV,UAAU,EACV,SAAS,EACT,UAAU,EACV,aAAa,EACb,YAAY,EACZ,UAAU,EACV,cAAc,EACd,cAAc,EACd,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,4BAA4B,GAC7B,MAAM,SAAS,CAAC;AAGjB,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEjE,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC3C,OAAO,EACL,OAAO,EACP,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,IAAI,EACJ,OAAO,EACP,GAAG,EACH,WAAW,EACX,UAAU,EACV,WAAW,EACX,eAAe,EACf,eAAe,GAChB,MAAM,cAAc,CAAC;AAEtB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,OAAO,EAAE,WAAW,EAAE,KAAK,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC3F,OAAO,EACL,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,GAAG,EACH,cAAc,EACd,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,GACtB,MAAM,YAAY,CAAC"}