@privy-io/react-auth 1.91.0 → 1.92.0

package/dist/dts/useSolanaWallets.d.ts

@@ -1,322 +0,0 @@
-import { TransactionResponse } from '@ethersproject/providers';
-import { aH as PrivyErrorCode, U as User, L as LoginMethod, aI as LinkedAccountWithMetadata, O as OAuthTokens, f as BaseConnectedWallet, s as Wallet, w as MfaMethod, aJ as UserRecoveryMethod, D as SolanaTransactionReceipt, C as Chain, aK as FundingMethod, a5 as SolanaCluster, aE as ConnectedSolanaWallet } from './types.js';
-
-/**
- * `CallbackError` optionally includes a second parameter with further error details.
- */
-type CallbackError<Details extends Record<string, any> | undefined = undefined> = Details extends Record<string, any> ? (error: PrivyErrorCode, details: Details) => void : (error: PrivyErrorCode) => void;
-interface PrivyEvents {
-    login: {
-        /**
-         * Callback that will execute once a `login` flow successfully completes.
-         * - If `config.embeddedWallets.createOnLogin` is set to 'off' or a wallet creation flow is not applicable,
-         *   this will run after the user successfully authenticates.
-         * - If `config.embeddedWallets.createOnLogin` is set to 'users-without-wallets' or 'all-users',
-         *   this will run after the user successfully authenticates _and_ creates their wallet (if applicable).
-         * - If a user is already authenticated, this will run immediately and the `wasAlreadyAuthenticated` flag will be set to `true`.
-         *
-         * @param user {@link User} the `user` oject corresponding to the authenticated user
-         * @param isNewUser {boolean} boolean flag indicating if this is the user's first time logging in to your app
-         * @param wasAlreadyAuthenticated {boolean} - boolean flag indicating whether the user entered the application already authenticated
-         * @param loginMethod {string} - the method used by the user to login
-         * @param loginAccount - the account corresponding to the loginMethod used
-         */
-        onComplete?: (user: User, isNewUser: boolean, wasAlreadyAuthenticated: boolean, loginMethod: LoginMethod | null, loginAccount: LinkedAccountWithMetadata | null) => void;
-        /**
-         * @experimental
-         *
-         * Callback that will execute once a successful OAuth login flow completes.
-         * This will only run in the case of an OAuth login flow.
-         *
-         * This will always be called before `onComplete` in the case of an OAuth login flow.
-         * If you will be doing anything after the user is logged in (e.g. sending data to your API or redirecting to an authenticated route), you should wait for `onComplete` to run.
-         *
-         * @param oAuthTokens {@link OAuthTokens} - the OAuth tokens returned from the OAuth provider
-         */
-        onOAuthLoginComplete?: (oAuthTokens: OAuthTokens) => void;
-        /**
-         * Callback that will execute in the case of a non-successful login.
-         *
-         * @param error {@link PrivyErrorCode} - the corresponding error code
-         *
-         */
-        onError?: CallbackError;
-    };
-    logout: {
-        /**
-         * Callback that will execute when a user successfully logs out.
-         */
-        onSuccess?: () => void;
-    };
-    connectWallet: {
-        /**
-         * Callback that will execute once a successful `connectWallet` completes.
-         * This will not run in the case of a wallet-based authentication or link flow.
-         *
-         * @param wallet {@link BaseConnectedWallet} the `wallet` object correspending to the connection
-         */
-        onSuccess?: (wallet: BaseConnectedWallet) => void;
-        /**
-         * Callback that will execute in the case of a non-successful wallet connection.
-         *
-         * @param error {@link PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    createWallet: {
-        /**
-         * Callback that will execute once on a successful embedded wallet creation.
-         * This will run when `createWallet` is called manually, or when `config.embeddedWallets.createOnLogin` triggers
-         * an automatic wallet creation.
-         *
-         * @param wallet {@link BaseConnectedWallet}- the created `wallet` object
-         *
-         */
-        onSuccess?: (wallet: Wallet) => void;
-        /**
-         * Callback that will execute in the case of a non-successful wallet creation.
-         *
-         * @param error {@link PrivyErrorCode} - the corresponding error code
-         *
-         */
-        onError?: CallbackError;
-    };
-    linkAccount: {
-        /**
-         * Callback that will execute once on a successful linking of a new account/login method.
-         * This will run when any of the 'link' methods are called manually.
-         * @param user {@link User}- the user the account was linked to
-         * @param linkMethod {@link LoginMethod}- the type of linked account
-         * @param linkedAccount - the newly linked account
-         */
-        onSuccess?: (user: User, linkMethod: LoginMethod, linkedAccount: LinkedAccountWithMetadata) => void;
-        /**
-         * Callback that will execute in the case of a non-successful account linking.
-         *
-         * @param error {PrivyErrorCode} - the corresponding error code
-         * @param details.linkMethod {LoginMethod} - the type of (attempted) linked account
-         *
-         */
-        onError?: CallbackError<{
-            linkMethod: LoginMethod;
-        }>;
-    };
-    update: {
-        /**
-         * Callback that will execute once on a successful updating of an account.
-         * This will run when any of the 'updateAccount' methods are called manually.
-         * @param user {@link User}- the user the account was linked to
-         * @param updateMethod {@link LoginMethod}- the type of updated account
-         * @param updatedAccount - the newly updated account
-         */
-        onSuccess?: (user: User, updateMethod: LoginMethod, updatedAccount: LinkedAccountWithMetadata) => void;
-        /**
-         * Callback that will execute in the case of a non-successful account linking.
-         *
-         * @param error {PrivyErrorCode} - the corresponding error code
-         * @param details.linkMethod {LoginMethod} - the type of (attempted) linked account
-         *
-         */
-        onError?: CallbackError<{
-            linkMethod: LoginMethod;
-        }>;
-    };
-    configureMfa: {
-        /**
-         * Callback that will execute when MFA is required to complete a given action.
-         * @param mfaMethods {@link MfaMethod[]} - List of MFA methods that the user can choose from
-         */
-        onMfaRequired: (mfaMethods: MfaMethod[]) => void;
-    };
-    setWalletPassword: {
-        /**
-         * Callback that will execute once a successful `setWalletPassword` completes.
-         * @param  wallet {@link Wallet}- the `wallet` object that the password was set for
-         */
-        onSuccess?: (wallet: Wallet) => void;
-        /**
-         * Callback that will execute in the case of a non-successful setWalletPassword.
-         *
-         * @param error {PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    setWalletRecovery: {
-        /**
-         * Callback that will execute once a successful `setWalletRecovery` completes.
-         * @param  wallet {@link Wallet}- the `walle]et` object that the recovery was set for
-         */
-        onSuccess?: (method: UserRecoveryMethod, wallet: Wallet) => void;
-        /**
-         * Callback that will execute in the case of a non-successful setWalletRecovery.
-         *
-         * @param error {PrivyErrorCode} - the corresponding error code
-         */
-        onError?: CallbackError;
-    };
-    signMessage: {
-        /**
-         * Callback that will execute once a successful `signMessage` completes.
-         * This will not run in the case of a wallet-based authentication or link flow.
-         * @param signature - the signature (type string) of the embedded wallet used to sign message
-         */
-        onSuccess?: (signature: string) => void;
-        /**
-         * Callback that will execute in the case of a non-successful signMessage.
-         *
-         * @param error {@link PrivyErrorCode} - the corresponding error code
-         *  */
-        onError?: CallbackError;
-    };
-    signTypedData: {
-        /**
-         * Callback that will execute once a successful `signTypedData` completes.
-         * @param signature - the signature (type string) of the embedded wallet used to sign
-         */
-        onSuccess?: (signature: string) => void;
-        /**
-         * Callback that will execute in the case of a non-successful signTypedData.
-         *
-         * @param error {@link PrivyErrorCode} - the corresponding error code
-         *  */
-        onError?: CallbackError;
-    };
-    sendTransaction: {
-        /**
-         * Callback that will execute once a successful `sendTransaction` completes.
-         * This will not run in the case of a wallet-based authentication or link flow.
-         * @param response - the response (type TransactionResponse https://docs.ethers.org/v5/api/providers/types/#providers-TransactionResponse) from the successful transaction
-         */
-        onSuccess?: (response: TransactionResponse) => void;
-        /**
-         * Callback that will execute in the case of a non-successful sendTransaction.
-         *
-         * @param error {@link PrivyErrorCode} - the corresponding error code
-         *  */
-        onError?: CallbackError;
-    };
-    sendSolanaTransaction: {
-        /**
-         * Callback that will execute once a successful `sendSolanaTransaction` completes.
-         * This will not run in the case of a wallet-based authentication or link flow.
-         * @param response - the response {@link https://solana-labs.github.io/solana-web3.js/types/ParsedTransactionMeta.html SolanaTransactionReceipt} from the successful transaction
-         */
-        onSuccess?: (response: SolanaTransactionReceipt) => void;
-        /**
-         * Callback that will execute in the case of a non-successful sendTransaction.
-         *
-         * @param error {@link PrivyErrorCode} - the corresponding error code
-         *  */
-        onError?: CallbackError;
-    };
-    accessToken: {
-        /**
-         * Callback that will execute when a user's access token is granted.
-         * @param accessToken - The user's access token
-         */
-        onAccessTokenGranted: (accessToken: string) => void;
-        /**
-         * Callback that will execute when a user's access token is removed.
-         */
-        onAccessTokenRemoved: () => void;
-    };
-    oAuthAuthorization: {
-        /**
-         * Callback that will execute when a user successfully authorizes an OAuth flow.
-         *
-         * @param oAuthTokens {@link OAuthTokens} - the OAuth tokens returned from the OAuth provider:
-         * @param oAuthTokens.provider - {string}  The OAuth provider type.
-         * @param oAuthTokens.accessToken - {string} The OAuth access token.
-         * @param oAuthTokens.accessTokenExpiresInSeconds - {number} (optional) The number of seconds until the OAuth access token expires.
-         * @param oAuthTokens.refreshToken - {string} (optional) The OAuth refresh token.
-         * @param oAuthTokens.refreshTokenExpiresInSeconds - {number} (optional) The number of seconds until the OAuth refresh token expires.
-         * if the refresh token is present and this field is undefined, it is assumed
-         * that the refresh token does not have an expiration date.
-         * @param oAuthTokens.scopes -  {string[]} (optional) The list of OAuth scopes the access token is approved for.
-         *
-         * @param o.user {@link User} (optional) The list of OAuth scopes the access token is approved for.
-         */
-        onOAuthTokenGrant: (oAuthTokens: OAuthTokens, o: {
-            user: User;
-        }) => void;
-    };
-    fundWallet: {
-        /**
-         * Callback that will execute when a funding flow is exited. This fires when a user closes a funding flow modal, for any reason.
-         *
-         * @param fundingMethod {@link FundingMethod} The funding method associated with the flow at time of exit. If the user had not yet selected
-         * @param balance {@link BigNumber} The value for the funded wallet at the point of user exit.
-         * a recovery method, this will be null.
-         */
-        onUserExited?: (o: {
-            address: string;
-            chain: Chain;
-            fundingMethod: FundingMethod | 'manual' | null;
-            balance: bigint | undefined;
-        }) => void;
-    };
-    fundSolanaWallet: {
-        /**
-         * Callback that will execute when a funding flow is exited. This fires when a user closes a funding flow modal, for any reason.
-         *
-         * @param fundingMethod {@link FundingMethod} The funding method associated with the flow at time of exit. If the user had not yet selected
-         * @param balance {@link BigNumber} The value for the funded wallet at the point of user exit.
-         * a recovery method, this will be null.
-         */
-        onUserExited?: (o: {
-            address: string;
-            cluster: SolanaCluster;
-            fundingMethod: FundingMethod | 'manual' | null;
-            balance: bigint | undefined;
-        }) => void;
-    };
-    customAuth: {
-        /**
-         * Callback that will execute when Privy successfully exchanges a custom auth JWT for a Privy JWT
-         * @param o.user - The Privy user
-         */
-        onAuthenticated: (o: {
-            user: User;
-        }) => void;
-        /**
-         * Callback that will execute when Privy detects a user is logged out from the third-party auth system, and correspondingly logs the user out.
-         */
-        onUnauthenticated: () => void;
-    };
-}
-
-/**
- * Hook to create and interact with Solana wallets. This currently only supports an embedded Solana wallet and no
- * external wallets.
- *
- * @returns wallets {ConnectedSolanaWallet[]} an array of connected Solana wallets
- * @returns createWallet {() => Promise<Wallet>} an method to create an embedded Solana wallet.
- */
-interface UseSolanaWalletsInterface {
-    /**
-     * An array of the connected Solana wallets for the user. Currently, this will only contain the embedded
-     * Solana wallet if the user has created one.
-     */
-    wallets: ConnectedSolanaWallet[];
-    /**
-     * Method to create an embedded Solana wallet for a user. This method will throw an error if the user already has an
-     * embedded Solana or Ethereum wallet. Currently, only embedded Solana wallets with automatic recovery are supported.
-     * @returns wallet {Wallet} the Solana linked account for the user.
-     */
-    createWallet: () => Promise<Wallet>;
-    /**
-     * Shows the user a Privy modal, from which they can copy their embedded solana wallet's private
-     * key for easy export to another wallet client (e.g. Phantom, Backpack). The private key is loaded
-     * on an iframe running on a separate domain from your app, meaning your app cannot access it.
-     *
-     * This method will error if the user is not authenticated or does not have an embedded solana wallet.
-     * @param options {@link {address: string}} (optional) wallet address to export the private key for
-     * @returns Promise that resolves once the user exits the modal
-     */
-    exportWallet: (options?: {
-        address: string;
-    }) => Promise<void>;
-}
-declare const useSolanaWallets: () => UseSolanaWalletsInterface;
-
-export { type CallbackError as C, type PrivyEvents as P, type UseSolanaWalletsInterface as U, useSolanaWallets as u };