@phantom/browser-sdk 1.0.0-beta.0 → 1.0.0-beta.10

package/README.md

@@ -44,8 +44,7 @@ import { BrowserSDK, AddressType } from "@phantom/browser-sdk";
 const sdk = new BrowserSDK({
   providerType: "embedded",
   addressTypes: [AddressType.solana, AddressType.ethereum],
-  apiBaseUrl: "https://api.phantom.app/v1/wallets",
-  organizationId: "your-org-id",
+  appId: "your-app-id", // Get your app ID from phantom.com/portal
 });
 
 const { addresses } = await sdk.connect();
@@ -107,7 +106,7 @@ const result = await sdk.connect({
   },
 });
 
-// Apple authentication (skips provider selection) 
+// Apple authentication (skips provider selection)
 const result = await sdk.connect({
   authOptions: {
     provider: "apple",
@@ -132,7 +131,7 @@ const signedTx = await sdk.solana.signTransaction(transaction);
 const result = await sdk.solana.signAndSendTransaction(transaction);
 
 // Network switching
-await sdk.solana.switchNetwork('devnet');
+await sdk.solana.switchNetwork("devnet");
 
 // Utilities
 const publicKey = await sdk.solana.getPublicKey();
@@ -143,8 +142,8 @@ const isConnected = sdk.solana.isConnected();
 
 ```typescript
 // EIP-1193 requests
-const accounts = await sdk.ethereum.request({ method: 'eth_accounts' });
-const chainId = await sdk.ethereum.request({ method: 'eth_chainId' });
+const accounts = await sdk.ethereum.request({ method: "eth_accounts" });
+const chainId = await sdk.ethereum.request({ method: "eth_chainId" });
 
 // Message signing
 const signature = await sdk.ethereum.signPersonalMessage(message, address);
@@ -190,82 +189,39 @@ Creates a non-custodial wallet embedded in your application. Requires API config
 const sdk = new BrowserSDK({
   providerType: "embedded",
   addressTypes: [AddressType.solana, AddressType.ethereum],
-  apiBaseUrl: "https://api.phantom.app/v1/wallets",
-  organizationId: "your-org-id",
-  embeddedWalletType: "app-wallet", // or 'user-wallet'
+  appId: "your-app-id", // Get your app ID from phantom.com/portal
   authOptions: {
-    authUrl: "https://auth.phantom.app", // optional, defaults to "https://connect.phantom.app"
+    authUrl: "https://connect.phantom.app/login", // optional, defaults to "https://connect.phantom.app/login"
     redirectUrl: "https://yourapp.com/callback", // optional, defaults to current page
   },
-  appName: "My DApp", // optional, for branding
-  appLogo: "https://myapp.com/logo.png", // optional, for branding
   autoConnect: true, // optional, auto-connect to existing session (default: true for embedded)
 });
 ```
 
-### Embedded Wallet Types
-
-#### App Wallet (`'app-wallet'`)
-
-- **New wallets** created per application
-- **Unfunded** by default - you need to fund them
-- **Independent** from user's existing Phantom wallet
-- **Perfect for**: Gaming, DeFi protocols, or apps that need fresh wallets
-
-```typescript
-const sdk = new BrowserSDK({
-  providerType: "embedded",
-  embeddedWalletType: "app-wallet",
-  addressTypes: [AddressType.solana],
-  // ... other config
-});
-```
+### Embedded Wallet Type
 
 #### User Wallet (`'user-wallet'`)
 
 - **Uses Phantom authentication** - user logs in with existing Phantom account
 - **Potentially funded** - brings in user's existing wallet balance
 - **Connected** to user's Phantom ecosystem
-- **Perfect for**: Trading platforms, NFT marketplaces, or apps needing funded wallets
+- **Perfect for**: All embedded wallet use cases
 
 ```typescript
 const sdk = new BrowserSDK({
   providerType: "embedded",
-  embeddedWalletType: "user-wallet",
+  appId: "your-app-id",
   addressTypes: [AddressType.solana, AddressType.ethereum],
-  // ... other config
 });
 ```
 
 ### Available AddressTypes
 
-| AddressType                 | Supported Chains                    |
-| --------------------------- | ----------------------------------- |
-| `AddressType.solana`        | Solana Mainnet, Devnet, Testnet     |
-| `AddressType.ethereum`      | Ethereum, Polygon, Arbitrum, and more |
-
-### Solana Provider Configuration
-
-When using `AddressType.solana`, you can choose between two Solana libraries:
-
-```typescript
-const sdk = new BrowserSDK({
-  providerType: "embedded",
-  addressTypes: [AddressType.solana],
-  solanaProvider: "web3js", // or 'kit'
-  // ... other config
-});
-```
-
-**Provider Options:**
-
-- `'web3js'` (default) - Uses `@solana/web3.js` library
-- `'kit'` - Uses `@solana/kit` library (modern, TypeScript-first)
-
-**When to use each:**
+| AddressType            | Supported Chains                      |
+| ---------------------- | ------------------------------------- |
+| `AddressType.solana`   | Solana Mainnet, Devnet, Testnet       |
+| `AddressType.ethereum` | Ethereum, Polygon, Arbitrum, and more |
 
-- **@solana/web3.js**: Better ecosystem compatibility, wider community support
-- **@solana/kit**: Better TypeScript support, modern architecture, smaller bundle size
 
 ### Auto-Connect Feature
 
@@ -274,8 +230,8 @@ The SDK can automatically reconnect to existing sessions when instantiated, prov
 ```typescript
 const sdk = new BrowserSDK({
   providerType: "embedded",
+  appId: "your-app-id",
   addressTypes: [AddressType.solana],
-  // ... other config
   autoConnect: true, // Default: true for embedded, false for injected
 });
 
@@ -297,8 +253,8 @@ if (sdk.isConnected()) {
 ```typescript
 const sdk = new BrowserSDK({
   providerType: "embedded",
+  appId: "your-app-id",
   addressTypes: [AddressType.solana],
-  // ... other config
   autoConnect: false, // Disable auto-connect
 });
 
@@ -319,20 +275,35 @@ new BrowserSDK(config: BrowserSDKConfig)
 ```typescript
 interface BrowserSDKConfig {
   providerType: "injected" | "embedded";
-  appName?: string; // Optional app name for branding
-  appLogo?: string; // Optional app logo URL for branding
   addressTypes?: [AddressType, ...AddressType[]]; // Networks to enable (e.g., [AddressType.solana])
 
   // Required for embedded provider only
-  apiBaseUrl?: string; // Phantom API base URL
-  organizationId?: string; // Your organization ID
+  appId?: string; // Your app ID from phantom.com/portal (required for embedded provider)
+  
+  // Optional configuration
+  apiBaseUrl?: string; // Phantom API base URL (optional, has default)
   authOptions?: {
-    authUrl?: string; // Custom auth URL (default: "https://connect.phantom.app")
-    redirectUrl?: string; // Custom redirect URL after authentication
+    authUrl?: string; // Custom auth URL (optional, defaults to "https://connect.phantom.app/login")
+    redirectUrl?: string; // Custom redirect URL after authentication (optional)
   };
-  embeddedWalletType?: "app-wallet" | "user-wallet"; // Wallet type
-  solanaProvider?: "web3js" | "kit"; // Solana library choice (default: 'web3js')
-  autoConnect?: boolean; // Enable auto-connect to existing sessions (default: true)
+  embeddedWalletType?: "user-wallet"; // Wallet type (optional, defaults to "user-wallet", currently the only supported type)
+  autoConnect?: boolean; // Enable auto-connect to existing sessions (optional, defaults to true for embedded)
+}
+```
+
+### Extension Detection
+
+For injected provider usage, you can check if the Phantom extension is installed:
+
+```typescript
+import { waitForPhantomExtension } from "@phantom/browser-sdk";
+
+const isAvailable = await waitForPhantomExtension(5000);
+
+if (isAvailable) {
+  console.log("Phantom extension is available!");
+} else {
+  console.log("Phantom extension not found");
 }
 ```
 
@@ -416,8 +387,8 @@ const result = await sdk.solana.signAndSendTransaction(transaction);
 Switch between Solana networks.
 
 ```typescript
-await sdk.solana.switchNetwork('mainnet');
-await sdk.solana.switchNetwork('devnet');
+await sdk.solana.switchNetwork("mainnet");
+await sdk.solana.switchNetwork("devnet");
 ```
 
 #### getPublicKey()
@@ -445,11 +416,17 @@ const connected = sdk.solana.isConnected();
 Make an EIP-1193 compatible request.
 
 ```typescript
-const accounts = await sdk.ethereum.request({ method: 'eth_accounts' });
-const chainId = await sdk.ethereum.request({ method: 'eth_chainId' });
-const balance = await sdk.ethereum.request({ 
-  method: 'eth_getBalance', 
-  params: [address, 'latest'] 
+const accounts = await sdk.ethereum.request({ method: "eth_accounts" });
+const chainId = await sdk.ethereum.request({ method: "eth_chainId" });
+const balance = await sdk.ethereum.request({
+  method: "eth_getBalance",
+  params: [address, "latest"],
+});
+
+// Sign transaction via RPC (alternative to signTransaction method)
+const signedTx = await sdk.ethereum.request({
+  method: "eth_signTransaction",
+  params: [{ to: "0x...", value: "0x...", gas: "0x..." }],
 });
 ```
 
@@ -473,32 +450,46 @@ const typedData = {
       { name: "name", type: "string" },
       { name: "version", type: "string" },
       { name: "chainId", type: "uint256" },
-      { name: "verifyingContract", type: "address" }
+      { name: "verifyingContract", type: "address" },
     ],
     Mail: [
       { name: "from", type: "string" },
       { name: "to", type: "string" },
-      { name: "contents", type: "string" }
-    ]
+      { name: "contents", type: "string" },
+    ],
   },
   primaryType: "Mail",
   domain: {
     name: "Ether Mail",
     version: "1",
     chainId: 1,
-    verifyingContract: "0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC"
+    verifyingContract: "0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC",
   },
   message: {
     from: "Alice",
     to: "Bob",
-    contents: "Hello!"
-  }
+    contents: "Hello!",
+  },
 };
 
 const signature = await sdk.ethereum.signTypedData(typedData, address);
 // Returns: { signature: string, rawSignature: string }
 ```
 
+#### signTransaction(transaction)
+
+Sign an Ethereum transaction without sending it.
+
+```typescript
+const signedTx = await sdk.ethereum.signTransaction({
+  to: "0x742d35Cc6634C0532925a3b8D4C8db86fB5C4A7E",
+  value: "1000000000000000000", // 1 ETH in wei
+  gas: "21000",
+  gasPrice: "20000000000", // 20 gwei
+});
+// Returns: string (hex-encoded signed transaction)
+```
+
 #### sendTransaction(transaction)
 
 Send an Ethereum transaction.
@@ -518,8 +509,8 @@ const result = await sdk.ethereum.sendTransaction({
 Switch to a different Ethereum chain.
 
 ```typescript
-await sdk.ethereum.switchChain(1);    // Ethereum mainnet
-await sdk.ethereum.switchChain(137);  // Polygon
+await sdk.ethereum.switchChain(1); // Ethereum mainnet
+await sdk.ethereum.switchChain(137); // Polygon
 await sdk.ethereum.switchChain(42161); // Arbitrum One
 ```
 
@@ -571,10 +562,10 @@ import { NetworkId } from "@phantom/browser-sdk";
 
 // Enable auto-confirm for specific chains
 const result = await sdk.enableAutoConfirm({
-  chains: [NetworkId.SOLANA_MAINNET, NetworkId.ETHEREUM_MAINNET]
+  chains: [NetworkId.SOLANA_MAINNET, NetworkId.ETHEREUM_MAINNET],
 });
 
-// Enable auto-confirm for all supported chains  
+// Enable auto-confirm for all supported chains
 const result = await sdk.enableAutoConfirm();
 
 console.log("Auto-confirm enabled:", result.enabled);
@@ -619,29 +610,29 @@ console.log("Supported chains:", supportedChains.chains);
 import { NetworkId } from "@phantom/browser-sdk";
 
 // Solana networks
-NetworkId.SOLANA_MAINNET   // "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp"
-NetworkId.SOLANA_DEVNET    // "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1"
-NetworkId.SOLANA_TESTNET   // "solana:4uhcVJyU9pJkvQyS88uRDiswHXSCkY3z"
+NetworkId.SOLANA_MAINNET; // "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp"
+NetworkId.SOLANA_DEVNET; // "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1"
+NetworkId.SOLANA_TESTNET; // "solana:4uhcVJyU9pJkvQyS88uRDiswHXSCkY3z"
 
 // Ethereum networks
-NetworkId.ETHEREUM_MAINNET // "eip155:1"
-NetworkId.ETHEREUM_SEPOLIA // "eip155:11155111"
+NetworkId.ETHEREUM_MAINNET; // "eip155:1"
+NetworkId.ETHEREUM_SEPOLIA; // "eip155:11155111"
 
-// Polygon networks  
-NetworkId.POLYGON_MAINNET  // "eip155:137"
-NetworkId.POLYGON_AMOY     // "eip155:80002"
+// Polygon networks
+NetworkId.POLYGON_MAINNET; // "eip155:137"
+NetworkId.POLYGON_AMOY; // "eip155:80002"
 
 // Arbitrum networks
-NetworkId.ARBITRUM_ONE     // "eip155:42161"
-NetworkId.ARBITRUM_SEPOLIA // "eip155:421614"
+NetworkId.ARBITRUM_ONE; // "eip155:42161"
+NetworkId.ARBITRUM_SEPOLIA; // "eip155:421614"
 
 // Optimism networks
-NetworkId.OPTIMISM_MAINNET // "eip155:10"
-NetworkId.OPTIMISM_GOERLI  // "eip155:420"
+NetworkId.OPTIMISM_MAINNET; // "eip155:10"
+NetworkId.OPTIMISM_GOERLI; // "eip155:420"
 
 // Base networks
-NetworkId.BASE_MAINNET     // "eip155:8453"
-NetworkId.BASE_SEPOLIA     // "eip155:84532"
+NetworkId.BASE_MAINNET; // "eip155:8453"
+NetworkId.BASE_SEPOLIA; // "eip155:84532"
 ```
 
 **Important Notes:**
@@ -661,14 +652,14 @@ The BrowserSDK provides dynamic debug configuration that can be changed at runti
 // Enable debug logging
 sdk.enableDebug();
 
-// Disable debug logging  
+// Disable debug logging
 sdk.disableDebug();
 
 // Set debug level
 sdk.setDebugLevel(DebugLevel.INFO);
 
 // Set debug callback function
-sdk.setDebugCallback((message) => {
+sdk.setDebugCallback(message => {
   console.log(`[${message.category}] ${message.message}`, message.data);
 });
 
@@ -676,10 +667,10 @@ sdk.setDebugCallback((message) => {
 sdk.configureDebug({
   enabled: true,
   level: DebugLevel.DEBUG,
-  callback: (message) => {
+  callback: message => {
     // Handle debug messages
     console.log(`[${message.level}] ${message.category}: ${message.message}`);
-  }
+  },
 });
 ```
 
@@ -689,10 +680,10 @@ sdk.configureDebug({
 import { DebugLevel } from "@phantom/browser-sdk";
 
 // Available debug levels (in order of verbosity)
-DebugLevel.ERROR   // 0 - Only error messages
-DebugLevel.WARN    // 1 - Warning and error messages  
-DebugLevel.INFO    // 2 - Info, warning, and error messages
-DebugLevel.DEBUG   // 3 - All debug messages (most verbose)
+DebugLevel.ERROR; // 0 - Only error messages
+DebugLevel.WARN; // 1 - Warning and error messages
+DebugLevel.INFO; // 2 - Info, warning, and error messages
+DebugLevel.DEBUG; // 3 - All debug messages (most verbose)
 ```
 
 ### Debug Message Structure
@@ -701,11 +692,11 @@ Debug callbacks receive a `DebugMessage` object:
 
 ```typescript
 interface DebugMessage {
-  timestamp: number;     // Unix timestamp
-  level: DebugLevel;     // Message level
-  category: string;      // Component category (e.g., "BrowserSDK", "ProviderManager")
-  message: string;       // Debug message text
-  data?: any;           // Additional debug data (optional)
+  timestamp: number; // Unix timestamp
+  level: DebugLevel; // Message level
+  category: string; // Component category (e.g., "BrowserSDK", "ProviderManager")
+  message: string; // Debug message text
+  data?: any; // Additional debug data (optional)
 }
 ```
 
@@ -716,7 +707,7 @@ import { BrowserSDK, DebugLevel } from "@phantom/browser-sdk";
 
 const sdk = new BrowserSDK({
   providerType: "embedded",
-  // ... other config
+  appId: "your-app-id",
 });
 
 // Store debug messages
@@ -726,17 +717,17 @@ const debugMessages: DebugMessage[] = [];
 sdk.configureDebug({
   enabled: true,
   level: DebugLevel.INFO,
-  callback: (message) => {
+  callback: message => {
     debugMessages.push(message);
-    
+
     // Keep only last 100 messages
     if (debugMessages.length > 100) {
       debugMessages.shift();
     }
-    
+
     // Update UI
     updateDebugConsole();
-  }
+  },
 });
 
 // Dynamic debug level changing
@@ -783,7 +774,6 @@ import { BrowserSDK, AddressType } from "@phantom/browser-sdk";
 const sdk = new BrowserSDK({
   providerType: "injected",
   addressTypes: [AddressType.solana],
-  solanaProvider: "web3js",
 });
 
 await sdk.connect();
@@ -835,9 +825,8 @@ import {
 import { BrowserSDK, AddressType } from "@phantom/browser-sdk";
 
 const sdk = new BrowserSDK({
-  providerType: "injected", 
+  providerType: "injected",
   addressTypes: [AddressType.solana],
-  solanaProvider: "kit",
 });
 
 await sdk.connect();
@@ -926,4 +915,3 @@ const result = await sdk.ethereum.sendTransaction({
   maxPriorityFeePerGas: parseGwei("2").toString(),
 });
 ```
-

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { EmbeddedProviderConfig, AuthOptions, ConnectResult, WalletAddress, EmbeddedProviderEvent, EventCallback } from '@phantom/embedded-provider-core';
 export { AuthOptions, ConnectResult, SignAndSendTransactionParams, SignMessageParams, SignMessageResult, SignedTransaction, WalletAddress } from '@phantom/embedded-provider-core';
-import { ISolanaChain, IEthereumChain } from '@phantom/chains';
-export { EthTransactionRequest, IEthereumChain, ISolanaChain } from '@phantom/chains';
+import { ISolanaChain, IEthereumChain } from '@phantom/chain-interfaces';
+export { EthTransactionRequest, IEthereumChain, ISolanaChain } from '@phantom/chain-interfaces';
 import { AddressType } from '@phantom/client';
 export { AddressType } from '@phantom/client';
 import { AutoConfirmEnableParams, AutoConfirmResult, AutoConfirmSupportedChainsResult } from '@phantom/browser-injected-sdk/auto-confirm';
@@ -52,18 +52,43 @@ declare const DebugCategory: {
     readonly SESSION: "Session";
 };
 
+declare global {
+    interface Window {
+        phantom?: {
+            solana?: unknown;
+            ethereum?: unknown;
+        };
+    }
+}
+interface InjectedProviderConfig {
+    addressTypes: AddressType[];
+}
+
 interface DebugConfig {
     enabled?: boolean;
     level?: DebugLevel;
     callback?: DebugCallback;
 }
-interface BrowserSDKConfig extends Partial<EmbeddedProviderConfig> {
-    providerType: "injected" | "embedded" | (string & Record<never, never>);
-    addressTypes: [AddressType, ...AddressType[]];
-    apiBaseUrl?: string;
-    organizationId?: string;
-    embeddedWalletType?: "app-wallet" | "user-wallet" | (string & Record<never, never>);
+type BrowserSDKConfig = Prettify<(ExtendedEmbeddedProviderConfig | ExtendedInjectedProviderConfig) & {
     autoConnect?: boolean;
+}>;
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+interface ExtendedEmbeddedProviderConfig extends Omit<EmbeddedProviderConfig, "authOptions" | "apiBaseUrl" | "embeddedWalletType"> {
+    providerType: "embedded";
+    apiBaseUrl?: string;
+    embeddedWalletType?: "app-wallet" | "user-wallet";
+    authOptions?: {
+        authUrl?: string;
+        redirectUrl?: string;
+    };
+}
+interface ExtendedInjectedProviderConfig extends InjectedProviderConfig {
+    providerType: "injected";
+    appId?: never;
+    authOptions?: never;
+    embeddedWalletType?: never;
 }
 
 interface Provider {
@@ -71,6 +96,7 @@ interface Provider {
     disconnect(): Promise<void>;
     getAddresses(): WalletAddress[];
     isConnected(): boolean;
+    autoConnect(): Promise<void>;
     solana: ISolanaChain;
     ethereum: IEthereumChain;
 }
@@ -138,7 +164,7 @@ declare class BrowserSDK {
     /**
      * Check if Phantom extension is installed
      */
-    static isPhantomInstalled(): boolean;
+    static isPhantomInstalled(timeoutMs?: number): Promise<boolean>;
     /**
      * Add event listener for provider events (connect, connect_start, connect_error, disconnect, error)
      * Works with both embedded and injected providers
@@ -205,18 +231,13 @@ declare class BrowserSDK {
     getSupportedAutoConfirmChains(): Promise<AutoConfirmSupportedChainsResult>;
 }
 
-/**
- * Constants used throughout the browser SDK
- */
-declare const DEFAULT_AUTH_URL = "https://connect.phantom.app";
-declare const DEFAULT_WALLET_API_URL = "https://api.phantom.app/v1/wallets";
-
 /**
  * Browser detection utility to identify browser name and version
  */
 interface BrowserInfo {
     name: string;
     version: string;
+    userAgent: string;
 }
 /**
  * Parse browser information from a user agent string
@@ -237,5 +258,35 @@ declare function getPlatformName(): string;
  * Format: "Chrome 120.0" or "Firefox 119.0"
  */
 declare function getBrowserDisplayName(): string;
+/**
+ * Detect if the current device is a mobile device
+ * Checks user agent for mobile indicators and screen size
+ */
+declare function isMobileDevice(): boolean;
+
+/**
+ * Generates a deeplink URL to open the current page in Phantom mobile app
+ * @param ref Optional referrer parameter
+ * @returns Phantom mobile app deeplink URL
+ */
+declare function getDeeplinkToPhantom(ref?: string): string;
+
+/**
+ * Wait for Phantom extension to be available with retry logic
+ *
+ * @param timeoutMs - Maximum time to wait in milliseconds (default: 3000)
+ * @returns Promise<boolean> - true if Phantom extension is available, false if timeout reached
+ *
+ * Usage:
+ * ```typescript
+ * const isAvailable = await waitForPhantomExtension(5000);
+ * if (isAvailable) {
+ *   console.log("Phantom extension is available!");
+ * } else {
+ *   console.log("Phantom extension not found or timed out");
+ * }
+ * ```
+ */
+declare function waitForPhantomExtension(timeoutMs?: number): Promise<boolean>;
 
-export { BrowserInfo, BrowserSDK, BrowserSDKConfig, DEFAULT_AUTH_URL, DEFAULT_WALLET_API_URL, DebugCallback, DebugCategory, DebugConfig, DebugLevel, DebugMessage, Provider, debug, detectBrowser, getBrowserDisplayName, getPlatformName, parseBrowserFromUserAgent };
+export { BrowserInfo, BrowserSDK, BrowserSDKConfig, DebugCallback, DebugCategory, DebugConfig, DebugLevel, DebugMessage, Provider, debug, detectBrowser, getBrowserDisplayName, getDeeplinkToPhantom, getPlatformName, isMobileDevice, parseBrowserFromUserAgent, waitForPhantomExtension };