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

package/README.md

@@ -45,7 +45,7 @@ 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",
 });
 
 const { addresses } = await sdk.connect();
@@ -107,7 +107,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 +132,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 +143,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);
@@ -191,14 +191,12 @@ 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",
   embeddedWalletType: "app-wallet", // or 'user-wallet'
   authOptions: {
     authUrl: "https://auth.phantom.app", // optional, defaults to "https://connect.phantom.app"
     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)
 });
 ```
@@ -239,10 +237,10 @@ const sdk = new BrowserSDK({
 
 ### Available AddressTypes
 
-| AddressType                 | Supported Chains                    |
-| --------------------------- | ----------------------------------- |
-| `AddressType.solana`        | Solana Mainnet, Devnet, Testnet     |
-| `AddressType.ethereum`      | Ethereum, Polygon, Arbitrum, and more |
+| AddressType            | Supported Chains                      |
+| ---------------------- | ------------------------------------- |
+| `AddressType.solana`   | Solana Mainnet, Devnet, Testnet       |
+| `AddressType.ethereum` | Ethereum, Polygon, Arbitrum, and more |
 
 ### Solana Provider Configuration
 
@@ -319,13 +317,11 @@ 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 (required for embedded provider)
   authOptions?: {
     authUrl?: string; // Custom auth URL (default: "https://connect.phantom.app")
     redirectUrl?: string; // Custom redirect URL after authentication
@@ -336,6 +332,22 @@ interface BrowserSDKConfig {
 }
 ```
 
+### 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");
+}
+```
+
 ### Core Methods
 
 #### connect()
@@ -416,8 +428,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 +457,11 @@ 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"],
 });
 ```
 
@@ -473,26 +485,26 @@ 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);
@@ -518,8 +530,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 +583,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 +631,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 +673,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 +688,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 +701,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 +713,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)
 }
 ```
 
@@ -726,17 +738,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
@@ -835,7 +847,7 @@ import {
 import { BrowserSDK, AddressType } from "@phantom/browser-sdk";
 
 const sdk = new BrowserSDK({
-  providerType: "injected", 
+  providerType: "injected",
   addressTypes: [AddressType.solana],
   solanaProvider: "kit",
 });
@@ -926,4 +938,3 @@ const result = await sdk.ethereum.sendTransaction({
   maxPriorityFeePerGas: parseGwei("2").toString(),
 });
 ```
-

package/dist/index.d.ts

@@ -61,7 +61,7 @@ interface BrowserSDKConfig extends Partial<EmbeddedProviderConfig> {
     providerType: "injected" | "embedded" | (string & Record<never, never>);
     addressTypes: [AddressType, ...AddressType[]];
     apiBaseUrl?: string;
-    organizationId?: string;
+    appId?: string;
     embeddedWalletType?: "app-wallet" | "user-wallet" | (string & Record<never, never>);
     autoConnect?: boolean;
 }
@@ -138,7 +138,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
@@ -238,4 +238,22 @@ declare function getPlatformName(): string;
  */
 declare function getBrowserDisplayName(): string;
 
-export { BrowserInfo, BrowserSDK, BrowserSDKConfig, DEFAULT_AUTH_URL, DEFAULT_WALLET_API_URL, DebugCallback, DebugCategory, DebugConfig, DebugLevel, DebugMessage, Provider, debug, detectBrowser, getBrowserDisplayName, getPlatformName, parseBrowserFromUserAgent };
+/**
+ * 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, waitForPhantomExtension };