feat: browser compatible BlockfrostUtxoProvider

Author: rhyslbw

packages/cardano-services/src/Utxo/BlockfrostUtxoProvider/BlockfrostUtxoProvider.ts renamed to packages/cardano-services-client/src/UtxoProvider/BlockfrostUtxoProvider.ts

@@ -1,20 +1,18 @@
-import { BlockfrostProvider } from '../../util/BlockfrostProvider/BlockfrostProvider';
-import {
-  BlockfrostToCore,
-  blockfrostToProviderError,
-  fetchByAddressSequentially
-} from '@cardano-sdk/cardano-services-client';
+import { BlockfrostProvider, BlockfrostToCore, fetchByAddressSequentially } from '../blockfrost';
 import { Cardano, Serialization, UtxoByAddressesArgs, UtxoProvider } from '@cardano-sdk/core';
 import { PaginationOptions } from '@blockfrost/blockfrost-js/lib/types';
 import { Responses } from '@blockfrost/blockfrost-js';
-import { Schemas } from '@blockfrost/blockfrost-js/lib/types/open-api';
 
 export class BlockfrostUtxoProvider extends BlockfrostProvider implements UtxoProvider {
-  protected async fetchUtxos(addr: Cardano.PaymentAddress, pagination: PaginationOptions): Promise<Cardano.Utxo[]> {
-    const utxos: Responses['address_utxo_content'] = (await this.blockfrost.addressesUtxos(
-      addr.toString(),
-      pagination
-    )) as Responses['address_utxo_content'];
+  protected async fetchUtxos(
+    addr: Cardano.PaymentAddress,
+    { page, count, order }: PaginationOptions
+  ): Promise<Cardano.Utxo[]> {
+    let queryString = `addresses/${addr.toString()}/utxo`;
+    if (page) queryString += `?page=${page}`;
+    if (count) queryString += `?count=${count}`;
+    if (order) queryString += `?order=${order}`;
+    const utxos = await this.request<Responses['address_utxo_content']>(queryString);
 
     const utxoPromises = utxos.map((utxo) =>
       this.fetchDetailsFromCBOR(utxo.tx_hash).then((tx) => {
@@ -26,10 +24,9 @@ export class BlockfrostUtxoProvider extends BlockfrostProvider implements UtxoPr
   }
 
   async fetchCBOR(hash: string): Promise<string> {
-    return this.blockfrost
-      .instance<Schemas['script_cbor']>(`txs/${hash}/cbor`)
+    return this.request<Responses['tx_content_cbor']>(`txs/${hash}/cbor`)
       .then((response) => {
-        if (response.body.cbor) return response.body.cbor;
+        if (response.cbor) return response.cbor;
         throw new Error('CBOR is null');
       })
       .catch((_error) => {
@@ -54,13 +51,14 @@ export class BlockfrostUtxoProvider extends BlockfrostProvider implements UtxoPr
         addresses.map(async (address) =>
           fetchByAddressSequentially<Cardano.Utxo, Cardano.Utxo>({
             address,
-            request: async (addr: Cardano.PaymentAddress, pagination) => await this.fetchUtxos(addr, pagination)
+            request: async (addr: Cardano.PaymentAddress, pagination: PaginationOptions) =>
+              await this.fetchUtxos(addr, pagination)
           })
         )
       );
       return utxoResults.flat(1);
     } catch (error) {
-      throw blockfrostToProviderError(error);
+      throw this.toProviderError(error);
     }
   }
 }

packages/cardano-services-client/src/UtxoProvider/index.ts

@@ -1 +1,2 @@
+export * from './BlockfrostUtxoProvider';
 export * from './utxoHttpProvider';

packages/cardano-services-client/test/Utxo/BlockfrostUtxoProvider.test.ts

@@ -0,0 +1,83 @@
+import { BlockfrostClient, BlockfrostUtxoProvider } from '../../src';
+import { Cardano } from '@cardano-sdk/core';
+import { Responses } from '@blockfrost/blockfrost-js';
+import { logger } from '@cardano-sdk/util-dev';
+import { mockResponses } from '../AssetInfoProvider/util';
+jest.mock('@blockfrost/blockfrost-js');
+
+const generateUtxoResponseMock = (qty: number) =>
+  [...Array.from({ length: qty }).keys()].map((num) => ({
+    amount: [
+      {
+        quantity: String(50_928_877 + num),
+        unit: 'lovelace'
+      },
+      {
+        quantity: num + 1,
+        unit: 'b01fb3b8c3dd6b3705a5dc8bcd5a70759f70ad5d97a72005caeac3c652657675746f31333237'
+      }
+    ],
+    block: 'b1b23210b9de8f3edef233f21f7d6e1fb93efe124ba126ba924edec3043e75b46',
+    output_index: num,
+    tx_hash: '0f3abbc8fc19c2e61bab6059bf8a466e6e754833a08a62a6c56fe0e78f19d9d5',
+    tx_index: num
+  })) as Responses['address_utxo_content'];
+
+describe('blockfrostUtxoProvider', () => {
+  let request: jest.Mock;
+  let provider: BlockfrostUtxoProvider;
+  let address: Cardano.PaymentAddress;
+
+  beforeEach(async () => {
+    request = jest.fn();
+    const client = { request } as unknown as BlockfrostClient;
+    provider = new BlockfrostUtxoProvider(client, logger);
+    address = Cardano.PaymentAddress(
+      'addr_test1qz2fxv2umyhttkxyxp8x0dlpdt3k6cwng5pxj3jhsydzer3jcu5d8ps7zex2k2xt3uqxgjqnnj83ws8lhrn648jjxtwq2ytjqp'
+    );
+  });
+
+  describe('utxoByAddresses', () => {
+    test('used addresses', async () => {
+      mockResponses(request, [
+        [`addresses/${address.toString()}/utxo?page=1?count=100`, generateUtxoResponseMock(100)],
+        [`addresses/${address.toString()}/utxo?page=2?count=100`, generateUtxoResponseMock(100)],
+        [`addresses/${address.toString()}/utxo?page=3?count=100`, generateUtxoResponseMock(0)]
+      ]);
+      const response = await provider.utxoByAddresses({
+        addresses: [address]
+      });
+
+      expect(response).toBeTruthy();
+      expect(response[0]).toHaveLength(2);
+      expect(response[0][0]).toMatchObject<Cardano.TxIn>({
+        index: 0,
+        txId: Cardano.TransactionId('0f3abbc8fc19c2e61bab6059bf8a466e6e754833a08a62a6c56fe0e78f19d9d5')
+      });
+      expect(response[0][1]).toMatchObject<Cardano.TxOut>({
+        address,
+        value: {
+          assets: new Map([
+            [Cardano.AssetId('b01fb3b8c3dd6b3705a5dc8bcd5a70759f70ad5d97a72005caeac3c652657675746f31333237'), 1n]
+          ]),
+          coins: 50_928_877n
+        }
+      });
+
+      expect(response[1]).toHaveLength(2);
+      expect(response[1][0]).toMatchObject<Cardano.TxIn>({
+        index: 1,
+        txId: Cardano.TransactionId('0f3abbc8fc19c2e61bab6059bf8a466e6e754833a08a62a6c56fe0e78f19d9d5')
+      });
+      expect(response[1][1]).toMatchObject<Cardano.TxOut>({
+        address,
+        value: {
+          assets: new Map([
+            [Cardano.AssetId('b01fb3b8c3dd6b3705a5dc8bcd5a70759f70ad5d97a72005caeac3c652657675746f31333237'), 2n]
+          ]),
+          coins: 50_928_878n
+        }
+      });
+    });
+  });
+});

packages/cardano-services/src/Program/programs/providerServer.ts

@@ -17,6 +17,7 @@ import {
 import {
   BlockfrostAssetProvider,
   BlockfrostNetworkInfoProvider,
+  BlockfrostUtxoProvider,
   CardanoWsClient,
   TxSubmitApiProvider
 } from '@cardano-sdk/cardano-services-client';
@@ -45,7 +46,6 @@ import {
 } from '../../ChainHistory';
 import { BlockfrostRewardsProvider, DbSyncRewardsProvider, RewardsHttpService } from '../../Rewards';
 import { BlockfrostTxSubmitProvider, NodeTxSubmitProvider, TxSubmitHttpService } from '../../TxSubmit';
-import { BlockfrostUtxoProvider, DbSyncUtxoProvider, UtxoHttpService } from '../../Utxo';
 import {
   CommonOptionsDescriptions,
   ConnectionNames,
@@ -63,6 +63,7 @@ import {
   TypeormStakePoolProvider,
   createHttpStakePoolMetadataService
 } from '../../StakePool';
+import { DbSyncUtxoProvider, UtxoHttpService } from '../../Utxo';
 import { DnsResolver, createDnsResolver, getCardanoNode, getDbPools, getGenesisData } from '../utils';
 import { GenesisData } from '../../types';
 import { HandleHttpService, TypeOrmHandleProvider } from '../../Handle';
@@ -298,7 +299,7 @@ const serviceMapFactory = (options: ServiceMapFactoryOptions) => {
 
   const getBlockfrostAssetProvider = () => new BlockfrostAssetProvider(getBlockfrostClient(), logger);
 
-  const getBlockfrostUtxoProvider = () => new BlockfrostUtxoProvider({ blockfrost: getBlockfrostApi(), logger });
+  const getBlockfrostUtxoProvider = () => new BlockfrostUtxoProvider(getBlockfrostClient(), logger);
 
   const getDbSyncUtxoProvider = withDbSyncProvider(
     (dbPools, cardanoNode) =>

packages/cardano-services/src/Utxo/BlockfrostUtxoProvider/index.ts

@@ -1,3 +1,2 @@
-export * from './BlockfrostUtxoProvider';
 export * from './UtxoHttpService';
 export * from './DbSyncUtxoProvider';