@did-btcr2/bitcoin 0.3.4 → 0.5.0

package/src/client/rest/transaction.ts

@@ -1,28 +1,31 @@
 import { Bytes } from '@did-btcr2/common';
-import { RawTransactionRest, RestApiCallParams } from '../../types.js';
+import { RawTransactionRest } from '../../types.js';
+import { HttpRequest } from '../http.js';
+import { EsploraProtocol } from './protocol.js';
 
 export class BitcoinTransaction {
-  private api: (params: RestApiCallParams) => Promise<any>;
+  private readonly protocol: EsploraProtocol;
+  private readonly exec: (req: HttpRequest) => Promise<any>;
 
-  constructor(api: (params: RestApiCallParams) => Promise<any>) {
-    this.api = api;
+  constructor(protocol: EsploraProtocol, exec: (req: HttpRequest) => Promise<any>) {
+    this.protocol = protocol;
+    this.exec = exec;
   }
 
   /**
    * Returns the transaction in JSON format.
    * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxid | Esplora GET /tx/:txid } for details.
    * @param {string} txid The transaction id (required).
-   * @returns {GetRawTransaction} A promise resolving to data about a transaction in the form specified by verbosity.
+   * @returns {Promise<RawTransactionRest>} A promise resolving to data about a transaction.
    */
   public async get(txid: string): Promise<RawTransactionRest> {
-    return await this.api({ path: `/tx/${txid}` });
+    return await this.exec(this.protocol.getTx(txid));
   }
 
   /**
-   * Returns the transaction in JSON format.
-   * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxid | Esplora GET /tx/:txid } for details.
+   * Checks if a transaction is confirmed.
    * @param {string} txid The transaction id (required).
-   * @returns {GetRawTransaction} A promise resolving to data about a transaction in the form specified by verbosity.
+   * @returns {Promise<boolean>} True if the transaction is confirmed.
    */
   public async isConfirmed(txid: string): Promise<boolean> {
     const tx = await this.get(txid);
@@ -30,35 +33,32 @@ export class BitcoinTransaction {
   }
 
   /**
-   * Returns the raw transaction in hex or as binary data.
-   * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxidhex | Esplora GET /tx/:txid/hex } and
-   * {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxidraw | Esplora GET /tx/:txid/raw } for details.
+   * Returns the raw transaction as a hex string.
+   * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxidhex | Esplora GET /tx/:txid/hex } for details.
    * @param {string} txid The transaction id (required).
-   * @returns {Promise<RawTransactionRest | string>} A promise resolving to the raw transaction in the specified format.
+   * @returns {Promise<string>} A promise resolving to the raw transaction hex.
    */
   public async getHex(txid: string): Promise<string> {
-    return await this.api({ path: `/tx/${txid}/hex` });
+    return await this.exec(this.protocol.getTxHex(txid));
   }
 
   /**
-   * Returns the raw transaction in hex or as binary data.
-   * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxidhex | Esplora GET /tx/:txid/hex } and
-   * {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxidraw | Esplora GET /tx/:txid/raw } for details.
+   * Returns the raw transaction as binary data.
+   * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxidraw | Esplora GET /tx/:txid/raw } for details.
    * @param {string} txid The transaction id (required).
-   * @returns {Promise<RawTransactionRest | string>} A promise resolving to the raw transaction in the specified format.
+   * @returns {Promise<Bytes>} A promise resolving to the raw transaction bytes.
    */
   public async getRaw(txid: string): Promise<Bytes> {
-    return await this.api({ path: `/tx/${txid}/raw` });
+    return await this.exec(this.protocol.getTxRaw(txid));
   }
 
   /**
-   * Broadcast a raw transaction to the network. The transaction should be provided as hex in the request body. The txid
-   * will be returned on success.
+   * Broadcast a raw transaction to the network.
    * See {@link https://github.com/blockstream/esplora/blob/master/API.md#post-tx | Esplora POST /tx } for details.
    * @param {string} tx The raw transaction in hex format (required).
    * @returns {Promise<string>} The transaction id of the broadcasted transaction.
    */
   public async send(tx: string): Promise<string> {
-    return await this.api({ path: '/tx', method: 'POST', body: tx, headers: { 'Content-Type': 'text/plain' } });
+    return await this.exec(this.protocol.postTx(tx));
   }
-}
+}