Error Handling

import { DepositError, getDisplayMessage } from '@swype-org/deposit';

class DepositError extends Error {
  readonly code: DepositErrorCode;
  constructor(code: DepositErrorCode, message: string);
}

function getDisplayMessage(error: DepositError): string

try {
  await deposit.requestDeposit({ /* ... */ });
} catch (err) {
  if (err instanceof DepositError) {
    // Show user-friendly message in your UI
    showToast(getDisplayMessage(err));

    // Log machine-readable code for debugging
    console.error(err.code, err.message);
  }
}

const { error, displayMessage } = useBlinkDeposit({ signer: '/api/sign-payment' });

// displayMessage is null when there is no error,
// otherwise it's the result of getDisplayMessage(error)
{error && <p className="error">{displayMessage}</p>}

try {
  await deposit.requestDeposit({ /* ... */ });
} catch (err) {
  if (!(err instanceof DepositError)) throw err;

  switch (err.code) {
    case 'DEPOSIT_DISMISSED':
      // User intentionally closed, no action needed
      break;
    case 'SIGNER_REQUEST_FAILED':
    case 'SIGNER_NETWORK_ERROR':
    case 'SIGNER_TIMEOUT':
      // Signer issue, prompt retry
      showRetryDialog(getDisplayMessage(err));
      break;
    case 'SIGNER_RESPONSE_INVALID':
      // Integration bug, log for investigation
      reportError(err);
      break;
    case 'FLOW_TIMEOUT':
      // Flow took too long, prompt retry
      showRetryDialog(getDisplayMessage(err));
      break;
    case 'INVALID_REQUEST':
      // Bad input, show validation error
      showValidationError(getDisplayMessage(err));
      break;
  }
}

type DepositErrorCode =
  | 'DEPOSIT_DISMISSED'
  | 'SIGNER_REQUEST_FAILED'
  | 'SIGNER_NETWORK_ERROR'
  | 'SIGNER_RESPONSE_INVALID'
  | 'SIGNER_TIMEOUT'
  | 'FLOW_TIMEOUT'
  | 'INVALID_REQUEST';