@dynamic-labs/sdk-react-core 0.17.16 → 0.17.100-viem.1

package/src/lib/context/DynamicContext/DynamicContext.d.ts

@@ -1,164 +1,164 @@
-import { Dispatch, SetStateAction, ReactNode } from 'react';
-import { WalletConnector, FetchPublicAddressOpts, WalletConnectorsMethod } from '@dynamic-labs/wallet-connector-core';
-import { DynamicJwt, NameServiceData, ProjectSettings } from '@dynamic-labs/sdk-api';
-import { LogLevel } from '@dynamic-labs/logger';
-import { EvmNetwork, NetworkConfigurationMap, WalletUiUtils } from '@dynamic-labs/types';
-import { WalletOption, UserProfile, Wallet, MultiWalletWidgetState, AccountSwitchState, AwaitingSignatureState, ChainToWalletMap, AuthModeType, DynamicRPCProviders, DynamicEventsCallbacks, WalletWithAction, AccessDeniedCustomButton } from '../../shared';
-import { ThemeData, ThemeSetting } from '../ThemeContext';
-import { MultiWalletWidgetStateSetter } from '../../utils/hooks/multiWallet';
-import { SocialNetworkIconType } from '../../utils/functions/getSocialNetworkIcon';
-import { Callback } from './useCustomerCallbacks';
-import { DisplayOrder, SetDisplayOrderPriority } from './hooks';
-export interface IDynamicContext {
-    accessDeniedMessagePrimary?: string;
-    accessDeniedMessageSecondary?: string;
-    accessDeniedButton?: AccessDeniedCustomButton;
-    accountSwitchState: AccountSwitchState;
-    appLogoUrl?: string;
-    appName?: string;
-    authMode: AuthModeType;
-    authToken: string | undefined;
-    authorizationViewDisplayOrder: DisplayOrder;
-    awaitingSignatureState: AwaitingSignatureState;
-    clearStatesOnBackClick: () => void;
-    computeConnectedStateForWallets: () => Promise<void>;
-    connectWallet: (walletConnector: WalletConnector, fetchPublicAddressOpts?: FetchPublicAddressOpts) => Promise<string>;
-    connectedWallet: Wallet | null;
-    connectedWallets: Wallet[];
-    consumeNonce: () => string | undefined;
-    cssOverrides?: string | JSX.Element;
-    debugError: boolean;
-    decodedAuthToken: Omit<DynamicJwt, 'jwt'> | undefined;
-    decodedOnboardingOnlyToken: Omit<DynamicJwt, 'jwt'> | undefined;
-    defaultNumberOfWalletsToShow: number;
-    desktopUri: string;
-    displayTermsOfService: boolean;
-    environmentId: string;
-    environmentName?: string;
-    eventsCallbacks?: DynamicEventsCallbacks;
-    getNameService: (address?: string) => Promise<NameServiceData | undefined>;
-    handleLogOut: () => Promise<void>;
-    handleUnlinkWallet(walletId: string): Promise<void>;
-    isAuthenticated: boolean;
-    isProjectSettingsLoading: boolean;
-    isSingleWalletAccount: boolean;
-    isVerifying: boolean;
-    loadingNetwork: boolean;
-    loginWithEmail: boolean;
-    multiWallet: boolean;
-    multiWalletWidgetState: MultiWalletWidgetState;
-    network: number | string | undefined;
-    networkConfigurations: NetworkConfigurationMap | undefined;
-    newToWeb3WalletChainMap: ChainToWalletMap;
-    notInTheListImageUrl?: string;
-    onboardingImageUrl?: string;
-    onboardingOnlyJwt: string | undefined;
-    policiesConsentInnerComponent?: ReactNode | ReactNode[];
-    primaryWallet: Wallet | null;
-    primaryWalletId: string | undefined;
-    privacyPolicyUrl?: string;
-    projectSettings: ProjectSettings | undefined;
-    qrcodeUri: string;
-    rpcProviders: DynamicRPCProviders;
-    sdkHasLoaded: boolean;
-    secondaryWallets: Wallet[];
-    selectedWalletConnector: WalletConnector | null;
-    selectedWalletWithAction: WalletWithAction | null;
-    setAuthMode: Dispatch<SetStateAction<AuthModeType>>;
-    setAuthorizationViewDisplayOrder: SetDisplayOrderPriority;
-    setCallback: (callback: Callback) => void;
-    setDesktopUri: Dispatch<SetStateAction<string>>;
-    setIsSingleWalletAccount: Dispatch<SetStateAction<boolean>>;
-    setIsVerifying: Dispatch<SetStateAction<boolean>>;
-    setLogInWithEmail: Dispatch<SetStateAction<boolean>>;
-    setMultiWalletWidgetState: MultiWalletWidgetStateSetter;
-    setNetwork: Dispatch<SetStateAction<number | string | undefined>>;
-    setOnboardingOnlyJwt: Dispatch<SetStateAction<string | undefined>>;
-    setPrimaryWallet: (walletId: string) => Promise<void>;
-    setPrimaryWalletId: (walletId: string) => void;
-    setQrcodeUri: Dispatch<SetStateAction<string>>;
-    setSelectedWalletConnector: (connector: WalletConnector | null) => void;
-    setSelectedWalletWithAction: (walletWithAction: WalletWithAction | null) => void;
-    setShowAuthFlow: Dispatch<SetStateAction<boolean>>;
-    setShowDynamicUserProfile: Dispatch<SetStateAction<boolean>>;
-    setShowQrcodeModal: Dispatch<SetStateAction<boolean>>;
-    setShowWidgetStatePopup: Dispatch<SetStateAction<boolean>>;
-    setUser: Dispatch<SetStateAction<UserProfile | undefined>>;
-    /**
-     * The set state action which regulates displaying the bridge widget
-     */
-    setShowBridgeWidget: Dispatch<SetStateAction<boolean>>;
-    shadowDOMEnabled: boolean;
-    showAuthFlow: boolean;
-    showDynamicUserProfile: boolean;
-    /**
-     * The boolean value representing the state of displaying the bridge widget
-     */
-    showBridgeWidget: boolean;
-    showQrcodeModal: boolean;
-    showWidgetStatePopup: boolean;
-    signWithEmailWalletName?: string;
-    siweStatement?: string;
-    socialMediaIconUrl?: Record<string, string> | Record<SocialNetworkIconType, string>;
-    socialMediaLinkText?: string;
-    socialMediaUrl?: string;
-    termsOfServiceUrl?: string;
-    theme?: ThemeData | ThemeSetting;
-    toolkitEnabled?: boolean;
-    user: UserProfile | undefined;
-    walletConnector: WalletConnector | null;
-    walletUiUtils: WalletUiUtils;
-    wallets: WalletOption[];
-    walletsFilter?: (options: WalletOption[]) => WalletOption[];
-}
-export interface DynamicContextProps {
-    children: ReactNode;
-    settings: {
-        accessDeniedMessagePrimary?: string;
-        accessDeniedMessageSecondary?: string;
-        accessDeniedButton?: AccessDeniedCustomButton;
-        apiBaseUrl?: string;
-        appLogoUrl?: string;
-        appName?: string;
-        cssOverrides?: string | JSX.Element;
-        debugError?: boolean;
-        defaultNumberOfWalletsToShow?: number;
-        displayTermsOfService?: boolean;
-        enableVisitTrackingOnConnectOnly?: boolean;
-        environmentId: string;
-        localStorageSuffix?: string;
-        eventsCallbacks?: DynamicEventsCallbacks;
-        evmNetworks?: EvmNetwork[];
-        /**
-         * @deprecated Set flow network in dashboard instead
-         */
-        flowNetwork?: 'testnet' | 'mainnet';
-        initialAuthenticationMode?: AuthModeType;
-        /**
-         * The log level to use for client side logging with our SDK
-         * @default WARN
-         */
-        logLevel?: keyof typeof LogLevel;
-        /** @deprecated enable multi wallet in the bashboard settings instead */
-        multiWallet?: boolean;
-        newToWeb3WalletChainMap?: ChainToWalletMap;
-        notInTheListImageUrl?: string;
-        onboardingImageUrl?: string;
-        policiesConsentInnerComponent?: ReactNode | ReactNode[];
-        privacyPolicyUrl?: string;
-        shadowDOMEnabled?: boolean;
-        signWithEmailWalletName?: string;
-        siweStatement?: string;
-        socialMediaIconUrl?: Record<string, string> | Record<SocialNetworkIconType, string>;
-        socialMediaLinkText?: string;
-        socialMediaUrl?: string;
-        termsOfServiceUrl?: string;
-        toolkitEnabled?: boolean;
-        walletConnectV1Bridge?: string;
-        walletConnectors?: WalletConnectorsMethod[];
-        walletsFilter?: (options: WalletOption[]) => WalletOption[];
-    };
-    theme?: ThemeData | ThemeSetting;
-}
-export declare const DynamicContext: import("react").Context<IDynamicContext | undefined>;
-export declare const DynamicContextProvider: ({ settings: { accessDeniedMessagePrimary, accessDeniedMessageSecondary, accessDeniedButton, apiBaseUrl, appLogoUrl, appName, cssOverrides, defaultNumberOfWalletsToShow, flowNetwork, initialAuthenticationMode, debugError, displayTermsOfService, newToWeb3WalletChainMap, enableVisitTrackingOnConnectOnly, environmentId, localStorageSuffix, eventsCallbacks, evmNetworks, walletsFilter, logLevel, multiWallet: deprecatedMultiWallet, notInTheListImageUrl, onboardingImageUrl, policiesConsentInnerComponent, privacyPolicyUrl, signWithEmailWalletName, socialMediaLinkText, socialMediaIconUrl, socialMediaUrl, termsOfServiceUrl, toolkitEnabled, siweStatement, shadowDOMEnabled, walletConnectV1Bridge, walletConnectors: walletConnectorsProp, }, children, theme, }: DynamicContextProps) => JSX.Element;
+import { Dispatch, SetStateAction, ReactNode } from 'react';
+import { WalletConnector, FetchPublicAddressOpts, WalletConnectorsMethod } from '@dynamic-labs/wallet-connector-core';
+import { DynamicJwt, NameServiceData, ProjectSettings } from '@dynamic-labs/sdk-api';
+import { LogLevel } from '@dynamic-labs/logger';
+import { EvmNetwork, NetworkConfigurationMap, WalletUiUtils } from '@dynamic-labs/types';
+import { WalletOption, UserProfile, Wallet, MultiWalletWidgetState, AccountSwitchState, AwaitingSignatureState, ChainToWalletMap, AuthModeType, DynamicRPCProviders, DynamicEventsCallbacks, WalletWithAction, AccessDeniedCustomButton } from '../../shared';
+import { ThemeData, ThemeSetting } from '../ThemeContext';
+import { MultiWalletWidgetStateSetter } from '../../utils/hooks/multiWallet';
+import { SocialNetworkIconType } from '../../utils/functions/getSocialNetworkIcon';
+import { Callback } from './useCustomerCallbacks';
+import { DisplayOrder, SetDisplayOrderPriority } from './hooks';
+export interface IDynamicContext {
+    accessDeniedMessagePrimary?: string;
+    accessDeniedMessageSecondary?: string;
+    accessDeniedButton?: AccessDeniedCustomButton;
+    accountSwitchState: AccountSwitchState;
+    appLogoUrl?: string;
+    appName?: string;
+    authMode: AuthModeType;
+    authToken: string | undefined;
+    authorizationViewDisplayOrder: DisplayOrder;
+    awaitingSignatureState: AwaitingSignatureState;
+    clearStatesOnBackClick: () => void;
+    computeConnectedStateForWallets: () => Promise<void>;
+    connectWallet: (walletConnector: WalletConnector, fetchPublicAddressOpts?: FetchPublicAddressOpts) => Promise<string>;
+    connectedWallet: Wallet | null;
+    connectedWallets: Wallet[];
+    consumeNonce: () => string | undefined;
+    cssOverrides?: string | JSX.Element;
+    debugError: boolean;
+    decodedAuthToken: Omit<DynamicJwt, 'jwt'> | undefined;
+    decodedOnboardingOnlyToken: Omit<DynamicJwt, 'jwt'> | undefined;
+    defaultNumberOfWalletsToShow: number;
+    desktopUri: string;
+    displayTermsOfService: boolean;
+    environmentId: string;
+    environmentName?: string;
+    eventsCallbacks?: DynamicEventsCallbacks;
+    getNameService: (address?: string) => Promise<NameServiceData | undefined>;
+    handleLogOut: () => Promise<void>;
+    handleUnlinkWallet(walletId: string): Promise<void>;
+    isAuthenticated: boolean;
+    isProjectSettingsLoading: boolean;
+    isSingleWalletAccount: boolean;
+    isVerifying: boolean;
+    loadingNetwork: boolean;
+    loginWithEmail: boolean;
+    multiWallet: boolean;
+    multiWalletWidgetState: MultiWalletWidgetState;
+    network: number | string | undefined;
+    networkConfigurations: NetworkConfigurationMap | undefined;
+    newToWeb3WalletChainMap: ChainToWalletMap;
+    notInTheListImageUrl?: string;
+    onboardingImageUrl?: string;
+    onboardingOnlyJwt: string | undefined;
+    policiesConsentInnerComponent?: ReactNode | ReactNode[];
+    primaryWallet: Wallet | null;
+    primaryWalletId: string | undefined;
+    privacyPolicyUrl?: string;
+    projectSettings: ProjectSettings | undefined;
+    qrcodeUri: string;
+    rpcProviders: DynamicRPCProviders;
+    sdkHasLoaded: boolean;
+    secondaryWallets: Wallet[];
+    selectedWalletConnector: WalletConnector | null;
+    selectedWalletWithAction: WalletWithAction | null;
+    setAuthMode: Dispatch<SetStateAction<AuthModeType>>;
+    setAuthorizationViewDisplayOrder: SetDisplayOrderPriority;
+    setCallback: (callback: Callback) => void;
+    setDesktopUri: Dispatch<SetStateAction<string>>;
+    setIsSingleWalletAccount: Dispatch<SetStateAction<boolean>>;
+    setIsVerifying: Dispatch<SetStateAction<boolean>>;
+    setLogInWithEmail: Dispatch<SetStateAction<boolean>>;
+    setMultiWalletWidgetState: MultiWalletWidgetStateSetter;
+    setNetwork: Dispatch<SetStateAction<number | string | undefined>>;
+    setOnboardingOnlyJwt: Dispatch<SetStateAction<string | undefined>>;
+    setPrimaryWallet: (walletId: string) => Promise<void>;
+    setPrimaryWalletId: (walletId: string) => void;
+    setQrcodeUri: Dispatch<SetStateAction<string>>;
+    setSelectedWalletConnector: (connector: WalletConnector | null) => void;
+    setSelectedWalletWithAction: (walletWithAction: WalletWithAction | null) => void;
+    setShowAuthFlow: Dispatch<SetStateAction<boolean>>;
+    setShowDynamicUserProfile: Dispatch<SetStateAction<boolean>>;
+    setShowQrcodeModal: Dispatch<SetStateAction<boolean>>;
+    setShowWidgetStatePopup: Dispatch<SetStateAction<boolean>>;
+    setUser: Dispatch<SetStateAction<UserProfile | undefined>>;
+    /**
+     * The set state action which regulates displaying the bridge widget
+     */
+    setShowBridgeWidget: Dispatch<SetStateAction<boolean>>;
+    shadowDOMEnabled: boolean;
+    showAuthFlow: boolean;
+    showDynamicUserProfile: boolean;
+    /**
+     * The boolean value representing the state of displaying the bridge widget
+     */
+    showBridgeWidget: boolean;
+    showQrcodeModal: boolean;
+    showWidgetStatePopup: boolean;
+    signWithEmailWalletName?: string;
+    siweStatement?: string;
+    socialMediaIconUrl?: Record<string, string> | Record<SocialNetworkIconType, string>;
+    socialMediaLinkText?: string;
+    socialMediaUrl?: string;
+    termsOfServiceUrl?: string;
+    theme?: ThemeData | ThemeSetting;
+    toolkitEnabled?: boolean;
+    user: UserProfile | undefined;
+    walletConnector: WalletConnector | null;
+    walletUiUtils: WalletUiUtils;
+    wallets: WalletOption[];
+    walletsFilter?: (options: WalletOption[]) => WalletOption[];
+}
+export interface DynamicContextProps {
+    children: ReactNode;
+    settings: {
+        accessDeniedMessagePrimary?: string;
+        accessDeniedMessageSecondary?: string;
+        accessDeniedButton?: AccessDeniedCustomButton;
+        apiBaseUrl?: string;
+        appLogoUrl?: string;
+        appName?: string;
+        cssOverrides?: string | JSX.Element;
+        debugError?: boolean;
+        defaultNumberOfWalletsToShow?: number;
+        displayTermsOfService?: boolean;
+        enableVisitTrackingOnConnectOnly?: boolean;
+        environmentId: string;
+        localStorageSuffix?: string;
+        eventsCallbacks?: DynamicEventsCallbacks;
+        evmNetworks?: EvmNetwork[];
+        /**
+         * @deprecated Set flow network in dashboard instead
+         */
+        flowNetwork?: 'testnet' | 'mainnet';
+        initialAuthenticationMode?: AuthModeType;
+        /**
+         * The log level to use for client side logging with our SDK
+         * @default WARN
+         */
+        logLevel?: keyof typeof LogLevel;
+        /** @deprecated enable multi wallet in the bashboard settings instead */
+        multiWallet?: boolean;
+        newToWeb3WalletChainMap?: ChainToWalletMap;
+        notInTheListImageUrl?: string;
+        onboardingImageUrl?: string;
+        policiesConsentInnerComponent?: ReactNode | ReactNode[];
+        privacyPolicyUrl?: string;
+        shadowDOMEnabled?: boolean;
+        signWithEmailWalletName?: string;
+        siweStatement?: string;
+        socialMediaIconUrl?: Record<string, string> | Record<SocialNetworkIconType, string>;
+        socialMediaLinkText?: string;
+        socialMediaUrl?: string;
+        termsOfServiceUrl?: string;
+        toolkitEnabled?: boolean;
+        walletConnectV1Bridge?: string;
+        walletConnectors?: WalletConnectorsMethod[];
+        walletsFilter?: (options: WalletOption[]) => WalletOption[];
+    };
+    theme?: ThemeData | ThemeSetting;
+}
+export declare const DynamicContext: import("react").Context<IDynamicContext | undefined>;
+export declare const DynamicContextProvider: ({ settings: { accessDeniedMessagePrimary, accessDeniedMessageSecondary, accessDeniedButton, apiBaseUrl, appLogoUrl, appName, cssOverrides, defaultNumberOfWalletsToShow, flowNetwork, initialAuthenticationMode, debugError, displayTermsOfService, newToWeb3WalletChainMap, enableVisitTrackingOnConnectOnly, environmentId, localStorageSuffix, eventsCallbacks, evmNetworks, walletsFilter, logLevel, multiWallet: deprecatedMultiWallet, notInTheListImageUrl, onboardingImageUrl, policiesConsentInnerComponent, privacyPolicyUrl, signWithEmailWalletName, socialMediaLinkText, socialMediaIconUrl, socialMediaUrl, termsOfServiceUrl, toolkitEnabled, siweStatement, shadowDOMEnabled, walletConnectV1Bridge, walletConnectors: walletConnectorsProp, }, children, theme, }: DynamicContextProps) => JSX.Element;