feat: panic receipts have doc links (#456)

FuelLabs · Aug 24, 2022 · 48285d4 · 48285d4
1 parent 745e65b
commit 48285d4
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 4 deletions.
diff --git a/.changeset/curvy-bears-tell.md b/.changeset/curvy-bears-tell.md
@@ -0,0 +1,6 @@
+---
+"@fuel-ts/contract": minor
+"@fuel-ts/script": minor
+---
+
+Failures now output the reason
diff --git a/packages/script/src/constants.ts b/packages/script/src/constants.ts
@@ -0,0 +1,39 @@
+// From https://github.com/FuelLabs/fuel-asm/blob/eb78378c3b7c22a53b834381c387d89b3c0ef122/src/panic_reason.rs#L13
+export const PANIC_REASONS = [
+  'Success',
+  'Revert',
+  'OutOfGas',
+  'TransactionValidity',
+  'MemoryOverflow',
+  'ArithmeticOverflow',
+  'ContractNotFound',
+  'MemoryOwnership',
+  'NotEnoughBalance',
+  'ExpectedInternalContext',
+  'AssetIdNotFound',
+  'InputNotFound',
+  'OutputNotFound',
+  'WitnessNotFound',
+  'TransactionMaturity',
+  'InvalidMetadataIdentifier',
+  'MalformedCallStructure',
+  'ReservedRegisterNotWritable',
+  'ErrorFlag',
+  'InvalidImmediateValue',
+  'ExpectedCoinInput',
+  'MaxMemoryAccess',
+  'MemoryWriteOverlap',
+  'ContractNotInInputs',
+  'InternalBalanceOverflow',
+  'ContractMaxSize',
+  'ExpectedUnallocatedStack',
+  'MaxStaticContractsReached',
+  'TransferAmountCannotBeZero',
+  'ExpectedOutputVariable',
+  'ExpectedParentInternalContext',
+  'IllegalJump',
+  'NonZeroMessageOutputRecipient',
+  'ZeroedMessageOutputRecipient',
+];
+
+export const PANIC_DOC_URL = 'https://docs.rs/fuel-asm/latest/fuel_asm/enum.PanicReason.html';
diff --git a/packages/script/src/errors.ts b/packages/script/src/errors.ts
@@ -1,20 +1,23 @@
 import { ZeroBytes32 } from '@fuel-ts/constants';
 import type {
-  CallResult,
+  TransactionResult,
   TransactionResultLogDataReceipt,
   TransactionResultLogReceipt,
   TransactionResultRevertReceipt,
 } from '@fuel-ts/providers';
 import { ReceiptType } from '@fuel-ts/transactions';
 
+import { getDocs } from './utils';
+
 const bigintReplacer = (key: unknown, value: unknown) =>
   typeof value === 'bigint' ? value.toString() : value;
 
 const printLineWithId = (id: string, line: string) =>
   `${id === ZeroBytes32 ? 'script' : id}: ${line}`;
 
 export class ScriptResultDecoderError extends Error {
-  constructor(result: CallResult, message: string) {
+  constructor(result: TransactionResult<'failure'>, message: string) {
+    const docLink = JSON.stringify(getDocs(result.status), null, 2);
     const revertReceipts = result.receipts.filter(
       (r) => r.type === ReceiptType.Revert
     ) as TransactionResultRevertReceipt[];
@@ -46,7 +49,7 @@ export class ScriptResultDecoderError extends Error {
       2
     )}`;
     super(
-      `${message}\n\n${revertsText ? `${revertsText}\n\n` : ''}${
+      `${message}\n\n${docLink}\n\n${revertsText ? `${revertsText}\n\n` : ''}${
         logsText ? `${logsText}\n\n` : ''
       }${receiptsText}`
     );

diff --git a/packages/script/src/script.ts b/packages/script/src/script.ts
@@ -7,6 +7,7 @@ import type {
   TransactionResultReturnDataReceipt,
   TransactionResultRevertReceipt,
   TransactionResultScriptResultReceipt,
+  TransactionResult,
 } from '@fuel-ts/providers';
 import { ReceiptType } from '@fuel-ts/transactions';
 
@@ -111,7 +112,10 @@ export class Script<TData = void, TResult = void> {
       const decoded = this.scriptResultDecoder(scriptResult);
       return decoded;
     } catch (error) {
-      throw new ScriptResultDecoderError(callResult, (error as Error).message);
+      throw new ScriptResultDecoderError(
+        callResult as TransactionResult<'failure'>,
+        (error as Error).message
+      );
     }
   }
 }
diff --git a/packages/script/src/utils.ts b/packages/script/src/utils.ts
@@ -0,0 +1,19 @@
+import type { TransactionResult } from '@fuel-ts/providers';
+
+import { PANIC_DOC_URL, PANIC_REASONS } from './constants';
+
+const getFailureReason = (reason: string): string =>
+  PANIC_REASONS.includes(reason) ? reason : 'unknown';
+
+export const getDocs = (
+  status: TransactionResult<'failure'>['status']
+): { doc: string; reason: string } => {
+  if (status?.type === 'failure') {
+    const reason = getFailureReason(status.reason);
+    return {
+      doc: reason !== 'unknown' ? `${PANIC_DOC_URL}#variant.${reason}` : PANIC_DOC_URL,
+      reason,
+    };
+  }
+  return { doc: PANIC_DOC_URL, reason: 'unknown' };
+};