@bsv/sdk 1.0.37 → 1.0.39

package/src/transaction/broadcasters/ARC.ts

@@ -9,10 +9,16 @@ import {toHex} from "../../primitives/utils.js";
 export interface ArcConfig {
   /** Authentication token for the ARC API */
   apiKey?: string
-  /** Deployment id used annotating api calls in XDeployment-ID header - this value will be randomly generated if not set */
-  deploymentId?: string
   /** The HTTP client used to make requests to the ARC API. */
   httpClient?: HttpClient
+  /** Deployment id used annotating api calls in XDeployment-ID header - this value will be randomly generated if not set */
+  deploymentId?: string
+  /** notification callback endpoint for proofs and double spend notification */
+  callbackUrl?: string
+  /** default access token for notification callback endpoint. It will be used as a Authorization header for the http callback */
+  callbackToken?: string
+  /** additional headers to be attached to all tx submissions. */
+  headers?: Record<string, string>
 }
 
 
@@ -27,6 +33,9 @@ export default class ARC implements Broadcaster {
   readonly URL: string
   readonly apiKey: string | undefined
   readonly deploymentId: string
+  readonly callbackUrl: string | undefined
+  readonly callbackToken: string | undefined
+  readonly headers: Record<string, string> | undefined
   private readonly httpClient: HttpClient;
 
   /**
@@ -49,11 +58,17 @@ export default class ARC implements Broadcaster {
     if (typeof config === 'string') {
       this.apiKey = config
       this.httpClient = defaultHttpClient()
+      this.deploymentId = defaultDeploymentId()
+      this.callbackToken = undefined
+      this.callbackUrl = undefined
     } else {
-      const {apiKey, deploymentId, httpClient} = config ?? {} as ArcConfig
+      const {apiKey, deploymentId, httpClient, callbackToken, callbackUrl, headers } = config ?? {} as ArcConfig
+      this.apiKey = apiKey
       this.httpClient = httpClient ?? defaultHttpClient()
       this.deploymentId = deploymentId ?? defaultDeploymentId()
-      this.apiKey = apiKey
+      this.callbackToken = callbackToken
+      this.callbackUrl = callbackUrl
+      this.headers = headers
     }
   }
 
@@ -91,11 +106,20 @@ export default class ARC implements Broadcaster {
           message: `${txStatus} ${extraInfo}`
         }
       } else {
-        return {
+        const r: BroadcastFailure = {
           status: 'error',
           code: response.status.toString() ?? 'ERR_UNKNOWN',
-          description: response.data?.detail ?? 'Unknown error'
+          description: 'Unknown error'
+        }
+        if (typeof response.data === 'string') {
+          try {
+            const data = JSON.parse(response.data)
+            if (typeof data.detail === 'string') {
+              r.description = data.detail
+            }
+          } catch {}
         }
+        return r
       }
     } catch (error) {
       return {
@@ -118,6 +142,20 @@ export default class ARC implements Broadcaster {
       headers['Authorization'] = `Bearer ${this.apiKey}`
     }
 
+    if (this.callbackUrl) {
+      headers['X-CallbackUrl'] = this.callbackUrl
+    }
+
+    if (this.callbackToken) {
+      headers['X-CallbackToken'] = this.callbackToken
+    }
+
+    if (!!this.headers) {
+      for (const key in this.headers) {
+        headers[key] = this.headers[key]
+      }
+    }
+
     return headers
   }
 }

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

@@ -165,9 +165,9 @@ describe('ARC Broadcaster', () => {
   it('should handle non-200 responses', async () => {
     const mockFetch = mockedFetch({
       status: '400',
-      data: {
+      data: JSON.stringify({
         detail: 'Bad request'
-      }
+      })
     })
 
     const broadcaster = new ARC(URL, {httpClient: new FetchHttpClient(mockFetch)})
@@ -189,7 +189,7 @@ describe('ARC Broadcaster', () => {
       headers: {
         get(key: string) {
           if (key === 'Content-Type') {
-            return 'application/json'
+            return 'application/json; charset=UTF-8'
           }
         }
       },
@@ -205,7 +205,7 @@ describe('ARC Broadcaster', () => {
           statusCode: response.status,
           statusMessage: response.status == 200 ? 'OK' : 'Bad request',
           headers: {
-            'content-type': 'application/json'
+            'content-type': 'application/json; charset=UTF-8'
           },
           on: (event, handler) => {
             if (event === 'data') handler(JSON.stringify(response.data))

package/src/transaction/http/FetchHttpClient.ts

@@ -38,7 +38,7 @@ export class FetchHttpClient implements HttpClient {
 
     const res = await this.fetch(url, fetchOptions);
     const mediaType = res.headers.get('Content-Type');
-    const data = mediaType === 'application/json' ? await res.json() : await res.text();
+    const data = mediaType.startsWith('application/json') ? await res.json() : await res.text();
 
     return {
       ok: res.ok,

package/src/transaction/http/NodejsHttpClient.ts

@@ -32,7 +32,7 @@ export class NodejsHttpClient implements HttpClient {
         res.on('end', () => {
           const ok = res.statusCode >= 200 && res.statusCode <= 299;
           const mediaType = res.headers['content-type'];
-          const data = body && mediaType === 'application/json' ? JSON.parse(body) : body;
+          const data = body && mediaType.startsWith('application/json') ? JSON.parse(body) : body;
           resolve({
             status: res.statusCode,
             statusText: res.statusMessage,

package/src/transaction/index.ts

@@ -2,5 +2,6 @@ export { default as Transaction } from './Transaction.js'
 export { default as MerklePath } from './MerklePath.js'
 export type { default as TransactionInput } from './TransactionInput.js'
 export type { default as TransactionOutput } from './TransactionOutput.js'
-export type * as Broadcaster from './Broadcaster.js'
+export type { Broadcaster, BroadcastFailure, BroadcastResponse } from './Broadcaster.js'
+export { isBroadcastResponse, isBroadcastFailure } from './Broadcaster.js'
 export type { default as ChainTracker } from './ChainTracker.js'