@phantom/server-sdk 1.0.0-beta.2 → 1.0.0-beta.20

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

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { AddressType, NetworkId, PhantomClient, Organization, GetWalletsResult, CreateWalletResult } 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 { ParsedSignatureResult, ParsedTransaction, ParsedTransactionResult, parseSignMessageResponse, parseToKmsTransaction, parseTransactionResponse } from '@phantom/parsers';
 export { NetworkId } from '@phantom/constants';
 export { ApiKeyStamper } from '@phantom/api-key-stamper';
 
@@ -13,7 +13,7 @@ interface WalletAddress {
 interface ServerSDKConfig {
     organizationId: string;
     appId: string;
-    apiBaseUrl: string;
+    apiBaseUrl?: string;
     apiPrivateKey: string;
 }
 interface ServerSignMessageParams {
@@ -27,12 +27,14 @@ interface ServerSignTransactionParams {
     transaction: any;
     networkId: NetworkId;
     derivationIndex?: number;
+    account?: string;
 }
 interface ServerSignAndSendTransactionParams {
     walletId: string;
     transaction: any;
     networkId: NetworkId;
     derivationIndex?: number;
+    account?: string;
 }
 declare class ServerSDK {
     private config;
@@ -40,6 +42,7 @@ declare class ServerSDK {
     constructor(config: ServerSDKConfig);
     /**
      * Sign a message - supports plain text and automatically converts to base64url
+     * Routes to appropriate signing method based on network type
      * @param params - Message parameters with plain text message
      * @returns Promise<ParsedSignatureResult> - Parsed signature with explorer URL
      */

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,
@@ -42,50 +42,130 @@ __export(src_exports, {
   getNetworkDescription: () => import_client2.getNetworkDescription,
   getNetworkIdsByChain: () => import_client2.getNetworkIdsByChain,
   getSupportedNetworkIds: () => import_client2.getSupportedNetworkIds,
-  parseMessage: () => import_parsers2.parseMessage,
   parseSignMessageResponse: () => import_parsers2.parseSignMessageResponse,
+  parseToKmsTransaction: () => import_parsers2.parseToKmsTransaction,
   parseTransactionResponse: () => import_parsers2.parseTransactionResponse,
-  parseTransactionToBase64Url: () => import_parsers2.parseTransactionToBase64Url,
   supportsTransactionSubmission: () => import_client2.supportsTransactionSubmission
 });
 module.exports = __toCommonJS(src_exports);
 var import_client = require("@phantom/client");
+var import_utils = require("@phantom/utils");
+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.20",
+  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:^",
+    "@phantom/utils": "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
     );
   }
   /**
    * Sign a message - supports plain text and automatically converts to base64url
+   * Routes to appropriate signing method based on network type
    * @param params - Message parameters with plain text message
    * @returns Promise<ParsedSignatureResult> - Parsed signature with explorer URL
    */
   async signMessage(params) {
-    const parsedMessage = (0, import_parsers.parseMessage)(params.message);
+    const base64UrlMessage = (0, import_base64url.stringToBase64url)(params.message);
     const signMessageParams = {
       walletId: params.walletId,
-      message: parsedMessage.base64url,
+      message: base64UrlMessage,
       networkId: params.networkId,
       derivationIndex: params.derivationIndex
     };
-    const rawResponse = await this.client.signMessage(signMessageParams);
+    const rawResponse = (0, import_utils.isEthereumChain)(params.networkId) ? await this.client.ethereumSignMessage(signMessageParams) : await this.client.signRawPayload(signMessageParams);
     return (0, import_parsers.parseSignMessageResponse)(rawResponse, params.networkId);
   }
   /**
@@ -94,14 +174,18 @@ var ServerSDK = class {
    * @returns Promise<ParsedTransactionResult> - Parsed transaction result without hash
    */
   async signTransaction(params) {
-    const parsedTransaction = await (0, import_parsers.parseTransactionToBase64Url)(params.transaction, params.networkId);
-    const signTransactionParams = {
+    const parsedTransaction = await (0, import_parsers.parseToKmsTransaction)(params.transaction, params.networkId);
+    const transactionPayload = parsedTransaction.parsed;
+    if (!transactionPayload) {
+      throw new Error("Failed to parse transaction: no valid encoding found");
+    }
+    const rawResponse = await this.client.signTransaction({
       walletId: params.walletId,
-      transaction: parsedTransaction.base64url,
+      transaction: transactionPayload,
       networkId: params.networkId,
-      derivationIndex: params.derivationIndex
-    };
-    const rawResponse = await this.client.signTransaction(signTransactionParams);
+      derivationIndex: params.derivationIndex,
+      account: params.account
+    });
     return await (0, import_parsers.parseTransactionResponse)(rawResponse.rawTransaction, params.networkId);
   }
   /**
@@ -110,21 +194,27 @@ var ServerSDK = class {
    * @returns Promise<ParsedTransactionResult> - Parsed transaction result with hash and explorer URL
    */
   async signAndSendTransaction(params) {
-    const parsedTransaction = await (0, import_parsers.parseTransactionToBase64Url)(params.transaction, params.networkId);
-    const signAndSendParams = {
+    const parsedTransaction = await (0, import_parsers.parseToKmsTransaction)(params.transaction, params.networkId);
+    const transactionPayload = parsedTransaction.parsed;
+    if (!transactionPayload) {
+      throw new Error("Failed to parse transaction: no valid encoding found");
+    }
+    const rawResponse = await this.client.signAndSendTransaction({
       walletId: params.walletId,
-      transaction: parsedTransaction.base64url,
+      transaction: transactionPayload,
       networkId: params.networkId,
-      derivationIndex: params.derivationIndex
-    };
-    const rawResponse = await this.client.signAndSendTransaction(signAndSendParams);
+      derivationIndex: params.derivationIndex,
+      account: params.account
+    });
     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
@@ -133,11 +223,11 @@ var ServerSDK = class {
     const base64urlPublicKey = (0, import_base64url.base64urlEncode)(import_bs58.default.decode(keyPair.publicKey));
     return tempClient.createOrganization(name, [
       {
-        username: `user-${Date.now()}`,
+        username: `user-${(0, import_utils.randomUUID)()}`,
         role: "ADMIN",
         authenticators: [
           {
-            authenticatorName: `auth-${Date.now()}`,
+            authenticatorName: `auth-${(0, import_utils.getSecureTimestampSync)()}`,
             authenticatorKind: "keypair",
             publicKey: base64urlPublicKey,
             algorithm: "Ed25519"
@@ -170,9 +260,8 @@ var ServerSDK = class {
   getNetworkDescription,
   getNetworkIdsByChain,
   getSupportedNetworkIds,
-  parseMessage,
   parseSignMessageResponse,
+  parseToKmsTransaction,
   parseTransactionResponse,
-  parseTransactionToBase64Url,
   supportsTransactionSubmission
 });

package/dist/index.mjs

@@ -2,12 +2,74 @@
 import {
   PhantomClient
 } from "@phantom/client";
+import { randomUUID, getSecureTimestampSync, isEthereumChain } from "@phantom/utils";
+import {
+  ANALYTICS_HEADERS,
+  DEFAULT_WALLET_API_URL
+} from "@phantom/constants";
 import { ApiKeyStamper } from "@phantom/api-key-stamper";
-import { base64urlEncode } from "@phantom/base64url";
+import { base64urlEncode, stringToBase64url } from "@phantom/base64url";
 import bs58 from "bs58";
+
+// package.json
+var package_default = {
+  name: "@phantom/server-sdk",
+  version: "1.0.0-beta.20",
+  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:^",
+    "@phantom/utils": "workspace:^",
+    bs58: "^6.0.0"
+  },
+  files: [
+    "dist"
+  ],
+  publishConfig: {
+    directory: "_release/package"
+  }
+};
+
+// src/index.ts
 import {
-  parseMessage,
-  parseTransactionToBase64Url,
+  parseToKmsTransaction,
   parseSignMessageResponse,
   parseTransactionResponse
 } from "@phantom/parsers";
@@ -26,39 +88,59 @@ import {
 import { NetworkId } from "@phantom/constants";
 import { ApiKeyStamper as ApiKeyStamper2 } from "@phantom/api-key-stamper";
 import {
-  parseMessage as parseMessage2,
-  parseTransactionToBase64Url as parseTransactionToBase64Url2,
+  parseToKmsTransaction as parseToKmsTransaction2,
   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
     );
   }
   /**
    * Sign a message - supports plain text and automatically converts to base64url
+   * Routes to appropriate signing method based on network type
    * @param params - Message parameters with plain text message
    * @returns Promise<ParsedSignatureResult> - Parsed signature with explorer URL
    */
   async signMessage(params) {
-    const parsedMessage = parseMessage(params.message);
+    const base64UrlMessage = stringToBase64url(params.message);
     const signMessageParams = {
       walletId: params.walletId,
-      message: parsedMessage.base64url,
+      message: base64UrlMessage,
       networkId: params.networkId,
       derivationIndex: params.derivationIndex
     };
-    const rawResponse = await this.client.signMessage(signMessageParams);
+    const rawResponse = isEthereumChain(params.networkId) ? await this.client.ethereumSignMessage(signMessageParams) : await this.client.signRawPayload(signMessageParams);
     return parseSignMessageResponse(rawResponse, params.networkId);
   }
   /**
@@ -67,14 +149,18 @@ var ServerSDK = class {
    * @returns Promise<ParsedTransactionResult> - Parsed transaction result without hash
    */
   async signTransaction(params) {
-    const parsedTransaction = await parseTransactionToBase64Url(params.transaction, params.networkId);
-    const signTransactionParams = {
+    const parsedTransaction = await parseToKmsTransaction(params.transaction, params.networkId);
+    const transactionPayload = parsedTransaction.parsed;
+    if (!transactionPayload) {
+      throw new Error("Failed to parse transaction: no valid encoding found");
+    }
+    const rawResponse = await this.client.signTransaction({
       walletId: params.walletId,
-      transaction: parsedTransaction.base64url,
+      transaction: transactionPayload,
       networkId: params.networkId,
-      derivationIndex: params.derivationIndex
-    };
-    const rawResponse = await this.client.signTransaction(signTransactionParams);
+      derivationIndex: params.derivationIndex,
+      account: params.account
+    });
     return await parseTransactionResponse(rawResponse.rawTransaction, params.networkId);
   }
   /**
@@ -83,21 +169,27 @@ var ServerSDK = class {
    * @returns Promise<ParsedTransactionResult> - Parsed transaction result with hash and explorer URL
    */
   async signAndSendTransaction(params) {
-    const parsedTransaction = await parseTransactionToBase64Url(params.transaction, params.networkId);
-    const signAndSendParams = {
+    const parsedTransaction = await parseToKmsTransaction(params.transaction, params.networkId);
+    const transactionPayload = parsedTransaction.parsed;
+    if (!transactionPayload) {
+      throw new Error("Failed to parse transaction: no valid encoding found");
+    }
+    const rawResponse = await this.client.signAndSendTransaction({
       walletId: params.walletId,
-      transaction: parsedTransaction.base64url,
+      transaction: transactionPayload,
       networkId: params.networkId,
-      derivationIndex: params.derivationIndex
-    };
-    const rawResponse = await this.client.signAndSendTransaction(signAndSendParams);
+      derivationIndex: params.derivationIndex,
+      account: params.account
+    });
     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
@@ -106,11 +198,11 @@ var ServerSDK = class {
     const base64urlPublicKey = base64urlEncode(bs58.decode(keyPair.publicKey));
     return tempClient.createOrganization(name, [
       {
-        username: `user-${Date.now()}`,
+        username: `user-${randomUUID()}`,
         role: "ADMIN",
         authenticators: [
           {
-            authenticatorName: `auth-${Date.now()}`,
+            authenticatorName: `auth-${getSecureTimestampSync()}`,
             authenticatorKind: "keypair",
             publicKey: base64urlPublicKey,
             algorithm: "Ed25519"
@@ -142,9 +234,8 @@ export {
   getNetworkDescription,
   getNetworkIdsByChain,
   getSupportedNetworkIds,
-  parseMessage2 as parseMessage,
   parseSignMessageResponse2 as parseSignMessageResponse,
+  parseToKmsTransaction2 as parseToKmsTransaction,
   parseTransactionResponse2 as parseTransactionResponse,
-  parseTransactionToBase64Url2 as parseTransactionToBase64Url,
   supportsTransactionSubmission
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phantom/server-sdk",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.20",
   "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,12 @@
     "typescript": "^5.0.4"
   },
   "dependencies": {
-    "@phantom/api-key-stamper": "^1.0.0-beta.2",
-    "@phantom/base64url": "^1.0.0-beta.2",
-    "@phantom/client": "^1.0.0-beta.2",
-    "@phantom/constants": "^1.0.0-beta.2",
-    "@phantom/parsers": "^1.0.0-beta.2",
+    "@phantom/api-key-stamper": "^1.0.0-beta.8",
+    "@phantom/base64url": "^1.0.0-beta.8",
+    "@phantom/client": "^1.0.0-beta.20",
+    "@phantom/constants": "^1.0.0-beta.8",
+    "@phantom/parsers": "^1.0.0-beta.8",
+    "@phantom/utils": "^1.0.0-beta.20",
     "bs58": "^6.0.0"
   },
   "files": [