@bsv/sdk 1.3.12 → 1.3.13

package/src/transaction/broadcasters/__tests/ARC.test.ts

@@ -1,18 +1,20 @@
-import ARC from '../../../../dist/cjs/src/transaction/broadcasters/ARC.js'
-import Transaction from '../../../../dist/cjs/src/transaction/Transaction.js'
-import {NodejsHttpClient} from "../../../../dist/cjs/src/transaction/http/NodejsHttpClient.js";
-import {FetchHttpClient} from "../../../../dist/cjs/src/transaction/http/FetchHttpClient.js";
-import {HttpClientRequestOptions} from "../../http";
+import ARC from '../../../transaction/broadcasters/ARC'
+import Transaction from '../../../transaction/Transaction'
+import { NodejsHttpClient } from '../../../transaction/http/NodejsHttpClient'
+import { FetchHttpClient } from '../../../transaction/http/FetchHttpClient'
+import { HttpClientRequestOptions } from '../../http'
 
 // Mock Transaction
-jest.mock('../../Transaction', () => {
-  return {
-    default: jest.fn().mockImplementation(() => {
-      return {
-        toHex: () => 'mocked_transaction_hex'
-      }
-    })
+jest.mock('../../../transaction/Transaction', () => {
+  class MockTransaction {
+    toHex() {
+      return 'mocked_transaction_hex'
+    }
+    toHexEF() {
+      return 'mocked_transaction_hexEF'
+    }
   }
+  return { __esModule: true, default: MockTransaction }
 })
 
 describe('ARC Broadcaster', () => {
@@ -35,7 +37,7 @@ describe('ARC Broadcaster', () => {
   it('should broadcast successfully using window.fetch', async () => {
     // Mocking window.fetch
     const mockFetch = mockedFetch(successResponse)
-    global.window = {fetch: mockFetch} as any
+    global.window = { fetch: mockFetch } as any
 
     const broadcaster = new ARC(URL)
     const response = await broadcaster.broadcast(transaction)
@@ -64,10 +66,11 @@ describe('ARC Broadcaster', () => {
   })
 
   it('should broadcast successfully using provided fetch', async () => {
-
     const mockFetch = mockedFetch(successResponse)
 
-    const broadcaster = new ARC(URL, {httpClient: new FetchHttpClient(mockFetch)})
+    const broadcaster = new ARC(URL, {
+      httpClient: new FetchHttpClient(mockFetch)
+    })
     const response = await broadcaster.broadcast(transaction)
 
     expect(mockFetch).toHaveBeenCalled()
@@ -79,9 +82,10 @@ describe('ARC Broadcaster', () => {
   })
 
   it('should broadcast successfully using provided https', async () => {
-
     const mockHttps = mockedHttps(successResponse)
-    const broadcaster = new ARC(URL, {httpClient: new NodejsHttpClient(mockHttps)})
+    const broadcaster = new ARC(URL, {
+      httpClient: new NodejsHttpClient(mockHttps)
+    })
 
     const response = await broadcaster.broadcast(transaction)
 
@@ -95,10 +99,13 @@ describe('ARC Broadcaster', () => {
   it('should send default request headers when broadcasting', async () => {
     const mockFetch = mockedFetch(successResponse)
 
-    const broadcaster = new ARC(URL, {httpClient: new FetchHttpClient(mockFetch)})
+    const broadcaster = new ARC(URL, {
+      httpClient: new FetchHttpClient(mockFetch)
+    })
     await broadcaster.broadcast(transaction)
 
-    const {headers} = (mockFetch as jest.Mock).mock.calls[0][1] as HttpClientRequestOptions
+    const { headers } = (mockFetch as jest.Mock).mock
+      .calls[0][1] as HttpClientRequestOptions
 
     expect(headers['Content-Type']).toEqual('application/json')
     expect(headers['XDeployment-ID']).toBeDefined()
@@ -110,10 +117,14 @@ describe('ARC Broadcaster', () => {
     const mockFetch = mockedFetch(successResponse)
     const apiKey = 'mainnet_1234567890'
 
-    const broadcaster = new ARC(URL, {apiKey, httpClient: new FetchHttpClient(mockFetch)})
+    const broadcaster = new ARC(URL, {
+      apiKey,
+      httpClient: new FetchHttpClient(mockFetch)
+    })
     await broadcaster.broadcast(transaction)
 
-    const {headers} = (mockFetch as jest.Mock).mock.calls[0][1] as HttpClientRequestOptions
+    const { headers } = (mockFetch as jest.Mock).mock
+      .calls[0][1] as HttpClientRequestOptions
 
     expect(headers['XDeployment-ID']).toBeDefined()
     expect(headers['XDeployment-ID']).toMatch(/ts-sdk-.*/)
@@ -122,36 +133,42 @@ describe('ARC Broadcaster', () => {
 
   it('should handle api key as second argument', async () => {
     const mockFetch = mockedFetch(successResponse)
-    global.window = {fetch: mockFetch} as any
+    global.window = { fetch: mockFetch } as any
 
     const apiKey = 'mainnet_1234567890'
 
     const broadcaster = new ARC(URL, apiKey)
     await broadcaster.broadcast(transaction)
 
-    const {headers} = (mockFetch as jest.Mock).mock.calls[0][1] as HttpClientRequestOptions
+    const { headers } = (mockFetch as jest.Mock).mock
+      .calls[0][1] as HttpClientRequestOptions
 
     expect(headers['Authorization']).toEqual(`Bearer ${apiKey}`)
   })
 
-
   it('should send provided deployment id', async () => {
     const mockFetch = mockedFetch(successResponse)
     const deploymentId = 'custom_deployment_id'
 
-    const broadcaster = new ARC(URL, {deploymentId, httpClient: new FetchHttpClient(mockFetch)})
+    const broadcaster = new ARC(URL, {
+      deploymentId,
+      httpClient: new FetchHttpClient(mockFetch)
+    })
     await broadcaster.broadcast(transaction)
 
-    const {headers} = (mockFetch as jest.Mock).mock.calls[0][1] as HttpClientRequestOptions
+    const { headers } = (mockFetch as jest.Mock).mock
+      .calls[0][1] as HttpClientRequestOptions
 
     expect(headers['XDeployment-ID']).toEqual(deploymentId)
   })
 
   it('should handle network errors', async () => {
     const mockFetch = jest.fn().mockRejectedValue(new Error('Network error'))
-    global.window = {fetch: mockFetch} as any
+    global.window = { fetch: mockFetch } as any
 
-    const broadcaster = new ARC(URL, {httpClient: new FetchHttpClient(mockFetch)})
+    const broadcaster = new ARC(URL, {
+      httpClient: new FetchHttpClient(mockFetch)
+    })
     const response = await broadcaster.broadcast(transaction)
 
     expect(mockFetch).toHaveBeenCalled()
@@ -170,7 +187,9 @@ describe('ARC Broadcaster', () => {
       })
     })
 
-    const broadcaster = new ARC(URL, {httpClient: new FetchHttpClient(mockFetch)})
+    const broadcaster = new ARC(URL, {
+      httpClient: new FetchHttpClient(mockFetch)
+    })
     const response = await broadcaster.broadcast(transaction)
 
     expect(mockFetch).toHaveBeenCalled()
@@ -185,15 +204,7 @@ describe('ARC Broadcaster', () => {
   })
 
   it('handles error 460', async () => {
-    // Model the actual response format received from...
-    const apiKey: string = '...'
-    if (apiKey !== '...') {
-      const URL = 'https://arc.taal.com'
-      const arc = new ARC(URL, apiKey)
-      const response = await arc.broadcast(transaction)
-      expect(response.more).toBeTruthy()
-    }
-
+    // Mock the fetch response to simulate the error 460 response
     const mockFetch = mockedFetch({
       status: 460,
       data: {
@@ -203,12 +214,33 @@ describe('ARC Broadcaster', () => {
       }
     })
 
-    const broadcaster = new ARC(URL, {httpClient: new FetchHttpClient(mockFetch)})
+    // Initialize the ARC broadcaster with the mocked fetch client
+    const URL = 'https://arc.taal.com'
+    const apiKey = 'mock_api_key' // Example API key
+    const broadcaster = new ARC(URL, {
+      apiKey,
+      httpClient: new FetchHttpClient(mockFetch)
+    })
+
+    // Simulate broadcasting the transaction
     const response = await broadcaster.broadcast(transaction)
-    expect(response.status).toBe('error')
-    expect(response.code).toBe('460')
-    expect(response.description).toBe('Transaction is not in extended format, missing input scripts')
-    expect(response.txid).toBe('d21633ba23f70118185227be58a63527675641ad37967e2aa461559f577aec43')
+
+    // Check if the response is an error as expected
+    if (response.status === 'error') {
+      // Validate the BroadcastFailure response properties
+      expect(response.status).toBe('error')
+      expect(response.code).toBe('460')
+      expect(response.description).toBe(
+        'Transaction is not in extended format, missing input scripts'
+      )
+      expect(response.txid).toBe(
+        'd21633ba23f70118185227be58a63527675641ad37967e2aa461559f577aec43'
+      )
+      expect(response.more).toBeTruthy() // Validate the presence of additional error details
+    } else {
+      // Fail the test if the response is not an error
+      fail('Expected a BroadcastFailure but got a BroadcastResponse')
+    }
   })
 
   function mockedFetch(response) {
@@ -224,7 +256,7 @@ describe('ARC Broadcaster', () => {
         }
       },
       json: async () => response.data
-    });
+    })
   }
 
   function mockedHttps(response) {
@@ -252,4 +284,4 @@ describe('ARC Broadcaster', () => {
     jest.mock('https', () => https)
     return https
   }
-})
+})

package/src/transaction/broadcasters/__tests/WhatsOnChainBroadcaster.test.ts

@@ -1,17 +1,19 @@
-import Transaction from '../../../../dist/cjs/src/transaction/Transaction.js'
-import { NodejsHttpClient } from '../../../../dist/cjs/src/transaction/http/NodejsHttpClient.js'
-import WhatsOnChainBroadcaster from '../../../../dist/cjs/src/transaction/broadcasters/WhatsOnChainBroadcaster.js'
-import { FetchHttpClient } from '../../../../dist/cjs/src/transaction/http/FetchHttpClient.js'
+import Transaction from '../../../transaction/Transaction'
+import { NodejsHttpClient } from '../../../transaction/http/NodejsHttpClient'
+import WhatsOnChainBroadcaster from '../../../transaction/broadcasters/WhatsOnChainBroadcaster'
+import { FetchHttpClient } from '../../../transaction/http/FetchHttpClient'
 
 // Mock Transaction
-jest.mock('../../Transaction', () => {
-  return {
-    default: jest.fn().mockImplementation(() => {
-      return {
-        toHex: () => 'mocked_transaction_hex'
-      }
-    })
+jest.mock('../../../transaction/Transaction', () => {
+  class MockTransaction {
+    toHex() {
+      return 'mocked_transaction_hex'
+    }
+    toHexEF() {
+      return 'mocked_transaction_hexEF'
+    }
   }
+  return { __esModule: true, default: MockTransaction }
 })
 
 describe('WhatsOnChainBroadcaster', () => {
@@ -47,7 +49,7 @@ describe('WhatsOnChainBroadcaster', () => {
     // Mocking Node.js https module
     mockedHttps(successResponse)
     global.window = {} as any
-    
+
     const broadcaster = new WhatsOnChainBroadcaster(network)
     const response = await broadcaster.broadcast(transaction)
 
@@ -61,7 +63,10 @@ describe('WhatsOnChainBroadcaster', () => {
   it('should broadcast successfully using provided fetch', async () => {
     const mockFetch = mockedFetch(successResponse)
 
-    const broadcaster = new WhatsOnChainBroadcaster(network, new FetchHttpClient(mockFetch))
+    const broadcaster = new WhatsOnChainBroadcaster(
+      network,
+      new FetchHttpClient(mockFetch)
+    )
     const response = await broadcaster.broadcast(transaction)
 
     expect(mockFetch).toHaveBeenCalled()
@@ -74,7 +79,10 @@ describe('WhatsOnChainBroadcaster', () => {
 
   it('should broadcast successfully using provided https', async () => {
     const mockHttps = mockedHttps(successResponse)
-    const broadcaster = new WhatsOnChainBroadcaster(network, new NodejsHttpClient(mockHttps))
+    const broadcaster = new WhatsOnChainBroadcaster(
+      network,
+      new NodejsHttpClient(mockHttps)
+    )
 
     const response = await broadcaster.broadcast(transaction)
 
@@ -118,13 +126,13 @@ describe('WhatsOnChainBroadcaster', () => {
     })
   })
 
-  function mockedFetch (response) {
+  function mockedFetch(response) {
     return jest.fn().mockResolvedValue({
       ok: response.status === 200,
       status: response.status,
       statusText: response.status === 200 ? 'OK' : 'Bad request',
       headers: {
-        get (key: string) {
+        get(key: string) {
           if (key === 'Content-Type') {
             return 'text/plain'
           }
@@ -134,7 +142,7 @@ describe('WhatsOnChainBroadcaster', () => {
     })
   }
 
-  function mockedHttps (response) {
+  function mockedHttps(response) {
     const https = {
       request: (url, options, callback) => {
         // eslint-disable-next-line

package/src/transaction/broadcasters/index.ts

@@ -1,4 +1,4 @@
-export { default as ARC } from './ARC.js'
-export type { ArcConfig } from './ARC.js'
-export { default as WhatsOnChainBroadcaster } from './WhatsOnChainBroadcaster.js'
-export { defaultBroadcaster } from './DefaultBroadcaster.js'
+export { default as ARC } from "./ARC";
+export type { ArcConfig } from "./ARC";
+export { default as WhatsOnChainBroadcaster } from "./WhatsOnChainBroadcaster";
+export { defaultBroadcaster } from "./DefaultBroadcaster";

package/src/transaction/chaintrackers/DefaultChainTracker.ts

@@ -1,6 +1,6 @@
-import WhatsOnChain from './WhatsOnChain.js'
-import ChainTracker from '../ChainTracker.js'
+import WhatsOnChain from "./WhatsOnChain";
+import ChainTracker from "../ChainTracker";
 
-export function defaultChainTracker (): ChainTracker {
-  return new WhatsOnChain()
+export function defaultChainTracker(): ChainTracker {
+  return new WhatsOnChain();
 }

package/src/transaction/chaintrackers/WhatsOnChain.ts

@@ -1,27 +1,27 @@
-import ChainTracker from '../ChainTracker.js'
-import { HttpClient } from '../http/HttpClient.js'
-import { defaultHttpClient } from '../http/DefaultHttpClient.js'
+import ChainTracker from "../ChainTracker";
+import { HttpClient } from "../http/HttpClient";
+import { defaultHttpClient } from "../http/DefaultHttpClient";
 
 /** Configuration options for the WhatsOnChain ChainTracker. */
 export interface WhatsOnChainConfig {
   /** Authentication token for the WhatsOnChain API */
-  apiKey?: string
+  apiKey?: string;
   /** The HTTP client used to make requests to the API. */
-  httpClient?: HttpClient
+  httpClient?: HttpClient;
 }
 
 interface WhatsOnChainBlockHeader {
-  merkleroot: string
+  merkleroot: string;
 }
 
 /**
  * Represents a chain tracker based on What's On Chain .
  */
 export default class WhatsOnChain implements ChainTracker {
-  readonly network: string
-  readonly apiKey: string
-  private readonly URL: string
-  private readonly httpClient: HttpClient
+  readonly network: string;
+  readonly apiKey: string;
+  private readonly URL: string;
+  private readonly httpClient: HttpClient;
 
   /**
    * Constructs an instance of the WhatsOnChain ChainTracker.
@@ -29,58 +29,73 @@ export default class WhatsOnChain implements ChainTracker {
    * @param {'main' | 'test' | 'stn'} network - The BSV network to use when calling the WhatsOnChain API.
    * @param {WhatsOnChainConfig} config - Configuration options for the WhatsOnChain ChainTracker.
    */
-  constructor (network: 'main' | 'test' | 'stn' = 'main', config: WhatsOnChainConfig = {}) {
-    const { apiKey, httpClient } = config
-    this.network = network
-    this.URL = `https://api.whatsonchain.com/v1/bsv/${network}`
-    this.httpClient = httpClient ?? defaultHttpClient()
-    this.apiKey = apiKey
+  constructor(
+    network: "main" | "test" | "stn" = "main",
+    config: WhatsOnChainConfig = {}
+  ) {
+    const { apiKey, httpClient } = config;
+    this.network = network;
+    this.URL = `https://api.whatsonchain.com/v1/bsv/${network}`;
+    this.httpClient = httpClient ?? defaultHttpClient();
+    this.apiKey = apiKey;
   }
 
-  async isValidRootForHeight (root: string, height: number): Promise<boolean> {
+  async isValidRootForHeight(root: string, height: number): Promise<boolean> {
     const requestOptions = {
-      method: 'GET',
-      headers: this.getHttpHeaders()
-    }
+      method: "GET",
+      headers: this.getHttpHeaders(),
+    };
 
-    const response = await this.httpClient.request<WhatsOnChainBlockHeader>(`${this.URL}/block/${height}/header`, requestOptions)
+    const response = await this.httpClient.request<WhatsOnChainBlockHeader>(
+      `${this.URL}/block/${height}/header`,
+      requestOptions
+    );
     if (response.ok) {
-      const { merkleroot } = response.data
-      return merkleroot === root
+      const { merkleroot } = response.data;
+      return merkleroot === root;
     } else if (response.status === 404) {
-      return false
+      return false;
     } else {
-      throw new Error(`Failed to verify merkleroot for height ${height} because of an error: ${JSON.stringify(response.data)} `)
+      throw new Error(
+        `Failed to verify merkleroot for height ${height} because of an error: ${JSON.stringify(response.data)} `
+      );
     }
   }
 
-  async currentHeight (): Promise<number> {
+  async currentHeight(): Promise<number> {
     try {
       const requestOptions = {
-        method: 'GET',
-        headers: this.getHttpHeaders()
-      }
+        method: "GET",
+        headers: this.getHttpHeaders(),
+      };
 
-      const response = await this.httpClient.request<{ height: number }>(`${this.URL}/block/headers`, requestOptions)
+      const response = await this.httpClient.request<{ height: number }>(
+        `${this.URL}/block/headers`,
+        requestOptions
+      );
       if (response.ok) {
-        return response.data[0].height
+        return response.data[0].height;
       } else {
-        throw new Error(`Failed to get current height because of an error: ${JSON.stringify(response.data)} `)
+        throw new Error(
+          `Failed to get current height because of an error: ${JSON.stringify(response.data)} `
+        );
       }
     } catch (error) {
-      throw new Error(`Failed to get current height because of an error: ${error?.message}`)
+      throw new Error(
+        `Failed to get current height because of an error: ${error?.message}`
+      );
     }
   }
 
-  private getHttpHeaders () {
+  private getHttpHeaders() {
     const headers: Record<string, string> = {
-      Accept: 'application/json'
-    }
+      Accept: "application/json",
+    };
 
     if (this.apiKey) {
-      headers.Authorization = this.apiKey
+      headers.Authorization = this.apiKey;
     }
 
-    return headers
+    return headers;
   }
 }