@phantom/browser-sdk 0.0.2 → 0.0.3

package/dist/solana/index.d.ts

@@ -1,7 +1,94 @@
 import { ChainPlugin } from '../index.js';
+import { PublicKey, Transaction, VersionedTransaction, SendOptions } from '@solana/web3.js';
+
+type SolanaSignInData = {
+    domain?: string;
+    address?: string;
+    statement?: string;
+    uri?: string;
+    version?: string;
+    chainId?: string;
+    nonce?: string;
+    issuedAt?: string;
+    expirationTime?: string;
+    notBefore?: string;
+    requestId?: string;
+    resources?: string[];
+};
+type DisplayEncoding = "utf8" | "hex";
+interface PhantomSolanaProvider {
+    isPhantom: boolean;
+    publicKey: PublicKey | null;
+    isConnected: boolean;
+    connect: (opts?: {
+        onlyIfTrusted?: boolean;
+    }) => Promise<{
+        publicKey: PublicKey;
+    }>;
+    disconnect: () => Promise<void>;
+    signMessage: (message: Uint8Array, display?: DisplayEncoding) => Promise<{
+        signature: Uint8Array;
+        publicKey: PublicKey;
+    }>;
+    signIn: (signInData: SolanaSignInData) => Promise<{
+        address: PublicKey;
+        signature: Uint8Array;
+        signedMessage: Uint8Array;
+    }>;
+    signAndSendTransaction: (transaction: Transaction | VersionedTransaction, options?: SendOptions) => Promise<{
+        signature: string;
+        publicKey?: string;
+    }>;
+    signAllTransactions: (transactions: (Transaction | VersionedTransaction)[]) => Promise<(Transaction | VersionedTransaction)[]>;
+    signTransaction: (transaction: Transaction | VersionedTransaction) => Promise<Transaction | VersionedTransaction>;
+}
+interface SolanaOperationOptions {
+    getProvider?: () => PhantomSolanaProvider | null;
+}
+
+/**
+ * Signs a message using the Phantom provider.
+ * @param message The message to sign (as a Uint8Array).
+ * @param display The display encoding for the message (optional, defaults to utf8).
+ * @param options Optional parameters, including a custom getProvider function.
+ * @returns A promise that resolves with the signature and public key.
+ * @throws Error if Phantom provider is not found or if the operation fails.
+ */
+declare function signMessage(message: Uint8Array, display?: DisplayEncoding, options?: SolanaOperationOptions): Promise<{
+    signature: Uint8Array;
+    publicKey: PublicKey;
+}>;
+
+/**
+ * Signs in with Solana using the Phantom provider.
+ * @param signInData The sign-in data.
+ * @param options Optional parameters, including a custom getProvider function.
+ * @returns A promise that resolves with the address, signature, and signed message.
+ * @throws Error if Phantom provider is not found or if the operation fails.
+ */
+declare function signIn(signInData: SolanaSignInData, options?: SolanaOperationOptions): Promise<{
+    address: PublicKey;
+    signature: Uint8Array;
+    signedMessage: Uint8Array;
+}>;
+
+/**
+ * Signs and sends a transaction using the Phantom provider.
+ * @param transaction The transaction to sign and send.
+ * @param options Options for sending the transaction and other operations.
+ * @returns A promise that resolves with the transaction signature and optionally the public key.
+ * @throws Error if Phantom provider is not found or if the operation fails.
+ */
+declare function signAndSendTransaction(transaction: Transaction | VersionedTransaction, operationOptions?: SolanaOperationOptions): Promise<{
+    signature: string;
+    publicKey?: string;
+}>;
 
 type Solana = {
-    getProvider: () => NonNullable<unknown> | null;
+    getProvider: () => PhantomSolanaProvider | null;
+    signMessage: typeof signMessage;
+    signIn: typeof signIn;
+    signAndSendTransaction: typeof signAndSendTransaction;
 };
 declare function createSolanaPlugin(): ChainPlugin<Solana>;
 

package/dist/solana/index.js

@@ -29,9 +29,57 @@ function getProvider() {
   return window.phantom?.solana ?? null;
 }
 
+// src/solana/signMessage.ts
+async function signMessage(message, display, options) {
+  const getProviderFn = options?.getProvider || getProvider;
+  const provider = getProviderFn();
+  if (!provider) {
+    throw new Error("Phantom provider not found.");
+  }
+  if (!provider.signMessage) {
+    throw new Error("The connected provider does not support signMessage.");
+  }
+  if (!provider.isConnected) {
+    throw new Error("Provider is not connected.");
+  }
+  return provider.signMessage(message, display);
+}
+
+// src/solana/signIn.ts
+async function signIn(signInData, options) {
+  const getProviderFn = options?.getProvider || getProvider;
+  const provider = getProviderFn();
+  if (!provider) {
+    throw new Error("Phantom provider not found.");
+  }
+  if (!provider.signIn) {
+    throw new Error("The connected provider does not support signIn.");
+  }
+  return provider.signIn(signInData);
+}
+
+// src/solana/signAndSendTransaction.ts
+async function signAndSendTransaction(transaction, operationOptions) {
+  const getProviderFn = operationOptions?.getProvider || getProvider;
+  const provider = getProviderFn();
+  if (!provider) {
+    throw new Error("Phantom provider not found.");
+  }
+  if (!provider.signAndSendTransaction) {
+    throw new Error("The connected provider does not support signAndSendTransaction.");
+  }
+  if (!provider.isConnected) {
+    throw new Error("Provider is not connected.");
+  }
+  return provider.signAndSendTransaction(transaction);
+}
+
 // src/solana/plugin.ts
 var solana = {
-  getProvider
+  getProvider,
+  signMessage,
+  signIn,
+  signAndSendTransaction
 };
 function createSolanaPlugin() {
   return {

package/dist/solana/index.mjs

@@ -3,9 +3,57 @@ function getProvider() {
   return window.phantom?.solana ?? null;
 }
 
+// src/solana/signMessage.ts
+async function signMessage(message, display, options) {
+  const getProviderFn = options?.getProvider || getProvider;
+  const provider = getProviderFn();
+  if (!provider) {
+    throw new Error("Phantom provider not found.");
+  }
+  if (!provider.signMessage) {
+    throw new Error("The connected provider does not support signMessage.");
+  }
+  if (!provider.isConnected) {
+    throw new Error("Provider is not connected.");
+  }
+  return provider.signMessage(message, display);
+}
+
+// src/solana/signIn.ts
+async function signIn(signInData, options) {
+  const getProviderFn = options?.getProvider || getProvider;
+  const provider = getProviderFn();
+  if (!provider) {
+    throw new Error("Phantom provider not found.");
+  }
+  if (!provider.signIn) {
+    throw new Error("The connected provider does not support signIn.");
+  }
+  return provider.signIn(signInData);
+}
+
+// src/solana/signAndSendTransaction.ts
+async function signAndSendTransaction(transaction, operationOptions) {
+  const getProviderFn = operationOptions?.getProvider || getProvider;
+  const provider = getProviderFn();
+  if (!provider) {
+    throw new Error("Phantom provider not found.");
+  }
+  if (!provider.signAndSendTransaction) {
+    throw new Error("The connected provider does not support signAndSendTransaction.");
+  }
+  if (!provider.isConnected) {
+    throw new Error("Provider is not connected.");
+  }
+  return provider.signAndSendTransaction(transaction);
+}
+
 // src/solana/plugin.ts
 var solana = {
-  getProvider
+  getProvider,
+  signMessage,
+  signIn,
+  signAndSendTransaction
 };
 function createSolanaPlugin() {
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phantom/browser-sdk",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -30,5 +30,8 @@
     "eslint": "8.53.0",
     "tsup": "^6.7.0",
     "typescript": "^5.0.4"
+  },
+  "dependencies": {
+    "@solana/web3.js": "^1.98.2"
   }
 }