fix: provide a getOrdinalsInUtxos if found function (#317)

* fix: provide a getOrdinalsInUtxos if found function

* test: add tests for getUtxoOrdinalBundleIfFound

api/ordinals.ts

@@ -1,4 +1,4 @@
-import axios from 'axios';
+import axios, { isAxiosError } from 'axios';
 import EsploraApiProvider from '../api/esplora/esploraAPiProvider';
 import XordApiProvider from '../api/ordinals/provider';
 import { INSCRIPTION_REQUESTS_SERVICE_URL, ORDINALS_URL, XVERSE_API_BASE_URL, XVERSE_INSCRIBE_URL } from '../constant';
@@ -273,6 +273,26 @@ export const getUtxoOrdinalBundle = async (
   return response.data;
 };
 
+export const getUtxoOrdinalBundleIfFound = async (
+  network: NetworkType,
+  txid: string,
+  vout: number,
+): Promise<UtxoBundleResponse | undefined> => {
+  try {
+    const data = await getUtxoOrdinalBundle(network, txid, vout);
+    return data;
+  } catch (e) {
+    // we don't reject on 404s because if the UTXO is not found,
+    // it is likely this is a UTXO from an unpublished txn.
+    // this is required for gamma.io purchase flow
+    if (!isAxiosError(e) || e.response?.status !== 404) {
+      // rethrow error if response was not 404
+      throw e;
+    }
+    return undefined;
+  }
+};
+
 export const mapRareSatsAPIResponseToBundle = (apiBundle: UtxoOrdinalBundle): Bundle => {
   const generalBundleInfo = {
     txid: apiBundle.txid,

package.json

@@ -18,7 +18,7 @@
     "@stacks/transactions": "4.3.5",
     "@stacks/wallet-sdk": "^5.0.2",
     "@zondax/ledger-stacks": "^1.0.4",
-    "axios": "0.27.2",
+    "axios": "1.4.0",
     "base64url": "^3.0.1",
     "bip32": "^4.0.0",
     "bip39": "3.0.3",

tests/api/ordinals.test.ts

@@ -1,6 +1,43 @@
-import { mapRareSatsAPIResponseToBundle } from '../../api/ordinals';
+import { AxiosError, AxiosResponse } from 'axios';
+import { getUtxoOrdinalBundleIfFound, mapRareSatsAPIResponseToBundle } from '../../api/ordinals';
 import { Bundle, UtxoOrdinalBundle } from '../../types/api/xverse/ordinals';
-import { describe, expect, it } from 'vitest';
+import { describe, expect, it, vi, afterEach } from 'vitest';
+
+const mocked = vi.hoisted(() => ({
+  get: vi.fn(),
+}));
+vi.mock('axios', async () => ({
+  ...(await vi.importActual<any>('axios')),
+  default: {
+    get: mocked.get,
+  },
+}));
+
+describe('getUtxoOrdinalBundleIfFound', () => {
+  afterEach(() => {
+    vi.resetAllMocks();
+  });
+
+  it('rejects if API returns 500', () => {
+    mocked.get.mockRejectedValueOnce(
+      new AxiosError('server error', undefined, undefined, undefined, { status: 500 } as AxiosResponse),
+    );
+
+    expect(getUtxoOrdinalBundleIfFound('Testnet', '', 0)).rejects.toEqual(
+      expect.objectContaining({ message: 'server error' }),
+    );
+    expect(mocked.get).toHaveBeenCalledOnce();
+  });
+
+  it('resolves undefined if API returns 404', () => {
+    mocked.get.mockRejectedValueOnce(
+      new AxiosError('not found', undefined, undefined, undefined, { status: 404 } as AxiosResponse),
+    );
+
+    expect(getUtxoOrdinalBundleIfFound('Testnet', '', 0)).resolves.toEqual(undefined);
+    expect(mocked.get).toHaveBeenCalledOnce();
+  });
+});
 
 describe('rareSats', () => {
   describe('mapRareSatsAPIResponseToRareSats', () => {

types/error.ts

@@ -20,7 +20,7 @@ export class ResponseError extends Error {
 export type ApiResponseErrorParams = {
   status: number;
   data: unknown;
-  headers: Record<string, string>;
+  headers: unknown;
 };
 export class ApiResponseError extends Error implements ApiResponseErrorParams {
   public status;