@privy-io/react-auth 1.36.1 → 1.37.0

package/dist/index.d.ts

@@ -64,7 +64,7 @@ type TransactionReceipt = {
     status?: number;
     gasUsed: string;
     cumulativeGasUsed: string;
-    effectiveGasPrice: string;
+    effectiveGasPrice?: string;
 };
 interface BaseRpcRequestType {
     method: JsonRpcMethodType;
@@ -112,44 +112,6 @@ interface eth_signTypedData_v4Response {
 type RpcRequestType = eth_signTransaction | eth_populateTransactionRequest | eth_sign | personal_sign | eth_signTypedData_v4;
 type RpcResponseType = eth_signTransactionResponse | eth_populateTransactionRequestResponse | eth_signResponse | personal_signResponse | eth_signTypedData_v4Response;
 
-type WalletCreateRequestDataType = {
-    accessToken: string;
-    recoveryPin?: string;
-};
-type WalletConnectRequestDataType = {
-    accessToken: string;
-    address: string;
-};
-type WalletRecoverRequestDataType = {
-    accessToken: string;
-    address: string;
-    recoveryPin?: string;
-};
-type WalletRpcRequestDataType = {
-    accessToken: string;
-    address: string;
-    request: RpcRequestType;
-};
-type WalletCreateResponseDataType = {
-    address: string;
-};
-type WalletConnectResponseDataType = {
-    address: string;
-};
-type WalletRecoverResponseDataType = {
-    address: string;
-};
-type WalletRpcResponseDataType = {
-    address: string;
-    response: RpcResponseType;
-};
-interface EmbeddedWalletProxy {
-    create: (data: WalletCreateRequestDataType) => Promise<WalletCreateResponseDataType>;
-    connect: (data: WalletConnectRequestDataType) => Promise<WalletConnectResponseDataType>;
-    recover: (data: WalletRecoverRequestDataType) => Promise<WalletRecoverResponseDataType>;
-    rpc: (data: WalletRpcRequestDataType) => Promise<WalletRpcResponseDataType>;
-}
-
 /**
  * These types are fully compatible with WAGMI chain types, in case
  * we need interop in the future.
@@ -209,7 +171,45 @@ type RpcConfig = {
     };
 };
 
-declare const SUPPORTED_CHAINS: readonly [Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain];
+declare const DEFAULT_SUPPORTED_CHAINS: readonly [Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain];
+
+type WalletCreateRequestDataType = {
+    accessToken: string;
+    recoveryPin?: string;
+};
+type WalletConnectRequestDataType = {
+    accessToken: string;
+    address: string;
+};
+type WalletRecoverRequestDataType = {
+    accessToken: string;
+    address: string;
+    recoveryPin?: string;
+};
+type WalletRpcRequestDataType = {
+    accessToken: string;
+    address: string;
+    request: RpcRequestType;
+};
+type WalletCreateResponseDataType = {
+    address: string;
+};
+type WalletConnectResponseDataType = {
+    address: string;
+};
+type WalletRecoverResponseDataType = {
+    address: string;
+};
+type WalletRpcResponseDataType = {
+    address: string;
+    response: RpcResponseType;
+};
+interface EmbeddedWalletProxy {
+    create: (data: WalletCreateRequestDataType) => Promise<WalletCreateResponseDataType>;
+    connect: (data: WalletConnectRequestDataType) => Promise<WalletConnectResponseDataType>;
+    recover: (data: WalletRecoverRequestDataType) => Promise<WalletRecoverResponseDataType>;
+    rpc: (data: WalletRpcRequestDataType) => Promise<WalletRpcResponseDataType>;
+}
 
 declare abstract class PrivyError extends Error {
     /**
@@ -312,7 +312,8 @@ declare class Embedded1193Provider extends EventEmitter implements EIP1193Provid
     provider: StaticJsonRpcProvider;
     chainId: number;
     rpcConfig: RpcConfig;
-    constructor(walletProxy: EmbeddedWalletProxy, address: string, rpcConfig: RpcConfig, chainId?: number);
+    chains: Chain[];
+    constructor(walletProxy: EmbeddedWalletProxy, address: string, rpcConfig: RpcConfig, chains: Chain[], chainId?: number);
     handleSendTransaction(args: RequestArguments): Promise<string>;
     private handleSwitchEthereumChain;
     private handlePersonalSign;
@@ -367,9 +368,10 @@ declare abstract class WalletConnector extends EventEmitter<ConnectorEvents> {
     initialized: boolean;
     wallets: BaseConnectedWallet[];
     walletClientType: WalletClientType;
+    chains: Chain[];
     abstract connectorType: ConnectorType;
     abstract proxyProvider: PrivyProxyProvider | Embedded1193Provider;
-    constructor(walletClientType: WalletClientType);
+    constructor(walletClientType: WalletClientType, chains: Chain[]);
     /**
      * Builds a connected wallet object to be exposed to the developer. This object
      * contains the address, chainId, and a few helper methods.
@@ -572,7 +574,8 @@ declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
     private activeWallet?;
     private walletConnectCloudProjectId;
     private rpcConfig;
-    constructor(walletConnectCloudProjectId: string, rpcConfig: RpcConfig);
+    private chains;
+    constructor(walletConnectCloudProjectId: string, rpcConfig: RpcConfig, chains: Chain[]);
     /**
      * The core wallets array that is exposed to developers. It builds
      * the wallets away with the following logic:
@@ -684,7 +687,7 @@ declare class PrivyClient {
      * 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, rpcConfig: RpcConfig): void;
+    initializeConnectorManager(walletConnectCloudProjectId: string, rpcConfig: RpcConfig, chains: Chain[]): void;
     generateApi(): Http;
     /**
      * In the case of cookie-based auth, re-initialize the http client with the custom api url.
@@ -736,7 +739,7 @@ declare class PrivyClient {
         disableAutoRefresh?: boolean;
     }): Promise<string | null>;
     getServerConfig(): Promise<PrivyServerConfig>;
-    getUsdTokenPrice(chainId: string | number): Promise<number | undefined>;
+    getUsdTokenPrice(chain: Chain): Promise<number | undefined>;
     /**
      * Get a short-lived token to start a new Privy session from the existing authenticated session.
      *
@@ -1225,6 +1228,7 @@ type PrivyClientConfig = {
      * @experimental
      */
     rpcConfig?: RpcConfig;
+    additionalChains?: Chain[];
     captchaEnabled?: boolean;
     /** All embedded wallets configuration */
     embeddedWallets?: {
@@ -1840,4 +1844,4 @@ declare function useConnectWallet(callbacks?: PrivyEvents['connectWallet']): {
     connectWallet: () => void;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, SUPPORTED_CHAINS, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useLogin, useLogout, usePrivy, useWallets };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useLogin, useLogout, usePrivy, useWallets };