@phantom/embedded-provider-core 1.0.0-beta.2 → 1.0.0-beta.21

package/README.md

@@ -60,7 +60,6 @@ const config: EmbeddedProviderConfig = {
   appId: "your-app-id",
   embeddedWalletType: "user-wallet", // or 'app-wallet'
   addressTypes: ["solana", "ethereum"],
-  solanaProvider: "web3js",
   authOptions: {
     authUrl: "https://auth.phantom.app",
     redirectUrl: "https://your-app.com/callback",
@@ -180,7 +179,6 @@ For server-side authenticated users:
 const authOptions = {
   provider: "jwt",
   jwtToken: "your-jwt-token",
-  customAuthData: { userId: "user123" },
 };
 
 const result = await provider.connect(authOptions);
@@ -194,7 +192,6 @@ For social login flows:
 // Google OAuth
 const authOptions = {
   provider: "google",
-  customAuthData: { referrer: "landing-page" },
 };
 
 await provider.connect(authOptions); // Will redirect/deep link
@@ -276,7 +273,6 @@ interface EmbeddedProviderConfig {
   addressTypes: [AddressType, ...AddressType[]]; // Supported blockchain addresses
 
   // Optional
-  solanaProvider?: "web3js" | "kit"; // Solana library preference
   authOptions?: {
     authUrl?: string; // Custom auth URL
     redirectUrl?: string; // OAuth redirect URL

package/dist/index.d.mts

@@ -1,8 +1,8 @@
-import { StamperWithKeyManagement } from '@phantom/sdk-types';
+import { StamperWithKeyManagement, Transaction, VersionedTransaction } from '@phantom/sdk-types';
+import { ClientSideSdkHeaders, NetworkId } from '@phantom/constants';
 import { AddressType } from '@phantom/client';
-import { NetworkId } from '@phantom/constants';
 import { ParsedSignatureResult, ParsedTransactionResult } from '@phantom/parsers';
-import { ISolanaChain, IEthereumChain, EthTransactionRequest } from '@phantom/chains';
+import { ISolanaChain, IEthereumChain, EthTransactionRequest } from '@phantom/chain-interfaces';
 
 interface Keypair {
     publicKey: string;
@@ -22,20 +22,21 @@ interface Session {
     stamperInfo: StamperInfo;
     keypair?: Keypair;
     authProvider?: string;
-    userInfo?: Record<string, any>;
     status: "pending" | "completed" | "failed";
     createdAt: number;
     lastUsed: number;
     authenticatorCreatedAt: number;
     authenticatorExpiresAt: number;
     lastRenewalAttempt?: number;
-    username: string;
     accountDerivationIndex?: number;
+    authUserId?: string;
 }
 interface EmbeddedStorage {
     getSession(): Promise<Session | null>;
     saveSession(session: Session): Promise<void>;
     clearSession(): Promise<void>;
+    getShouldClearPreviousSession(): Promise<boolean>;
+    setShouldClearPreviousSession(should: boolean): Promise<void>;
 }
 
 /**
@@ -60,38 +61,49 @@ interface URLParamsAccessor {
 
 interface AuthResult {
     walletId: string;
+    organizationId: string;
     provider?: string;
-    userInfo?: Record<string, any>;
-    accountDerivationIndex?: number;
+    accountDerivationIndex: number;
+    expiresInMs: number;
+    authUserId?: string;
 }
 interface PhantomConnectOptions {
-    organizationId: string;
-    parentOrganizationId: string;
+    publicKey: string;
     appId: string;
     provider?: "google" | "apple";
     redirectUrl?: string;
-    customAuthData?: Record<string, any>;
     authUrl?: string;
     sessionId: string;
+    clearPreviousSession?: boolean;
+    allowRefresh?: boolean;
 }
 interface JWTAuthOptions {
     appId: string;
-    organizationId: string;
-    parentOrganizationId: string;
+    publicKey: string;
     jwtToken: string;
-    customAuthData?: Record<string, any>;
 }
 interface AuthProvider {
     authenticate(options: PhantomConnectOptions | JWTAuthOptions): Promise<void | AuthResult>;
     resumeAuthFromRedirect?(): AuthResult | null;
 }
+interface PhantomAppAuthOptions {
+    publicKey: string;
+    appId: string;
+    sessionId: string;
+}
+interface PhantomAppProvider {
+    authenticate(options: PhantomAppAuthOptions): Promise<AuthResult>;
+    isAvailable(): boolean;
+}
 
 interface PlatformAdapter {
     name: string;
     storage: EmbeddedStorage;
     authProvider: AuthProvider;
+    phantomAppProvider: PhantomAppProvider;
     urlParamsAccessor: URLParamsAccessor;
     stamper: StamperWithKeyManagement;
+    analyticsHeaders?: Partial<ClientSideSdkHeaders>;
 }
 interface DebugLogger {
     info(category: string, message: string, data?: any): void;
@@ -108,11 +120,17 @@ interface ConnectResult {
     walletId?: string;
     addresses: WalletAddress[];
     status?: "pending" | "completed";
+    providerType?: "embedded" | "injected";
+    authUserId?: string;
 }
 interface SignMessageParams {
     message: string;
     networkId: NetworkId;
 }
+interface SignTypedDataV4Params {
+    typedData: any;
+    networkId: NetworkId;
+}
 interface SignMessageResult extends ParsedSignatureResult {
 }
 interface SignTransactionParams {
@@ -126,30 +144,52 @@ interface SignAndSendTransactionParams {
 interface SignedTransaction extends ParsedTransactionResult {
 }
 interface AuthOptions {
-    provider?: "google" | "apple" | "jwt";
+    provider: "google" | "apple" | "jwt" | "phantom" | "injected";
     jwtToken?: string;
     customAuthData?: Record<string, any>;
 }
 interface EmbeddedProviderConfig {
     apiBaseUrl: string;
     appId: string;
-    organizationId: string;
-    authOptions?: {
-        authUrl?: string;
-        redirectUrl?: string;
+    authOptions: {
+        authUrl: string;
+        redirectUrl: string;
     };
     embeddedWalletType: "app-wallet" | "user-wallet" | (string & Record<never, never>);
-    addressTypes: [AddressType, ...AddressType[]];
-    solanaProvider: "web3js" | "kit" | (string & Record<never, never>);
+    addressTypes: AddressType[];
 }
 
 type EmbeddedProviderEvent = "connect" | "connect_start" | "connect_error" | "disconnect" | "error";
-type EventCallback = (data?: any) => void;
+interface ConnectEventData extends ConnectResult {
+    source: "auto-connect" | "manual-connect" | "manual-existing" | "existing-session" | "manual";
+}
+interface ConnectStartEventData {
+    source: "auto-connect" | "manual-connect";
+    authOptions?: {
+        provider?: string;
+    };
+}
+interface ConnectErrorEventData {
+    error: string;
+    source: "auto-connect" | "manual-connect";
+}
+interface DisconnectEventData {
+    source: "manual";
+}
+interface EmbeddedProviderEventMap {
+    connect: ConnectEventData;
+    connect_start: ConnectStartEventData;
+    connect_error: ConnectErrorEventData;
+    disconnect: DisconnectEventData;
+    error: any;
+}
+type EventCallback<T = any> = (data: T) => void;
 declare class EmbeddedProvider {
     private config;
     private platform;
     private storage;
     private authProvider;
+    private phantomAppProvider;
     private urlParamsAccessor;
     private stamper;
     private logger;
@@ -161,29 +201,36 @@ declare class EmbeddedProvider {
     readonly ethereum: IEthereumChain;
     private eventListeners;
     constructor(config: EmbeddedProviderConfig, platform: PlatformAdapter, logger: DebugLogger);
-    on(event: EmbeddedProviderEvent, callback: EventCallback): void;
-    off(event: EmbeddedProviderEvent, callback: EventCallback): void;
+    on<K extends EmbeddedProviderEvent>(event: K, callback: EventCallback<EmbeddedProviderEventMap[K]>): void;
+    off<K extends EmbeddedProviderEvent>(event: K, callback: EventCallback<EmbeddedProviderEventMap[K]>): void;
     private emit;
+    /**
+     * Get the appropriate address for a given network ID from available addresses
+     */
+    private getAddressForNetwork;
     private getAndFilterWalletAddresses;
     private validateAndCleanSession;
     private tryExistingConnection;
     private validateAuthOptions;
     private isSessionValid;
     autoConnect(): Promise<void>;
-    private createOrganizationAndStamper;
-    connect(authOptions?: AuthOptions): Promise<ConnectResult>;
-    disconnect(): Promise<void>;
+    private initializeStamper;
+    private createOrganizationForAppWallet;
+    connect(authOptions: AuthOptions): Promise<ConnectResult>;
+    disconnect(shouldClearPreviousSession?: boolean): Promise<void>;
     signMessage(params: SignMessageParams): Promise<ParsedSignatureResult>;
+    signEthereumMessage(params: SignMessageParams): Promise<ParsedSignatureResult>;
+    signTypedDataV4(params: SignTypedDataV4Params): Promise<ParsedSignatureResult>;
     signTransaction(params: SignTransactionParams): Promise<ParsedTransactionResult>;
     signAndSendTransaction(params: SignAndSendTransactionParams): Promise<ParsedTransactionResult>;
     getAddresses(): WalletAddress[];
     isConnected(): boolean;
     private handleAuthFlow;
     private handleJWTAuth;
+    private handlePhantomAuth;
     private handleRedirectAuth;
     private completeAuthConnection;
     private ensureValidAuthenticator;
-    private renewAuthenticator;
     private initializeClientFromSession;
 }
 
@@ -212,11 +259,14 @@ declare class EmbeddedSolanaChain implements ISolanaChain {
         signature: Uint8Array;
         publicKey: string;
     }>;
-    signTransaction<T>(transaction: T): Promise<T>;
-    signAndSendTransaction<T>(transaction: T): Promise<{
+    signTransaction(transaction: Transaction | VersionedTransaction): Promise<Transaction | VersionedTransaction>;
+    signAndSendTransaction(transaction: Transaction | VersionedTransaction): Promise<{
         signature: string;
     }>;
-    signAllTransactions<T>(transactions: T[]): Promise<T[]>;
+    signAllTransactions(transactions: (Transaction | VersionedTransaction)[]): Promise<(Transaction | VersionedTransaction)[]>;
+    signAndSendAllTransactions(transactions: (Transaction | VersionedTransaction)[]): Promise<{
+        signatures: string[];
+    }>;
     connect(_options?: {
         onlyIfTrusted?: boolean;
     }): Promise<{
@@ -257,7 +307,7 @@ declare class EmbeddedEthereumChain implements IEthereumChain {
     signTypedData(typedData: any, address: string): Promise<string>;
     signTransaction(transaction: EthTransactionRequest): Promise<string>;
     sendTransaction(transaction: EthTransactionRequest): Promise<string>;
-    switchChain(chainId: number): Promise<void>;
+    switchChain(chainId: number | string): Promise<void>;
     getChainId(): Promise<number>;
     getAccounts(): Promise<string[]>;
     isConnected(): boolean;
@@ -285,4 +335,4 @@ declare const AUTHENTICATOR_EXPIRATION_TIME_MS: number;
  */
 declare const AUTHENTICATOR_RENEWAL_WINDOW_MS: number;
 
-export { AUTHENTICATOR_EXPIRATION_TIME_MS, AUTHENTICATOR_RENEWAL_WINDOW_MS, AuthOptions, AuthProvider, AuthResult, ConnectResult, DebugLogger, EmbeddedEthereumChain, EmbeddedProvider, EmbeddedProviderConfig, EmbeddedProviderEvent, EmbeddedSolanaChain, EmbeddedStorage, EventCallback, JWTAuth, JWTAuthOptions, Keypair, PhantomConnectOptions, PlatformAdapter, Session, SignAndSendTransactionParams, SignMessageParams, SignMessageResult, SignTransactionParams, SignedTransaction, StamperInfo, URLParamsAccessor, WalletAddress, generateSessionId, retryWithBackoff };
+export { AUTHENTICATOR_EXPIRATION_TIME_MS, AUTHENTICATOR_RENEWAL_WINDOW_MS, AuthOptions, AuthProvider, AuthResult, ConnectErrorEventData, ConnectEventData, ConnectResult, ConnectStartEventData, DebugLogger, DisconnectEventData, EmbeddedEthereumChain, EmbeddedProvider, EmbeddedProviderConfig, EmbeddedProviderEvent, EmbeddedProviderEventMap, EmbeddedSolanaChain, EmbeddedStorage, EventCallback, JWTAuth, JWTAuthOptions, Keypair, PhantomAppAuthOptions, PhantomAppProvider, PhantomConnectOptions, PlatformAdapter, Session, SignAndSendTransactionParams, SignMessageParams, SignMessageResult, SignTransactionParams, SignTypedDataV4Params, SignedTransaction, StamperInfo, URLParamsAccessor, WalletAddress, generateSessionId, retryWithBackoff };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { StamperWithKeyManagement } from '@phantom/sdk-types';
+import { StamperWithKeyManagement, Transaction, VersionedTransaction } from '@phantom/sdk-types';
+import { ClientSideSdkHeaders, NetworkId } from '@phantom/constants';
 import { AddressType } from '@phantom/client';
-import { NetworkId } from '@phantom/constants';
 import { ParsedSignatureResult, ParsedTransactionResult } from '@phantom/parsers';
-import { ISolanaChain, IEthereumChain, EthTransactionRequest } from '@phantom/chains';
+import { ISolanaChain, IEthereumChain, EthTransactionRequest } from '@phantom/chain-interfaces';
 
 interface Keypair {
     publicKey: string;
@@ -22,20 +22,21 @@ interface Session {
     stamperInfo: StamperInfo;
     keypair?: Keypair;
     authProvider?: string;
-    userInfo?: Record<string, any>;
     status: "pending" | "completed" | "failed";
     createdAt: number;
     lastUsed: number;
     authenticatorCreatedAt: number;
     authenticatorExpiresAt: number;
     lastRenewalAttempt?: number;
-    username: string;
     accountDerivationIndex?: number;
+    authUserId?: string;
 }
 interface EmbeddedStorage {
     getSession(): Promise<Session | null>;
     saveSession(session: Session): Promise<void>;
     clearSession(): Promise<void>;
+    getShouldClearPreviousSession(): Promise<boolean>;
+    setShouldClearPreviousSession(should: boolean): Promise<void>;
 }
 
 /**
@@ -60,38 +61,49 @@ interface URLParamsAccessor {
 
 interface AuthResult {
     walletId: string;
+    organizationId: string;
     provider?: string;
-    userInfo?: Record<string, any>;
-    accountDerivationIndex?: number;
+    accountDerivationIndex: number;
+    expiresInMs: number;
+    authUserId?: string;
 }
 interface PhantomConnectOptions {
-    organizationId: string;
-    parentOrganizationId: string;
+    publicKey: string;
     appId: string;
     provider?: "google" | "apple";
     redirectUrl?: string;
-    customAuthData?: Record<string, any>;
     authUrl?: string;
     sessionId: string;
+    clearPreviousSession?: boolean;
+    allowRefresh?: boolean;
 }
 interface JWTAuthOptions {
     appId: string;
-    organizationId: string;
-    parentOrganizationId: string;
+    publicKey: string;
     jwtToken: string;
-    customAuthData?: Record<string, any>;
 }
 interface AuthProvider {
     authenticate(options: PhantomConnectOptions | JWTAuthOptions): Promise<void | AuthResult>;
     resumeAuthFromRedirect?(): AuthResult | null;
 }
+interface PhantomAppAuthOptions {
+    publicKey: string;
+    appId: string;
+    sessionId: string;
+}
+interface PhantomAppProvider {
+    authenticate(options: PhantomAppAuthOptions): Promise<AuthResult>;
+    isAvailable(): boolean;
+}
 
 interface PlatformAdapter {
     name: string;
     storage: EmbeddedStorage;
     authProvider: AuthProvider;
+    phantomAppProvider: PhantomAppProvider;
     urlParamsAccessor: URLParamsAccessor;
     stamper: StamperWithKeyManagement;
+    analyticsHeaders?: Partial<ClientSideSdkHeaders>;
 }
 interface DebugLogger {
     info(category: string, message: string, data?: any): void;
@@ -108,11 +120,17 @@ interface ConnectResult {
     walletId?: string;
     addresses: WalletAddress[];
     status?: "pending" | "completed";
+    providerType?: "embedded" | "injected";
+    authUserId?: string;
 }
 interface SignMessageParams {
     message: string;
     networkId: NetworkId;
 }
+interface SignTypedDataV4Params {
+    typedData: any;
+    networkId: NetworkId;
+}
 interface SignMessageResult extends ParsedSignatureResult {
 }
 interface SignTransactionParams {
@@ -126,30 +144,52 @@ interface SignAndSendTransactionParams {
 interface SignedTransaction extends ParsedTransactionResult {
 }
 interface AuthOptions {
-    provider?: "google" | "apple" | "jwt";
+    provider: "google" | "apple" | "jwt" | "phantom" | "injected";
     jwtToken?: string;
     customAuthData?: Record<string, any>;
 }
 interface EmbeddedProviderConfig {
     apiBaseUrl: string;
     appId: string;
-    organizationId: string;
-    authOptions?: {
-        authUrl?: string;
-        redirectUrl?: string;
+    authOptions: {
+        authUrl: string;
+        redirectUrl: string;
     };
     embeddedWalletType: "app-wallet" | "user-wallet" | (string & Record<never, never>);
-    addressTypes: [AddressType, ...AddressType[]];
-    solanaProvider: "web3js" | "kit" | (string & Record<never, never>);
+    addressTypes: AddressType[];
 }
 
 type EmbeddedProviderEvent = "connect" | "connect_start" | "connect_error" | "disconnect" | "error";
-type EventCallback = (data?: any) => void;
+interface ConnectEventData extends ConnectResult {
+    source: "auto-connect" | "manual-connect" | "manual-existing" | "existing-session" | "manual";
+}
+interface ConnectStartEventData {
+    source: "auto-connect" | "manual-connect";
+    authOptions?: {
+        provider?: string;
+    };
+}
+interface ConnectErrorEventData {
+    error: string;
+    source: "auto-connect" | "manual-connect";
+}
+interface DisconnectEventData {
+    source: "manual";
+}
+interface EmbeddedProviderEventMap {
+    connect: ConnectEventData;
+    connect_start: ConnectStartEventData;
+    connect_error: ConnectErrorEventData;
+    disconnect: DisconnectEventData;
+    error: any;
+}
+type EventCallback<T = any> = (data: T) => void;
 declare class EmbeddedProvider {
     private config;
     private platform;
     private storage;
     private authProvider;
+    private phantomAppProvider;
     private urlParamsAccessor;
     private stamper;
     private logger;
@@ -161,29 +201,36 @@ declare class EmbeddedProvider {
     readonly ethereum: IEthereumChain;
     private eventListeners;
     constructor(config: EmbeddedProviderConfig, platform: PlatformAdapter, logger: DebugLogger);
-    on(event: EmbeddedProviderEvent, callback: EventCallback): void;
-    off(event: EmbeddedProviderEvent, callback: EventCallback): void;
+    on<K extends EmbeddedProviderEvent>(event: K, callback: EventCallback<EmbeddedProviderEventMap[K]>): void;
+    off<K extends EmbeddedProviderEvent>(event: K, callback: EventCallback<EmbeddedProviderEventMap[K]>): void;
     private emit;
+    /**
+     * Get the appropriate address for a given network ID from available addresses
+     */
+    private getAddressForNetwork;
     private getAndFilterWalletAddresses;
     private validateAndCleanSession;
     private tryExistingConnection;
     private validateAuthOptions;
     private isSessionValid;
     autoConnect(): Promise<void>;
-    private createOrganizationAndStamper;
-    connect(authOptions?: AuthOptions): Promise<ConnectResult>;
-    disconnect(): Promise<void>;
+    private initializeStamper;
+    private createOrganizationForAppWallet;
+    connect(authOptions: AuthOptions): Promise<ConnectResult>;
+    disconnect(shouldClearPreviousSession?: boolean): Promise<void>;
     signMessage(params: SignMessageParams): Promise<ParsedSignatureResult>;
+    signEthereumMessage(params: SignMessageParams): Promise<ParsedSignatureResult>;
+    signTypedDataV4(params: SignTypedDataV4Params): Promise<ParsedSignatureResult>;
     signTransaction(params: SignTransactionParams): Promise<ParsedTransactionResult>;
     signAndSendTransaction(params: SignAndSendTransactionParams): Promise<ParsedTransactionResult>;
     getAddresses(): WalletAddress[];
     isConnected(): boolean;
     private handleAuthFlow;
     private handleJWTAuth;
+    private handlePhantomAuth;
     private handleRedirectAuth;
     private completeAuthConnection;
     private ensureValidAuthenticator;
-    private renewAuthenticator;
     private initializeClientFromSession;
 }
 
@@ -212,11 +259,14 @@ declare class EmbeddedSolanaChain implements ISolanaChain {
         signature: Uint8Array;
         publicKey: string;
     }>;
-    signTransaction<T>(transaction: T): Promise<T>;
-    signAndSendTransaction<T>(transaction: T): Promise<{
+    signTransaction(transaction: Transaction | VersionedTransaction): Promise<Transaction | VersionedTransaction>;
+    signAndSendTransaction(transaction: Transaction | VersionedTransaction): Promise<{
         signature: string;
     }>;
-    signAllTransactions<T>(transactions: T[]): Promise<T[]>;
+    signAllTransactions(transactions: (Transaction | VersionedTransaction)[]): Promise<(Transaction | VersionedTransaction)[]>;
+    signAndSendAllTransactions(transactions: (Transaction | VersionedTransaction)[]): Promise<{
+        signatures: string[];
+    }>;
     connect(_options?: {
         onlyIfTrusted?: boolean;
     }): Promise<{
@@ -257,7 +307,7 @@ declare class EmbeddedEthereumChain implements IEthereumChain {
     signTypedData(typedData: any, address: string): Promise<string>;
     signTransaction(transaction: EthTransactionRequest): Promise<string>;
     sendTransaction(transaction: EthTransactionRequest): Promise<string>;
-    switchChain(chainId: number): Promise<void>;
+    switchChain(chainId: number | string): Promise<void>;
     getChainId(): Promise<number>;
     getAccounts(): Promise<string[]>;
     isConnected(): boolean;
@@ -285,4 +335,4 @@ declare const AUTHENTICATOR_EXPIRATION_TIME_MS: number;
  */
 declare const AUTHENTICATOR_RENEWAL_WINDOW_MS: number;
 
-export { AUTHENTICATOR_EXPIRATION_TIME_MS, AUTHENTICATOR_RENEWAL_WINDOW_MS, AuthOptions, AuthProvider, AuthResult, ConnectResult, DebugLogger, EmbeddedEthereumChain, EmbeddedProvider, EmbeddedProviderConfig, EmbeddedProviderEvent, EmbeddedSolanaChain, EmbeddedStorage, EventCallback, JWTAuth, JWTAuthOptions, Keypair, PhantomConnectOptions, PlatformAdapter, Session, SignAndSendTransactionParams, SignMessageParams, SignMessageResult, SignTransactionParams, SignedTransaction, StamperInfo, URLParamsAccessor, WalletAddress, generateSessionId, retryWithBackoff };
+export { AUTHENTICATOR_EXPIRATION_TIME_MS, AUTHENTICATOR_RENEWAL_WINDOW_MS, AuthOptions, AuthProvider, AuthResult, ConnectErrorEventData, ConnectEventData, ConnectResult, ConnectStartEventData, DebugLogger, DisconnectEventData, EmbeddedEthereumChain, EmbeddedProvider, EmbeddedProviderConfig, EmbeddedProviderEvent, EmbeddedProviderEventMap, EmbeddedSolanaChain, EmbeddedStorage, EventCallback, JWTAuth, JWTAuthOptions, Keypair, PhantomAppAuthOptions, PhantomAppProvider, PhantomConnectOptions, PlatformAdapter, Session, SignAndSendTransactionParams, SignMessageParams, SignMessageResult, SignTransactionParams, SignTypedDataV4Params, SignedTransaction, StamperInfo, URLParamsAccessor, WalletAddress, generateSessionId, retryWithBackoff };