@privy-io/react-auth 1.58.0 → 1.58.1-beta-20240304170528

package/dist/index.d.ts

@@ -2906,6 +2906,30 @@ declare function useCreateWallet(callbacks?: PrivyEvents['createWallet']): {
     createWallet: () => Promise<Wallet>;
 };
 
+/**
+ * Allows you to fund a user's wallets.
+ * 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.
+     *
+     * 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 address {string} typed data payload to be signed
+     * @param fundWalletConfig {@link FundWalletConfig} (optional) options to customize the wallet fund modal
+     */
+    fundWallet: (address: string, fundWalletConfig?: FundWalletConfig) => Promise<void>;
+}
+declare const useFundWallet: () => UseFundWalletInterface;
+
 /**
  * Use this hook to send a transaction using the embedded wallet and to attach callbacks for success and errors.
  * Note that the callbacks will only fire for explicit sendTransaction calls from the Privy SDK.
@@ -3044,4 +3068,4 @@ declare function addRpcUrlOverrideToChain(chain: Chain, rpcUrl: string): {
     testnet?: boolean | undefined;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Farcaster, FarcasterWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginMethodOrderOption, LoginWithCode, MessageTypes, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, TypedMessage, UnsignedTransactionRequest, UseLoginWithEmail, UseLoginWithSms, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, WalletWithMetadata, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, useConnectWallet, useCreateWallet, useLogin, useLoginWithEmail, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, usePrivy, useRegisterMfaListener, useSendTransaction, useSetWalletPassword, useSignMessage, useSignTypedData, useToken, useWallets };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Farcaster, FarcasterWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginMethodOrderOption, LoginWithCode, MessageTypes, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, TypedMessage, UnsignedTransactionRequest, UseLoginWithEmail, UseLoginWithSms, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, WalletWithMetadata, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, useConnectWallet, useCreateWallet, useFundWallet, useLogin, useLoginWithEmail, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, usePrivy, useRegisterMfaListener, useSendTransaction, useSetWalletPassword, useSignMessage, useSignTypedData, useToken, useWallets };