@privy-io/react-auth 1.22.0 → 1.23.0-beta.2

package/dist/index.d.ts

@@ -1,9 +1,63 @@
-import React from 'react';
+import React, { ReactElement } from 'react';
 import { ExternalProvider, Web3Provider } from '@ethersproject/providers';
 import WCProvider from '@walletconnect/web3-provider';
 import { AbstractProvider } from 'web3-core';
 import { AxiosResponse, AxiosRequestConfig } from 'axios';
 
+type Address = string;
+type HexString = string;
+type BytesLike = ArrayLike<number> | string;
+type AccessList = Array<{
+    address: string;
+    storageKeys: Array<string>;
+}>;
+type AccessListish = AccessList | Array<[string, Array<string>]> | Record<string, Array<string>>;
+type Quantity = HexString | number | bigint;
+type UnsignedTransactionRequest = {
+    to?: Address;
+    nonce?: number;
+    gasLimit?: Quantity;
+    gasPrice?: Quantity;
+    data?: BytesLike;
+    /** Integer of the value sent with this transaction, in Wei. */
+    value?: Quantity;
+    chainId?: number;
+    type?: number;
+    accessList?: AccessListish;
+    maxPriorityFeePerGas?: Quantity;
+    maxFeePerGas?: Quantity;
+};
+type Log = {
+    blockNumber: number;
+    blockHash: string;
+    transactionIndex: number;
+    removed: boolean;
+    address: string;
+    data: string;
+    topics: Array<string>;
+    transactionHash: string;
+    logIndex: number;
+};
+type TransactionReceipt = {
+    to: string;
+    from: string;
+    contractAddress: string;
+    transactionIndex: number;
+    root?: string;
+    logs: Array<Log>;
+    logsBloom: string;
+    blockHash: string;
+    transactionHash: string;
+    blockNumber: number;
+    confirmations: number;
+    byzantium: boolean;
+    type: number;
+    status?: number;
+    gasUsed: string;
+    cumulativeGasUsed: string;
+    effectiveGasPrice: string;
+};
+
 declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github", "apple"];
 type OAuthProviderType = typeof SUPPORTED_OAUTH_PROVIDERS[number];
 declare const SUPPORTED_WALLET_CONNECTION_TYPES: readonly ["metamask", "phantom", "coinbase_wallet", "wallet_connect"];
@@ -219,9 +273,32 @@ type PrivyClientConfig = {
          *  Used for buttons, active borders, etc. This will generate light and dark variants.
          *  This overrides the server setting `accent_color`. */
         accentColor?: HexColor;
-        /** Logo url for the main privy modal screen.
+        /** Logo for the main privy modal screen.
+         *  This can be a string (url) or an img / svg react element.
+         *  If passing an element, Privy will overwrite the `style` props, to ensure proper rendering.
          *  This overrides the server setting `logo_url` */
-        logo?: string;
+        logo?: string | ReactElement;
+        /** Determines the order of the login options in the privy modal. If true, the wallet login will render above
+         *  social and email / sms login options.
+         *  This overrides the server setting `show_wallet_login_first` */
+        showWalletLoginFirst?: boolean;
+    };
+    /** Specified login methods for the privy modal.
+     *  Existence of options in this list overrides the server settings `wallet_auth`, `email_auth`, `sms_auth`, `google_oauth`, `twitter_oauth`,
+     *  `discord_oauth`, `github_oauth`, `apple_oauth` (respectively).
+     *  Only `email` OR `sms` can be specified, not both. If both are specified, `email` will be used.
+     *  The order of this array does not currently dictate order of the social login methods in the UI. */
+    loginMethods?: Array<'wallet' | 'email' | 'sms' | 'google' | 'twitter' | 'discord' | 'github' | 'apple'>;
+    /** All legal configuration */
+    legal?: {
+        /** URL to the terms and conditions page for your application.
+         *  Rendered as a link in the privy modal footer.
+         *  This overrides the server setting `terms_and_conditions_url` */
+        termsAndConditionsUrl?: string | null;
+        /** URL to the privacy policy page for your application.
+         *  Rendered as a link in the privy modal footer.
+         *  This overrides the server setting `privacy_policy_url` */
+        privacyPolicyUrl?: string | null;
     };
 };
 interface AllowlistConfig {
@@ -235,6 +312,11 @@ type SignMessageModalUIOptions = {
     description?: string;
     buttonText?: string;
 };
+type SendTransactionModalUIOptions = {
+    title?: string;
+    description?: string;
+    buttonText?: string;
+};
 
 declare function getAccessToken(): Promise<string | null>;
 /**
@@ -677,7 +759,8 @@ interface PrivyInterface {
      *
      * This function currently has a precondition that the user has a Privy wallet. It will fail otherwise.
      */
-    signMessage: (message: string, data?: SignMessageModalUIOptions) => Promise<string>;
+    signMessage: (message: string, uiOptions?: SignMessageModalUIOptions) => Promise<string>;
+    sendTransaction: (data: UnsignedTransactionRequest, uiOptions?: SendTransactionModalUIOptions) => Promise<TransactionReceipt>;
     exportWallet: () => Promise<void>;
 }
 /**