@reown/appkit-core 1.6.0 → 1.6.1-rc.0

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

@@ -11,7 +11,7 @@ export type { OnRampControllerState, OnRampProvider } from '../src/controllers/O
 export { ConnectionController } from '../src/controllers/ConnectionController.js';
 export type { ConnectionControllerClient, ConnectionControllerState } from '../src/controllers/ConnectionController.js';
 export { ConnectorController } from '../src/controllers/ConnectorController.js';
-export type { ConnectorControllerState } from '../src/controllers/ConnectorController.js';
+export type { ConnectorControllerState, ConnectorWithProviders } from '../src/controllers/ConnectorController.js';
 export { SnackController } from '../src/controllers/SnackController.js';
 export type { SnackControllerState } from '../src/controllers/SnackController.js';
 export { ApiController } from '../src/controllers/ApiController.js';

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

@@ -45,4 +45,5 @@ export declare const ChainController: {
     checkIfNamesSupported(): boolean;
     resetNetwork(namespace: ChainNamespace): void;
     resetAccount(chain: ChainNamespace | undefined): void;
+    disconnect(): Promise<void>;
 };

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

@@ -1,5 +1,5 @@
 import type { AuthConnector, Connector } from '../utils/TypeUtil.js';
-interface ConnectorWithProviders extends Connector {
+export interface ConnectorWithProviders extends Connector {
     connectors?: Connector[];
 }
 export interface ConnectorControllerState {
@@ -21,4 +21,3 @@ export declare const ConnectorController: {
     getConnector(id: string, rdns?: string | null): ConnectorWithProviders | undefined;
     syncIfAuthConnector(connector: Connector | AuthConnector): void;
 };
-export {};

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

@@ -115,6 +115,11 @@ export interface OptionsControllerStatePublic {
      * @default false
      */
     enableEmbedded?: boolean;
+    /**
+     * Allow users to switch to an unsupported chain.
+     * @default false
+     */
+    allowUnsupportedChain?: boolean;
 }
 export interface OptionsControllerStateInternal {
     sdkType: 'appkit';
@@ -156,5 +161,6 @@ export declare const OptionsController: {
     setSocialsOrder(socialsOrder: SocialProvider[]): void;
     setCollapseWallets(collapseWallets: boolean): void;
     setEnableEmbedded(enableEmbedded: OptionsControllerState['enableEmbedded']): void;
+    setAllowUnsupportedChain(allowUnsupportedChain: OptionsControllerState['allowUnsupportedChain']): void;
 };
 export {};

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

@@ -63,7 +63,7 @@ export declare const ConstantsUtil: {
         legalCheckbox: false;
         smartSessions: false;
         collapseWallets: false;
-        connectMethodsOrder: ("email" | "social" | "wallet")[];
         walletFeaturesOrder: ("swaps" | "send" | "receive" | "onramp")[];
+        connectMethodsOrder: undefined;
     };
 };

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

@@ -47,5 +47,6 @@ export declare const CoreHelperUtil: {
     uniqueBy<T>(arr: T[], key: keyof T): T[];
     generateSdkVersion(adapters: ChainAdapter[], platform: SDKFramework, version: string): AppKitSdkVersion;
     createAccount<N extends ChainNamespace>(namespace: N, address: string, type: NamespaceTypeMap[N]): AccountTypeMap[N];
+    isCaipAddress(address?: unknown): address is `eip155:${string}:${string}` | `eip155:${number}:${string}` | `solana:${string}:${string}` | `solana:${number}:${string}` | `polkadot:${string}:${string}` | `polkadot:${number}:${string}` | `bip122:${string}:${string}` | `bip122:${number}:${string}`;
 };
 export {};

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

@@ -1,4 +1,4 @@
 import type { Features, FeaturesKeys } from './TypeUtil.js';
 export declare const OptionsUtil: {
-    getFeatureValue(key: FeaturesKeys, features?: Features): boolean | import("./TypeUtil.js").SocialProvider[] | import("./TypeUtil.js").ConnectMethod[] | import("./TypeUtil.js").WalletFeature[] | undefined;
+    getFeatureValue(key: FeaturesKeys, features?: Features): boolean | import("./TypeUtil.js").SocialProvider[] | import("./TypeUtil.js").WalletFeature[] | import("./TypeUtil.js").ConnectMethod[] | undefined;
 };

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

@@ -1,5 +1,8 @@
 import type { CaipNetworkId } from '@reown/appkit-common';
 import UniversalProvider from '@walletconnect/universal-provider';
+/**
+ * SIWXUtil holds the methods to interact with the SIWX plugin and must be called internally on AppKit.
+ */
 export declare const SIWXUtil: {
     getSIWX(): SIWXConfig | undefined;
     initializeIfEnabled(): Promise<void>;
@@ -16,19 +19,69 @@ export declare const SIWXUtil: {
         network: string;
         isSmartAccount: boolean;
     };
+    clearSessions(): Promise<void>;
 };
 /**
- * @experimental - This is an experimental feature and it is not production ready
+ * This interface represents the SIWX configuration plugin, which is used to create and manage SIWX messages and sessions.
+ * AppKit provides predefined implementations for this interface through `@reown/appkit-siwx`.
+ * You may use it to create a custom implementation following your needs, but watch close for the methods requirements.
  */
 export interface SIWXConfig {
+    /**
+     * This method will be called to create a new message to be signed by the user.
+     *
+     * Constraints:
+     * - The message MUST be unique and contain all the necessary information to verify the user's identity.
+     * - SIWXMessage.toString() method MUST be implemented to return the message string.
+     *
+     * @param input SIWXMessage.Input
+     * @returns SIWXMessage
+     */
     createMessage: (input: SIWXMessage.Input) => Promise<SIWXMessage>;
+    /**
+     * This method will be called to store a new single session.
+     *
+     * Constraints:
+     * - This method MUST verify if the session is valid and store it in the storage successfully.
+     *
+     * @param session SIWXSession
+     */
     addSession: (session: SIWXSession) => Promise<void>;
+    /**
+     * This method will be called to revoke all the sessions stored for a specific chain and address.
+     *
+     * Constraints:
+     * - This method MUST delete all the sessions stored for the specific chain and address successfully.
+     *
+     * @param chainId CaipNetworkId
+     * @param address string
+     */
     revokeSession: (chainId: CaipNetworkId, address: string) => Promise<void>;
+    /**
+     * This method will be called to replace all the sessions in the storage with the new ones.
+     *
+     * Constraints:
+     * - This method MUST verify all the sessions before storing them in the storage;
+     * - This method MUST replace all the sessions in the storage with the new ones succesfully otherwise it MUST throw an error.
+     *
+     * @param sessions SIWXSession[]
+     */
     setSessions: (sessions: SIWXSession[]) => Promise<void>;
+    /**
+     * This method will be called to get all the sessions stored for a specific chain and address.
+     *
+     * Constraints:
+     * - This method MUST return only sessions that are verified and valid;
+     * - This method MUST NOT return expired sessions.
+     *
+     * @param chainId CaipNetworkId
+     * @param address string
+     * @returns
+     */
     getSessions: (chainId: CaipNetworkId, address: string) => Promise<SIWXSession[]>;
 }
 /**
- * @experimental - This is an experimental feature and it is not production ready
+ * This interface represents a SIWX session, which is used to store the user's identity information.
  */
 export interface SIWXSession {
     data: SIWXMessage.Data;
@@ -37,18 +90,20 @@ export interface SIWXSession {
     cacao?: Cacao;
 }
 /**
- * @experimental - This is an experimental feature and it is not production ready
+ * This interface represents a SIWX message, which is used to create a message to be signed by the user.
+ * This must contain the necessary information to verify the user's identity and how to generate the string message.
  */
 export interface SIWXMessage extends SIWXMessage.Data, SIWXMessage.Methods {
 }
 export declare namespace SIWXMessage {
     /**
-     * @experimental - This is an experimental feature and it is not production ready
+     * This interface represents the SIWX message data, which is used to create a message to be signed by the user.
      */
     interface Data extends Input, Metadata, Identifier {
     }
     /**
-     * @experimental - This is an experimental feature and it is not production ready
+     * This interface represents the SIWX message input.
+     * Here must contain what is different for each user of the application.
      */
     interface Input {
         accountAddress: string;
@@ -56,7 +111,8 @@ export declare namespace SIWXMessage {
         notBefore?: Timestamp;
     }
     /**
-     * @experimental - This is an experimental feature and it is not production ready
+     * This interface represents the SIWX message metadata.
+     * Here must contain the main data related to the app.
      */
     interface Metadata {
         domain: string;
@@ -67,7 +123,8 @@ export declare namespace SIWXMessage {
         resources?: string[];
     }
     /**
-     * @experimental - This is an experimental feature and it is not production ready
+     * This interface represents the SIWX message identifier.
+     * Here must contain the request id and the timestamps.
      */
     interface Identifier {
         requestId?: string;
@@ -75,16 +132,21 @@ export declare namespace SIWXMessage {
         expirationTime?: Timestamp;
     }
     /**
-     * @experimental - This is an experimental feature and it is not production ready
+     * This interface represents the SIWX message methods.
+     * Here must contain the method to generate the message string and any other method performed by the SIWX message.
      */
     interface Methods {
         toString: () => string;
     }
     /**
-     * @experimental - This is an experimental feature and it is not production ready
+     * The timestamp is a UTC string representing the time in ISO 8601 format.
      */
     type Timestamp = string;
 }
+/**
+ * The Cacao interface is a reference of CAIP-74 and represents a chain-agnostic Object Capability (OCAP).
+ * https://chainagnostic.org/CAIPs/caip-74
+ */
 export interface Cacao {
     h: Cacao.Header;
     p: Cacao.Payload;

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

@@ -18,7 +18,7 @@ export declare const SwapApiUtil: {
         fast: string | undefined;
         instant: string | undefined;
     } | null>;
-    fetchSwapAllowance({ tokenAddress, userAddress, sourceTokenAmount, sourceTokenDecimals }: Pick<BlockchainApiSwapAllowanceRequest, "userAddress" | "tokenAddress"> & {
+    fetchSwapAllowance({ tokenAddress, userAddress, sourceTokenAmount, sourceTokenDecimals }: Pick<BlockchainApiSwapAllowanceRequest, "tokenAddress" | "userAddress"> & {
         sourceTokenAmount: string;
         sourceTokenDecimals: number;
     }): Promise<boolean>;

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

@@ -347,6 +347,9 @@ export type Event = {
 } | {
     type: 'track';
     event: 'DISCONNECT_ERROR';
+    properties?: {
+        message: string;
+    };
 } | {
     type: 'track';
     event: 'CLICK_WALLET_HELP';
@@ -732,12 +735,12 @@ export type EstimateGasTransactionArgs = {
     chainNamespace: 'solana';
 };
 export interface WriteContractArgs {
-    receiverAddress: `0x${string}`;
-    tokenAmount: bigint;
     tokenAddress: `0x${string}`;
     fromAddress: `0x${string}`;
-    method: 'send' | 'transfer' | 'call';
+    method: 'send' | 'transfer' | 'call' | 'approve';
     abi: any;
+    args: unknown[];
+    chainNamespace: ChainNamespace;
 }
 export interface NetworkControllerClient {
     switchCaipNetwork: (network: CaipNetwork) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reown/appkit-core",
-  "version": "1.6.0",
+  "version": "1.6.1-rc.0",
   "type": "module",
   "main": "./dist/esm/exports/index.js",
   "types": "./dist/types/exports/index.d.ts",
@@ -36,11 +36,11 @@
     }
   },
   "dependencies": {
-    "@walletconnect/universal-provider": "2.17.0",
+    "@walletconnect/universal-provider": "2.17.2",
     "valtio": "1.11.2",
     "viem": "2.x",
-    "@reown/appkit-common": "1.6.0",
-    "@reown/appkit-wallet": "1.6.0"
+    "@reown/appkit-common": "1.6.1-rc.0",
+    "@reown/appkit-wallet": "1.6.1-rc.0"
   },
   "peerDependencies": {},
   "devDependencies": {