@privy-io/react-auth 1.74.1 → 1.75.0-beta-20240715213704

package/dist/index.d.ts

@@ -510,7 +510,8 @@ declare enum PrivyErrorCode {
     USER_LIMIT_REACHED = "max_accounts_reached",
     DISALLOWED_LOGIN_METHOD = "disallowed_login_method",
     PASSKEY_NOT_ALLOWED = "passkey_not_allowed",
-    USER_DOES_NOT_EXIST = "user_does_not_exist"
+    USER_DOES_NOT_EXIST = "user_does_not_exist",
+    INSUFFICIENT_BALANCE = "insufficient_balance"
 }
 
 declare class WalletTimeoutError extends PrivyConnectorError {
@@ -1227,6 +1228,10 @@ declare class PrivyClient {
  * 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';
+type MoonpayUiConfig = {
+    accentColor?: string;
+    theme?: 'light' | 'dark';
+};
 /**
  * Cryptocurrency codes for the MoonPay fiat on-ramp. These codes
  * follow the format {TOKEN_NAME}_{NETWORK_NAME}.
@@ -1239,10 +1244,7 @@ type MoonpayConfig = {
     currencyCode?: MoonpayCurrencyCode;
     quoteCurrencyAmount?: number;
     paymentMethod?: MoonpayPaymentMethod;
-    uiConfig?: {
-        accentColor?: string;
-        theme?: 'light' | 'dark';
-    };
+    uiConfig?: MoonpayUiConfig;
 };
 type MoonpaySignRequest = {
     address: string;
@@ -1314,6 +1316,9 @@ interface LinkMetadata {
 type FundWalletConfig = {
     config: MoonpayConfig;
     provider?: 'moonpay';
+} | {
+    chain?: Chain;
+    amount?: string;
 };
 /**
  * Possible methods of user-driven recovery.
@@ -1464,18 +1469,19 @@ 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.
+    /**
+     * Prompt the user to go through the funding flow and for the connected wallet.
      *
-     *  This will open the modal with a prompt for the user to navigate to a third-party on-ramp provider.
+     * This will open the modal with a prompt for the user to select a funding method (if multiple are enabled).
      *
-     *  Once the user continues to the on-ramp flow, Privy will display the on-ramp status screen, and wait
-     *  for the transaction to complete.
+     * Once the user continues to the funding flow, Privy will display the funding 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.
+     * 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.
+     * Privy currently supports funding via external wallets and Moonpay.
      *
-     *  @param {FundWalletConfig} fundWalletConfig The configuration for the fiat onramp flow.
+     *  @param {FundWalletConfig} fundWalletConfig Funding configuration to specify chain and funding amount (if enabled)
      * **/
     fund: (fundWalletConfig?: FundWalletConfig) => Promise<void>;
     /** Unlink this wallet to the authenticated user. Throws a PrivyClientError if the user is not
@@ -1825,6 +1831,19 @@ type TelegramAuthConfiguration = {
     linkEnabled: boolean;
     seamlessAuthEnabled: boolean;
 };
+type FundingMethod = 'moonpay' | 'coinbase-onramp' | 'external';
+type FundingConfig = {
+    /** The recommended currency for the user to fund.  Note: to begin with we default to the chain's native currency. */
+    defaultRecommendedCurrency: {
+        chain: string;
+    };
+    /** The recommended amount of the specified currency to fund, in human readable format (eg '0.1') */
+    defaultRecommendedAmount: string;
+    /** The list of funding methods enabled for the app */
+    methods: FundingMethod[];
+    /** Whether to prompt the user to fund upon embedded wallet creation */
+    promptFundingOnWalletCreation: boolean;
+};
 type PrivyServerConfig = {
     id?: string;
     name?: string;
@@ -1866,6 +1885,7 @@ type PrivyServerConfig = {
     accentColor?: string;
     mfaMethods?: Array<MfaMethod>;
     telegramAuthConfiguration?: TelegramAuthConfiguration;
+    fundingConfig?: FundingConfig;
 };
 type HexColor = `#${string}`;
 /**
@@ -2204,6 +2224,7 @@ interface PrivyClientConfig {
         noPromptOnMfaRequired?: boolean;
     };
     /**
+     * @deprecated. Use `fundingMethodConfigurations -> moonpay -> useSandbox` instead.
      * Setting associated with fiat-on-ramp flows
      */
     fiatOnRamp?: {
@@ -2214,6 +2235,31 @@ interface PrivyClientConfig {
          */
         useSandbox?: boolean;
     };
+    /**
+     * Settings associated with funding methods
+     */
+    fundingMethodConfig?: {
+        moonpay: {
+            /**
+             * Determines whether to use the Moonpay sandbox flow.
+             *
+             * Defaults to false.
+             */
+            useSandbox?: boolean;
+            /**
+             * Determines the payment method for each Moonpay transaction.
+             *
+             * Defaults to Moonpay's default.
+             */
+            paymentMethod?: MoonpayPaymentMethod;
+            /**
+             * Determines the UI settings for each Moonpay transaction.
+             *
+             * Defaults to Moonpay's default.
+             */
+            uiConfig?: MoonpayUiConfig;
+        };
+    };
 }
 interface AllowlistConfig {
     errorTitle: string | null;
@@ -2426,6 +2472,9 @@ type PrivyFarcasterSignerInitResponse = {
     public_key: string;
     status: 'revoked';
 };
+type RuntimeLoginOverridableOptions = {
+    loginMethods?: PrivyClientConfig['loginMethods'];
+};
 
 declare function getAccessToken(): Promise<string | null>;
 /**
@@ -2524,8 +2573,9 @@ interface PrivyInterface {
     } | MouseEvent<any, any>) => void;
     /**
      * Opens the Privy login modal and prompts the user to login.
+     * @param options.loginMethods {LoginMethod[]} custom login methods to display in the login modal. This will overwrite the value provider to the client config.
      */
-    login: () => void;
+    login: (options?: RuntimeLoginOverridableOptions | MouseEvent<any, any>) => void;
     /**
      * Opens the Privy login modal and prompts the user to login or connect a wallet.
      */
@@ -2988,7 +3038,7 @@ 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
+     * @param fundWalletConfig {@link FundWalletConfig} (optional) Funding configuration to specify chain and funding amount (if enabled), in the case of insufficient funds
      * @returns Promise for the transaction's {@link TransactionReceipt}
      */
     sendTransaction: (data: UnsignedTransactionRequest, uiOptions?: SendTransactionModalUIOptions, fundWalletConfig?: FundWalletConfig) => Promise<TransactionReceipt>;
@@ -3408,7 +3458,7 @@ declare function useLogin(callbacks?: PrivyEvents['login']): {
     /**
      * Opens the Privy login modal and prompts the user to login.
      */
-    login: () => void;
+    login: (options?: RuntimeLoginOverridableOptions | react.MouseEvent<any, any> | undefined) => void;
 };
 
 /**
@@ -3717,24 +3767,24 @@ declare function useCreateWallet(callbacks?: PrivyEvents['createWallet']): {
 };
 
 /**
- * Method to fund a user's wallet via Privy's fiat on-ramp integration by inputting a valid wallet address.
+ * Method to fund a user's wallet via Privy's funding feature by inputting a valid wallet address.
  * You can access the fields and methods documented here via the {@link useFundWallet} hook.
  */
 interface UseFundWalletInterface {
     /**
-     * Prompt the user to go through the fiat onramp flow and fund the specified wallet.
+     * Prompt the user to go through the funding flow and for a specified wallet.
      *
-     * This will open the modal with a prompt for the user to navigate to a third-party on-ramp provider.
+     * This will open the modal with a prompt for the user to select a funding method (if multiple are enabled).
      *
-     * Once the user continues to the on-ramp flow, Privy will display the on-ramp status screen, and wait
+     * Once the user continues to the funding flow, Privy will display the funding 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.
+     * Privy currently supports funding via external wallets and Moonpay.
      *
      * @param address typed data payload to be signed
-     * @param fundWalletConfig {@link FundWalletConfig} (optional) options to customize the wallet fund modal
+     * @param fundWalletConfig {@link FundWalletConfig} Funding configuration to specify chain and funding amount (if enabled)
      */
     fundWallet: (address: string, fundWalletConfig?: FundWalletConfig) => Promise<void>;
 }