@privy-io/react-auth 1.28.0-beta.1 → 1.28.0-beta.11

package/dist/index.d.ts

@@ -184,7 +184,7 @@ declare class ProviderRpcError extends PrivyError {
 
 declare global {
     interface Window {
-        ethereum?: unknown;
+        ethereum?: any;
     }
 }
 type ProviderConnectInfo = {
@@ -352,12 +352,12 @@ type CoinbaseWalletClientType = 'coinbase_wallet';
  *
  * How this works:
  *
- * The raw data is pulled from https://registry.walletconnect.com/api/v2/wallets
+ * The raw data is pulled from https://registry.walletconnect.com/api/v3/wallets
  * Some post-processing is done using the following script.
  *
  * const axios = require('axios');
  * const walletTypes = [];
- * axios.get("https://registry.walletconnect.com/api/v2/wallets").then((apiResult) => {
+ * axios.get("https://explorer-api.walletconnect.com/v3/wallets?projectId=2f05ae7f1116030fde2d36508f472bfb&entries=400&page=1&version=2&chains=eip155%3A1").then((apiResult) => {
  *   Object.values(apiResult.data.listings).forEach((walletEntry) => {
  *     if (!walletEntry.mobile.native || !walletEntry.mobile.universal) return;
  *     if (!walletEntry.chains.includes('eip155:1')) return;
@@ -369,7 +369,7 @@ type CoinbaseWalletClientType = 'coinbase_wallet';
  *   console.log(walletTypes.join("\n  | "));
  * });
  */
-type WalletConnectWalletClientType = 'rainbow' | 'trust' | 'uniswap' | 'metamask' | 'argent' | 'spot' | 'zerion' | 'bitkeep' | 'unstoppable' | 'omni' | 'mathwallet' | 'bitpay' | '1inch' | 'eidoo' | 'coin98' | 'unstoppable' | 'alphawallet' | 'rwallet' | 'plasmapay' | 'o3wallet' | 'hashkey_me' | 'defiant' | 'essentials' | 'stasis' | 'julwallet' | 'tangem' | 'secux' | 'linen' | 'ambire' | 'obvious' | 'easypocket' | 'rice_wallet' | 'safemoon' | 'simplehold' | 'bitizen' | 'slavi_wallet' | 'nufinetes' | 'now_wallet' | 'blocto' | 'timeless' | 'arculus_wallet' | 'card' | 'mew_wallet' | 'pltwallet' | 'avacus' | 'bitski' | 'hippowallet' | 'edge' | 'assure' | 'enjin_wallet' | 'slingshot' | 'coinstats' | 'bitcoincom_wallet' | 'defiant' | 'binance';
+type WalletConnectWalletClientType = 'metamask' | 'trust' | 'safe' | 'rainbow' | 'uniswap' | 'zerion' | 'argent' | 'spot' | 'omni' | 'cryptocom' | 'blockchain' | 'safepal' | 'bitkeep' | 'zengo' | '1inch' | 'binance' | 'exodus' | 'mew_wallet' | 'alphawallet' | 'keyring_pro' | 'mathwallet' | 'unstoppable' | 'obvious' | 'ambire' | 'internet_money_wallet' | 'coin98' | 'abc_wallet' | 'arculus_wallet' | 'haha' | 'cling_wallet' | 'broearn' | 'copiosa' | 'burrito_wallet' | 'enjin_wallet' | 'plasma_wallet' | 'avacus' | 'bee' | 'pitaka' | 'pltwallet' | 'minerva' | 'kryptogo' | 'prema' | 'slingshot' | 'kriptonio' | 'timeless' | 'secux' | 'bitizen' | 'blocto' | 'safemoon';
 /** @hidden */
 type UnknownWalletClientType = 'unknown';
 type WalletClientType = InjectedWalletClientType | CoinbaseWalletClientType | WalletConnectWalletClientType | EmbeddedWalletClientType | UnknownWalletClientType;
@@ -396,26 +396,36 @@ interface LinkMetadata {
 interface Wallet {
     /** The wallet address. */
     address: string;
-    /** Chain type of the wallet address. */
+    /**
+     * @deprecated Use `chainId` instead.
+     *
+     * Chain type of the wallet address.
+     */
     chainType: 'ethereum' | 'solana';
     /**
-     * @experimental
-     * DO NOT USE: This feature is under active development.
+     * CAIP-2 formatted chain ID during the most recent verification.
      *
-     * e.g. testnet, mainnet, goerli */
+     * e.g. eip155:1, eip155:5, eip155:137, etc.
+     */
     chainId?: string;
     /**
-     * The wallet client used for this wallet. At the moment, there are only two expected values:
-     *
-     *     1. privy
-     *     2. unknown
+     * @deprecated Use `walletClientType` instead.
+     */
+    walletClient: 'privy' | 'unknown';
+    /**
+     * The wallet client used for this wallet during the most recent verification.
      *
      * If the value is `privy`, then this is a privy embedded wallet.
      *
-     * In the future, this may contain more information about other wallet clients,
-     * like metamask, coinbase, etc.
+     * Other values include but are not limited to `metamask`, `rainbow`, `coinbase_wallet`, etc.
      */
-    walletClient: 'privy' | 'unknown';
+    walletClientType?: string;
+    /**
+     * The connector type used for this wallet during the most recent verification.
+     *
+     * This includes but is not limited to `injected`, `wallet_connect`, `coinbase_wallet`, `embedded`.
+     */
+    connectorType?: string;
     /**
      * If this is a 'privy' embedded wallet, stores the recovery method:
      *
@@ -633,6 +643,7 @@ type PrivyServerConfig = {
     createdAt?: Date;
     updatedAt?: Date;
     customApiUrl?: string | null;
+    walletConnectCloudProjectId?: string | null;
     embeddedWalletConfig: EmbeddedWalletsConfig;
     /** May be deprecated from the server config in a future release */
     logoUrl?: string;
@@ -683,6 +694,7 @@ type PrivyClientConfig = {
          *  This overrides the server setting `privacy_policy_url` */
         privacyPolicyUrl?: string | null;
     };
+    walletConnectCloudProjectId?: string;
     /** All embedded wallets configuration */
     embeddedWallets?: {
         /**
@@ -835,7 +847,8 @@ declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
     initialized: boolean;
     private storedConnections;
     private activeWallet?;
-    constructor();
+    private walletConnectCloudProjectId;
+    constructor(walletConnectCloudProjectId: string);
     /**
      * The core wallets array that is exposed to developers. It builds
      * the wallets away with the following logic:
@@ -849,10 +862,6 @@ declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
      * Detect and add all valid wallet connectors.
      */
     initialize(): void;
-    /**
-     * Restore previous Wallet Connect connections that have been stored in local storage.
-     */
-    restoreWalletConnectConnectors(): void;
     /**
      * Helper function to find a wallet connector by connector type and wallet client type.
      */
@@ -875,7 +884,7 @@ declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
      * Creates a new wallet connector for the given connector type and wallet client type.
      * If a connector already exists, it will be returned instead.
      */
-    createWalletConnector(connectorType: ConnectorType, walletClientType: WalletClientType): WalletConnector | null;
+    createWalletConnector(connectorType: ConnectorType, walletClientType: WalletClientType): Promise<WalletConnector | null>;
     private addWalletConnector;
     /**
      * Upon initialization, loads previous connections from local storage. If local storage
@@ -1132,8 +1141,19 @@ interface ResponsePhoneAccount {
 interface ResponseEthereumAccount {
     type: 'wallet';
     address: string;
+    /**
+     * @deprecated This will be removed in favor of the CAIP-2 formatted chain_id field.
+     *
+     * Chain type of the wallet address.
+     */
     chain_type: 'ethereum';
+    chain_id?: string;
+    /**
+     * @deprecated Use `wallet_client_type` instead.
+     */
     wallet_client: 'privy' | 'unknown';
+    wallet_client_type?: string;
+    connector_type?: string;
     recovery_method?: 'privy' | 'user-passcode';
     verified_at: number;
 }
@@ -1260,7 +1280,7 @@ declare class PrivyClient {
     apiUrl: string;
     fallbackApiUrl: string;
     authFlow?: AuthFlow;
-    connectors: ConnectorManager;
+    connectors?: ConnectorManager;
     /**
      * Creates a new Privy client.
      * @param options Initialization options.
@@ -1279,6 +1299,12 @@ declare class PrivyClient {
          */
         timeout?: number;
     });
+    /**
+     * ConnectorManager initialization is deferred because the input parameter may be overridden by the server
+     * config. We can set this once and only once. If it is set twice, event listeners will be created
+     * on the first ConnectorManager and are not re-created.
+     */
+    initializeConnectorManager(walletConnectCloudProjectId: string): void;
     generateApi(): Http;
     /**
      * In the case of cookie-based auth, re-initialize the http client with the custom api url.