@privy-io/react-auth 1.31.0-beta.8 → 1.31.0-beta.9

package/dist/index.d.ts

@@ -782,31 +782,123 @@ interface EmbeddedWalletsConfig {
     createOnLogin: EmbeddedWalletCreateOnLoginConfig;
     requireUserPasswordOnCreate: boolean;
 }
+/**
+ * UI configuration object for the embedded wallet's Sign Message screen
+ */
 type SignMessageModalUIOptions = {
+    /**
+     * Title for the Sign Message screen. Defaults to 'Sign'.
+     */
     title?: string;
+    /**
+     * Description text for the Sign Message screen. Defaults to
+     * 'Sign to continue'.
+     */
     description?: string;
+    /**
+     * Text for the CTA button on the Sign Message screen. Defaults to
+     * 'Sign and Continue'
+     */
     buttonText?: string;
 };
-type SendTransactionModalTransactionInfo = {
+/**
+ * UI customization object for additional transaction details. Will be shown
+ * in an expandable accordion in the Send Transaction screen.
+ */
+type TransactionUIOptions = {
+    /**
+     * Title for the transaction details accordion within the
+     * Send Transaction screen. Defaults to 'Details'.
+     */
+    title?: string;
+    /**
+     * Action that the user is taking when sending this transaction. This
+     * should be short (<4 words, e.g. 'Buy NFT'). Will be shown inside
+     * the transaction details accordion in Send Transaction screen.
+     */
+    action?: string;
+    /**
+     * If the transaction to be sent is a call to a smart contract, you may
+     * use this object to fill in additional details about the contract being called.
+     */
+    contractInfo?: ContractUIOptions;
+    /**
+     * @deprecated Use `description` in `SendTransactionModalUIOptions` instead.
+     */
     description?: string;
-    action: string;
-    actionDescription: string;
+    /**
+     * @deprecated Use `title` instead.
+     */
+    actionDescription?: string;
 };
-type SenderInfo = {
+/**
+ * If the transaction to be sent is a call to a smart contract, you may use this
+ * object to fill in additional details about the contract being called.
+ */
+type ContractUIOptions = {
+    /**
+     * URL with more information about the smart contract.
+     */
     url: string;
+    /**
+     * Name of smart contract being called.
+     */
     name: string;
-    actionText: string;
+    /**
+     * URL for an image to show in the Send Transaction screen.
+     */
     imgUrl?: string;
+    /**
+     * Alt text for the image in the Send Transaction screen, if a
+     * valid `imgUrl` is set.
+     */
     imgAltText?: string;
+    /**
+     * Size for the image in the Send Transaction screen, if a valid
+     * `imgUrl` is set.
+     */
     imgSize?: 'sm' | 'lg';
+    /**
+     * @deprecated Use `description` in `SendTransactionModalUIOptions` instead.
+     */
+    actionText?: string;
 };
+/**
+ * UI customization object for the embedded wallet's Send Transaction screen
+ */
 type SendTransactionModalUIOptions = {
-    modalTitle?: string;
-    title?: string;
+    /**
+     * Text to display at top of Send Transaction screen. Defaults to
+     * 'Review transaction' or 'Send <token symbol>' if transaction is a simple
+     * token transfer.
+     */
+    header?: string;
+    /**
+     * Description of the transaction being sent.
+     */
     description?: string;
+    /**
+     * Text to show on CTA button for Send Transaction screen. Defaults to
+     * 'Submit'.
+     */
     buttonText?: string;
-    senderInfo?: SenderInfo;
-    transactionInfo?: SendTransactionModalTransactionInfo;
+    /**
+     * Details about the transaction that the user will send. Will be shown
+     * in an accordion in the Send Transaction screen.
+     */
+    transactionInfo?: TransactionUIOptions;
+    /**
+     * @deprecated Use `header` instead.
+     */
+    title?: string;
+    /**
+     * @deprecated Use `header` instead.
+     */
+    modalTitle?: string;
+    /**
+     * @deprecated Use `transactionInfo.contractInfo` instead.
+     */
+    senderInfo?: ContractUIOptions;
 };
 
 declare function getAccessToken(): Promise<string | null>;
@@ -1465,4 +1557,4 @@ declare function useConnectWallet(callbacks?: PrivyEvents['connectWallet']): {
     connectWallet: () => void;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, ConnectedWallet, ConnectorManager, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useLogin, useLogout, usePrivy, useWallets };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useLogin, useLogout, usePrivy, useWallets };