@privy-io/react-auth 1.26.0-beta.9 → 1.26.1-beta.1

package/dist/index.d.ts

@@ -140,12 +140,65 @@ interface EmbeddedWalletProxy {
     rpc: (data: WalletRpcRequestDataType) => Promise<WalletRpcResponseDataType>;
 }
 
+declare abstract class PrivyError extends Error {
+    /**
+     * Privy error type.
+     */
+    abstract type: string;
+    /**
+     * Original Error object, it the error originated client-side.
+     */
+    cause?: Error;
+    /**
+     * An optional error code, often included in Privy API responses.
+     */
+    privyErrorCode?: PrivyErrorCode;
+    /**
+     * @param type Privy error type.
+     * @param message Human-readable message.
+     * @param cause Source of this error.
+     */
+    protected constructor(message: string, cause?: unknown, privyErrorCode?: PrivyErrorCode);
+    toString(): string;
+}
+declare enum PrivyErrorCode {
+    MISSING_OR_INVALID_PRIVY_APP_ID = "missing_or_invalid_privy_app_id",
+    MISSING_OR_INVALID_PRIVY_ACCOUNT_ID = "missing_or_invalid_privy_account_id",
+    INVALID_DATA = "invalid_data",
+    LINKED_TO_ANOTHER_USER = "linked_to_another_user",
+    ALLOWLIST_REJECTED = "allowlist_rejected"
+}
+
+/**
+ * A ProviderRpcError combines the necessary bits of the {PrivyError} with the
+ * EIP-compliant ProviderRpcError. This is meant to be a type around errors raised
+ * by the ethereum provider.
+ */
+declare class ProviderRpcError extends PrivyError {
+    type: string;
+    readonly code: number;
+    readonly data?: unknown;
+    constructor(message: string, code: number, data?: unknown);
+}
+
 declare global {
     interface Window {
         ethereum?: unknown;
     }
 }
-type EIP1193OnEventHandler = ((accounts: string[]) => void) | ((chainId: string | number) => void);
+type ProviderConnectInfo = {
+    chainId: string;
+};
+type OnConnectEventHandler = (connectInfo: ProviderConnectInfo) => void;
+type OnDisconnectEventHandler = (error: ProviderRpcError) => void;
+type OnChainChangedEventHandler = (chainId: string | number) => void;
+type OnAccountsChangedEventHandler = (accounts: string[]) => void;
+type ProviderMessage = {
+    type: string;
+    data: unknown;
+};
+type OnMessageEventHandler = (message: ProviderMessage) => void;
+type EIP1193OnEventHandler = OnConnectEventHandler | OnDisconnectEventHandler | OnChainChangedEventHandler | OnAccountsChangedEventHandler | OnMessageEventHandler;
 interface EIP1193Provider {
     request: (request: {
         method: string;
@@ -251,8 +304,10 @@ declare abstract class WalletConnector extends EventEmitter<ConnectorEvents> {
     buildConnectedWallet(address: string, chainId: string): BaseConnectedWallet;
     /**
      * Sync all accounts available via the provider if the wallet is connected.
+     *
+     * @param prefetchedAccounts - pass in an accounts array from eth_accounts if already fetched to avoid a repeated call
      */
-    syncAccounts(): Promise<void>;
+    syncAccounts(prefetchedAccounts?: string[]): Promise<void>;
     /**
      * Get the most recently connected wallet.
      */
@@ -269,7 +324,7 @@ declare abstract class WalletConnector extends EventEmitter<ConnectorEvents> {
      * @returns {string} The resulting signature.
      */
     sign(message: string): Promise<string>;
-    protected onAccountsChanged: (_: string[]) => void;
+    protected onAccountsChanged: (accounts: string[]) => void;
     protected onChainChanged: (chainId: string) => void;
     protected onDisconnect: () => void;
     protected onConnect: () => void;
@@ -362,7 +417,7 @@ interface Wallet {
     walletClient: 'privy' | 'unknown';
 }
 /**
- * Object representation of a connected wallet.
+ * Object representation of a base connected wallet from a wallet connector.
  */
 interface BaseConnectedWallet {
     /** The wallet address. */
@@ -371,16 +426,26 @@ interface BaseConnectedWallet {
     chainId: string;
     /** The first time this wallet was connected without break. */
     connectedAt: number;
-    /** The wallet client where this key-pair is stored. */
+    /**
+     * @experimental **Experimental**: This property is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
+     *
+     * The wallet client where this key-pair is stored.
+     * e.g. metamask, rainbow, coinbase_wallet, etc.
+     */
     walletClientType: WalletClientType;
-    /** The connector used to initiate the connection with the wallet client. */
+    /**
+     * @experimental **Experimental**: This property is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
+     *
+     * The connector used to initiate the connection with the wallet client.
+     * e.g. injected, wallet_connect, coinbase_wallet, etc.
+     */
     connectorType: ConnectorType;
     /** Returns true if the wallet is connected, false otherwise */
     isConnected: () => Promise<boolean>;
     /** Helper methods to build providers for interfacing with this wallet. */
-    getEthereumProvider: () => EIP1193Provider;
-    getEthersProvider: () => Web3Provider;
-    getWeb3jsProvider: () => AbstractProvider;
+    getEthereumProvider: () => Promise<EIP1193Provider>;
+    getEthersProvider: () => Promise<Web3Provider>;
+    getWeb3jsProvider: () => Promise<AbstractProvider>;
     /**
      * Perform personal_sign with the user's wallet.
      *
@@ -388,10 +453,18 @@ interface BaseConnectedWallet {
      * @returns {string} The resulting signature.
      */
     sign: (message: string) => Promise<string>;
-    /** Disconnect method does not work on all connector types and will no-op if
-     * that is the case (metamask does not support programmatic disconnects) */
+    /**
+     * @experimental **Experimental**: This property is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
+     *
+     * Disconnect method does not work on all connector types and will no-op if
+     * an incompatible connector is used (metamask and phantom do not support
+     * programmatic disconnects)
+     */
     disconnect: () => void;
 }
+/**
+ * Object representation of a connected wallet.
+ */
 interface ConnectedWallet extends BaseConnectedWallet {
     /** True if this wallet is linked to the authenticated user. False if it is not yet linked or
      * the user has not yet authenticated. */
@@ -954,13 +1027,13 @@ interface PrivyInterface {
      */
     setActiveWallet: (address: string) => Promise<void>;
     /**
-     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/faq/experimental-features subject to change at any time}.
+     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
      *
      * Get a short-lived, one-time-use token to start a new Privy session from the existing authenticated session. Raises an exception if the current session was already forked from a previous session.
      */
     forkSession: () => Promise<string>;
     /**
-     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/faq/experimental-features subject to change at any time}.
+     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
      *
      * Prompts a user to create an Ethereum wallet through Privy.
      *
@@ -972,7 +1045,7 @@ interface PrivyInterface {
      */
     createWallet: () => Promise<Wallet>;
     /**
-     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/faq/experimental-features subject to change at any time}.
+     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
      *
      * Prompts a user to sign a message using their Privy wallet.
      *