@phantom/server-sdk 1.0.0-beta.1 → 1.0.0-beta.3

package/README.md

@@ -86,8 +86,8 @@ dotenv.config();
 // Initialize the SDK
 const sdk = new ServerSDK({
   organizationId: process.env.ORGANIZATION_ID!,
+  appId: process.env.APP_ID!,
   apiPrivateKey: process.env.PRIVATE_KEY!,
-  apiBaseUrl: process.env.API_URL!,
 });
 
 // Create a wallet
@@ -121,6 +121,72 @@ console.log("Solana address:", solanaAddress);
 console.log("Ethereum address:", ethereumAddress);
 ```
 
+### Transaction Signing Methods
+
+The Server SDK provides two methods for handling transactions:
+
+1. **`signTransaction(params)`** - Signs a transaction without submitting it to the network
+   - Returns the signed transaction 
+   - No network interaction
+   - Useful for offline signing or when you want to broadcast later
+
+2. **`signAndSendTransaction(params)`** - Signs and submits the transaction to the network
+   - Returns both signed transaction and transaction hash
+   - Requires network connectivity
+   - Transaction is immediately broadcast to the blockchain
+
+### Signing Only (No Network Submission)
+
+#### Solana Transaction Signing
+
+```typescript
+import { Transaction, SystemProgram, PublicKey } from "@solana/web3.js";
+
+// Create a Solana transaction
+const transaction = new Transaction().add(
+  SystemProgram.transfer({
+    fromPubkey: new PublicKey(solanaAddress),
+    toPubkey: new PublicKey(recipientAddress),
+    lamports: 1000000, // 0.001 SOL
+  }),
+);
+
+// Set transaction parameters
+transaction.recentBlockhash = blockhash;
+transaction.feePayer = new PublicKey(solanaAddress);
+
+// Sign the transaction (without sending)
+const signed = await sdk.signTransaction({
+  walletId: wallet.walletId,
+  transaction,
+  networkId: NetworkId.SOLANA_MAINNET,
+});
+
+console.log("Signed transaction:", signed.rawTransaction);
+// You can broadcast this transaction later using your own RPC client
+```
+
+#### Ethereum Transaction Signing
+
+```typescript
+// Viem transaction object
+const evmTransaction = {
+  to: "0x742d35Cc6634C0532925a3b8D4C8db86fB5C4A7E",
+  value: 1000000000000000000n, // 1 ETH in wei
+  data: "0x",
+  gasLimit: 21000n,
+};
+
+const signed = await sdk.signTransaction({
+  walletId: wallet.walletId,
+  transaction: evmTransaction,
+  networkId: NetworkId.ETHEREUM_MAINNET,
+});
+
+console.log("Signed transaction:", signed.rawTransaction);
+// You can broadcast this signed transaction using your preferred method
+```
+
 ### Signing and Sending Transactions
 
 #### Solana - Native Web3.js Transaction Objects
@@ -279,7 +345,8 @@ For complete API documentation, visit **[docs.phantom.com/server-sdk](https://do
 ### Key Methods
 
 - `createWallet(walletName?)` - Creates a new wallet
-- `signAndSendTransaction(params)` - Signs and optionally submits transactions
+- `signTransaction(params)` - Signs transactions without submitting to network
+- `signAndSendTransaction(params)` - Signs and submits transactions to network
 - `signMessage(params)` - Signs arbitrary messages
 - `getWalletAddresses(walletId, derivationPaths?)` - Retrieves wallet addresses
 - `getWallets(limit?, offset?)` - Lists all wallets with pagination

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { AddressType, NetworkId, PhantomClient, Organization, GetWalletsResult, CreateWalletResult } from '@phantom/client';
-export { CreateWalletResult, DerivationPath, GetWalletsResult, NetworkConfig, PhantomClient, SignedTransaction, Transaction, Wallet, deriveSubmissionConfig, generateKeyPair, getDerivationPathForNetwork, getNetworkConfig, getNetworkDescription, getNetworkIdsByChain, getSupportedNetworkIds, supportsTransactionSubmission } from '@phantom/client';
+export { CreateWalletResult, DerivationPath, GetWalletsResult, NetworkConfig, PhantomClient, SignedTransaction, SignedTransactionResult, Transaction, Wallet, deriveSubmissionConfig, generateKeyPair, getDerivationPathForNetwork, getNetworkConfig, getNetworkDescription, getNetworkIdsByChain, getSupportedNetworkIds, supportsTransactionSubmission } from '@phantom/client';
 import { ParsedSignatureResult, ParsedTransactionResult } from '@phantom/parsers';
 export { ParsedMessage, ParsedSignatureResult, ParsedTransaction, ParsedTransactionResult, parseMessage, parseSignMessageResponse, parseTransactionResponse, parseTransactionToBase64Url } from '@phantom/parsers';
 export { NetworkId } from '@phantom/constants';
@@ -13,7 +13,7 @@ interface WalletAddress {
 interface ServerSDKConfig {
     organizationId: string;
     appId: string;
-    apiBaseUrl: string;
+    apiBaseUrl?: string;
     apiPrivateKey: string;
 }
 interface ServerSignMessageParams {
@@ -22,6 +22,12 @@ interface ServerSignMessageParams {
     networkId: NetworkId;
     derivationIndex?: number;
 }
+interface ServerSignTransactionParams {
+    walletId: string;
+    transaction: any;
+    networkId: NetworkId;
+    derivationIndex?: number;
+}
 interface ServerSignAndSendTransactionParams {
     walletId: string;
     transaction: any;
@@ -38,6 +44,12 @@ declare class ServerSDK {
      * @returns Promise<ParsedSignatureResult> - Parsed signature with explorer URL
      */
     signMessage(params: ServerSignMessageParams): Promise<ParsedSignatureResult>;
+    /**
+     * Sign a transaction - supports various transaction formats and automatically parses them
+     * @param params - Transaction parameters with flexible transaction format
+     * @returns Promise<ParsedTransactionResult> - Parsed transaction result without hash
+     */
+    signTransaction(params: ServerSignTransactionParams): Promise<ParsedTransactionResult>;
     /**
      * Sign and send a transaction - supports various transaction formats and automatically parses them
      * @param params - Transaction parameters with flexible transaction format
@@ -56,4 +68,4 @@ declare class ServerSDK {
     }[]>;
 }
 
-export { ServerSDK, ServerSDKConfig, ServerSignAndSendTransactionParams, ServerSignMessageParams, WalletAddress };
+export { ServerSDK, ServerSDKConfig, ServerSignAndSendTransactionParams, ServerSignMessageParams, ServerSignTransactionParams, WalletAddress };

package/dist/index.js

@@ -32,7 +32,7 @@ var src_exports = {};
 __export(src_exports, {
   ApiKeyStamper: () => import_api_key_stamper2.ApiKeyStamper,
   DerivationPath: () => import_client2.DerivationPath,
-  NetworkId: () => import_constants.NetworkId,
+  NetworkId: () => import_constants2.NetworkId,
   PhantomClient: () => import_client2.PhantomClient,
   ServerSDK: () => ServerSDK,
   deriveSubmissionConfig: () => import_client2.deriveSubmissionConfig,
@@ -50,24 +50,102 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 var import_client = require("@phantom/client");
+var import_constants = require("@phantom/constants");
 var import_api_key_stamper = require("@phantom/api-key-stamper");
 var import_base64url = require("@phantom/base64url");
 var import_bs58 = __toESM(require("bs58"));
+
+// package.json
+var package_default = {
+  name: "@phantom/server-sdk",
+  version: "1.0.0-beta.3",
+  description: "Server SDK for Phantom Wallet",
+  main: "dist/index.js",
+  module: "dist/index.mjs",
+  types: "dist/index.d.ts",
+  exports: {
+    ".": {
+      import: "./dist/index.mjs",
+      require: "./dist/index.js",
+      types: "./dist/index.d.ts"
+    }
+  },
+  scripts: {
+    "?pack-release": "When https://github.com/changesets/changesets/issues/432 has a solution we can remove this trick",
+    "pack-release": "rimraf ./_release && yarn pack && mkdir ./_release && tar zxvf ./package.tgz --directory ./_release && rm ./package.tgz",
+    build: "rimraf ./dist && tsup",
+    dev: "tsc --watch",
+    clean: "rm -rf dist",
+    test: "jest",
+    "test:watch": "jest --watch",
+    lint: "eslint src --ext .ts,.tsx",
+    "check-types": "yarn tsc --noEmit",
+    prettier: 'prettier --write "src/**/*.{ts,tsx}"'
+  },
+  devDependencies: {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.0",
+    dotenv: "^16.4.1",
+    eslint: "8.53.0",
+    jest: "^29.7.0",
+    prettier: "^3.5.2",
+    rimraf: "^6.0.1",
+    "ts-jest": "^29.1.2",
+    tsup: "^6.7.0",
+    typescript: "^5.0.4"
+  },
+  dependencies: {
+    "@phantom/api-key-stamper": "workspace:^",
+    "@phantom/base64url": "workspace:^",
+    "@phantom/client": "workspace:^",
+    "@phantom/constants": "workspace:^",
+    "@phantom/parsers": "workspace:^",
+    bs58: "^6.0.0"
+  },
+  files: [
+    "dist"
+  ],
+  publishConfig: {
+    directory: "_release/package"
+  }
+};
+
+// src/index.ts
 var import_parsers = require("@phantom/parsers");
 var import_client2 = require("@phantom/client");
-var import_constants = require("@phantom/constants");
+var import_constants2 = require("@phantom/constants");
 var import_api_key_stamper2 = require("@phantom/api-key-stamper");
 var import_parsers2 = require("@phantom/parsers");
+function getNodeVersion() {
+  if (typeof process !== "undefined" && process.version) {
+    return process.version;
+  }
+  return "unknown";
+}
+function getSdkVersion() {
+  return package_default.version || "unknown";
+}
+function createServerSdkHeaders(appId) {
+  return {
+    [import_constants.ANALYTICS_HEADERS.SDK_TYPE]: "server",
+    [import_constants.ANALYTICS_HEADERS.SDK_VERSION]: getSdkVersion(),
+    [import_constants.ANALYTICS_HEADERS.PLATFORM]: `node`,
+    [import_constants.ANALYTICS_HEADERS.PLATFORM_VERSION]: `${getNodeVersion()}`,
+    [import_constants.ANALYTICS_HEADERS.APP_ID]: appId
+  };
+}
 var ServerSDK = class {
   constructor(config) {
     this.config = config;
     const stamper = new import_api_key_stamper.ApiKeyStamper({
       apiSecretKey: config.apiPrivateKey
     });
+    const headers = createServerSdkHeaders(config.appId);
     this.client = new import_client.PhantomClient(
       {
-        apiBaseUrl: config.apiBaseUrl,
-        organizationId: config.organizationId
+        apiBaseUrl: config.apiBaseUrl || import_constants.DEFAULT_WALLET_API_URL,
+        organizationId: config.organizationId,
+        headers
       },
       stamper
     );
@@ -88,6 +166,22 @@ var ServerSDK = class {
     const rawResponse = await this.client.signMessage(signMessageParams);
     return (0, import_parsers.parseSignMessageResponse)(rawResponse, params.networkId);
   }
+  /**
+   * Sign a transaction - supports various transaction formats and automatically parses them
+   * @param params - Transaction parameters with flexible transaction format
+   * @returns Promise<ParsedTransactionResult> - Parsed transaction result without hash
+   */
+  async signTransaction(params) {
+    const parsedTransaction = await (0, import_parsers.parseTransactionToBase64Url)(params.transaction, params.networkId);
+    const signTransactionParams = {
+      walletId: params.walletId,
+      transaction: parsedTransaction.base64url,
+      networkId: params.networkId,
+      derivationIndex: params.derivationIndex
+    };
+    const rawResponse = await this.client.signTransaction(signTransactionParams);
+    return await (0, import_parsers.parseTransactionResponse)(rawResponse.rawTransaction, params.networkId);
+  }
   /**
    * Sign and send a transaction - supports various transaction formats and automatically parses them
    * @param params - Transaction parameters with flexible transaction format
@@ -105,10 +199,12 @@ var ServerSDK = class {
     return await (0, import_parsers.parseTransactionResponse)(rawResponse.rawTransaction, params.networkId, rawResponse.hash);
   }
   createOrganization(name, keyPair) {
+    const headers = createServerSdkHeaders(this.config.appId);
     const tempClient = new import_client.PhantomClient(
       {
-        apiBaseUrl: this.config.apiBaseUrl,
-        organizationId: this.config.organizationId
+        apiBaseUrl: this.config.apiBaseUrl || import_constants.DEFAULT_WALLET_API_URL,
+        organizationId: this.config.organizationId,
+        headers
       },
       new import_api_key_stamper.ApiKeyStamper({
         apiSecretKey: keyPair.secretKey

package/dist/index.mjs

@@ -2,9 +2,70 @@
 import {
   PhantomClient
 } from "@phantom/client";
+import {
+  ANALYTICS_HEADERS,
+  DEFAULT_WALLET_API_URL
+} from "@phantom/constants";
 import { ApiKeyStamper } from "@phantom/api-key-stamper";
 import { base64urlEncode } from "@phantom/base64url";
 import bs58 from "bs58";
+
+// package.json
+var package_default = {
+  name: "@phantom/server-sdk",
+  version: "1.0.0-beta.3",
+  description: "Server SDK for Phantom Wallet",
+  main: "dist/index.js",
+  module: "dist/index.mjs",
+  types: "dist/index.d.ts",
+  exports: {
+    ".": {
+      import: "./dist/index.mjs",
+      require: "./dist/index.js",
+      types: "./dist/index.d.ts"
+    }
+  },
+  scripts: {
+    "?pack-release": "When https://github.com/changesets/changesets/issues/432 has a solution we can remove this trick",
+    "pack-release": "rimraf ./_release && yarn pack && mkdir ./_release && tar zxvf ./package.tgz --directory ./_release && rm ./package.tgz",
+    build: "rimraf ./dist && tsup",
+    dev: "tsc --watch",
+    clean: "rm -rf dist",
+    test: "jest",
+    "test:watch": "jest --watch",
+    lint: "eslint src --ext .ts,.tsx",
+    "check-types": "yarn tsc --noEmit",
+    prettier: 'prettier --write "src/**/*.{ts,tsx}"'
+  },
+  devDependencies: {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.0",
+    dotenv: "^16.4.1",
+    eslint: "8.53.0",
+    jest: "^29.7.0",
+    prettier: "^3.5.2",
+    rimraf: "^6.0.1",
+    "ts-jest": "^29.1.2",
+    tsup: "^6.7.0",
+    typescript: "^5.0.4"
+  },
+  dependencies: {
+    "@phantom/api-key-stamper": "workspace:^",
+    "@phantom/base64url": "workspace:^",
+    "@phantom/client": "workspace:^",
+    "@phantom/constants": "workspace:^",
+    "@phantom/parsers": "workspace:^",
+    bs58: "^6.0.0"
+  },
+  files: [
+    "dist"
+  ],
+  publishConfig: {
+    directory: "_release/package"
+  }
+};
+
+// src/index.ts
 import {
   parseMessage,
   parseTransactionToBase64Url,
@@ -31,16 +92,36 @@ import {
   parseSignMessageResponse as parseSignMessageResponse2,
   parseTransactionResponse as parseTransactionResponse2
 } from "@phantom/parsers";
+function getNodeVersion() {
+  if (typeof process !== "undefined" && process.version) {
+    return process.version;
+  }
+  return "unknown";
+}
+function getSdkVersion() {
+  return package_default.version || "unknown";
+}
+function createServerSdkHeaders(appId) {
+  return {
+    [ANALYTICS_HEADERS.SDK_TYPE]: "server",
+    [ANALYTICS_HEADERS.SDK_VERSION]: getSdkVersion(),
+    [ANALYTICS_HEADERS.PLATFORM]: `node`,
+    [ANALYTICS_HEADERS.PLATFORM_VERSION]: `${getNodeVersion()}`,
+    [ANALYTICS_HEADERS.APP_ID]: appId
+  };
+}
 var ServerSDK = class {
   constructor(config) {
     this.config = config;
     const stamper = new ApiKeyStamper({
       apiSecretKey: config.apiPrivateKey
     });
+    const headers = createServerSdkHeaders(config.appId);
     this.client = new PhantomClient(
       {
-        apiBaseUrl: config.apiBaseUrl,
-        organizationId: config.organizationId
+        apiBaseUrl: config.apiBaseUrl || DEFAULT_WALLET_API_URL,
+        organizationId: config.organizationId,
+        headers
       },
       stamper
     );
@@ -61,6 +142,22 @@ var ServerSDK = class {
     const rawResponse = await this.client.signMessage(signMessageParams);
     return parseSignMessageResponse(rawResponse, params.networkId);
   }
+  /**
+   * Sign a transaction - supports various transaction formats and automatically parses them
+   * @param params - Transaction parameters with flexible transaction format
+   * @returns Promise<ParsedTransactionResult> - Parsed transaction result without hash
+   */
+  async signTransaction(params) {
+    const parsedTransaction = await parseTransactionToBase64Url(params.transaction, params.networkId);
+    const signTransactionParams = {
+      walletId: params.walletId,
+      transaction: parsedTransaction.base64url,
+      networkId: params.networkId,
+      derivationIndex: params.derivationIndex
+    };
+    const rawResponse = await this.client.signTransaction(signTransactionParams);
+    return await parseTransactionResponse(rawResponse.rawTransaction, params.networkId);
+  }
   /**
    * Sign and send a transaction - supports various transaction formats and automatically parses them
    * @param params - Transaction parameters with flexible transaction format
@@ -78,10 +175,12 @@ var ServerSDK = class {
     return await parseTransactionResponse(rawResponse.rawTransaction, params.networkId, rawResponse.hash);
   }
   createOrganization(name, keyPair) {
+    const headers = createServerSdkHeaders(this.config.appId);
     const tempClient = new PhantomClient(
       {
-        apiBaseUrl: this.config.apiBaseUrl,
-        organizationId: this.config.organizationId
+        apiBaseUrl: this.config.apiBaseUrl || DEFAULT_WALLET_API_URL,
+        organizationId: this.config.organizationId,
+        headers
       },
       new ApiKeyStamper({
         apiSecretKey: keyPair.secretKey

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phantom/server-sdk",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "description": "Server SDK for Phantom Wallet",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -15,7 +15,7 @@
   "scripts": {
     "?pack-release": "When https://github.com/changesets/changesets/issues/432 has a solution we can remove this trick",
     "pack-release": "rimraf ./_release && yarn pack && mkdir ./_release && tar zxvf ./package.tgz --directory ./_release && rm ./package.tgz",
-    "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts",
+    "build": "rimraf ./dist && tsup",
     "dev": "tsc --watch",
     "clean": "rm -rf dist",
     "test": "jest",
@@ -37,11 +37,11 @@
     "typescript": "^5.0.4"
   },
   "dependencies": {
-    "@phantom/api-key-stamper": "^1.0.0-beta.1",
-    "@phantom/base64url": "^1.0.0-beta.1",
-    "@phantom/client": "^1.0.0-beta.1",
-    "@phantom/constants": "^1.0.0-beta.1",
-    "@phantom/parsers": "^1.0.0-beta.1",
+    "@phantom/api-key-stamper": "^1.0.0-beta.3",
+    "@phantom/base64url": "^1.0.0-beta.3",
+    "@phantom/client": "^1.0.0-beta.3",
+    "@phantom/constants": "^1.0.0-beta.3",
+    "@phantom/parsers": "^1.0.0-beta.3",
     "bs58": "^6.0.0"
   },
   "files": [