@dynamic-labs-wallet/node-svm 0.0.321 → 0.0.323

package/index.cjs.js

@@ -15,6 +15,7 @@ function _extends() {
 }
 
 const ERROR_CREATE_WALLET_ACCOUNT = 'Error creating svm wallet account';
+const ERROR_SIGN_RAW_MESSAGE = 'Error signing raw message';
 
 // Base58 encoding/decoding (Bitcoin alphabet) without external dependencies
 // Implementation adapted from the reference algorithm; suitable for keys/signatures
@@ -209,12 +210,61 @@ class DynamicSvmWalletClient extends node.DynamicWalletClient {
             throw error;
         }
     }
+    /**
+   * Signs a pre-formatted (raw) message without additional encoding.
+   * The message must be a hex string representing already-hashed data.
+   *
+   * @param message The pre-formatted hex message to sign
+   * @param accountAddress Solana address (base58 encoded)
+   * @param password The password for encrypted backup shares
+   */ async signRawMessage({ message, accountAddress, password = undefined, externalServerKeyShares }) {
+        if (!accountAddress) {
+            throw new Error('Account address is required');
+        }
+        try {
+            // Attempt to recover key shares from backup if not provided
+            await this.ensureKeySharesRecovered({
+                accountAddress,
+                password,
+                walletOperation: node.WalletOperation.SIGN_MESSAGE,
+                externalServerKeyShares,
+                errorMessage: 'External server key shares are required to sign a raw message. No backup shares available for recovery.'
+            });
+            const messageHex = node.stripHexPrefix(message);
+            const signatureEd25519 = await this.sign({
+                message: messageHex,
+                accountAddress,
+                chainName: this.chainName,
+                password,
+                externalServerKeyShares,
+                isFormatted: true
+            });
+            return encodeBase58(signatureEd25519);
+        } catch (error) {
+            logError$1({
+                message: ERROR_SIGN_RAW_MESSAGE,
+                error: error,
+                context: {
+                    accountAddress
+                }
+            });
+            throw new Error(ERROR_SIGN_RAW_MESSAGE);
+        }
+    }
     //todo:should txn just be a string?
-    async signTransaction({ senderAddress, transaction, password = undefined, externalServerKeyShares }) {
+    async signTransaction({ senderAddress, transaction, password = undefined, externalServerKeyShares, sponsor = false }) {
         // Validate inputs early
         if (!senderAddress) {
             throw new Error('Sender address is required');
         }
+        if (sponsor) {
+            if (typeof transaction === 'string') {
+                throw new TypeError('sponsor=true requires a Transaction or VersionedTransaction object, not a hex string');
+            }
+            transaction = await this.sponsorTransaction({
+                transaction
+            });
+        }
         await this.verifyPassword({
             accountAddress: senderAddress,
             password
@@ -381,6 +431,37 @@ class DynamicSvmWalletClient extends node.DynamicWalletClient {
             externalKeySharesWithBackupStatus
         };
     }
+    /**
+   * Sponsors a Solana transaction via the Dynamic gas sponsorship API.
+   *
+   * Sends the unsigned transaction to Dynamic's sponsorTransaction endpoint,
+   * which replaces the fee payer with the sponsor's address. The returned
+   * transaction object has the sponsor as fee payer and should be passed to
+   * {@link signTransaction} instead of the original transaction.
+   *
+   * Gas sponsorship must be enabled for your environment in the Dynamic
+   * dashboard before calling this method.
+   *
+   * @param transaction - Unsigned Solana transaction (legacy or versioned).
+   * @returns The sponsored transaction with the gas sponsor as fee payer.
+   */ async sponsorTransaction({ transaction, traceContext }) {
+        // Serialize the unsigned transaction to base64 wire format
+        const serialized = transaction instanceof web3_js.VersionedTransaction ? transaction.serialize() : transaction.serialize({
+            requireAllSignatures: false,
+            verifySignatures: false
+        });
+        const txBase64 = Buffer.from(serialized).toString('base64');
+        const { transaction: sponsoredBase64 } = await this.apiClient.requestSvmSponsoredTransaction({
+            transaction: txBase64,
+            traceContext
+        });
+        const sponsoredBytes = Buffer.from(sponsoredBase64, 'base64');
+        // Deserialize back to the same transaction type
+        if (transaction instanceof web3_js.VersionedTransaction) {
+            return web3_js.VersionedTransaction.deserialize(sponsoredBytes);
+        }
+        return web3_js.Transaction.from(sponsoredBytes);
+    }
     async getSvmWallets() {
         const wallets = await this.getWallets();
         const svmWallets = wallets.filter((wallet)=>wallet.chainName === 'solana');
@@ -589,6 +670,62 @@ const logError = node.createLogError('node-svm');
         throw error;
     }
 };
+/**
+ * Signs a pre-formatted (raw) message using delegated signing for SVM.
+ * The message must be a hex string representing already-hashed data.
+ *
+ * @param client - The delegated SVM wallet client
+ * @param options - Signing options
+ * @param options.walletId - The wallet ID
+ * @param options.walletApiKey - The wallet API key
+ * @param options.keyShare - The server key share
+ * @param options.message - Hex string of the already-hashed data to sign
+ *
+ * @returns The base58-encoded signature
+ *
+ * @example
+ * // Sign a pre-hashed message
+ * const signature = await delegatedSignRawMessage(client, {
+ *   walletId,
+ *   walletApiKey,
+ *   keyShare,
+ *   message: preHashedHex, // hex string of already-hashed data
+ * });
+ *
+ * @example
+ * // Sign a SHA-256 hash derived from arbitrary application data
+ * import { createHash } from 'crypto';
+ * const hash = createHash('sha256').update('my application data').digest('hex');
+ * const signature = await delegatedSignRawMessage(client, {
+ *   walletId,
+ *   walletApiKey,
+ *   keyShare,
+ *   message: hash,
+ * });
+ *
+ */ const delegatedSignRawMessage = async (client, { walletId, walletApiKey, keyShare, message })=>{
+    if (!keyShare || !walletId || !walletApiKey) {
+        throw new Error('Delegated key share, wallet ID, and wallet API key are required to sign a raw message');
+    }
+    try {
+        return await delegatedSignMessage(client, {
+            walletId,
+            walletApiKey,
+            keyShare,
+            message: node.stripHexPrefix(message),
+            isFormatted: true
+        });
+    } catch (error) {
+        logError({
+            message: 'Error in delegatedSignRawMessage',
+            error: error,
+            context: {
+                walletId
+            }
+        });
+        throw error;
+    }
+};
 /**
  * Revoke delegation - delegates to the node package
  */ const revokeDelegation = async (client, params)=>{
@@ -597,12 +734,14 @@ const logError = node.createLogError('node-svm');
 
 exports.DynamicSvmWalletClient = DynamicSvmWalletClient;
 exports.ERROR_CREATE_WALLET_ACCOUNT = ERROR_CREATE_WALLET_ACCOUNT;
+exports.ERROR_SIGN_RAW_MESSAGE = ERROR_SIGN_RAW_MESSAGE;
 exports.addSignatureToTransaction = addSignatureToTransaction;
 exports.attachSignature = attachSignature;
 exports.createDelegatedSvmWalletClient = createDelegatedSvmWalletClient;
 exports.createSolanaTransaction = createSolanaTransaction;
 exports.decodeBase58 = decodeBase58;
 exports.delegatedSignMessage = delegatedSignMessage;
+exports.delegatedSignRawMessage = delegatedSignRawMessage;
 exports.delegatedSignTransaction = delegatedSignTransaction;
 exports.encodeBase58 = encodeBase58;
 exports.getBalance = getBalance;

package/index.esm.js

@@ -1,5 +1,5 @@
-import { createLogError, DynamicWalletClient, getMPCChainConfig, getExternalServerKeyShareBackupInfo, WalletOperation, SOLANA_RPC_URL, createDelegatedWalletClient, delegatedSignMessage as delegatedSignMessage$1, revokeDelegation as revokeDelegation$1 } from '@dynamic-labs-wallet/node';
-import { PublicKey, VersionedTransaction, Keypair, Connection, Transaction, SystemProgram } from '@solana/web3.js';
+import { createLogError, DynamicWalletClient, getMPCChainConfig, getExternalServerKeyShareBackupInfo, WalletOperation, stripHexPrefix, SOLANA_RPC_URL, createDelegatedWalletClient, delegatedSignMessage as delegatedSignMessage$1, revokeDelegation as revokeDelegation$1 } from '@dynamic-labs-wallet/node';
+import { PublicKey, VersionedTransaction, Keypair, Transaction, Connection, SystemProgram } from '@solana/web3.js';
 
 function _extends() {
     _extends = Object.assign || function assign(target) {
@@ -13,6 +13,7 @@ function _extends() {
 }
 
 const ERROR_CREATE_WALLET_ACCOUNT = 'Error creating svm wallet account';
+const ERROR_SIGN_RAW_MESSAGE = 'Error signing raw message';
 
 // Base58 encoding/decoding (Bitcoin alphabet) without external dependencies
 // Implementation adapted from the reference algorithm; suitable for keys/signatures
@@ -207,12 +208,61 @@ class DynamicSvmWalletClient extends DynamicWalletClient {
             throw error;
         }
     }
+    /**
+   * Signs a pre-formatted (raw) message without additional encoding.
+   * The message must be a hex string representing already-hashed data.
+   *
+   * @param message The pre-formatted hex message to sign
+   * @param accountAddress Solana address (base58 encoded)
+   * @param password The password for encrypted backup shares
+   */ async signRawMessage({ message, accountAddress, password = undefined, externalServerKeyShares }) {
+        if (!accountAddress) {
+            throw new Error('Account address is required');
+        }
+        try {
+            // Attempt to recover key shares from backup if not provided
+            await this.ensureKeySharesRecovered({
+                accountAddress,
+                password,
+                walletOperation: WalletOperation.SIGN_MESSAGE,
+                externalServerKeyShares,
+                errorMessage: 'External server key shares are required to sign a raw message. No backup shares available for recovery.'
+            });
+            const messageHex = stripHexPrefix(message);
+            const signatureEd25519 = await this.sign({
+                message: messageHex,
+                accountAddress,
+                chainName: this.chainName,
+                password,
+                externalServerKeyShares,
+                isFormatted: true
+            });
+            return encodeBase58(signatureEd25519);
+        } catch (error) {
+            logError$1({
+                message: ERROR_SIGN_RAW_MESSAGE,
+                error: error,
+                context: {
+                    accountAddress
+                }
+            });
+            throw new Error(ERROR_SIGN_RAW_MESSAGE);
+        }
+    }
     //todo:should txn just be a string?
-    async signTransaction({ senderAddress, transaction, password = undefined, externalServerKeyShares }) {
+    async signTransaction({ senderAddress, transaction, password = undefined, externalServerKeyShares, sponsor = false }) {
         // Validate inputs early
         if (!senderAddress) {
             throw new Error('Sender address is required');
         }
+        if (sponsor) {
+            if (typeof transaction === 'string') {
+                throw new TypeError('sponsor=true requires a Transaction or VersionedTransaction object, not a hex string');
+            }
+            transaction = await this.sponsorTransaction({
+                transaction
+            });
+        }
         await this.verifyPassword({
             accountAddress: senderAddress,
             password
@@ -379,6 +429,37 @@ class DynamicSvmWalletClient extends DynamicWalletClient {
             externalKeySharesWithBackupStatus
         };
     }
+    /**
+   * Sponsors a Solana transaction via the Dynamic gas sponsorship API.
+   *
+   * Sends the unsigned transaction to Dynamic's sponsorTransaction endpoint,
+   * which replaces the fee payer with the sponsor's address. The returned
+   * transaction object has the sponsor as fee payer and should be passed to
+   * {@link signTransaction} instead of the original transaction.
+   *
+   * Gas sponsorship must be enabled for your environment in the Dynamic
+   * dashboard before calling this method.
+   *
+   * @param transaction - Unsigned Solana transaction (legacy or versioned).
+   * @returns The sponsored transaction with the gas sponsor as fee payer.
+   */ async sponsorTransaction({ transaction, traceContext }) {
+        // Serialize the unsigned transaction to base64 wire format
+        const serialized = transaction instanceof VersionedTransaction ? transaction.serialize() : transaction.serialize({
+            requireAllSignatures: false,
+            verifySignatures: false
+        });
+        const txBase64 = Buffer.from(serialized).toString('base64');
+        const { transaction: sponsoredBase64 } = await this.apiClient.requestSvmSponsoredTransaction({
+            transaction: txBase64,
+            traceContext
+        });
+        const sponsoredBytes = Buffer.from(sponsoredBase64, 'base64');
+        // Deserialize back to the same transaction type
+        if (transaction instanceof VersionedTransaction) {
+            return VersionedTransaction.deserialize(sponsoredBytes);
+        }
+        return Transaction.from(sponsoredBytes);
+    }
     async getSvmWallets() {
         const wallets = await this.getWallets();
         const svmWallets = wallets.filter((wallet)=>wallet.chainName === 'solana');
@@ -587,10 +668,66 @@ const logError = createLogError('node-svm');
         throw error;
     }
 };
+/**
+ * Signs a pre-formatted (raw) message using delegated signing for SVM.
+ * The message must be a hex string representing already-hashed data.
+ *
+ * @param client - The delegated SVM wallet client
+ * @param options - Signing options
+ * @param options.walletId - The wallet ID
+ * @param options.walletApiKey - The wallet API key
+ * @param options.keyShare - The server key share
+ * @param options.message - Hex string of the already-hashed data to sign
+ *
+ * @returns The base58-encoded signature
+ *
+ * @example
+ * // Sign a pre-hashed message
+ * const signature = await delegatedSignRawMessage(client, {
+ *   walletId,
+ *   walletApiKey,
+ *   keyShare,
+ *   message: preHashedHex, // hex string of already-hashed data
+ * });
+ *
+ * @example
+ * // Sign a SHA-256 hash derived from arbitrary application data
+ * import { createHash } from 'crypto';
+ * const hash = createHash('sha256').update('my application data').digest('hex');
+ * const signature = await delegatedSignRawMessage(client, {
+ *   walletId,
+ *   walletApiKey,
+ *   keyShare,
+ *   message: hash,
+ * });
+ *
+ */ const delegatedSignRawMessage = async (client, { walletId, walletApiKey, keyShare, message })=>{
+    if (!keyShare || !walletId || !walletApiKey) {
+        throw new Error('Delegated key share, wallet ID, and wallet API key are required to sign a raw message');
+    }
+    try {
+        return await delegatedSignMessage(client, {
+            walletId,
+            walletApiKey,
+            keyShare,
+            message: stripHexPrefix(message),
+            isFormatted: true
+        });
+    } catch (error) {
+        logError({
+            message: 'Error in delegatedSignRawMessage',
+            error: error,
+            context: {
+                walletId
+            }
+        });
+        throw error;
+    }
+};
 /**
  * Revoke delegation - delegates to the node package
  */ const revokeDelegation = async (client, params)=>{
     return revokeDelegation$1(client, params);
 };
 
-export { DynamicSvmWalletClient, ERROR_CREATE_WALLET_ACCOUNT, addSignatureToTransaction, attachSignature, createDelegatedSvmWalletClient, createSolanaTransaction, decodeBase58, delegatedSignMessage, delegatedSignTransaction, encodeBase58, getBalance, revokeDelegation, sendTransaction };
+export { DynamicSvmWalletClient, ERROR_CREATE_WALLET_ACCOUNT, ERROR_SIGN_RAW_MESSAGE, addSignatureToTransaction, attachSignature, createDelegatedSvmWalletClient, createSolanaTransaction, decodeBase58, delegatedSignMessage, delegatedSignRawMessage, delegatedSignTransaction, encodeBase58, getBalance, revokeDelegation, sendTransaction };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@dynamic-labs-wallet/node-svm",
-  "version": "0.0.321",
+  "version": "0.0.323",
   "license": "MIT",
   "type": "module",
   "dependencies": {
-    "@dynamic-labs-wallet/node": "0.0.321",
+    "@dynamic-labs-wallet/node": "0.0.323",
     "@solana/web3.js": "^1.98.2"
   },
   "publishConfig": {