@solana/web3.js 1.91.8 → 1.92.0

package/lib/index.d.ts

@@ -3753,8 +3753,21 @@ export class BpfLoader {
 }
 
 export class SendTransactionError extends Error {
-    logs: string[] | undefined;
-    constructor(message: string, logs?: string[]);
+    private signature;
+    private transactionMessage;
+    private transactionLogs?;
+    private resolvedLogs;
+    constructor({ action, signature, transactionMessage, transactionLogs, }: {
+        action: 'send' | 'simulate';
+        signature: TransactionSignature;
+        transactionMessage: string;
+        transactionLogs?: string[];
+    });
+    get transactionError(): {
+        message: string;
+        logs?: string[];
+    };
+    getLogs(connection: Connection): Promise<string[]>;
 }
 export const SolanaJSONRPCErrorCode: {
     readonly JSON_RPC_SERVER_ERROR_BLOCK_CLEANED_UP: -32001;

package/lib/index.esm.js

@@ -13,8 +13,8 @@ import require$$0$2, { Agent as Agent$1 } from 'https';
 import { coerce, instance, string, tuple, literal, unknown, type, number, array, nullable, optional, boolean, record, union, create, any, assert as assert$1 } from 'superstruct';
 import RpcClient from 'jayson/lib/client/browser';
 import * as nodeFetch from 'node-fetch';
-import RpcWebSocketCommonClient from 'rpc-websockets/dist/lib/client';
-import WebsocketFactory from 'rpc-websockets/dist/lib/client/websocket';
+import RpcWebSocketCommonClient from 'rpc-websockets/dist/lib/client.cjs';
+import WebsocketFactory from 'rpc-websockets/dist/lib/client/websocket.cjs';
 import { keccak_256 } from '@noble/hashes/sha3';
 import { secp256k1 } from '@noble/curves/secp256k1';
 
@@ -2125,6 +2125,94 @@ const SYSVAR_SLOT_HASHES_PUBKEY = new PublicKey('SysvarS1otHashes111111111111111
 const SYSVAR_SLOT_HISTORY_PUBKEY = new PublicKey('SysvarS1otHistory11111111111111111111111111');
 const SYSVAR_STAKE_HISTORY_PUBKEY = new PublicKey('SysvarStakeHistory1111111111111111111111111');
 
+class SendTransactionError extends Error {
+  constructor({
+    action,
+    signature,
+    transactionMessage,
+    transactionLogs
+  }) {
+    let message;
+    switch (action) {
+      case 'send':
+        message = `Transaction ${signature} resulted in an error. \n` + `${transactionMessage}. ` + (transactionLogs ? `Logs: \n${JSON.stringify(transactionLogs.slice(-10), null, 2)}. ` : '') + '\nCatch the SendTransactionError and call `getLogs()` on it for full details.';
+        break;
+      case 'simulate':
+        message = `Simulation failed. \nMessage: ${transactionMessage}. \n` + (transactionLogs ? `Logs: \n${JSON.stringify(transactionLogs.slice(-10), null, 2)}. ` : '') + '\nCatch the SendTransactionError and call `getLogs()` on it for full details.';
+        break;
+      default:
+        message = 'Unknown action';
+    }
+    super(message);
+    this.signature = void 0;
+    this.transactionMessage = void 0;
+    this.transactionLogs = void 0;
+    this.resolvedLogs = void 0;
+    this.signature = signature;
+    this.transactionMessage = transactionMessage;
+    this.transactionLogs = transactionLogs;
+    this.resolvedLogs = transactionLogs ? transactionLogs : undefined;
+  }
+  get transactionError() {
+    return {
+      message: this.transactionMessage,
+      logs: this.transactionLogs
+    };
+  }
+  async getLogs(connection) {
+    if (this.resolvedLogs === undefined) {
+      this.resolvedLogs = new Promise((resolve, reject) => {
+        connection.getTransaction(this.signature).then(tx => {
+          if (tx && tx.meta && tx.meta.logMessages) {
+            const logs = tx.meta.logMessages;
+            this.resolvedLogs = logs;
+            this.transactionLogs = logs;
+            resolve(logs);
+          } else {
+            reject(new Error('Log messages not found'));
+          }
+        }).catch(reject);
+      });
+    }
+    return await this.resolvedLogs;
+  }
+}
+
+// Keep in sync with client/src/rpc_custom_errors.rs
+// Typescript `enums` thwart tree-shaking. See https://bargsten.org/jsts/enums/
+const SolanaJSONRPCErrorCode = {
+  JSON_RPC_SERVER_ERROR_BLOCK_CLEANED_UP: -32001,
+  JSON_RPC_SERVER_ERROR_SEND_TRANSACTION_PREFLIGHT_FAILURE: -32002,
+  JSON_RPC_SERVER_ERROR_TRANSACTION_SIGNATURE_VERIFICATION_FAILURE: -32003,
+  JSON_RPC_SERVER_ERROR_BLOCK_NOT_AVAILABLE: -32004,
+  JSON_RPC_SERVER_ERROR_NODE_UNHEALTHY: -32005,
+  JSON_RPC_SERVER_ERROR_TRANSACTION_PRECOMPILE_VERIFICATION_FAILURE: -32006,
+  JSON_RPC_SERVER_ERROR_SLOT_SKIPPED: -32007,
+  JSON_RPC_SERVER_ERROR_NO_SNAPSHOT: -32008,
+  JSON_RPC_SERVER_ERROR_LONG_TERM_STORAGE_SLOT_SKIPPED: -32009,
+  JSON_RPC_SERVER_ERROR_KEY_EXCLUDED_FROM_SECONDARY_INDEX: -32010,
+  JSON_RPC_SERVER_ERROR_TRANSACTION_HISTORY_NOT_AVAILABLE: -32011,
+  JSON_RPC_SCAN_ERROR: -32012,
+  JSON_RPC_SERVER_ERROR_TRANSACTION_SIGNATURE_LEN_MISMATCH: -32013,
+  JSON_RPC_SERVER_ERROR_BLOCK_STATUS_NOT_AVAILABLE_YET: -32014,
+  JSON_RPC_SERVER_ERROR_UNSUPPORTED_TRANSACTION_VERSION: -32015,
+  JSON_RPC_SERVER_ERROR_MIN_CONTEXT_SLOT_NOT_REACHED: -32016
+};
+class SolanaJSONRPCError extends Error {
+  constructor({
+    code,
+    message,
+    data
+  }, customMessage) {
+    super(customMessage != null ? `${customMessage}: ${message}` : message);
+    this.code = void 0;
+    this.data = void 0;
+    this.code = code;
+    this.data = data;
+    this.name = 'SolanaJSONRPCError';
+  }
+}
+
 /**
  * Sign, send and confirm a transaction.
  *
@@ -2171,6 +2259,13 @@ async function sendAndConfirmTransaction(connection, transaction, signers, optio
     status = (await connection.confirmTransaction(signature, options && options.commitment)).value;
   }
   if (status.err) {
+    if (signature != null) {
+      throw new SendTransactionError({
+        action: 'send',
+        signature: signature,
+        transactionMessage: `Status: (${JSON.stringify(status)})`
+      });
+    }
     throw new Error(`Transaction ${signature} failed (${JSON.stringify(status)})`);
   }
   return signature;
@@ -4087,49 +4182,6 @@ class EpochSchedule {
   }
 }
 
-class SendTransactionError extends Error {
-  constructor(message, logs) {
-    super(message);
-    this.logs = void 0;
-    this.logs = logs;
-  }
-}
-
-// Keep in sync with client/src/rpc_custom_errors.rs
-// Typescript `enums` thwart tree-shaking. See https://bargsten.org/jsts/enums/
-const SolanaJSONRPCErrorCode = {
-  JSON_RPC_SERVER_ERROR_BLOCK_CLEANED_UP: -32001,
-  JSON_RPC_SERVER_ERROR_SEND_TRANSACTION_PREFLIGHT_FAILURE: -32002,
-  JSON_RPC_SERVER_ERROR_TRANSACTION_SIGNATURE_VERIFICATION_FAILURE: -32003,
-  JSON_RPC_SERVER_ERROR_BLOCK_NOT_AVAILABLE: -32004,
-  JSON_RPC_SERVER_ERROR_NODE_UNHEALTHY: -32005,
-  JSON_RPC_SERVER_ERROR_TRANSACTION_PRECOMPILE_VERIFICATION_FAILURE: -32006,
-  JSON_RPC_SERVER_ERROR_SLOT_SKIPPED: -32007,
-  JSON_RPC_SERVER_ERROR_NO_SNAPSHOT: -32008,
-  JSON_RPC_SERVER_ERROR_LONG_TERM_STORAGE_SLOT_SKIPPED: -32009,
-  JSON_RPC_SERVER_ERROR_KEY_EXCLUDED_FROM_SECONDARY_INDEX: -32010,
-  JSON_RPC_SERVER_ERROR_TRANSACTION_HISTORY_NOT_AVAILABLE: -32011,
-  JSON_RPC_SCAN_ERROR: -32012,
-  JSON_RPC_SERVER_ERROR_TRANSACTION_SIGNATURE_LEN_MISMATCH: -32013,
-  JSON_RPC_SERVER_ERROR_BLOCK_STATUS_NOT_AVAILABLE_YET: -32014,
-  JSON_RPC_SERVER_ERROR_UNSUPPORTED_TRANSACTION_VERSION: -32015,
-  JSON_RPC_SERVER_ERROR_MIN_CONTEXT_SLOT_NOT_REACHED: -32016
-};
-class SolanaJSONRPCError extends Error {
-  constructor({
-    code,
-    message,
-    data
-  }, customMessage) {
-    super(customMessage != null ? `${customMessage}: ${message}` : message);
-    this.code = void 0;
-    this.data = void 0;
-    this.code = code;
-    this.data = data;
-    this.name = 'SolanaJSONRPCError';
-  }
-}
-
 var fetchImpl = typeof globalThis.fetch === 'function' ?
 // The Fetch API is supported experimentally in Node 17.5+ and natively in Node 18+.
 globalThis.fetch :
@@ -4248,7 +4300,7 @@ function makeWebsocketUrl(endpoint) {
   const websocketPort =
   // Only shift the port by +1 as a convention for ws(s) only if given endpoint
   // is explicitly specifying the endpoint port (HTTP-based RPC), assuming
-  // we're directly trying to connect to solana-validator's ws listening port.
+  // we're directly trying to connect to agave-validator's ws listening port.
   // When the endpoint omits the port, we're connecting to the protocol
   // default ports: http(80) or https(443) and it's assumed we're behind a reverse
   // proxy which manages WebSocket upgrade and backend port redirection.
@@ -7910,7 +7962,12 @@ class Connection {
           console.error(res.error.message, logTrace);
         }
       }
-      throw new SendTransactionError('failed to simulate transaction: ' + res.error.message, logs);
+      throw new SendTransactionError({
+        action: 'simulate',
+        signature: '',
+        transactionMessage: res.error.message,
+        transactionLogs: logs
+      });
     }
     return res.result;
   }
@@ -8011,11 +8068,16 @@ class Connection {
     const unsafeRes = await this._rpcRequest('sendTransaction', args);
     const res = create(unsafeRes, SendTransactionRpcResult);
     if ('error' in res) {
-      let logs;
+      let logs = undefined;
       if ('data' in res.error) {
         logs = res.error.data.logs;
       }
-      throw new SendTransactionError('failed to send transaction: ' + res.error.message, logs);
+      throw new SendTransactionError({
+        action: skipPreflight ? 'send' : 'simulate',
+        signature: '',
+        transactionMessage: res.error.message,
+        transactionLogs: logs
+      });
     }
     return res.result;
   }
@@ -11003,6 +11065,13 @@ async function sendAndConfirmRawTransaction(connection, rawTransaction, confirma
   const confirmationPromise = confirmationStrategy ? connection.confirmTransaction(confirmationStrategy, commitment) : connection.confirmTransaction(signature, commitment);
   const status = (await confirmationPromise).value;
   if (status.err) {
+    if (signature != null) {
+      throw new SendTransactionError({
+        action: sendOptions?.skipPreflight ? 'send' : 'simulate',
+        signature: signature,
+        transactionMessage: `Status: (${JSON.stringify(status)})`
+      });
+    }
     throw new Error(`Raw transaction ${signature} failed (${JSON.stringify(status)})`);
   }
   return signature;