@phantom/server-sdk 0.0.3 → 0.0.4

package/README.md

@@ -1,228 +1,70 @@
 # Phantom Server SDK
 
-The Phantom Server SDK enables secure wallet creation, message signing and transaction signing and submission for your applications.
+The Phantom Server SDK provides a secure and straightforward way to create and manage wallets, sign transactions, and interact with multiple blockchains from your backend services.
 
-## Installation
-
-```bash
-npm install @phantom/server-sdk
-```
+## 📖 Documentation
 
-## Configuration
+Visit **[docs.phantom.com/server-sdk](https://docs.phantom.com/server-sdk)** for comprehensive documentation including:
 
-To get started, initialize the SDK with your credentials:
+- Getting Started Guide
+- Creating and Managing Wallets
+- Signing Transactions
+- Signing Messages
+- Complete API Reference
+- Integration Examples
+- Best Practices
+- Security Considerations
 
-```typescript
-import { ServerSDK } from '@phantom/server-sdk';
+## Installation
 
-const sdk = new ServerSDK({
-  apiPrivateKey: 'your-private-key',  // Base58 encoded private key
-  organizationId: 'your-org-id',      // Your organization ID
-  apiBaseUrl: 'https://api.phantom.app/wallet'
-});
+```bash
+npm install @phantom/server-sdk
 ```
 
-## Network Identifiers
-
-The SDK provides user-friendly enums for CAIP-2 network identifiers:
-
-```typescript
-import { NetworkId } from '@phantom/server-sdk';
-
-// Use the NetworkId enum for easy access to CAIP-2 identifiers
-const solanaMainnet = NetworkId.SOLANA_MAINNET; // 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp'
-const ethMainnet = NetworkId.ETHEREUM_MAINNET;  // 'eip155:1'
-const polygonMainnet = NetworkId.POLYGON_MAINNET; // 'eip155:137'
-
-// Example usage with SDK methods
-const result = await sdk.signAndSendTransaction(
-  walletId,
-  transaction,
-  NetworkId.SOLANA_MAINNET  // Instead of hardcoding 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp'
-);
-
-// Sign a message on Ethereum
-const signature = await sdk.signMessage(
-  walletId,
-  'Hello World',
-  NetworkId.ETHEREUM_MAINNET
-);
-
-
+```bash
+yarn add @phantom/server-sdk
 ```
 
-### Available Networks
-
-| Network | Enum Value | CAIP-2 ID |
-|---------|-----------|-----------|
-| **Solana** | | |
-| Mainnet | `NetworkId.SOLANA_MAINNET` | `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp` |
-| Devnet | `NetworkId.SOLANA_DEVNET` | `solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1` |
-| Testnet | `NetworkId.SOLANA_TESTNET` | `solana:4uhcVJyU9pJkvQyS88uRDiswHXSCkY3z` |
-| **Ethereum** | | |
-| Mainnet | `NetworkId.ETHEREUM_MAINNET` | `eip155:1` |
-| Goerli | `NetworkId.ETHEREUM_GOERLI` | `eip155:5` |
-| Sepolia | `NetworkId.ETHEREUM_SEPOLIA` | `eip155:11155111` |
-| **Polygon** | | |
-| Mainnet | `NetworkId.POLYGON_MAINNET` | `eip155:137` |
-| Mumbai | `NetworkId.POLYGON_MUMBAI` | `eip155:80001` |
-| **Arbitrum** | | |
-| One | `NetworkId.ARBITRUM_ONE` | `eip155:42161` |
-| Goerli | `NetworkId.ARBITRUM_GOERLI` | `eip155:421613` |
-| **Base** | | |
-| Mainnet | `NetworkId.BASE_MAINNET` | `eip155:8453` |
-| Sepolia | `NetworkId.BASE_SEPOLIA` | `eip155:84532` |
-
-## CAIP-2 Network Identifiers
-
-This SDK uses the CAIP-2 (Chain Agnostic Improvement Proposal 2) standard for network identifiers. CAIP-2 provides a standardized way to identify blockchain networks across different ecosystems.
-
-### Format
-CAIP-2 identifiers follow the format: `namespace:reference`
-
-### Common Network IDs
-- **Solana Mainnet**: `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`
-- **Solana Devnet**: `solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1`
-- **Ethereum Mainnet**: `eip155:1`
-- **Polygon Mainnet**: `eip155:137`
-- **Arbitrum One**: `eip155:42161`
-- **Base Mainnet**: `eip155:8453`
-
-## Methods
-
-### createWallet(walletName?: string)
-Creates a new wallet in your organization. Each wallet supports multiple chains.
-
-```typescript
-const wallet = await sdk.createWallet('My Main Wallet');
-// Returns: { 
-//   walletId: 'wallet-uuid',
-//   addresses: [
-//     { addressType: 'Solana', address: '...' },
-//     { addressType: 'Ethereum', address: '...' },
-//     { addressType: 'BitcoinSegwit', address: '...' },
-//     { addressType: 'Sui', address: '...' }
-//   ]
-// }
+```bash
+pnpm add @phantom/server-sdk
 ```
 
-### signAndSendTransaction(walletId: string, transaction: Uint8Array, networkId: string)
-Signs a transaction and tries to submits it to the blockchain. The SDK automatically handles network-specific requirements.
-If the networkId is not supported for sending, the transaction will only be signed.
+## Quick Start
 
 ```typescript
-import { NetworkId } from '@phantom/server-sdk';
+import { ServerSDK, NetworkId } from '@phantom/server-sdk';
 
-const transactionBuffer = new Uint8Array([...]); // Your serialized transaction
-const result = await sdk.signAndSendTransaction(
-  'wallet-id',
-  transactionBuffer,
-  NetworkId.SOLANA_MAINNET
-);
-
-// Returns: { 
-//   rawTransaction: 'base64-signed-transaction'
-//   txHash: 'tx-hash-string'
-// }
-
-// Extract the transaction signature (hash)
-// Note: requires 'import bs58 from "bs58"'
-const signedTx = Transaction.from(Buffer.from(result.rawTransaction, 'base64'));
-const signature = signedTx.signature 
-  ? bs58.encode(signedTx.signature)
-  : bs58.encode(signedTx.signatures[0].signature);
-```
+// Initialize the SDK
+const sdk = new ServerSDK({
+  organizationId: process.env.PHANTOM_ORGANIZATION_ID!,
+  apiPrivateKey: process.env.PHANTOM_PRIVATE_KEY!,
+  apiBaseUrl: process.env.PHANTOM_API_URL!
+});
 
-### signMessage(walletId: string, message: string, networkId: string)
-Signs a message with the specified wallet.
+// Create a wallet
+const wallet = await sdk.createWallet('My First Wallet');
+console.log('Wallet ID:', wallet.walletId);
+console.log('Addresses:', wallet.addresses);
 
-```typescript
+// Sign a message
 const signature = await sdk.signMessage(
-  'wallet-id', 
-  'Hello World', 
+  wallet.walletId,
+  'Hello, Phantom!',
   NetworkId.SOLANA_MAINNET
 );
-// Returns: base64 encoded signature
-```
-
-### getWallets(limit?: number, offset?: number)
-Retrieves all wallets for your organization with pagination support.
-
-```typescript
-// Get first 10 wallets
-const result = await sdk.getWallets(10, 0);
-// Returns: {
-//   wallets: [{ walletId: '...', walletName: '...' }, ...],
-//   totalCount: 25,
-//   limit: 10,
-//   offset: 0
-// }
-
-// Get all wallets (default limit: 20)
-const allWallets = await sdk.getWallets();
-```
-
-### getWalletAddresses(walletId: string, derivationPaths?: string[])
-Retrieves addresses for a specific wallet across different blockchains.
-
-```typescript
-const addresses = await sdk.getWalletAddresses('wallet-id');
-// Returns: [
-//   { addressType: 'Solana', address: '...' },
-//   { addressType: 'Ethereum', address: '...' },
-//   { addressType: 'Bitcoin', address: '...' },
-//   { addressType: 'Sui', address: '...' }
-// ]
-```
-
-## CAIP-2 Utility Functions
-
-The SDK exports several utility functions for working with CAIP-2 network identifiers:
-
-```typescript
-import {
-  deriveSubmissionConfig,
-  supportsTransactionSubmission,
-  getNetworkDescription,
-  getSupportedNetworkIds,
-  getNetworkIdsByChain
-} from '@phantom/server-sdk';
-
-// Check if a network supports transaction submission
-if (supportsTransactionSubmission('solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp')) {
-  // Network supports automatic transaction submission
-}
-
-// Get human-readable network description
-const description = getNetworkDescription('eip155:137'); // "Polygon Mainnet"
-
-// List all supported networks
-const allNetworks = getSupportedNetworkIds();
-
-// Get networks for a specific chain
-const solanaNetworks = getNetworkIdsByChain('solana');
-// ['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp', 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1', ...]
+console.log('Signature:', signature);
 ```
 
-## Security Best Practices
-
-- **Never expose your private key** in client-side code or commit it to version control
-- Store your credentials securely using environment variables or secret management systems
-- Each wallet is isolated and can only be accessed by your organization
-- All API requests are authenticated using cryptographic signatures
+For complete documentation and examples, visit **[docs.phantom.com/server-sdk](https://docs.phantom.com/server-sdk)**.
 
-## Error Handling
+## Resources
 
-All SDK methods throw descriptive errors when operations fail:
-
-```typescript
-try {
-  const wallet = await sdk.createWallet();
-} catch (error) {
-  console.error('Failed to create wallet:', error.message);
-}
-```
+- [Documentation](https://docs.phantom.com/server-sdk)
+- [Example Code](https://github.com/phantom/wallet-sdk/tree/main/examples/server-sdk-examples)
+- [Integration Guide](https://docs.phantom.com/server-sdk/integration-guide)
+- [API Reference](https://docs.phantom.com/server-sdk/api-reference)
+- [Changelog](./CHANGELOG.md)
 
-## Support
+## License
 
-For detailed integration examples and best practices, see the [Integration Guide](./INTEGRATION.md).
+This SDK is distributed under the MIT License. See the [LICENSE](../../LICENSE) file for details.

package/dist/auth.js

@@ -16,7 +16,7 @@ function createAuthenticatedAxiosInstance(signingKeypair) {
         const requestBody = typeof config.data === "string" ? config.data : JSON.stringify(config.data);
         const dataUtf8 = Buffer.from(requestBody, "utf8");
         const signature = tweetnacl_1.default.sign.detached(dataUtf8, signingKeypair.secretKey);
-        config.headers["X-Phantom-Sig"] = Buffer.from(signature).toString("base64");
+        config.headers["X-Phantom-Sig"] = Buffer.from(signature).toString("base64url");
         return config;
     });
     return instance;

package/dist/index.js

@@ -97,7 +97,7 @@ class ServerSDK {
     async signAndSendTransaction(walletId, transaction, networkId) {
         try {
             // Encode the Uint8Array as a base64 string
-            const encodedTransaction = Buffer.from(transaction).toString('base64');
+            const encodedTransaction = Buffer.from(transaction).toString('base64url');
             const submissionConfig = (0, caip2_mappings_1.deriveSubmissionConfig)(networkId);
             // If we don't have a submission config, the transaction will only be signed, not submitted
             if (!submissionConfig) {
@@ -181,7 +181,7 @@ class ServerSDK {
                 curve: networkConfig.curve,
                 addressFormat: networkConfig.addressFormat,
             };
-            const base64StringMessage = Buffer.from(message, "utf8").toString("base64");
+            const base64StringMessage = Buffer.from(message, "utf8").toString("base64url");
             const signRequest = {
                 organizationId: this.config.organizationId,
                 walletId: walletId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phantom/server-sdk",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Server SDK for Phantom Wallet",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",