feat: browser compatible BlockfrostTxSubmitProvider

Author: rhyslbw

packages/cardano-services/src/TxSubmit/BlockfrostTxSubmitProvider/BlockfrostTxSubmitProvider.ts renamed to packages/cardano-services-client/src/TxSubmitProvider/BlockfrostTxSubmitProvider.ts

@@ -1,14 +1,18 @@
-import { BlockfrostProvider } from '../../util/BlockfrostProvider/BlockfrostProvider';
+import { BlockfrostClient, BlockfrostProvider } from '../blockfrost';
+import { Logger } from 'ts-log';
 import { SubmitTxArgs, TxSubmitProvider } from '@cardano-sdk/core';
-import { blockfrostToProviderError } from '@cardano-sdk/cardano-services-client';
 
 export class BlockfrostTxSubmitProvider extends BlockfrostProvider implements TxSubmitProvider {
+  constructor(client: BlockfrostClient, logger: Logger) {
+    super(client, logger);
+  }
+
   async submitTx({ signedTransaction }: SubmitTxArgs): Promise<void> {
     // @ todo handle context and resolutions
     try {
-      await this.blockfrost.txSubmit(signedTransaction);
+      await this.request<string>('tx/submit', signedTransaction);
     } catch (error) {
-      throw blockfrostToProviderError(error);
+      throw this.toProviderError(error);
     }
   }
 }

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

@@ -1,2 +1,3 @@
+export * from './BlockfrostTxSubmitProvider';
 export * from './TxSubmitApiProvider';
 export * from './txSubmitHttpProvider';

packages/cardano-services-client/test/TxSubmitProvider/BlockfrostTxSubmitProvider.test.ts

@@ -0,0 +1,23 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { BlockfrostClient, BlockfrostTxSubmitProvider } from '../../src';
+import { ProviderError } from '@cardano-sdk/core';
+import { logger } from '@cardano-sdk/util-dev';
+import { mockResponses } from '../AssetInfoProvider/util';
+
+describe('blockfrostTxSubmitProvider', () => {
+  let request: jest.Mock;
+  let provider: BlockfrostTxSubmitProvider;
+
+  beforeEach(async () => {
+    request = jest.fn();
+    const client = { request } as unknown as BlockfrostClient;
+    provider = new BlockfrostTxSubmitProvider(client, logger);
+  });
+
+  describe('submitTx', () => {
+    it('wraps error in UnknownTxSubmissionError', async () => {
+      mockResponses(request, [['tx/submit', new Error('some error')]]);
+      await expect(provider.submitTx({ signedTransaction: null as any })).rejects.toThrowError(ProviderError);
+    });
+  });
+});

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

@@ -19,6 +19,7 @@ import {
   BlockfrostChainHistoryProvider,
   BlockfrostNetworkInfoProvider,
   BlockfrostRewardsProvider,
+  BlockfrostTxSubmitProvider,
   BlockfrostUtxoProvider,
   CardanoWsClient,
   TxSubmitApiProvider
@@ -41,7 +42,6 @@ import {
   StubTokenMetadataService,
   TypeormAssetProvider
 } from '../../Asset';
-import { BlockfrostTxSubmitProvider, NodeTxSubmitProvider, TxSubmitHttpService } from '../../TxSubmit';
 import { ChainHistoryHttpService, DbSyncChainHistoryProvider } from '../../ChainHistory';
 import {
   CommonOptionsDescriptions,
@@ -52,7 +52,7 @@ import {
   handlePolicyIdsFromFile,
   suffixType2Cli
 } from '../options';
-import { DbPools, DbSyncEpochPollService, TypeormProvider, getBlockfrostApi, getBlockfrostClient } from '../../util';
+import { DbPools, DbSyncEpochPollService, TypeormProvider, getBlockfrostClient } from '../../util';
 import { DbSyncNetworkInfoProvider, NetworkInfoHttpService } from '../../NetworkInfo';
 import { DbSyncRewardsProvider, RewardsHttpService } from '../../Rewards';
 import {
@@ -68,6 +68,7 @@ import { HandleHttpService, TypeOrmHandleProvider } from '../../Handle';
 import { HttpServer, HttpServerConfig, HttpService, getListen } from '../../Http';
 import { InMemoryCache, NoCache } from '../../InMemoryCache';
 import { MissingProgramOption, MissingServiceDependency, RunnableDependencies, UnknownServiceName } from '../errors';
+import { NodeTxSubmitProvider, TxSubmitHttpService } from '../../TxSubmit';
 import { ProviderServerArgs, ProviderServerOptionDescriptions, ServiceNames } from './types';
 import { WarmCache } from '../../InMemoryCache/WarmCache';
 import { createDbSyncMetadataService } from '../../Metadata';
@@ -362,8 +363,7 @@ const serviceMapFactory = (options: ServiceMapFactoryOptions) => {
       ),
     ServiceNames.Rewards
   );
-  const getBlockfrostTxSubmitProvider = () =>
-    new BlockfrostTxSubmitProvider({ blockfrost: getBlockfrostApi(), logger });
+  const getBlockfrostTxSubmitProvider = () => new BlockfrostTxSubmitProvider(getBlockfrostClient(), logger);
 
   return {
     [ServiceNames.Asset]: async () =>

packages/cardano-services/src/TxSubmit/BlockfrostTxSubmitProvider/index.ts

@@ -1,3 +1,2 @@
-export * from './BlockfrostTxSubmitProvider';
 export * from './NodeTxSubmitProvider';
 export * from './TxSubmitHttpService';