From 93c20d0a472333bf233d7fa6ae5ea3192fe221bc Mon Sep 17 00:00:00 2001
From: Josh <josh.hundley@gmail.com>
Date: Mon, 26 Jul 2021 13:54:50 -0700
Subject: [PATCH] feat: show transaction errors in log (#18843)

---
 .../transaction/ProgramLogSection.tsx         | 205 +++++++++++++++++-
 1 file changed, 201 insertions(+), 4 deletions(-)

diff --git a/explorer/src/components/transaction/ProgramLogSection.tsx b/explorer/src/components/transaction/ProgramLogSection.tsx
index eec1e81b4f..29b9aeb065 100644
--- a/explorer/src/components/transaction/ProgramLogSection.tsx
+++ b/explorer/src/components/transaction/ProgramLogSection.tsx
@@ -1,12 +1,205 @@
 import React from "react";
 import { SignatureProps } from "pages/TransactionDetailsPage";
 import { useTransactionDetails } from "providers/transactions";
+import { TransactionError } from "@solana/web3.js";
+
+const transactionErrorMessage: Map<string, string> = new Map([
+  ["AccountInUse", "Account in use"],
+  ["AccountLoadedTwice", "Account loaded twice"],
+  [
+    "AccountNotFound",
+    "Attempt to debit an account but found no record of a prior credit.",
+  ],
+  ["ProgramAccountNotFound", "Attempt to load a program that does not exist"],
+  ["InsufficientFundsForFee", "Insufficient funds for fee"],
+  [
+    "InvalidAccountForFee",
+    "This account may not be used to pay transaction fees",
+  ],
+  ["AlreadyProcessed", "This transaction has already been processed"],
+  ["BlockhashNotFound", "Blockhash not found"],
+  ["CallChainTooDeep", "Loader call chain is too deep"],
+  [
+    "MissingSignatureForFee",
+    "Transaction requires a fee but has no signature present",
+  ],
+  ["InvalidAccountIndex", "Transaction contains an invalid account reference"],
+  ["SignatureFailure", "Transaction did not pass signature verification"],
+  [
+    "InvalidProgramForExecution",
+    "This program may not be used for executing instructions",
+  ],
+  [
+    "SanitizeFailure",
+    "Transaction failed to sanitize accounts offsets correctly",
+  ],
+  [
+    "ClusterMaintenance",
+    "Transactions are currently disabled due to cluster maintenance",
+  ],
+  [
+    "AccountBorrowOutstanding",
+    "Transaction processing left an account with an outstanding borrowed reference",
+  ],
+  ["InstructionError", "Error processing Instruction {0}: {1}"],
+]);
+
+const instructionErrorMessage: Map<string, string> = new Map([
+  ["GenericError", "generic instruction error"],
+  ["InvalidArgument", "invalid program argument"],
+  ["InvalidInstructionData", "invalid instruction data"],
+  ["InvalidAccountData", "invalid account data for instruction"],
+  ["AccountDataTooSmall", "account data too small for instruction"],
+  ["InsufficientFunds", "insufficient funds for instruction"],
+  ["IncorrectProgramId", "incorrect program id for instruction"],
+  ["MissingRequiredSignature", "missing required signature for instruction"],
+  [
+    "AccountAlreadyInitialized",
+    "instruction requires an uninitialized account",
+  ],
+  ["UninitializedAccount", "instruction requires an initialized account"],
+  [
+    "UnbalancedInstruction",
+    "sum of account balances before and after instruction do not match",
+  ],
+  ["ModifiedProgramId", "instruction modified the program id of an account"],
+  [
+    "ExternalAccountLamportSpend",
+    "instruction spent from the balance of an account it does not own",
+  ],
+  [
+    "ExternalAccountDataModified",
+    "instruction modified data of an account it does not own",
+  ],
+  [
+    "ReadonlyLamportChange",
+    "instruction changed the balance of a read-only account",
+  ],
+  ["ReadonlyDataModified", "instruction modified data of a read-only account"],
+  ["DuplicateAccountIndex", "instruction contains duplicate accounts"],
+  ["ExecutableModified", "instruction changed executable bit of an account"],
+  ["RentEpochModified", "instruction modified rent epoch of an account"],
+  ["NotEnoughAccountKeys", "insufficient account keys for instruction"],
+  ["AccountDataSizeChanged", "non-system instruction changed account size"],
+  ["AccountNotExecutable", "instruction expected an executable account"],
+  [
+    "AccountBorrowFailed",
+    "instruction tries to borrow reference for an account which is already borrowed",
+  ],
+  [
+    "AccountBorrowOutstanding",
+    "instruction left account with an outstanding borrowed reference",
+  ],
+  [
+    "DuplicateAccountOutOfSync",
+    "instruction modifications of multiply-passed account differ",
+  ],
+  ["Custom", "custom program error: {0}"],
+  ["InvalidError", "program returned invalid error code"],
+  ["ExecutableDataModified", "instruction changed executable accounts data"],
+  [
+    "ExecutableLamportChange",
+    "instruction changed the balance of a executable account",
+  ],
+  ["ExecutableAccountNotRentExempt", "executable accounts must be rent exempt"],
+  ["UnsupportedProgramId", "Unsupported program id"],
+  ["CallDepth", "Cross-program invocation call depth too deep"],
+  ["MissingAccount", "An account required by the instruction is missing"],
+  [
+    "ReentrancyNotAllowed",
+    "Cross-program invocation reentrancy not allowed for this instruction",
+  ],
+  [
+    "MaxSeedLengthExceeded",
+    "Length of the seed is too long for address generation",
+  ],
+  ["InvalidSeeds", "Provided seeds do not result in a valid address"],
+  ["InvalidRealloc", "Failed to reallocate account data"],
+  ["ComputationalBudgetExceeded", "Computational budget exceeded"],
+  [
+    "PrivilegeEscalation",
+    "Cross-program invocation with unauthorized signer or writable account",
+  ],
+  [
+    "ProgramEnvironmentSetupFailure",
+    "Failed to create program execution environment",
+  ],
+  ["ProgramFailedToComplete", "Program failed to complete"],
+  ["ProgramFailedToCompile", "Program failed to compile"],
+  ["Immutable", "Account is immutable"],
+  ["IncorrectAuthority", "Incorrect authority provided"],
+  ["BorshIoError", "Failed to serialize or deserialize account data: {0}"],
+  [
+    "AccountNotRentExempt",
+    "An account does not have enough lamports to be rent-exempt",
+  ],
+  ["InvalidAccountOwner", "Invalid account owner"],
+  ["ArithmeticOverflow", "Program arithmetic overflowed"],
+  ["UnsupportedSysvar", "Unsupported sysvar"],
+  ["IllegalOwner", "Provided owner is not allowed"],
+]);
+
+function getTransactionError(
+  error?: TransactionError | null
+): string | undefined {
+  if (!error) {
+    return;
+  }
+
+  if (typeof error === "string") {
+    const message = transactionErrorMessage.get(error);
+    if (message) {
+      return message;
+    }
+  } else if ("InstructionError" in error) {
+    const out = transactionErrorMessage.get("InstructionError");
+    const innerError = error["InstructionError"];
+    const index = innerError[0];
+    const instructionError = innerError[1];
+
+    if (out) {
+      return out
+        .replace("{0}", index)
+        .replace("{1}", getInstructionError(instructionError));
+    }
+  }
+
+  return "Unknown transaction error";
+}
+
+function getInstructionError(error: TransactionError): string {
+  let out;
+  let value;
+
+  if (typeof error === "string") {
+    const message = instructionErrorMessage.get(error);
+    if (message) {
+      return message;
+    }
+  } else if ("Custom" in error) {
+    out = instructionErrorMessage.get("Custom");
+    value = error["Custom"][0];
+  } else if ("BorshIoError" in error) {
+    out = instructionErrorMessage.get("BorshIoError");
+    value = error["BorshIoError"][0];
+  }
+
+  if (out && value) {
+    return out.replace("{0}", value);
+  }
+
+  return "Unknown instruction error";
+}
 
 export function ProgramLogSection({ signature }: SignatureProps) {
   const details = useTransactionDetails(signature);
   const logMessages = details?.data?.transaction?.meta?.logMessages;
 
-  if (!logMessages || logMessages.length < 1) {
+  const transactionError = getTransactionError(
+    details?.data?.transaction?.meta?.err
+  );
+
+  if ((!logMessages || logMessages.length < 1) && !transactionError) {
     return null;
   }
 
@@ -21,9 +214,13 @@ export function ProgramLogSection({ signature }: SignatureProps) {
       </div>
       <div className="card">
         <ul className="log-messages">
-          {logMessages.map((message, key) => (
-            <li key={key}>{message.replace(/^Program log: /, "")}</li>
-          ))}
+          {logMessages &&
+            logMessages.map((message, key) => (
+              <li key={key}>{message.replace(/^Program log: /, "")}</li>
+            ))}
+          {transactionError && (
+            <li className="mt-3">Transaction failed: {transactionError}</li>
+          )}
         </ul>
       </div>
     </>