@privy-io/react-auth 1.35.2-beta.2 → 1.36.0-beta.1

package/dist/index.d.ts

@@ -419,6 +419,364 @@ declare abstract class WalletConnector extends EventEmitter<ConnectorEvents> {
     abstract promptConnection(walletClientType: WalletClientType): void;
 }
 
+interface ResponseEmailAccount {
+    type: 'email';
+    address: string;
+    verified_at: number;
+}
+interface ResponsePhoneAccount {
+    type: 'phone';
+    phoneNumber: string;
+    verified_at: number;
+}
+interface ResponseEthereumAccount {
+    type: 'wallet';
+    address: string;
+    /**
+     * @deprecated This will be removed in favor of the CAIP-2 formatted chain_id field.
+     *
+     * Chain type of the wallet address.
+     */
+    chain_type: 'ethereum';
+    chain_id?: string;
+    /**
+     * @deprecated Use `wallet_client_type` instead.
+     */
+    wallet_client: 'privy' | 'unknown';
+    wallet_client_type?: string;
+    connector_type?: string;
+    recovery_method?: 'privy' | 'user-passcode';
+    verified_at: number;
+}
+interface ResponseOAuthGoogle {
+    type: 'google_oauth';
+    subject: string;
+    email: string;
+    name: string | null;
+    verified_at: number;
+}
+interface ResponseOAuthTwitter {
+    type: 'twitter_oauth';
+    subject: string;
+    username: string | null;
+    name: string | null;
+    verified_at: number;
+}
+interface ResponseOAuthDiscord {
+    type: 'discord_oauth';
+    subject: string;
+    username: string | null;
+    email: string | null;
+    verified_at: number;
+}
+interface ResponseOAuthGithub {
+    type: 'github_oauth';
+    subject: string;
+    username: string | null;
+    name: string | null;
+    email: string | null;
+    verified_at: number;
+}
+interface ResponseOAuthApple {
+    type: 'apple_oauth';
+    subject: string;
+    email: string;
+    verified_at: number;
+}
+interface ResponseCustomJwtAccount {
+    type: 'custom_auth';
+    custom_user_id: string;
+    verified_at: number;
+}
+type LinkedAccountsResponseType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub | ResponseOAuthApple | ResponseCustomJwtAccount>;
+interface GetCurrentUserResponse {
+    id: string;
+    created_at: number;
+    linked_accounts: LinkedAccountsResponseType;
+}
+
+interface DefaultsType {
+    baseURL: string;
+    timeout: number;
+}
+/**
+ * A raw http handler for making requests to the Privy API. It requires a Session
+ * object, which is used for fetching and including any tokens that are required
+ * for requests.
+ *
+ * Should not be used for external requests, as we attach a good deal of metadata to requests.
+ */
+declare class Http {
+    fallbackApiUrl: string;
+    private appId;
+    private client;
+    private defaults;
+    private sdkVersion;
+    private baseFetch;
+    constructor(appId: string, client: PrivyClient, defaults: DefaultsType);
+    get<T = any>(path: string, config?: FetchOptions<'json'>): Promise<T>;
+    post<T = any, D = any>(path: string, data?: D, config?: FetchOptions<'json'>): Promise<T>;
+    delete<T = any>(path: string, config?: FetchOptions<'json'>): Promise<T>;
+}
+
+/**
+ * Valid /session and <>/authenticate calls will respond with a token
+ * as well as a valid user object for streamlining.
+ */
+interface ValidSessionResponse {
+    user: GetCurrentUserResponse;
+    token: string;
+    refresh_token: string | null;
+    is_new_user?: boolean;
+}
+
+type AuthMeta = {
+    [key: string]: any;
+};
+/**
+ * An auth flow is an encapsulation of the business logic required for a given
+ * authentication process. It requires at least one definitive `authenticate`
+ * method that does the final token handshaking with the API, but may also
+ * include any number of methods/API calls necessary to set up the state (e.g.
+ * sending an email before being able to do a passwordless code login)
+ */
+interface AuthFlow {
+    api?: Http;
+    /**
+     * Any meta information necessary for the auth flow, that may also need to be
+     * shared out to things like frontend components for displaying state of the
+     * auth flow
+     */
+    meta: AuthMeta;
+    /**
+     * Handles the API authentication call(s) to log users in.
+     * Any preconditions must be addressed prior to calling
+     */
+    authenticate(): Promise<ValidSessionResponse>;
+    /**
+     * Handles the API link call(s) to link new user accounts.
+     * Requires user to already be logged in when called.
+     * Any preconditions must be addressed prior to calling
+     */
+    link(): Promise<GetCurrentUserResponse>;
+}
+
+interface ConnectorManagerEvents {
+    walletsUpdated(): void;
+}
+/** @hidden */
+declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
+    walletConnectors: WalletConnector[];
+    initialized: boolean;
+    private storedConnections;
+    private activeWallet?;
+    private walletConnectCloudProjectId;
+    private rpcConfig;
+    constructor(walletConnectCloudProjectId: string, rpcConfig: RpcConfig);
+    /**
+     * The core wallets array that is exposed to developers. It builds
+     * the wallets away with the following logic:
+     *
+     * 1. Flatten all wallets from all connectors
+     * 2. Sorted by connectedAt
+     * 3. Active wallet is moved to front of array (if it exists)
+     */
+    get wallets(): BaseConnectedWallet[];
+    /**
+     * Detect and add all valid wallet connectors.
+     */
+    initialize(): void;
+    /**
+     * Helper function to find a wallet connector by connector type and wallet client type.
+     */
+    findWalletConnector(connectorType: ConnectorType, walletClientType: WalletClientType): WalletConnector | null;
+    /**
+     * Add any connectedAt overrides for newly initialized wallets and pass-through change events.
+     */
+    private onInitialized;
+    /**
+     * Save connection history and pass-through change events.
+     */
+    private onWalletsUpdated;
+    addEmbeddedWalletConnector(walletProxy: EmbeddedWalletProxy, address: string): void;
+    /**
+     * Normally, we do not remove connectors after creation. Privy embedded wallets are an exception
+     * because they are closely tied with an authenticated state.
+     */
+    removeEmbeddedWalletConnector(): void;
+    /**
+     * Creates a new wallet connector for the given connector type and wallet client type.
+     * If a connector already exists, it will be returned instead.
+     */
+    createWalletConnector(connectorType: ConnectorType, walletClientType: WalletClientType): Promise<WalletConnector | null>;
+    private addWalletConnector;
+    /**
+     * Upon initialization, loads previous connections from local storage. If local storage
+     * is misformatted (e.g. due to previous privy:connectors usage), it returns an empty array that
+     * will be overwritten later.
+     *
+     * @returns StoredConnection[] list of stored connections from previous session
+     */
+    private loadConnectionHistory;
+    /**
+     * Saves all current connections to local storage overridding any previous connections.
+     */
+    private saveConnectionHistory;
+    /**
+     * @deprecated **Deprecated**: This feature will be removed and should be replaced by
+     * interfacing with wallets directly (wallets[0].getEthereumProvider()).
+     *
+     * Build an Ethereum provider for the most recently connected wallet.
+     */
+    getEthereumProvider: () => EIP1193Provider;
+    /**
+     * @deprecated **Deprecated**: This feature will be removed and should be replaced by
+     * interfacing with `wallets` directly.
+     *
+     * Performing personal_sign with the most recently connected wallet.
+     * If there is not a wallet connected, return null.
+     */
+    activeWalletSign(message: string): Promise<string | null>;
+    /**
+     * @deprecated **Deprecated**: This feature will be removed and should be replaced by
+     * interfacing with `wallets` directly.
+     */
+    setActiveWallet(address: string): void;
+}
+
+/**
+ * This should not be directly used by developers at the moment,
+ * so we doc-ignore it.
+ * @ignore
+ *
+ */
+declare class PrivyClient {
+    private api;
+    private appId;
+    private session;
+    private timeout;
+    private clientAnalyticsId;
+    useServerCookies: boolean;
+    apiUrl: string;
+    fallbackApiUrl: string;
+    authFlow?: AuthFlow;
+    connectors?: ConnectorManager;
+    /**
+     * Creates a new Privy client.
+     * @param options Initialization options.
+     */
+    constructor(options: {
+        /**
+         * The URL of the Privy API. Defaults to `https://api.privy.io/v0`.
+         */
+        apiUrl?: string;
+        /**
+         * The app id from your console
+         */
+        appId: string;
+        /**
+         * Time in milliseconds after which to timeout requests to the API. Defaults to `10000` (10 seconds).
+         */
+        timeout?: number;
+    });
+    /**
+     * ConnectorManager initialization is deferred because the input parameter may be overridden by the server
+     * config. We can set this once and only once. If it is set twice, event listeners will be created
+     * on the first ConnectorManager and are not re-created.
+     */
+    initializeConnectorManager(walletConnectCloudProjectId: string, rpcConfig: RpcConfig): void;
+    generateApi(): Http;
+    /**
+     * In the case of cookie-based auth, re-initialize the http client with the custom api url.
+     * @param customApiUrl the custom api url to use for cookie-based authFlow
+     */
+    updateApiUrl(customApiUrl?: string | null): void;
+    authenticate(): Promise<{
+        user: User | null;
+        isNewUser?: boolean | undefined;
+    }>;
+    link(): Promise<User | null>;
+    logout(): Promise<void>;
+    startAuthFlow(authFlow: AuthFlow): void;
+    unlinkEmail(address: string): Promise<User>;
+    unlinkPhone(phoneNumber: string): Promise<User>;
+    unlinkWallet(address: string): Promise<User>;
+    unlinkOAuth(provider: OAuthProviderType, subject: string): Promise<User>;
+    createAnalyticsEvent(eventName: string, payload?: {
+        [key: string]: any;
+    }, timestamp?: Date): Promise<void>;
+    signMoonpayOnRampUrl(signRequestData: MoonpaySignRequest): Promise<MoonpaySignResponse>;
+    /** DATA METHODS */
+    /**
+     * Fetches the currently authenticed user from the API or
+     * returns null if the user is not authenticated.
+     *
+     * This will refresh the user's access token and rotate
+     * the refresh token if needed.
+     *
+     * @returns Promise<User | null>
+     */
+    getAuthenticatedUser(): Promise<User | null>;
+    /**
+     * Grab the Privy access token for the currently logged in user. Verifies that the
+     * token has a valid signature, was issued by 'privy.io', and corresponds to the
+     * current app ID. If no valid token is found, this method will force a logout and return null.
+     *
+     * If the token is expired or expiring soon, this will attempt to
+     * first refresh the access token to ensure that the token is active. You can
+     * disable this behavior using `disableAutoRefresh`, although it is not
+     * recommended.
+     *
+     * @param disableAutoRefresh not recommended - optionally disable automatic
+     * token refresh when the token is
+     *
+     * @returns Promise<string | null>
+     */
+    getAccessToken(options?: {
+        disableAutoRefresh?: boolean;
+    }): Promise<string | null>;
+    getServerConfig(): Promise<PrivyServerConfig>;
+    getUsdTokenPrice(chainId: string | number): Promise<number | undefined>;
+    /**
+     * Get a short-lived token to start a new Privy session from the existing authenticated session.
+     *
+     * Rotates the access token and refresh token.
+     * Raises an exception if the current session was already forked from a previous session,
+     * or if the current session is not authenticated.
+     *
+     * @returns Promise<string>
+     */
+    forkSession(): Promise<string>;
+}
+
+/**
+ * Accepted payment methods for the MoonPay fiat on-ramp.
+ */
+type MoonpayPaymentMethod = 'ach_bank_transfer' | 'credit_debit_card' | 'gbp_bank_transfer' | 'gbp_open_banking_payment' | 'mobile_wallet' | 'sepa_bank_transfer' | 'sepa_open_banking_payment' | 'pix_instant_payment' | 'yellow_card_bank_transfer';
+/**
+ * Cryptocurrency codes for the MoonPay fiat on-ramp. These codes
+ * follow the format {TOKEN_NAME}_{NETWORK_NAME}.
+ */
+type MoonpayCurrencyCode = 'AVAX_CCHAIN' | 'CELO_CELO' | 'CUSD_CELO' | 'DAI_ETHEREUM' | 'ETH_ETHEREUM' | 'ETH_ARBITRUM' | 'ETH_POLYGON' | 'FIL_FVM' | 'MATIC_ETHEREUM' | 'MATIC_POLYGON' | 'USDC_ETHEREUM' | 'USDC_ARBITRUM' | 'USDC_OPTIMISM' | 'USDC_POLYGON' | 'USDT_ETHEREUM' | 'USDT_POLYGON' | 'WETH_POLYGON' | 'WBTC_ETHEREUM';
+type MoonpayConfig = {
+    currencyCode?: MoonpayCurrencyCode;
+    quoteCurrencyAmount?: number;
+    paymentMethod?: MoonpayPaymentMethod;
+    uiConfig?: {
+        accentColor?: string;
+        theme?: 'light' | 'dark';
+    };
+};
+type MoonpaySignRequest = {
+    address: string;
+    config: MoonpayConfig;
+    useSandbox: boolean;
+};
+type MoonpaySignResponse = {
+    signedUrl: string;
+    externalTransactionId: string;
+};
+
 declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github", "apple"];
 type OAuthProviderType = typeof SUPPORTED_OAUTH_PROVIDERS[number];
 /** @hidden */
@@ -469,6 +827,10 @@ interface LinkMetadata {
     /** Datetime when this account was linked to the user. */
     verifiedAt: Date;
 }
+type FundWalletConfig = {
+    config: MoonpayConfig;
+    provider?: 'moonpay';
+};
 /**
  * Object representation of a user's wallet.
  */
@@ -577,6 +939,20 @@ interface ConnectedWallet extends BaseConnectedWallet {
      * Throws a PrivyClientError if the wallet is not connected.
      */
     loginOrLink: () => Promise<void>;
+    /** Prompt the user to go through the fiat onramp flow.
+     *
+     *  This will open the modal with a prompt for the user to navigate to a third-party on-ramp provider.
+     *
+     *  Once the user continues to the on-ramp flow, Privy will display the on-ramp status screen, and wait
+     *  for the transaction to complete.
+     *
+     *  Note: Even after a successful funding, funds can take a few minutes to arrive in the user's wallet.
+     *
+     *  The current supported provider is Moonpay.
+     *
+     *  @param {FundWalletConfig} fundWalletConfig The configuration for the fiat onramp flow.
+     * **/
+    fund: (fundWalletConfig?: FundWalletConfig) => Promise<void>;
     /** Unlink this wallet to the authenticated user. Throws a PrivyClientError if the user is not
      * authenticated. */
     unlink: () => Promise<void>;
@@ -739,6 +1115,7 @@ type PrivyServerConfig = {
     customApiUrl?: string | null;
     walletConnectCloudProjectId?: string | null;
     embeddedWalletConfig: EmbeddedWalletsConfig;
+    fiatOnRampEnabled?: boolean;
     captchaEnabled?: boolean;
     /** May be deprecated from the server config in a future release */
     logoUrl?: string;
@@ -878,6 +1255,17 @@ type PrivyClientConfig = {
          */
         noPromptOnSignature?: boolean;
     };
+    /**
+     * Setting associated with fiat-on-ramp flows
+     */
+    fiatOnRamp?: {
+        /**
+         * Determines whether to use the sandbox flow.
+         *
+         * Defaults to false.
+         */
+        useSandbox?: boolean;
+    };
     /**
      * Override the default rendering settings, used for displaying in a non-modal setting.
      * For internal use only.
@@ -1074,99 +1462,16 @@ interface PrivyProviderProps {
  * This should wrap any components that will to use the Privy SDK via the {@link usePrivy} hook. As an example:
  *
  * ```typescript
- * // At your application root (e.g. `_app.tsx` in NextJS):
- * import {PrivyProvider} from '@privy-io/react-auth';
- *
- * <PrivyProvider appId="APP_ID_FROM_CONSOLE" onSuccess={() => console.log('Success!')}>
- *   <Component {...pageProps} />
- * </PrivyProvider>
- * ```
- *
- */
-declare const PrivyProvider: ({ config, ...props }: PrivyProviderProps) => JSX.Element;
-
-interface ConnectorManagerEvents {
-    walletsUpdated(): void;
-}
-/** @hidden */
-declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
-    walletConnectors: WalletConnector[];
-    initialized: boolean;
-    private storedConnections;
-    private activeWallet?;
-    private walletConnectCloudProjectId;
-    private rpcConfig;
-    constructor(walletConnectCloudProjectId: string, rpcConfig: RpcConfig);
-    /**
-     * The core wallets array that is exposed to developers. It builds
-     * the wallets away with the following logic:
-     *
-     * 1. Flatten all wallets from all connectors
-     * 2. Sorted by connectedAt
-     * 3. Active wallet is moved to front of array (if it exists)
-     */
-    get wallets(): BaseConnectedWallet[];
-    /**
-     * Detect and add all valid wallet connectors.
-     */
-    initialize(): void;
-    /**
-     * Helper function to find a wallet connector by connector type and wallet client type.
-     */
-    findWalletConnector(connectorType: ConnectorType, walletClientType: WalletClientType): WalletConnector | null;
-    /**
-     * Add any connectedAt overrides for newly initialized wallets and pass-through change events.
-     */
-    private onInitialized;
-    /**
-     * Save connection history and pass-through change events.
-     */
-    private onWalletsUpdated;
-    addEmbeddedWalletConnector(walletProxy: EmbeddedWalletProxy, address: string): void;
-    /**
-     * Normally, we do not remove connectors after creation. Privy embedded wallets are an exception
-     * because they are closely tied with an authenticated state.
-     */
-    removeEmbeddedWalletConnector(): void;
-    /**
-     * Creates a new wallet connector for the given connector type and wallet client type.
-     * If a connector already exists, it will be returned instead.
-     */
-    createWalletConnector(connectorType: ConnectorType, walletClientType: WalletClientType): Promise<WalletConnector | null>;
-    private addWalletConnector;
-    /**
-     * Upon initialization, loads previous connections from local storage. If local storage
-     * is misformatted (e.g. due to previous privy:connectors usage), it returns an empty array that
-     * will be overwritten later.
-     *
-     * @returns StoredConnection[] list of stored connections from previous session
-     */
-    private loadConnectionHistory;
-    /**
-     * Saves all current connections to local storage overridding any previous connections.
-     */
-    private saveConnectionHistory;
-    /**
-     * @deprecated **Deprecated**: This feature will be removed and should be replaced by
-     * interfacing with wallets directly (wallets[0].getEthereumProvider()).
-     *
-     * Build an Ethereum provider for the most recently connected wallet.
-     */
-    getEthereumProvider: () => EIP1193Provider;
-    /**
-     * @deprecated **Deprecated**: This feature will be removed and should be replaced by
-     * interfacing with `wallets` directly.
-     *
-     * Performing personal_sign with the most recently connected wallet.
-     * If there is not a wallet connected, return null.
-     */
-    activeWalletSign(message: string): Promise<string | null>;
-    /**
-     * @deprecated **Deprecated**: This feature will be removed and should be replaced by
-     * interfacing with `wallets` directly.
-     */
-    setActiveWallet(address: string): void;
-}
+ * // At your application root (e.g. `_app.tsx` in NextJS):
+ * import {PrivyProvider} from '@privy-io/react-auth';
+ *
+ * <PrivyProvider appId="APP_ID_FROM_CONSOLE" onSuccess={() => console.log('Success!')}>
+ *   <Component {...pageProps} />
+ * </PrivyProvider>
+ * ```
+ *
+ */
+declare const PrivyProvider: ({ config, ...props }: PrivyProviderProps) => JSX.Element;
 
 /**
  * Allows you to manage the user's current authentication state and access their linked accounts.
@@ -1402,9 +1707,10 @@ interface PrivyInterface {
      *
      * @param data {@link UnsignedTransactionRequest} transaction to be sent
      * @param uiOptions {@link SendTransactionModalUIOptions} (optional) UI options to customize the transaction request modal
+     * @param fundWalletConfig {@link FundWalletConfig} (optional) Configuration surrounding funding the wallet (if enabled), in the case of insufficient funds
      * @returns Promise for the transaction's {@link TransactionReceipt}
      */
-    sendTransaction: (data: UnsignedTransactionRequest, uiOptions?: SendTransactionModalUIOptions) => Promise<TransactionReceipt>;
+    sendTransaction: (data: UnsignedTransactionRequest, uiOptions?: SendTransactionModalUIOptions, fundWalletConfig?: FundWalletConfig) => Promise<TransactionReceipt>;
     /**
      * Shows the user a Privy modal, from which they can copy their embedded wallet's private
      * key for easy export to another wallet client (e.g. MetaMask). The private key is loaded
@@ -1436,252 +1742,6 @@ declare function useWallets(): UseWalletsInterface;
 
 declare const VERSION: string;
 
-interface ResponseEmailAccount {
-    type: 'email';
-    address: string;
-    verified_at: number;
-}
-interface ResponsePhoneAccount {
-    type: 'phone';
-    phoneNumber: string;
-    verified_at: number;
-}
-interface ResponseEthereumAccount {
-    type: 'wallet';
-    address: string;
-    /**
-     * @deprecated This will be removed in favor of the CAIP-2 formatted chain_id field.
-     *
-     * Chain type of the wallet address.
-     */
-    chain_type: 'ethereum';
-    chain_id?: string;
-    /**
-     * @deprecated Use `wallet_client_type` instead.
-     */
-    wallet_client: 'privy' | 'unknown';
-    wallet_client_type?: string;
-    connector_type?: string;
-    recovery_method?: 'privy' | 'user-passcode';
-    verified_at: number;
-}
-interface ResponseOAuthGoogle {
-    type: 'google_oauth';
-    subject: string;
-    email: string;
-    name: string | null;
-    verified_at: number;
-}
-interface ResponseOAuthTwitter {
-    type: 'twitter_oauth';
-    subject: string;
-    username: string | null;
-    name: string | null;
-    verified_at: number;
-}
-interface ResponseOAuthDiscord {
-    type: 'discord_oauth';
-    subject: string;
-    username: string | null;
-    email: string | null;
-    verified_at: number;
-}
-interface ResponseOAuthGithub {
-    type: 'github_oauth';
-    subject: string;
-    username: string | null;
-    name: string | null;
-    email: string | null;
-    verified_at: number;
-}
-interface ResponseOAuthApple {
-    type: 'apple_oauth';
-    subject: string;
-    email: string;
-    verified_at: number;
-}
-interface ResponseCustomJwtAccount {
-    type: 'custom_auth';
-    custom_user_id: string;
-    verified_at: number;
-}
-type LinkedAccountsResponseType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub | ResponseOAuthApple | ResponseCustomJwtAccount>;
-interface GetCurrentUserResponse {
-    id: string;
-    created_at: number;
-    linked_accounts: LinkedAccountsResponseType;
-}
-
-interface DefaultsType {
-    baseURL: string;
-    timeout: number;
-}
-/**
- * A raw http handler for making requests to the Privy API. It requires a Session
- * object, which is used for fetching and including any tokens that are required
- * for requests.
- *
- * Should not be used for external requests, as we attach a good deal of metadata to requests.
- */
-declare class Http {
-    fallbackApiUrl: string;
-    private appId;
-    private client;
-    private defaults;
-    private sdkVersion;
-    private baseFetch;
-    constructor(appId: string, client: PrivyClient, defaults: DefaultsType);
-    get<T = any>(path: string, config?: FetchOptions<'json'>): Promise<T>;
-    post<T = any, D = any>(path: string, data?: D, config?: FetchOptions<'json'>): Promise<T>;
-    delete<T = any>(path: string, config?: FetchOptions<'json'>): Promise<T>;
-}
-
-/**
- * Valid /session and <>/authenticate calls will respond with a token
- * as well as a valid user object for streamlining.
- */
-interface ValidSessionResponse {
-    user: GetCurrentUserResponse;
-    token: string;
-    refresh_token: string | null;
-    is_new_user?: boolean;
-}
-
-type AuthMeta = {
-    [key: string]: any;
-};
-/**
- * An auth flow is an encapsulation of the business logic required for a given
- * authentication process. It requires at least one definitive `authenticate`
- * method that does the final token handshaking with the API, but may also
- * include any number of methods/API calls necessary to set up the state (e.g.
- * sending an email before being able to do a passwordless code login)
- */
-interface AuthFlow {
-    api?: Http;
-    /**
-     * Any meta information necessary for the auth flow, that may also need to be
-     * shared out to things like frontend components for displaying state of the
-     * auth flow
-     */
-    meta: AuthMeta;
-    /**
-     * Handles the API authentication call(s) to log users in.
-     * Any preconditions must be addressed prior to calling
-     */
-    authenticate(): Promise<ValidSessionResponse>;
-    /**
-     * Handles the API link call(s) to link new user accounts.
-     * Requires user to already be logged in when called.
-     * Any preconditions must be addressed prior to calling
-     */
-    link(): Promise<GetCurrentUserResponse>;
-}
-
-/**
- * This should not be directly used by developers at the moment,
- * so we doc-ignore it.
- * @ignore
- *
- */
-declare class PrivyClient {
-    private api;
-    private appId;
-    private session;
-    private timeout;
-    private clientAnalyticsId;
-    useServerCookies: boolean;
-    apiUrl: string;
-    fallbackApiUrl: string;
-    authFlow?: AuthFlow;
-    connectors?: ConnectorManager;
-    /**
-     * Creates a new Privy client.
-     * @param options Initialization options.
-     */
-    constructor(options: {
-        /**
-         * The URL of the Privy API. Defaults to `https://api.privy.io/v0`.
-         */
-        apiUrl?: string;
-        /**
-         * The app id from your console
-         */
-        appId: string;
-        /**
-         * Time in milliseconds after which to timeout requests to the API. Defaults to `10000` (10 seconds).
-         */
-        timeout?: number;
-    });
-    /**
-     * ConnectorManager initialization is deferred because the input parameter may be overridden by the server
-     * config. We can set this once and only once. If it is set twice, event listeners will be created
-     * on the first ConnectorManager and are not re-created.
-     */
-    initializeConnectorManager(walletConnectCloudProjectId: string, rpcConfig: RpcConfig): void;
-    generateApi(): Http;
-    /**
-     * In the case of cookie-based auth, re-initialize the http client with the custom api url.
-     * @param customApiUrl the custom api url to use for cookie-based authFlow
-     */
-    updateApiUrl(customApiUrl?: string | null): void;
-    authenticate(): Promise<{
-        user: User | null;
-        isNewUser?: boolean | undefined;
-    }>;
-    link(): Promise<User | null>;
-    logout(): Promise<void>;
-    startAuthFlow(authFlow: AuthFlow): void;
-    unlinkEmail(address: string): Promise<User>;
-    unlinkPhone(phoneNumber: string): Promise<User>;
-    unlinkWallet(address: string): Promise<User>;
-    unlinkOAuth(provider: OAuthProviderType, subject: string): Promise<User>;
-    createAnalyticsEvent(eventName: string, payload?: {
-        [key: string]: any;
-    }, timestamp?: Date): Promise<void>;
-    /** DATA METHODS */
-    /**
-     * Fetches the currently authenticed user from the API or
-     * returns null if the user is not authenticated.
-     *
-     * This will refresh the user's access token and rotate
-     * the refresh token if needed.
-     *
-     * @returns Promise<User | null>
-     */
-    getAuthenticatedUser(): Promise<User | null>;
-    /**
-     * Grab the Privy access token for the currently logged in user. Verifies that the
-     * token has a valid signature, was issued by 'privy.io', and corresponds to the
-     * current app ID. If no valid token is found, this method will force a logout and return null.
-     *
-     * If the token is expired or expiring soon, this will attempt to
-     * first refresh the access token to ensure that the token is active. You can
-     * disable this behavior using `disableAutoRefresh`, although it is not
-     * recommended.
-     *
-     * @param disableAutoRefresh not recommended - optionally disable automatic
-     * token refresh when the token is
-     *
-     * @returns Promise<string | null>
-     */
-    getAccessToken(options?: {
-        disableAutoRefresh?: boolean;
-    }): Promise<string | null>;
-    getServerConfig(): Promise<PrivyServerConfig>;
-    getUsdTokenPrice(chainId: string | number): Promise<number | undefined>;
-    /**
-     * Get a short-lived token to start a new Privy session from the existing authenticated session.
-     *
-     * Rotates the access token and refresh token.
-     * Raises an exception if the current session was already forked from a previous session,
-     * or if the current session is not authenticated.
-     *
-     * @returns Promise<string>
-     */
-    forkSession(): Promise<string>;
-}
-
 type CallbackError = (error: PrivyErrorCode) => void;
 type PrivyEvents = {
     login: {
@@ -1774,4 +1834,4 @@ declare function useConnectWallet(callbacks?: PrivyEvents['connectWallet']): {
     connectWallet: () => void;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, SUPPORTED_CHAINS, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useLogin, useLogout, usePrivy, useWallets };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, SUPPORTED_CHAINS, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useLogin, useLogout, usePrivy, useWallets };