@reown/appkit-core 0.0.4 → 1.0.0

package/dist/types/exports/index.d.ts

@@ -23,7 +23,7 @@ export type { AssetControllerState } from '../src/controllers/AssetController.js
 export { ThemeController } from '../src/controllers/ThemeController.js';
 export type { ThemeControllerState } from '../src/controllers/ThemeController.js';
 export { OptionsController } from '../src/controllers/OptionsController.js';
-export type { OptionsControllerState } from '../src/controllers/OptionsController.js';
+export type { OptionsControllerStatePublic as OptionsControllerState } from '../src/controllers/OptionsController.js';
 export { BlockchainApiController } from '../src/controllers/BlockchainApiController.js';
 export { PublicStateController } from '../src/controllers/PublicStateController.js';
 export type { PublicStateControllerState } from '../src/controllers/PublicStateController.js';

package/dist/types/exports/react.d.ts

@@ -1,4 +1,4 @@
-export declare function useWeb3ModalNetwork(): {
+export declare function useAppKitNetwork(): {
     caipNetwork: {
         readonly id: `eip155:${string}` | `eip155:${number}` | `solana:${string}` | `solana:${number}` | `polkadot:${string}` | `polkadot:${number}`;
         readonly chainId: import("@reown/appkit-common").ChainId;
@@ -12,7 +12,7 @@ export declare function useWeb3ModalNetwork(): {
     } | undefined;
     chainId: import("@reown/appkit-common").ChainId | undefined;
 };
-export declare function useWeb3ModalAccount(): {
+export declare function useAppKitAccount(): {
     address: string | undefined;
     isConnected: boolean;
     status: "reconnecting" | "connected" | "disconnected" | "connecting" | undefined;

package/dist/types/src/controllers/AccountController.d.ts

@@ -35,6 +35,7 @@ export declare const AccountController: {
     setIsConnected(isConnected: AccountControllerState['isConnected'], chain: ChainNamespace | undefined): void;
     setStatus(status: AccountControllerState['status'], chain: ChainNamespace | undefined): void;
     getChainIsConnected(chain: ChainNamespace | undefined): boolean | undefined;
+    getCaipAddress(chain: ChainNamespace | undefined): `eip155:${string}:${string}` | `eip155:${number}:${string}` | `solana:${string}:${string}` | `solana:${number}:${string}` | `polkadot:${string}:${string}` | `polkadot:${number}:${string}` | undefined;
     setProvider(provider: AccountControllerState['provider'], chain: ChainNamespace | undefined): void;
     setCaipAddress(caipAddress: AccountControllerState['caipAddress'], chain: ChainNamespace | undefined): void;
     setBalance(balance: AccountControllerState['balance'], balanceSymbol: AccountControllerState['balanceSymbol'], chain: ChainNamespace): void;

package/dist/types/src/controllers/ApiController.d.ts

@@ -17,7 +17,7 @@ export declare const ApiController: {
     subscribeKey<K extends keyof ApiControllerState>(key: K, callback: (value: ApiControllerState[K]) => void): () => void;
     _getApiHeaders(): {
         'x-project-id': string;
-        'x-sdk-type': "w3m";
+        'x-sdk-type': "appkit";
         'x-sdk-version': import("../utils/TypeUtil.js").SdkVersion;
     };
     _filterOutExtensions(wallets: WcWallet[]): WcWallet[];

package/dist/types/src/controllers/ChainController.d.ts

@@ -1,16 +1,17 @@
 import type { ChainAdapter, Connector } from '../utils/TypeUtil.js';
 import { type NetworkControllerState } from './NetworkController.js';
 import { type AccountControllerState } from './AccountController.js';
-import { type CaipNetwork, type ChainNamespace } from '@reown/appkit-common';
+import { type CaipAddress, type CaipNetwork, type ChainNamespace } from '@reown/appkit-common';
 export interface ChainControllerState {
     activeChain: ChainNamespace | undefined;
+    activeCaipAddress: CaipAddress | undefined;
     activeCaipNetwork?: CaipNetwork;
     chains: Map<ChainNamespace, ChainAdapter>;
     activeConnector?: Connector;
     universalAdapter: Pick<ChainAdapter, 'networkControllerClient' | 'connectionControllerClient'>;
     noAdapters: boolean;
 }
-type ChainsInitializerAdapter = Pick<ChainAdapter, 'connectionControllerClient' | 'networkControllerClient' | 'defaultNetwork' | 'chainNamespace' | 'adapterType'>;
+type ChainsInitializerAdapter = Pick<ChainAdapter, 'connectionControllerClient' | 'networkControllerClient' | 'defaultNetwork' | 'chainNamespace' | 'adapterType' | 'caipNetworks'>;
 export declare const ChainController: {
     state: ChainControllerState;
     subscribeKey<K extends keyof ChainControllerState>(key: K, callback: (value: ChainControllerState[K]) => void): () => void;
@@ -20,7 +21,7 @@ export declare const ChainController: {
     setChainNetworkData(chain: ChainNamespace | undefined, props: Partial<NetworkControllerState>, replaceState?: boolean): void;
     setChainAccountData(chain: ChainNamespace | undefined, accountProps: Partial<AccountControllerState>, replaceState?: boolean): void;
     setAccountProp(prop: keyof AccountControllerState, value: AccountControllerState[keyof AccountControllerState], chain: ChainNamespace | undefined, replaceState?: boolean): void;
-    setActiveChain(chain: ChainNamespace | undefined): void;
+    setActiveChain(chain: ChainNamespace | undefined, caipNetwork?: NetworkControllerState['caipNetwork']): void;
     setActiveCaipNetwork(caipNetwork: NetworkControllerState['caipNetwork']): void;
     /**
      * The setCaipNetwork function is being called for different purposes and it needs to be controlled if it should replace the NetworkController state or not.

package/dist/types/src/controllers/ConnectionController.d.ts

@@ -41,7 +41,7 @@ export declare const ConnectionController: {
     _getClient(chain?: ChainNamespace): ConnectionControllerClient;
     setClient(client: ConnectionControllerClient): void;
     connectWalletConnect(): Promise<void>;
-    connectExternal(options: ConnectExternalOptions, chain: ChainNamespace): Promise<void>;
+    connectExternal(options: ConnectExternalOptions, chain: ChainNamespace, setChain?: boolean): Promise<void>;
     reconnectExternal(options: ConnectExternalOptions): Promise<void>;
     setPreferredAccountType(accountType: W3mFrameTypes.AccountType): Promise<void>;
     signMessage(message: string): Promise<string>;

package/dist/types/src/controllers/ConnectorController.d.ts

@@ -1,9 +1,9 @@
 import type { AuthConnector, Connector } from '../utils/TypeUtil.js';
 interface ConnectorWithProviders extends Connector {
-    providers?: Connector[];
+    connectors?: Connector[];
 }
 export interface ConnectorControllerState {
-    unMergedConnectors: Connector[];
+    allConnectors: Connector[];
     connectors: ConnectorWithProviders[];
 }
 export declare const ConnectorController: {

package/dist/types/src/controllers/EnsController.d.ts

@@ -2,6 +2,7 @@ type Suggestion = {
     name: string;
     registered: boolean;
 };
+export type ReownName = `${string}.reown.id` | `${string}.wcn.id`;
 export interface EnsControllerState {
     suggestions: Suggestion[];
     loading: boolean;
@@ -12,9 +13,9 @@ export declare const EnsController: {
     subscribeKey<K extends keyof EnsControllerState>(key: K, callback: (value: EnsControllerState[K]) => void): () => void;
     resolveName(name: string): Promise<import("../utils/TypeUtil.js").BlockchainApiLookupEnsName>;
     isNameRegistered(name: string): Promise<boolean>;
-    getSuggestions(name: string): Promise<Suggestion[]>;
+    getSuggestions(value: string): Promise<Suggestion[]>;
     getNamesForAddress(address: string): Promise<import("../utils/TypeUtil.js").BlockchainApiLookupEnsName[]>;
-    registerName(name: string): Promise<void>;
+    registerName(name: ReownName): Promise<void>;
     validateName(name: string): boolean;
     parseEnsApiError(error: unknown, defaultError: string): string;
 };

package/dist/types/src/controllers/EventsController.d.ts

@@ -8,7 +8,7 @@ export declare const EventsController: {
     subscribe(callback: (newState: EventsControllerState) => void): () => void;
     _getApiHeaders(): {
         'x-project-id': string;
-        'x-sdk-type': "w3m";
+        'x-sdk-type': "appkit";
         'x-sdk-version': import("../utils/TypeUtil.js").SdkVersion;
     };
     _sendAnalyticsEvent(payload: EventsControllerState): Promise<void>;

package/dist/types/src/controllers/OptionsController.d.ts

@@ -1,27 +1,111 @@
 import type { CustomWallet, Features, Metadata, ProjectId, SdkVersion, Tokens } from '../utils/TypeUtil.js';
-export interface OptionsControllerState {
-    projectId: ProjectId;
-    sdkType: 'w3m';
-    sdkVersion: SdkVersion;
+export interface OptionsControllerStatePublic {
+    /**
+     * A boolean that allows you to add or remove the "All Wallets" button on the modal
+     * @default 'SHOW'
+     * @see https://docs.walletconnect.com/appkit/react/core/options#allwallets
+     */
     allWallets?: 'SHOW' | 'HIDE' | 'ONLY_MOBILE';
+    /**
+     * The project ID for the AppKit. You can find or create your project ID in the Cloud.
+     * @see https://cloud.walletconnect.com/
+     */
+    projectId: ProjectId;
+    /**
+     * Array of wallet ids to be shown in the modal's connection view with priority. These wallets will also show up first in `All Wallets` view
+     * @default []
+     * @see https://docs.walletconnect.com/appkit/react/core/options#featuredwalletids
+     */
     featuredWalletIds?: string[];
+    /**
+     * Array of wallet ids to be shown (order is respected). Unlike `featuredWalletIds`, these wallets will be the only ones shown in `All Wallets` view and as recommended wallets.
+     * @default []
+     * @see https://docs.walletconnect.com/appkit/react/core/options#includewalletids
+     */
     includeWalletIds?: string[];
+    /**
+     * Array of wallet ids to be excluded from the wallet list in the modal.
+     * @default []
+     * @see https://docs.walletconnect.com/appkit/react/core/options#excludewalletids
+     */
     excludeWalletIds?: string[];
+    /**
+     * Array of tokens to show the user's balance of. Each key represents the chain id of the token's blockchain
+     * @default {}
+     * @see https://docs.walletconnect.com/appkit/react/core/options#tokens
+     */
     tokens?: Tokens;
+    /**
+     * Add custom wallets to the modal. CustomWallets is an array of objects, where each object contains specific information of a custom wallet.
+     * @default []
+     * @see https://docs.walletconnect.com/appkit/react/core/options#customwallets
+     *
+     */
     customWallets?: CustomWallet[];
+    /**
+     * You can add an url for the terms and conditions link.
+     * @default undefined
+     */
     termsConditionsUrl?: string;
+    /**
+     * You can add an url for the privacy policy link.
+     * @default undefined
+     */
     privacyPolicyUrl?: string;
-    isSiweEnabled?: boolean;
+    /**
+     * Set of fields that related to your project which will be used to populate the metadata of the modal.
+     * @default {}
+     */
     metadata?: Metadata;
+    /**
+     * Enable or disable the appending the AppKit to the DOM. Created for specific use cases like WebGL.
+     * @default false
+     */
     disableAppend?: boolean;
+    /**
+     * Enable or disable the all the wallet options (injected, Coinbase, QR, etc.). This is useful if you want to use only email and socials.
+     * @default true
+     */
+    enableWallets?: boolean;
+    /**
+     * Enable or disable the EIP6963 feature in your AppKit.
+     * @default false
+     */
     enableEIP6963?: boolean;
+    /**
+     * Enable or disable the Coinbase wallet in your AppKit.
+     * @default true
+     */
+    enableCoinbase?: boolean;
+    /**
+     * Enable or disable the Injected wallet in your AppKit.
+     * @default true
+     */
+    enableInjected?: boolean;
+    /**
+     * Enable or disable the WalletConnect QR code in your AppKit.
+     * @default true
+     */
+    enableWalletConnect?: boolean;
+    /**
+     * Features configuration object.
+     * @default { swaps: true, onramp: true, email: true, socials: ['google', 'x', 'discord', 'farcaster', 'github', 'apple', 'facebook'], history: true, analytics: true, allWallets: true }
+     * @see https://docs.walletconnect.com/appkit/react/core/options#features
+     */
+    features?: Features;
+}
+export interface OptionsControllerStateInternal {
+    sdkType: 'appkit';
+    sdkVersion: SdkVersion;
+    isSiweEnabled?: boolean;
     isUniversalProvider?: boolean;
     hasMultipleAddresses?: boolean;
-    features: Features;
 }
+type StateKey = keyof OptionsControllerStatePublic | keyof OptionsControllerStateInternal;
+type OptionsControllerState = OptionsControllerStatePublic & OptionsControllerStateInternal;
 export declare const OptionsController: {
-    state: OptionsControllerState;
-    subscribeKey<K extends keyof OptionsControllerState>(key: K, callback: (value: OptionsControllerState[K]) => void): () => void;
+    state: OptionsControllerStatePublic & OptionsControllerStateInternal;
+    subscribeKey<K extends StateKey>(key: K, callback: (value: OptionsControllerState[K]) => void): () => void;
     setOptions(options: OptionsControllerState): void;
     setFeatures(features: OptionsControllerState['features'] | undefined): void;
     setProjectId(projectId: OptionsControllerState['projectId']): void;
@@ -39,5 +123,8 @@ export declare const OptionsController: {
     setMetadata(metadata: OptionsControllerState['metadata']): void;
     setDisableAppend(disableAppend: OptionsControllerState['disableAppend']): void;
     setEIP6963Enabled(enableEIP6963: OptionsControllerState['enableEIP6963']): void;
+    setEnableWalletConnect(enableWalletConnect: OptionsControllerState['enableWalletConnect']): void;
+    setEnableWallets(enableWallets: OptionsControllerState['enableWallets']): void;
     setHasMultipleAddresses(hasMultipleAddresses: OptionsControllerState['hasMultipleAddresses']): void;
 };
+export {};

package/dist/types/src/utils/CoreHelperUtil.d.ts

@@ -1,6 +1,7 @@
-import type { Balance, ChainNamespace } from '@reown/appkit-common';
+import type { AppKitSdkVersion, Balance, ChainNamespace } from '@reown/appkit-common';
 import type { CaipAddress, CaipNetwork } from '@reown/appkit-common';
-import type { LinkingRecord } from './TypeUtil.js';
+import type { ChainAdapter, LinkingRecord } from './TypeUtil.js';
+type SDKFramework = 'html' | 'react' | 'vue';
 export declare const CoreHelperUtil: {
     isMobile(): boolean;
     checkCaipNetwork(network: CaipNetwork | undefined, networkName?: string): boolean | undefined;
@@ -40,4 +41,6 @@ export declare const CoreHelperUtil: {
     };
     isAddress(address: string, chain?: ChainNamespace): boolean;
     uniqueBy<T>(arr: T[], key: keyof T): T[];
+    generateSdkVersion(adapters: ChainAdapter[], platform: SDKFramework, version: string): AppKitSdkVersion;
 };
+export {};

package/dist/types/src/utils/StorageUtil.d.ts

@@ -6,7 +6,7 @@ export declare const StorageUtil: {
     }): void;
     getWalletConnectDeepLink(): any;
     deleteWalletConnectDeepLink(): void;
-    setWeb3ModalRecent(wallet: WcWallet): void;
+    setAppKitRecent(wallet: WcWallet): void;
     getRecentWallets(): WcWallet[];
     setConnectedConnector(connectorType: ConnectorType): void;
     getConnectedConnector(): ConnectorType | undefined;

package/dist/types/src/utils/TypeUtil.d.ts

@@ -1,10 +1,11 @@
 import type { W3mFrameProvider, W3mFrameTypes } from '@reown/appkit-wallet';
-import type { Balance, Transaction, CaipNetworkId, CaipNetwork, ChainNamespace, CaipAddress, AdapterType } from '@reown/appkit-common';
+import type { Balance, Transaction, CaipNetworkId, CaipNetwork, ChainNamespace, CaipAddress, AdapterType, SdkFramework, AppKitSdkVersion } from '@reown/appkit-common';
 import type { NetworkControllerClient, NetworkControllerState } from '../controllers/NetworkController.js';
 import type { ConnectionControllerClient } from '../controllers/ConnectionController.js';
 import type { AccountControllerState } from '../controllers/AccountController.js';
 import type { OnRampProviderOption } from '../controllers/OnRampController.js';
 import type { ConstantsUtil } from './ConstantsUtil.js';
+import type { ReownName } from '../controllers/EnsController.js';
 export type CaipNetworkCoinbaseNetwork = 'Ethereum' | 'Arbitrum One' | 'Polygon' | 'Avalanche' | 'OP Mainnet' | 'Celo';
 export type ConnectedWalletInfo = {
     name?: string;
@@ -34,7 +35,7 @@ export type Connector = {
     };
     provider?: unknown;
     chain: ChainNamespace;
-    providers?: Connector[];
+    connectors?: Connector[];
 };
 export interface AuthConnector extends Connector {
     provider: W3mFrameProvider;
@@ -46,7 +47,7 @@ export type CaipNamespaces = Record<string, {
     methods: string[];
     events: string[];
 }>;
-export type SdkVersion = `${'html' | 'react' | 'vue'}-wagmi-${string}` | `${'html' | 'react' | 'vue'}-ethers5-${string}` | `${'html' | 'react' | 'vue'}-ethers-${string}` | `${'html' | 'react' | 'vue'}-solana-${string}` | `${'html' | 'react' | 'vue'}-multichain-${string}`;
+export type SdkVersion = `${SdkFramework}-${AdapterType}-${string}` | AppKitSdkVersion;
 export interface BaseError {
     message?: string;
 }
@@ -237,7 +238,7 @@ export interface BlockchainApiBalanceResponse {
     balances: Balance[];
 }
 export interface BlockchainApiLookupEnsName {
-    name: string;
+    name: ReownName;
     registered: number;
     updated: number;
     addresses: Record<string, {
@@ -664,6 +665,7 @@ export type ChainAdapter = {
     chainNamespace: ChainNamespace;
     isUniversalAdapterClient?: boolean;
     adapterType?: AdapterType;
+    caipNetworks: CaipNetwork[];
     getAddress?: () => string | undefined;
     getError?: () => unknown;
     getChainId?: () => number | string | undefined;
@@ -723,7 +725,7 @@ export type Features = {
      * @description Enable or disable the socials feature. Enabled by default.
      * @type {FeaturesSocials[]}
      */
-    socials?: FeaturesSocials[];
+    socials?: FeaturesSocials[] | false;
     /**
      * @description Enable or disable the history feature. Enabled by default.
      * @type {boolean}

package/dist/types/tests/hooks/react.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/utils/EnsUtil.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/utils/FetchUtil.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/utils/OptionsUtil.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/utils/RouterUtil.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/utils/StorageUtil.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tests/utils/SwapApiUtil.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reown/appkit-core",
-  "version": "0.0.4",
+  "version": "1.0.0",
   "type": "module",
   "main": "./dist/esm/exports/index.js",
   "types": "./dist/types/exports/index.d.ts",
@@ -23,23 +23,23 @@
   "dependencies": {
     "@walletconnect/universal-provider": "2.16.1",
     "valtio": "1.11.2",
-    "@reown/appkit-common": "0.0.4",
-    "@reown/appkit-wallet": "0.0.4"
+    "@reown/appkit-common": "1.0.0",
+    "@reown/appkit-wallet": "1.0.0"
   },
   "devDependencies": {
-    "vitest": "2.0.3",
+    "vitest": "2.0.5",
     "@vitest/coverage-v8": "2.0.5",
     "viem": "2.21.4"
   },
-  "author": "reown <reown.com>",
+  "author": "Reown <support@reown.com> (https://reown.com)",
   "license": "Apache-2.0",
-  "homepage": "https://github.com/web3modal/web3modal",
+  "homepage": "https://github.com/reown-com/appkit",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/WalletConnect/shadow-appkit.git"
   },
   "bugs": {
-    "url": "https://github.com/web3modal/web3modal/issues"
+    "url": "https://github.com/reown-com/appkit/issues"
   },
   "scripts": {
     "build:clean": "rm -rf dist",

package/readme.md

@@ -1,10 +1,10 @@
-#### 📚 [Documentation](https://docs.walletconnect.com/2.0/web3modal/about)
+#### 📚 [Documentation](https://docs.walletconnect.com/2.0/appkit/about)
 
-#### 🔗 [Website](https://web3modal.com)
+#### 🔗 [Website](https://reown.com/appkit)
 
-# Web3Modal
+# AppKit
 
-Your on-ramp to web3 multichain. Web3Modal is a versatile library that makes it super easy to connect users with your Dapp and start interacting with the blockchain.
+Your on-ramp to web3 multichain. AppKit is a versatile library that makes it super easy to connect users with your Dapp and start interacting with the blockchain.
 
 <p align="center">
   <img src="./.github/assets/header.png" alt="" border="0">