@phantom/browser-sdk 1.0.0-beta.1 → 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",
-  appId: "your-app-id",
+  appId: "your-app-id", // Get your app ID from phantom.com/portal
 });
 
 const { addresses } = await sdk.connect();
@@ -190,48 +189,29 @@ 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",
-  appId: "your-app-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
   },
   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
 });
 ```
 
@@ -242,28 +222,6 @@ const sdk = new BrowserSDK({
 | `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:**
-
-- **@solana/web3.js**: Better ecosystem compatibility, wider community support
-- **@solana/kit**: Better TypeScript support, modern architecture, smaller bundle size
 
 ### Auto-Connect Feature
 
@@ -272,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
 });
 
@@ -295,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
 });
 
@@ -320,15 +278,16 @@ interface BrowserSDKConfig {
   addressTypes?: [AddressType, ...AddressType[]]; // Networks to enable (e.g., [AddressType.solana])
 
   // Required for embedded provider only
-  apiBaseUrl?: string; // Phantom API base URL
-  appId?: string; // Your app ID (required for embedded provider)
+  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)
 }
 ```
 
@@ -463,6 +422,12 @@ 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..." }],
+});
 ```
 
 #### signPersonalMessage(message, address)
@@ -511,6 +476,20 @@ 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.
@@ -728,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
@@ -795,7 +774,6 @@ import { BrowserSDK, AddressType } from "@phantom/browser-sdk";
 const sdk = new BrowserSDK({
   providerType: "injected",
   addressTypes: [AddressType.solana],
-  solanaProvider: "web3js",
 });
 
 await sdk.connect();
@@ -849,7 +827,6 @@ import { BrowserSDK, AddressType } from "@phantom/browser-sdk";
 const sdk = new BrowserSDK({
   providerType: "injected",
   addressTypes: [AddressType.solana],
-  solanaProvider: "kit",
 });
 
 await sdk.connect();

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;
-    appId?: 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;
 }
@@ -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,6 +258,18 @@ 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
@@ -256,4 +289,4 @@ declare function getBrowserDisplayName(): string;
  */
 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 };
+export { BrowserInfo, BrowserSDK, BrowserSDKConfig, DebugCallback, DebugCategory, DebugConfig, DebugLevel, DebugMessage, Provider, debug, detectBrowser, getBrowserDisplayName, getDeeplinkToPhantom, getPlatformName, isMobileDevice, parseBrowserFromUserAgent, waitForPhantomExtension };