@phantom/server-sdk 0.1.0 → 0.1.2

package/README.md

@@ -95,9 +95,12 @@ const wallet = await sdk.createWallet("My First Wallet");
 console.log("Wallet ID:", wallet.walletId);
 console.log("Addresses:", wallet.addresses);
 
-// Sign a message (base64url encoded)
-const message = Buffer.from("Hello, Phantom!").toString("base64url");
-const signature = await sdk.signMessage(wallet.walletId, message, NetworkId.SOLANA_MAINNET);
+// Sign a message
+const signature = await sdk.signMessage({
+  walletId: wallet.walletId,
+  message: "Hello, Phantom!",
+  networkId: NetworkId.SOLANA_MAINNET,
+});
 console.log("Signature:", signature);
 ```
 
@@ -120,6 +123,8 @@ console.log("Ethereum address:", ethereumAddress);
 
 ### Signing and Sending Transactions
 
+#### Solana - Native Web3.js Transaction Objects
+
 ```typescript
 import { Transaction, SystemProgram, PublicKey } from "@solana/web3.js";
 
@@ -136,31 +141,88 @@ const transaction = new Transaction().add(
 transaction.recentBlockhash = blockhash;
 transaction.feePayer = new PublicKey(solanaAddress);
 
-// Serialize the transaction
-const serializedTx = transaction.serialize({
-  requireAllSignatures: false,
-  verifySignatures: false,
+// Sign and send the transaction
+const signedTx = await sdk.signAndSendTransaction({
+  walletId: wallet.walletId,
+  transaction,
+  networkId: NetworkId.SOLANA_MAINNET,
 });
 
-// Convert to base64url
-const transactionBase64 = Buffer.from(serializedTx).toString("base64url");
+console.log("Signed transaction:", signedTx.rawTransaction);
+```
 
-// Sign and send the transaction
-const signedTx = await sdk.signAndSendTransaction(wallet.walletId, transactionBase64, NetworkId.SOLANA_MAINNET);
+#### Ethereum/EVM - Transaction Objects
 
-console.log("Signed transaction:", signedTx.rawTransaction);
+```typescript
+// Viem transaction object
+const evmTransaction = {
+  to: "0x742d35Cc6634C0532925a3b8D4C8db86fB5C4A7E",
+  value: 1000000000000000000n, // 1 ETH in wei
+  data: "0x",
+  gasLimit: 21000n,
+};
+
+const signedEvmTx = await sdk.signAndSendTransaction({
+  walletId: wallet.walletId,
+  transaction: evmTransaction, // Native EVM transaction object
+  networkId: NetworkId.ETHEREUM_MAINNET,
+});
+
+// Ethers.js transactions also supported
+const ethersTransaction = {
+  to: recipientAddress,
+  value: ethers.parseEther("0.01"),
+  serialize: () => "0x...", // Ethers serialization method
+};
+
+await sdk.signAndSendTransaction({
+  walletId: wallet.walletId,
+  transaction: ethersTransaction,
+  networkId: NetworkId.ETHEREUM_MAINNET,
+});
+```
+
+#### Raw Formats - Hex Strings and Bytes
+
+```typescript
+// Hex string transaction
+await sdk.signAndSendTransaction({
+  walletId: wallet.walletId,
+  transaction: "0x02f8710182013685012a05f2008301388094742d35cc...", // Raw hex
+  networkId: NetworkId.ETHEREUM_MAINNET,
+});
+
+// Raw bytes
+const transactionBytes = new Uint8Array([1, 2, 3, 4, 5 /* ... */]);
+await sdk.signAndSendTransaction({
+  walletId: wallet.walletId,
+  transaction: transactionBytes,
+  networkId: NetworkId.SOLANA_MAINNET,
+});
 ```
 
 ### Signing Messages
 
 ```typescript
-// Sign a message for Solana (base64url encoded)
-const solanaMessage = Buffer.from("Please sign this message to authenticate").toString("base64url");
-const solanaSignature = await sdk.signMessage(wallet.walletId, solanaMessage, NetworkId.SOLANA_MAINNET);
+const solanaSignature = await sdk.signMessage({
+  walletId: wallet.walletId,
+  message: "Please sign this message to authenticate",
+  networkId: NetworkId.SOLANA_MAINNET,
+});
 
-// Sign a message for Ethereum (base64url encoded)
-const ethMessage = Buffer.from("Sign in to our dApp").toString("base64url");
-const ethSignature = await sdk.signMessage(wallet.walletId, ethMessage, NetworkId.ETHEREUM_MAINNET);
+// Unicode messages work too
+const unicodeSignature = await sdk.signMessage({
+  walletId: wallet.walletId,
+  message: "🚀 Welcome to Web3! 你好世界", // Unicode text
+  networkId: NetworkId.SOLANA_MAINNET,
+});
+
+const ethMessage = Buffer.from().toString("base64url");
+const ethSignature = await sdk.signMessage({
+  walletId: wallet.walletId,
+  message: "Sign in to our dApp",
+  networkId: NetworkId.ETHEREUM_MAINNET,
+});
 ```
 
 ### Managing Wallets
@@ -218,8 +280,8 @@ For complete API documentation, visit **[docs.phantom.com/server-sdk](https://do
 ### Key Methods
 
 - `createWallet(walletName?)` - Creates a new wallet
-- `signAndSendTransaction(walletId, transaction, networkId)` - Signs and optionally submits transactions
-- `signMessage(walletId, message, networkId)` - Signs arbitrary messages
+- `signAndSendTransaction(params)` - Signs and optionally submits transactions
+- `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,6 +1,7 @@
-import { PhantomClient } from '@phantom/client';
+import { NetworkId, PhantomClient } from '@phantom/client';
 export { CreateWalletResult, DerivationPath, GetWalletsResult, NetworkConfig, NetworkId, PhantomClient, SignedTransaction, Transaction, Wallet, deriveSubmissionConfig, generateKeyPair, getDerivationPathForNetwork, getNetworkConfig, getNetworkDescription, getNetworkIdsByChain, getSupportedNetworkIds, supportsTransactionSubmission } from '@phantom/client';
 export { ApiKeyStamper } from '@phantom/api-key-stamper';
+export { ParsedMessage, ParsedTransaction, parseMessage, parseTransaction } from '@phantom/parsers';
 import { DerivationInfoAddressFormatEnum } from '@phantom/openapi-wallet-service';
 
 interface WalletAddress {
@@ -13,8 +14,30 @@ interface ServerSDKConfig {
     apiBaseUrl: string;
     apiPrivateKey: string;
 }
+interface ServerSignMessageParams {
+    walletId: string;
+    message: string;
+    networkId: NetworkId;
+}
+interface ServerSignAndSendTransactionParams {
+    walletId: string;
+    transaction: any;
+    networkId: NetworkId;
+}
 declare class ServerSDK extends PhantomClient {
     constructor(config: ServerSDKConfig);
+    /**
+     * Sign a message - supports plain text and automatically converts to base64url
+     * @param params - Message parameters with plain text message
+     * @returns Promise<string> - Base64 encoded signature
+     */
+    signMessage(params: ServerSignMessageParams): Promise<string>;
+    /**
+     * Sign and send a transaction - supports various transaction formats and automatically parses them
+     * @param params - Transaction parameters with flexible transaction format
+     * @returns Promise<SignedTransaction> - Signed transaction result
+     */
+    signAndSendTransaction(params: ServerSignAndSendTransactionParams): Promise<any>;
 }
 
-export { ServerSDK, ServerSDKConfig, WalletAddress };
+export { ServerSDK, ServerSDKConfig, ServerSignAndSendTransactionParams, ServerSignMessageParams, WalletAddress };

package/dist/index.js

@@ -32,13 +32,17 @@ __export(src_exports, {
   getNetworkDescription: () => import_client2.getNetworkDescription,
   getNetworkIdsByChain: () => import_client2.getNetworkIdsByChain,
   getSupportedNetworkIds: () => import_client2.getSupportedNetworkIds,
+  parseMessage: () => import_parsers2.parseMessage,
+  parseTransaction: () => import_parsers2.parseTransaction,
   supportsTransactionSubmission: () => import_client2.supportsTransactionSubmission
 });
 module.exports = __toCommonJS(src_exports);
 var import_client = require("@phantom/client");
 var import_api_key_stamper = require("@phantom/api-key-stamper");
+var import_parsers = require("@phantom/parsers");
 var import_client2 = require("@phantom/client");
 var import_api_key_stamper2 = require("@phantom/api-key-stamper");
+var import_parsers2 = require("@phantom/parsers");
 var ServerSDK = class extends import_client.PhantomClient {
   constructor(config) {
     const stamper = new import_api_key_stamper.ApiKeyStamper({
@@ -52,6 +56,34 @@ var ServerSDK = class extends import_client.PhantomClient {
       stamper
     );
   }
+  /**
+   * Sign a message - supports plain text and automatically converts to base64url
+   * @param params - Message parameters with plain text message
+   * @returns Promise<string> - Base64 encoded signature
+   */
+  signMessage(params) {
+    const parsedMessage = (0, import_parsers.parseMessage)(params.message);
+    const signMessageParams = {
+      walletId: params.walletId,
+      message: parsedMessage.base64url,
+      networkId: params.networkId
+    };
+    return super.signMessage(signMessageParams);
+  }
+  /**
+   * Sign and send a transaction - supports various transaction formats and automatically parses them
+   * @param params - Transaction parameters with flexible transaction format
+   * @returns Promise<SignedTransaction> - Signed transaction result
+   */
+  async signAndSendTransaction(params) {
+    const parsedTransaction = await (0, import_parsers.parseTransaction)(params.transaction, params.networkId);
+    const signAndSendParams = {
+      walletId: params.walletId,
+      transaction: parsedTransaction.base64url,
+      networkId: params.networkId
+    };
+    return super.signAndSendTransaction(signAndSendParams);
+  }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -67,5 +99,7 @@ var ServerSDK = class extends import_client.PhantomClient {
   getNetworkDescription,
   getNetworkIdsByChain,
   getSupportedNetworkIds,
+  parseMessage,
+  parseTransaction,
   supportsTransactionSubmission
 });

package/dist/index.mjs

@@ -1,6 +1,9 @@
 // src/index.ts
-import { PhantomClient } from "@phantom/client";
+import {
+  PhantomClient
+} from "@phantom/client";
 import { ApiKeyStamper } from "@phantom/api-key-stamper";
+import { parseMessage, parseTransaction } from "@phantom/parsers";
 import {
   PhantomClient as PhantomClient2,
   NetworkId,
@@ -15,6 +18,7 @@ import {
   generateKeyPair
 } from "@phantom/client";
 import { ApiKeyStamper as ApiKeyStamper2 } from "@phantom/api-key-stamper";
+import { parseMessage as parseMessage2, parseTransaction as parseTransaction2 } from "@phantom/parsers";
 var ServerSDK = class extends PhantomClient {
   constructor(config) {
     const stamper = new ApiKeyStamper({
@@ -28,6 +32,34 @@ var ServerSDK = class extends PhantomClient {
       stamper
     );
   }
+  /**
+   * Sign a message - supports plain text and automatically converts to base64url
+   * @param params - Message parameters with plain text message
+   * @returns Promise<string> - Base64 encoded signature
+   */
+  signMessage(params) {
+    const parsedMessage = parseMessage(params.message);
+    const signMessageParams = {
+      walletId: params.walletId,
+      message: parsedMessage.base64url,
+      networkId: params.networkId
+    };
+    return super.signMessage(signMessageParams);
+  }
+  /**
+   * Sign and send a transaction - supports various transaction formats and automatically parses them
+   * @param params - Transaction parameters with flexible transaction format
+   * @returns Promise<SignedTransaction> - Signed transaction result
+   */
+  async signAndSendTransaction(params) {
+    const parsedTransaction = await parseTransaction(params.transaction, params.networkId);
+    const signAndSendParams = {
+      walletId: params.walletId,
+      transaction: parsedTransaction.base64url,
+      networkId: params.networkId
+    };
+    return super.signAndSendTransaction(signAndSendParams);
+  }
 };
 export {
   ApiKeyStamper2 as ApiKeyStamper,
@@ -42,5 +74,7 @@ export {
   getNetworkDescription,
   getNetworkIdsByChain,
   getSupportedNetworkIds,
+  parseMessage2 as parseMessage,
+  parseTransaction2 as parseTransaction,
   supportsTransactionSubmission
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phantom/server-sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Server SDK for Phantom Wallet",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -13,6 +13,8 @@
     }
   },
   "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",
     "dev": "tsc --watch",
     "clean": "rm -rf dist",
@@ -34,11 +36,15 @@
     "typescript": "^5.0.4"
   },
   "dependencies": {
-    "@phantom/api-key-stamper": "workspace:^",
-    "@phantom/client": "workspace:^",
-    "@phantom/openapi-wallet-service": "^0.1.7"
+    "@phantom/api-key-stamper": "^0.1.1",
+    "@phantom/client": "^0.1.1",
+    "@phantom/openapi-wallet-service": "^0.1.7",
+    "@phantom/parsers": "^0.0.2"
   },
   "files": [
     "dist"
-  ]
-}
+  ],
+  "publishConfig": {
+    "directory": "_release/package"
+  }
+}