Add preflight check for error

Author: macalinao

packages/gill-extra/src/index.ts

@@ -13,4 +13,5 @@ export * from "./get-solscan-explorer-link.js";
 export * from "./ixs/index.js";
 export * from "./poll-confirm-transaction.js";
 export * from "./transaction.js";
+export * from "./transaction-error.js";
 export * from "./types.js";

packages/gill-extra/src/transaction-error.ts

@@ -0,0 +1,22 @@
+import type { TransactionError } from "@solana/kit";
+import { getSolanaErrorFromTransactionError } from "@solana/kit";
+
+export const parseTransactionError = (
+  err: TransactionError,
+  logs: string[] | null,
+): string => {
+  // First, try to extract Anchor error from logs
+  const anchorError = [...(logs ?? [])]
+    .reverse()
+    .find((log) => log.includes("AnchorError"));
+
+  if (anchorError) {
+    const errorMessageStart = anchorError.indexOf("Error Message: ");
+    if (errorMessageStart !== -1) {
+      return anchorError.slice(errorMessageStart + 15).trim();
+    }
+  }
+
+  const solanaError = getSolanaErrorFromTransactionError(err);
+  return solanaError.message;
+};

packages/gill-extra/src/types.ts

@@ -24,6 +24,10 @@ export interface SendTXOptions
    * @default true
    */
   waitForAccountRefetch?: boolean;
+  /**
+   * If true, skips the pre-flight simulation.
+   */
+  skipPreflight?: boolean;
 }
 
 export type SendTXFunction = (

packages/grill/src/types.ts

@@ -35,6 +35,10 @@ export type TransactionStatusEvent = {
       sig: Signature;
       explorerLink: string;
     }
+  | {
+      type: "error-simulation-failed";
+      errorMessage: string;
+    }
 );
 
 export type TransactionStatusEventCallback = (

packages/grill/src/utils/internal/create-send-tx.ts

@@ -14,13 +14,15 @@ import type { SolanaClient } from "gill";
 import type { TransactionStatusEvent } from "../../types.js";
 import {
   getSignatureFromBytes,
+  parseTransactionError,
   pollConfirmTransaction,
 } from "@macalinao/gill-extra";
 import {
   compressTransactionMessageUsingAddressLookupTables,
+  getSolanaErrorFromTransactionError,
   signAndSendTransactionMessageWithSigners,
 } from "@solana/kit";
-import { createTransaction } from "gill";
+import { createTransaction, simulateTransactionFactory } from "gill";
 
 export interface CreateSendTXParams {
   signer: TransactionSendingSigner | null;
@@ -41,6 +43,7 @@ export const createSendTX = ({
   onTransactionStatusEvent,
   getExplorerLink,
 }: CreateSendTXParams): SendTXFunction => {
+  const simulateTransaction = simulateTransactionFactory({ rpc });
   return async (
     name: string,
     ixs: readonly Instruction[],
@@ -84,6 +87,24 @@ export const createSendTX = ({
           )
         : transactionMessage;
 
+    // preflight
+    if (!options.skipPreflight) {
+      const simulationResult = await simulateTransaction(
+        finalTransactionMessage,
+      );
+      if (simulationResult.value.err) {
+        onTransactionStatusEvent({
+          ...baseEvent,
+          type: "error-simulation-failed",
+          errorMessage: parseTransactionError(
+            simulationResult.value.err,
+            simulationResult.value.logs,
+          ),
+        });
+        throw getSolanaErrorFromTransactionError(simulationResult.value.err);
+      }
+    }
+
     onTransactionStatusEvent({
       ...baseEvent,
       type: "awaiting-wallet-signature",