@reown/appkit-solana-react-native 0.0.0-feat-multichain-20250604171123 → 0.0.0-feat-multichain-phantom-20250606183519

package/lib/typescript/types.d.ts

@@ -0,0 +1,96 @@
+import type { CaipNetworkId, Namespaces, Storage, WalletInfo } from '@reown/appkit-common-react-native';
+import type nacl from 'tweetnacl';
+export interface TokenInfo {
+    address: string;
+    symbol: string;
+    name: string;
+    decimals: number;
+    logoURI?: string;
+}
+export type PhantomCluster = 'mainnet-beta' | 'testnet' | 'devnet';
+export interface PhantomProviderConfig {
+    appScheme: string;
+    dappUrl: string;
+    storage: Storage;
+    dappEncryptionKeyPair: nacl.BoxKeyPair;
+}
+export type PhantomConnectResult = PhantomSession;
+export interface PhantomSession {
+    sessionToken: string;
+    userPublicKey: string;
+    phantomEncryptionPublicKeyBs58: string;
+    cluster: PhantomCluster;
+}
+export interface SignTransactionRequestParams {
+    transaction: string;
+}
+export interface SignMessageRequestParams {
+    message: Uint8Array | string;
+    display?: 'utf8' | 'hex';
+}
+export interface SignAllTransactionsRequestParams {
+    transactions: string[];
+}
+export interface PhantomDeeplinkResponse {
+    phantom_encryption_public_key?: string;
+    nonce: string;
+    data: string;
+}
+export interface DecryptedConnectData {
+    public_key: string;
+    session: string;
+}
+export interface PhantomProviderConfig {
+    appScheme: string;
+    dappUrl: string;
+    storage: Storage;
+    dappEncryptionKeyPair: nacl.BoxKeyPair;
+}
+export interface PhantomSession {
+    sessionToken: string;
+    userPublicKey: string;
+    phantomEncryptionPublicKeyBs58: string;
+    cluster: PhantomCluster;
+}
+export type PhantomRpcMethod = 'connect' | 'disconnect' | 'signTransaction' | 'signAndSendTransaction' | 'signAllTransactions' | 'signMessage';
+export interface PhantomSignTransactionParams {
+    dapp_encryption_public_key: string;
+    redirect_link: string;
+    payload: string;
+    nonce: string;
+    cluster?: PhantomCluster;
+}
+export interface PhantomSignAllTransactionsParams {
+    dapp_encryption_public_key: string;
+    redirect_link: string;
+    payload: string;
+    nonce: string;
+    cluster?: PhantomCluster;
+}
+export interface PhantomSignMessageParams {
+    dapp_encryption_public_key: string;
+    redirect_link: string;
+    payload: string;
+    nonce: string;
+}
+export interface PhantomConnectParams {
+    app_url: string;
+    dapp_encryption_public_key: string;
+    redirect_link: string;
+    cluster?: PhantomCluster;
+}
+export interface PhantomDisconnectParams {
+    dapp_encryption_public_key: string;
+    redirect_link: string;
+    payload: string;
+    nonce: string;
+}
+export interface PhantomConnectorConfig {
+    cluster?: PhantomCluster;
+}
+export interface PhantomConnectorSessionData {
+    namespaces: Namespaces;
+    wallet: WalletInfo;
+    currentCaipNetworkId: CaipNetworkId;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/typescript/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,UAAU,EACV,OAAO,EACP,UAAU,EACX,MAAM,mCAAmC,CAAC;AAC3C,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAIlC,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAID,MAAM,MAAM,cAAc,GAAG,cAAc,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEnE,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,qBAAqB,EAAE,IAAI,CAAC,UAAU,CAAC;CACxC;AAED,MAAM,MAAM,oBAAoB,GAAG,cAAc,CAAC;AAElD,MAAM,WAAW,cAAc;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,8BAA8B,EAAE,MAAM,CAAC;IACvC,OAAO,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,4BAA4B;IAC3C,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,UAAU,GAAG,MAAM,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;CAC1B;AACD,MAAM,WAAW,gCAAgC;IAC/C,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED,MAAM,WAAW,uBAAuB;IACtC,6BAA6B,CAAC,EAAE,MAAM,CAAC;IACvC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,qBAAqB,EAAE,IAAI,CAAC,UAAU,CAAC;CACxC;AAED,MAAM,WAAW,cAAc;IAC7B,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,8BAA8B,EAAE,MAAM,CAAC;IACvC,OAAO,EAAE,cAAc,CAAC;CACzB;AAGD,MAAM,MAAM,gBAAgB,GACxB,SAAS,GACT,YAAY,GACZ,iBAAiB,GACjB,wBAAwB,GACxB,qBAAqB,GACrB,aAAa,CAAC;AAElB,MAAM,WAAW,4BAA4B;IAC3C,0BAA0B,EAAE,MAAM,CAAC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED,MAAM,WAAW,gCAAgC;IAC/C,0BAA0B,EAAE,MAAM,CAAC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,0BAA0B,EAAE,MAAM,CAAC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,0BAA0B,EAAE,MAAM,CAAC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED,MAAM,WAAW,uBAAuB;IACtC,0BAA0B,EAAE,MAAM,CAAC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf;AAID,MAAM,WAAW,sBAAsB;IACrC,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B;AAED,MAAM,WAAW,2BAA2B;IAC1C,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE,UAAU,CAAC;IACnB,oBAAoB,EAAE,aAAa,CAAC;CACrC"}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@reown/appkit-solana-react-native",
-  "version": "0.0.0-feat-multichain-20250604171123",
+  "version": "0.0.0-feat-multichain-phantom-20250606183519",
   "main": "lib/commonjs/index.js",
   "types": "lib/typescript/index.d.ts",
   "module": "lib/module/index.js",
-  "source": "src/index.tsx",
+  "react-native": "src/index.ts",
+  "source": "src/index.ts",
   "scripts": {
     "build": "bob build",
     "clean": "rm -rf lib",
@@ -38,7 +39,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@reown/appkit-common-react-native": "0.0.0-feat-multichain-20250604171123"
-  },
-  "react-native": "src/index.tsx"
+    "@reown/appkit-common-react-native": "0.0.0-feat-multichain-phantom-20250606183519",
+    "bs58": "6.0.0",
+    "tweetnacl": "1.0.3"
+  }
 }

package/src/connectors/PhantomConnector.ts

@@ -0,0 +1,329 @@
+import {
+  WalletConnector,
+  type AppKitNetwork,
+  type CaipNetworkId,
+  type ChainNamespace,
+  type ConnectOptions,
+  type Namespaces,
+  type WalletInfo,
+  type CaipAddress,
+  type ConnectorInitOptions,
+  type Storage,
+  solana,
+  solanaDevnet,
+  solanaTestnet
+} from '@reown/appkit-common-react-native';
+import nacl from 'tweetnacl';
+import bs58 from 'bs58';
+
+import { PhantomProvider, SOLANA_SIGNING_METHODS } from '../providers/PhantomProvider';
+import type {
+  PhantomCluster,
+  PhantomConnectorConfig,
+  PhantomConnectorSessionData,
+  PhantomProviderConfig
+} from '../types';
+
+const SOLANA_CLUSTER_TO_CHAIN_ID_PART: Record<PhantomCluster, string> = {
+  'mainnet-beta': solana.id as string,
+  'testnet': solanaTestnet.id as string,
+  'devnet': solanaDevnet.id as string
+};
+
+const PHANTOM_CONNECTOR_STORAGE_KEY = '@appkit/phantom-connector-data';
+const DAPP_KEYPAIR_STORAGE_KEY = '@appkit/phantom-dapp-secret-key';
+
+export class PhantomConnector extends WalletConnector {
+  private readonly config: PhantomConnectorConfig;
+
+  private currentCaipNetworkId: CaipNetworkId | null = null;
+  private dappEncryptionKeyPair?: nacl.BoxKeyPair;
+
+  private static readonly SUPPORTED_NAMESPACE: ChainNamespace = 'solana';
+
+  constructor(config: PhantomConnectorConfig) {
+    super({ type: 'phantom' });
+    this.config = config;
+  }
+
+  override async init(ops: ConnectorInitOptions) {
+    super.init(ops);
+    this.storage = ops.storage;
+    await this.initializeKeyPair();
+
+    const appScheme = ops.metadata.redirect?.universal;
+    if (!appScheme) {
+      throw new Error(
+        'Phantom Connector: No universal link found in metadata. Please add redirect.universal to the metadata.'
+      );
+    }
+
+    const providerConfig: PhantomProviderConfig = {
+      appScheme,
+      dappUrl: ops.metadata.url,
+      storage: ops.storage,
+      dappEncryptionKeyPair: this.dappEncryptionKeyPair!
+    };
+
+    this.provider = new PhantomProvider(providerConfig);
+    this.restoreSession();
+  }
+
+  private async initializeKeyPair(): Promise<void> {
+    try {
+      const secretKeyB58 = await this.getStorage().getItem(DAPP_KEYPAIR_STORAGE_KEY);
+      if (secretKeyB58) {
+        const secretKey = bs58.decode(secretKeyB58);
+        this.dappEncryptionKeyPair = nacl.box.keyPair.fromSecretKey(secretKey);
+      } else {
+        const newKeyPair = nacl.box.keyPair();
+        this.dappEncryptionKeyPair = newKeyPair;
+        await this.getStorage().setItem(
+          DAPP_KEYPAIR_STORAGE_KEY,
+          bs58.encode(newKeyPair.secretKey)
+        );
+      }
+    } catch (error) {
+      // disconnect and clear session
+      await this.disconnect();
+      throw error;
+    }
+  }
+
+  override async connect(opts?: ConnectOptions): Promise<Namespaces | undefined> {
+    if (this.isConnected()) {
+      return this.namespaces;
+    }
+
+    const defaultChain =
+      opts?.defaultChain?.split(':')?.[0] === 'solana'
+        ? opts?.defaultChain?.split(':')[1]
+        : opts?.namespaces?.['solana']?.chains?.[0]?.split(':')[1];
+
+    const requestedCluster =
+      this.config.cluster ??
+      (Object.keys(SOLANA_CLUSTER_TO_CHAIN_ID_PART).find(
+        key =>
+          SOLANA_CLUSTER_TO_CHAIN_ID_PART[key as keyof typeof SOLANA_CLUSTER_TO_CHAIN_ID_PART] ===
+          defaultChain
+      ) as PhantomCluster | undefined);
+
+    try {
+      const connectResult = await this.getProvider().connect({ cluster: requestedCluster });
+
+      const solanaChainIdPart = SOLANA_CLUSTER_TO_CHAIN_ID_PART[connectResult.cluster];
+      if (!solanaChainIdPart) {
+        throw new Error(
+          `Phantom Connect: Internal - Unknown cluster mapping for ${connectResult.cluster}`
+        );
+      }
+      this.currentCaipNetworkId = `solana:${solanaChainIdPart}` as CaipNetworkId;
+
+      this.wallet = {
+        name: 'Phantom Wallet',
+        id: 'phantom-wallet'
+      };
+
+      const userPublicKey = this.getProvider().getUserPublicKey();
+      if (!userPublicKey) {
+        throw new Error('Phantom Connect: Provider failed to return a user public key.');
+      }
+
+      const caipAddress = `${this.currentCaipNetworkId}:${userPublicKey}` as CaipAddress;
+      this.namespaces = {
+        [PhantomConnector.SUPPORTED_NAMESPACE]: {
+          accounts: [caipAddress],
+          methods: Object.values(SOLANA_SIGNING_METHODS),
+          events: [],
+          chains: [this.currentCaipNetworkId]
+        }
+      };
+
+      await this.saveSession(); // Save connector-specific session on successful connect
+
+      return this.namespaces;
+    } catch (error: any) {
+      this.clearSession();
+      throw error;
+    }
+  }
+
+  override async disconnect(): Promise<void> {
+    if (!this.isConnected()) {
+      return Promise.resolve();
+    }
+    try {
+      await this.getProvider().disconnect();
+    } catch (error: any) {
+      // console.warn(`PhantomConnector: Error during provider disconnect: ${error.message}. Proceeding with local clear.`);
+    }
+    await this.clearSession();
+  }
+
+  private async clearSession(): Promise<void> {
+    this.namespaces = undefined;
+    this.wallet = undefined;
+    this.currentCaipNetworkId = null;
+    await this.clearSessionStorage();
+  }
+
+  override getProvider(): PhantomProvider {
+    if (!this.provider) {
+      throw new Error('Phantom Connector: Provider not initialized. Call init() first.');
+    }
+
+    return this.provider as PhantomProvider;
+  }
+
+  private getStorage(): Storage {
+    if (!this.storage) {
+      throw new Error('Phantom Connector: Storage not initialized. Call init() first.');
+    }
+
+    return this.storage;
+  }
+
+  override getNamespaces(): Namespaces {
+    if (!this.namespaces) {
+      throw new Error('Phantom Connector: Not connected. Call connect() first.');
+    }
+
+    return this.namespaces;
+  }
+
+  override getChainId(namespace: ChainNamespace): CaipNetworkId | undefined {
+    if (namespace === PhantomConnector.SUPPORTED_NAMESPACE) {
+      return this.currentCaipNetworkId ?? undefined;
+    }
+
+    return undefined;
+  }
+
+  override getWalletInfo(): WalletInfo | undefined {
+    if (!this.isConnected()) {
+      return undefined;
+    }
+
+    return this.wallet;
+  }
+
+  isConnected(): boolean {
+    // Rely solely on the provider as the source of truth for connection status.
+    return this.getProvider().isConnected() && !!this.getProvider().getUserPublicKey();
+  }
+
+  override async switchNetwork(network: AppKitNetwork): Promise<void> {
+    const targetClusterName = Object.keys(SOLANA_CLUSTER_TO_CHAIN_ID_PART).find(
+      key =>
+        SOLANA_CLUSTER_TO_CHAIN_ID_PART[key as keyof typeof SOLANA_CLUSTER_TO_CHAIN_ID_PART] ===
+        network.id
+    ) as PhantomCluster | undefined;
+
+    if (!targetClusterName) {
+      throw new Error(`Cannot switch to unsupported network ID: ${network.id}`);
+    }
+
+    const currentClusterName = Object.keys(SOLANA_CLUSTER_TO_CHAIN_ID_PART).find(
+      key =>
+        `solana:${
+          SOLANA_CLUSTER_TO_CHAIN_ID_PART[key as keyof typeof SOLANA_CLUSTER_TO_CHAIN_ID_PART]
+        }` === this.currentCaipNetworkId
+    ) as PhantomCluster | undefined;
+
+    if (targetClusterName === currentClusterName && this.isConnected()) {
+      return Promise.resolve();
+    }
+
+    // For deeplink wallets, switching network effectively means re-connecting to the new cluster.
+    // We can try to disconnect the current session and then initiate a new connection.
+    // console.log(`Attempting to switch network to: ${targetClusterName}`);
+    await this.disconnect(); // Clear current session
+
+    // Create a temporary options object to guide the new connection
+    const tempConnectOpts: ConnectOptions = {
+      defaultChain: `solana:${SOLANA_CLUSTER_TO_CHAIN_ID_PART[targetClusterName]}` as CaipNetworkId
+    };
+
+    // Attempt to connect to the new cluster
+    // The connect method will use the defaultChain from opts to determine the cluster.
+    await this.connect(tempConnectOpts);
+
+    // Verify if the connection was successful and to the correct new network
+    if (
+      !this.isConnected() ||
+      this.getChainId(PhantomConnector.SUPPORTED_NAMESPACE) !== tempConnectOpts.defaultChain
+    ) {
+      throw new Error(
+        `Failed to switch network to ${targetClusterName}. Please try connecting manually.`
+      );
+    }
+  }
+
+  // Orchestrates session restoration
+  public async restoreSession(): Promise<boolean> {
+    try {
+      const providerSession = await this.getProvider().restoreSession();
+      if (!providerSession) {
+        return false;
+      }
+
+      // If provider session is restored, try to restore connector data
+      const storedConnectorDataJson = await this.getStorage().getItem(
+        PHANTOM_CONNECTOR_STORAGE_KEY
+      );
+      if (!storedConnectorDataJson) {
+        return false; // Provider session exists but connector data is missing
+      }
+
+      const connectorData: PhantomConnectorSessionData = JSON.parse(storedConnectorDataJson);
+      this.namespaces = connectorData.namespaces;
+      this.wallet = connectorData.wallet;
+      this.currentCaipNetworkId = connectorData.currentCaipNetworkId;
+
+      // await this.initializeKeyPair();
+
+      // Final validation
+      if (this.isConnected()) {
+        return true;
+      }
+
+      // If validation fails, something is out of sync. Clear everything.
+      await this.disconnect();
+
+      return false;
+    } catch (error) {
+      // On any error, disconnect to ensure a clean state
+      await this.disconnect();
+
+      return false;
+    }
+  }
+
+  // Saves only connector-specific data
+  private async saveSession(): Promise<void> {
+    if (!this.namespaces || !this.wallet || !this.currentCaipNetworkId) {
+      return;
+    }
+
+    const connectorData: PhantomConnectorSessionData = {
+      namespaces: this.namespaces,
+      wallet: this.wallet,
+      currentCaipNetworkId: this.currentCaipNetworkId
+    };
+
+    try {
+      await this.getStorage().setItem(PHANTOM_CONNECTOR_STORAGE_KEY, JSON.stringify(connectorData));
+    } catch (error) {
+      // console.error('PhantomConnector: Failed to save session.', error);
+    }
+  }
+
+  // Clears only connector-specific data from storage
+  private async clearSessionStorage(): Promise<void> {
+    try {
+      await this.getStorage().removeItem(PHANTOM_CONNECTOR_STORAGE_KEY);
+    } catch (error) {
+      // console.error('PhantomConnector: Failed to clear session from storage.', error);
+    }
+  }
+}

package/src/helpers.ts

@@ -1,10 +1,4 @@
-export interface TokenInfo {
-  address: string;
-  symbol: string;
-  name: string;
-  decimals: number;
-  logoURI?: string;
-}
+import type { TokenInfo } from './types';
 
 /**
  * Validates if the given string is a Solana address.
@@ -48,6 +42,7 @@ export async function getSolanaNativeBalance(rpcUrl: string, address: string): P
 }
 
 let tokenCache: Record<string, TokenInfo> = {};
+
 /**
  * Fetch metadata for a Solana SPL token using the Jupiter token list.
  * @param mint - The token's mint address
@@ -71,6 +66,13 @@ export async function getSolanaTokenMetadata(mint: string): Promise<TokenInfo |
   }
 }
 
+/**
+ * Get the balance of a token for a given address
+ * @param rpcUrl - The RPC URL to use
+ * @param address - The address to get the balance for
+ * @param tokenAddress - The address of the token to get the balance for
+ * @returns The balance of the token for the given address
+ */
 export async function getSolanaTokenBalance(
   rpcUrl: string,
   address: string,

package/src/index.ts

@@ -0,0 +1,8 @@
+// Connectors
+export { PhantomConnector } from './connectors/PhantomConnector';
+
+// Types
+export type { PhantomConnectorConfig } from './types';
+
+// Adapter
+export { SolanaAdapter } from './adapter';