@mr-zwets/bchn-api-wrapper 1.0.1 → 1.0.2

package/dist/interfaces/rpcInterfaces/wallet.d.ts

@@ -1,4 +1,5 @@
 import type { TokenData } from "../interfaces.js";
+/** Marks an in-wallet transaction as abandoned (only works on unconfirmed tx). */
 export interface AbandonTransaction {
     method: 'abandontransaction';
     params: [
@@ -6,11 +7,13 @@ export interface AbandonTransaction {
     ];
     response: null;
 }
+/** Stops current wallet rescan. */
 export interface AbortRescan {
     method: 'abortrescan';
     params: [];
     response: null;
 }
+/** Adds a multisig address to the wallet. */
 export interface AddMultisigAddress {
     method: 'addmultisigaddress';
     params: [
@@ -23,6 +26,7 @@ export interface AddMultisigAddress {
         redeemScript: string;
     };
 }
+/** Backs up wallet to specified file. */
 export interface BackupWallet {
     method: 'backupwallet';
     params: [
@@ -30,6 +34,7 @@ export interface BackupWallet {
     ];
     response: null;
 }
+/** Creates a new wallet. */
 export interface CreateWallet {
     method: 'createwallet';
     params: [
@@ -42,6 +47,7 @@ export interface CreateWallet {
         warning?: string;
     };
 }
+/** Dumps all wallet keys to a file. */
 export interface DumpWallet {
     method: 'dumpwallet';
     params: [
@@ -51,6 +57,7 @@ export interface DumpWallet {
         filename: string;
     };
 }
+/** Returns private key for an address. */
 export interface DumpPrivKey {
     method: 'dumpprivkey';
     params: [
@@ -58,6 +65,7 @@ export interface DumpPrivKey {
     ];
     response: string;
 }
+/** Encrypts wallet with passphrase (requires restart). */
 export interface EncryptWallet {
     method: 'encryptwallet';
     params: [
@@ -65,6 +73,7 @@ export interface EncryptWallet {
     ];
     response: string;
 }
+/** Returns addresses assigned to a label. */
 export interface GetAddressesByLabel {
     method: 'getaddressesbylabel';
     params: [
@@ -76,6 +85,7 @@ export interface GetAddressesByLabel {
         };
     };
 }
+/** Returns detailed information about an address. */
 export interface GetAddressInfo {
     method: 'getaddressinfo';
     params: [string];
@@ -104,6 +114,7 @@ export interface GetAddressInfo {
         }[];
     };
 }
+/** Returns wallet balance. */
 export interface GetBalance {
     method: 'getbalance';
     params: [
@@ -113,6 +124,7 @@ export interface GetBalance {
     ];
     response: number;
 }
+/** Generates a new address for receiving payments. */
 export interface GetNewAddress {
     method: 'getnewaddress';
     params: [
@@ -120,11 +132,13 @@ export interface GetNewAddress {
     ];
     response: string;
 }
+/** Returns a new address for receiving change. */
 export interface GetRawChangeAddress {
     method: 'getrawchangeaddress';
     params: [];
     response: string;
 }
+/** Returns total amount received by an address. */
 export interface GetReceivedByAddress {
     method: 'getreceivedbyaddress';
     params: [
@@ -133,6 +147,7 @@ export interface GetReceivedByAddress {
     ];
     response: number;
 }
+/** Returns total amount received by addresses with a label. */
 export interface GetReceivedByLabel {
     method: 'getreceivedbylabel';
     params: [
@@ -141,6 +156,7 @@ export interface GetReceivedByLabel {
     ];
     response: number;
 }
+/** Returns detailed information about an in-wallet transaction. */
 export interface GetTransaction {
     method: 'gettransaction';
     params: [
@@ -170,11 +186,13 @@ export interface GetTransaction {
         hex: string;
     };
 }
+/** Returns unconfirmed balance. */
 export interface GetUnconfirmedBalance {
     method: 'getunconfirmedbalance';
     params: [];
     response: number;
 }
+/** Returns wallet state info. */
 export interface GetWalletInfo {
     method: 'getwalletinfo';
     params: [];
@@ -195,6 +213,7 @@ export interface GetWalletInfo {
         private_keys_enabled: boolean;
     };
 }
+/** Imports an address or script for watching (without private key). */
 export interface ImportAddress {
     method: 'importaddress';
     params: [
@@ -205,6 +224,7 @@ export interface ImportAddress {
     ];
     response: number;
 }
+/** Imports multiple addresses/scripts/keys. */
 export interface ImportMulti {
     method: 'importmulti';
     params: [
@@ -232,6 +252,7 @@ export interface ImportMulti {
         };
     }[];
 }
+/** Imports a private key. */
 export interface ImportPrivKey {
     method: 'importprivkey';
     params: [
@@ -241,6 +262,7 @@ export interface ImportPrivKey {
     ];
     response: null;
 }
+/** Imports funds without rescan (requires merkle proof). */
 export interface ImportPrunedFunds {
     method: 'importprunedfunds';
     params: [
@@ -249,6 +271,7 @@ export interface ImportPrunedFunds {
     ];
     response: null;
 }
+/** Imports a public key for watching. */
 export interface ImportPubKey {
     method: 'importpubkey';
     params: [
@@ -258,6 +281,7 @@ export interface ImportPubKey {
     ];
     response: null;
 }
+/** Imports keys from a wallet dump file. */
 export interface ImportWallet {
     method: 'importwallet';
     params: [
@@ -265,6 +289,7 @@ export interface ImportWallet {
     ];
     response: null;
 }
+/** Refills the keypool. */
 export interface KeyPoolRefill {
     method: 'keypoolrefill';
     params: [
@@ -272,6 +297,7 @@ export interface KeyPoolRefill {
     ];
     response: null;
 }
+/** Returns addresses grouped by common ownership. */
 export interface ListAddressGroupings {
     method: 'listaddressgroupings';
     params: [];
@@ -285,6 +311,7 @@ export interface ListAddressGroupings {
         ][]
     ];
 }
+/** Returns all labels in the wallet. */
 export interface ListLabels {
     method: 'listlabels';
     params: [
@@ -292,6 +319,7 @@ export interface ListLabels {
     ];
     response: string[];
 }
+/** Returns list of locked unspent outputs. */
 export interface ListLockUnspent {
     method: 'listlockunspent';
     params: [];
@@ -300,6 +328,7 @@ export interface ListLockUnspent {
         vout: number;
     }[];
 }
+/** Lists transactions received by address. */
 export interface ListReceivedByAddress {
     method: 'listreceivedbyaddress';
     params: [
@@ -317,6 +346,7 @@ export interface ListReceivedByAddress {
         txids: string[];
     }[];
 }
+/** Lists transactions received by label. */
 export interface ListReceivedByLabel {
     method: 'listreceivedbylabel';
     params: [
@@ -331,6 +361,7 @@ export interface ListReceivedByLabel {
         label: string;
     }[];
 }
+/** Wallet transaction representation. */
 interface TransactionWallet {
     address?: string;
     category: 'send' | 'receive';
@@ -349,6 +380,7 @@ interface TransactionWallet {
     label?: string;
     to?: string;
 }
+/** Returns transactions since a block. */
 export interface ListSinceBlock {
     method: 'listsinceblock';
     params: [
@@ -363,6 +395,7 @@ export interface ListSinceBlock {
         lastblock: string;
     };
 }
+/** Returns recent transactions for the wallet. */
 export interface ListTransactions {
     method: 'listtransactions';
     params: [
@@ -373,6 +406,7 @@ export interface ListTransactions {
     ];
     response: TransactionWallet[];
 }
+/** Returns unspent outputs in the wallet. */
 export interface ListUnspent {
     method: 'listunspent';
     params: [
@@ -391,6 +425,7 @@ export interface ListUnspent {
     ];
     response: ListUnspentItem[];
 }
+/** Single UTXO from listunspent. */
 export interface ListUnspentItem {
     txid: string;
     vout: number;
@@ -405,6 +440,7 @@ export interface ListUnspentItem {
     solvable: boolean;
     safe: boolean;
 }
+/** Returns list of available wallets. */
 export interface ListWalletDir {
     method: 'listwalletdir';
     params: [];
@@ -414,11 +450,13 @@ export interface ListWalletDir {
         }[];
     };
 }
+/** Returns list of loaded wallets. */
 export interface ListWallets {
     method: 'importaddress';
     params: [];
     response: string[];
 }
+/** Loads a wallet from file. */
 export interface LoadWallet {
     method: 'loadwallet';
     params: [
@@ -429,6 +467,7 @@ export interface LoadWallet {
         warning?: string;
     };
 }
+/** Locks or unlocks unspent outputs. */
 export interface LockUnspent {
     method: 'lockunspent';
     params: [
@@ -440,6 +479,7 @@ export interface LockUnspent {
     ];
     response: boolean;
 }
+/** Removes imported pruned funds from wallet. */
 export interface RemovePrunedFunds {
     method: 'removeprunedfunds';
     params: [
@@ -447,6 +487,7 @@ export interface RemovePrunedFunds {
     ];
     response: null;
 }
+/** Rescans blockchain for wallet transactions. */
 export interface RescanBlockchain {
     method: 'rescanblockchain';
     params: [
@@ -458,6 +499,7 @@ export interface RescanBlockchain {
         stop_height: number;
     };
 }
+/** Sends to multiple recipients. */
 export interface SendMany {
     method: 'sendmany';
     params: [
@@ -473,6 +515,7 @@ export interface SendMany {
     ];
     response: string;
 }
+/** Sends to a single address. */
 export interface SendToAddress {
     method: 'sendtoaddress';
     params: [
@@ -486,6 +529,7 @@ export interface SendToAddress {
     ];
     response: string;
 }
+/** Sets the HD seed for the wallet. */
 export interface SetHdSeed {
     method: 'sethdseed';
     params: [
@@ -494,6 +538,7 @@ export interface SetHdSeed {
     ];
     response: null;
 }
+/** Sets the label for an address. */
 export interface SetLabel {
     method: 'setlabel';
     params: [
@@ -502,6 +547,7 @@ export interface SetLabel {
     ];
     response: null;
 }
+/** Sets the transaction fee per kB. */
 export interface SetTxFee {
     method: 'settxfee';
     params: [
@@ -509,6 +555,7 @@ export interface SetTxFee {
     ];
     response: boolean;
 }
+/** Signs a message with an address's private key. */
 export interface SignMessage {
     method: 'signmessage';
     params: [
@@ -517,6 +564,7 @@ export interface SignMessage {
     ];
     response: string;
 }
+/** Signs a raw transaction with wallet keys. */
 export interface SignRawTransactionWithWallet {
     method: 'signrawtransactionwithwallet';
     params: [
@@ -543,6 +591,7 @@ export interface SignRawTransactionWithWallet {
         }[];
     };
 }
+/** Unloads a wallet. */
 export interface UnloadWallet {
     method: 'unloadwallet';
     params: [
@@ -550,6 +599,7 @@ export interface UnloadWallet {
     ];
     response: null;
 }
+/** Creates and funds a PSBT. */
 export interface WalletCreateFundedPsbt {
     method: 'walletcreatefundedpsbt';
     params: [
@@ -583,11 +633,13 @@ export interface WalletCreateFundedPsbt {
         changepos: number;
     };
 }
+/** Locks the encrypted wallet. */
 export interface WalletLock {
     method: 'walletlock';
     params: [];
     response: null;
 }
+/** Unlocks the wallet for a specified time. */
 export interface WalletPassphrase {
     method: 'walletpassphrase';
     params: [
@@ -596,6 +648,7 @@ export interface WalletPassphrase {
     ];
     response: null;
 }
+/** Changes the wallet passphrase. */
 export interface WalletPassphraseChange {
     method: 'walletpassphrasechange';
     params: [
@@ -604,6 +657,7 @@ export interface WalletPassphraseChange {
     ];
     response: null;
 }
+/** Processes a PSBT with wallet data. */
 export interface WalletProcessPsbt {
     method: 'walletprocesspsbt';
     params: [

package/dist/interfaces/rpcInterfaces/zmq.d.ts

@@ -1,3 +1,4 @@
+/** Returns active ZMQ notification endpoints. */
 export interface GetZmqNotifications {
     method: 'getzmqnotifications';
     params: [];

package/dist/restClient.d.ts

@@ -1,17 +1,29 @@
 import type { RestClientConfig, formatOptions, ResponseType } from "./interfaces/interfaces.js";
-import type { BlockInfoNoTxDetails, BlockInfoTxDetails, ChainInfo, HeaderInfo, MempoolContent, MempoolInfo, TxDetails, UtxosInfo } from "./interfaces/restInterfaces/interfaces.js";
+import type { BlockInfoNoTxDetails, BlockInfoTxDetails, BlockInfoWithPatterns, ChainInfo, HeaderInfo, MempoolContent, MempoolInfo, TxDetails, TxDetailsWithPatterns, UtxosInfo } from "./interfaces/restInterfaces/interfaces.js";
+/** REST client for read-only BCHN blockchain access via the REST interface. */
 export declare class BchnRestClient {
     private baseUrl;
     private timeoutMs;
     private logger;
     constructor(config: RestClientConfig);
     private fetchFromNode;
+    /** Returns transaction details by txid. */
     getTransaction<TFormat extends formatOptions = 'json'>(txid: string, format?: TFormat): Promise<ResponseType<TFormat, TxDetails>>;
+    /** Returns block data. Use includeTxDetails=true for full transaction objects. */
     getBlock<TFormat extends formatOptions = 'json'>(blockhash: string, includeTxDetails: true, format?: TFormat): Promise<TFormat extends 'json' ? BlockInfoTxDetails : string>;
     getBlock<TFormat extends formatOptions = 'json'>(blockhash: string, includeTxDetails: false, format?: TFormat): Promise<TFormat extends 'json' ? BlockInfoNoTxDetails : string>;
+    /** Returns block headers starting from a specific block hash. */
     getBlockHeaders<TFormat extends formatOptions = 'json'>(count: number, blockhash: string, format?: TFormat): Promise<ResponseType<TFormat, HeaderInfo>>;
+    /** Returns current chain state (network, sync progress, best block). */
     getChainInfo(): Promise<ChainInfo>;
+    /** Queries UTXO set for specific outpoints. Outpoints format: "txid-vout". */
     getUTXOs<TFormat extends formatOptions = 'json'>(checkmempool: boolean, outpoints: string[], format?: TFormat): Promise<ResponseType<TFormat, UtxosInfo>>;
+    /** Returns mempool statistics (size, bytes, fee rates). */
     getMempoolInfo(): Promise<MempoolInfo>;
+    /** Returns all transactions currently in the mempool. */
     getMempoolContents(): Promise<MempoolContent>;
+    /** Returns block with bytecode pattern data (v29.0.0+). */
+    getBlockWithPatterns(blockhash: string): Promise<BlockInfoWithPatterns>;
+    /** Returns transaction with bytecode pattern data (v29.0.0+). */
+    getTransactionWithPatterns(txid: string): Promise<TxDetailsWithPatterns>;
 }

package/dist/restClient.js

@@ -8,6 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { validateUrl } from "./utils/utils.js";
+/** REST client for read-only BCHN blockchain access via the REST interface. */
 export class BchnRestClient {
     constructor(config) {
         var _a, _b;
@@ -52,7 +53,7 @@ export class BchnRestClient {
             }
         });
     }
-    // Get transaction details by transaction hash
+    /** Returns transaction details by txid. */
     getTransaction(txid_1) {
         return __awaiter(this, arguments, void 0, function* (txid, format = 'json') {
             return this.fetchFromNode(`tx/${txid}.${format}`, format);
@@ -65,19 +66,19 @@ export class BchnRestClient {
             return this.fetchFromNode(`${path}/${blockhash}.${format}`, format);
         });
     }
-    // Get block headers starting from a specific block hash
+    /** Returns block headers starting from a specific block hash. */
     getBlockHeaders(count_1, blockhash_1) {
         return __awaiter(this, arguments, void 0, function* (count, blockhash, format = 'json') {
             return this.fetchFromNode(`headers/${count}/${blockhash}.${format}`, format);
         });
     }
-    // Get chain info (chain state details)
+    /** Returns current chain state (network, sync progress, best block). */
     getChainInfo() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.fetchFromNode('chaininfo.json', 'json');
         });
     }
-    // Query UTXO set based on specific outpoints (txid and vout)
+    /** Queries UTXO set for specific outpoints. Outpoints format: "txid-vout". */
     getUTXOs(checkmempool_1, outpoints_1) {
         return __awaiter(this, arguments, void 0, function* (checkmempool, outpoints, format = 'json') {
             const path = (checkmempool ? 'checkmempool/' : '') + outpoints.join('/');
@@ -85,16 +86,28 @@ export class BchnRestClient {
             return this.fetchFromNode(endpoint, format);
         });
     }
-    // Get mempool information (basic)
+    /** Returns mempool statistics (size, bytes, fee rates). */
     getMempoolInfo() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.fetchFromNode('mempool/info.json', 'json');
         });
     }
-    // Get mempool contents (transactions currently in the mempool)
+    /** Returns all transactions currently in the mempool. */
     getMempoolContents() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.fetchFromNode('mempool/contents.json', 'json');
         });
     }
+    /** Returns block with bytecode pattern data (v29.0.0+). */
+    getBlockWithPatterns(blockhash) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchFromNode(`block/withpatterns/${blockhash}.json`, 'json');
+        });
+    }
+    /** Returns transaction with bytecode pattern data (v29.0.0+). */
+    getTransactionWithPatterns(txid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchFromNode(`tx/withpatterns/${txid}.json`, 'json');
+        });
+    }
 }

package/dist/rpcClient.d.ts

@@ -1,4 +1,5 @@
 import type { RpcClientConfig, RpcRequest } from "./interfaces/interfaces.js";
+/** RPC client for full BCHN node interaction via JSON-RPC. */
 export declare class BchnRpcClient {
     private url;
     private rpcUser;
@@ -8,5 +9,11 @@ export declare class BchnRpcClient {
     private logger;
     private timeoutMs;
     constructor(config: RpcClientConfig);
+    /**
+     * Sends a typed RPC request to the BCHN node.
+     * @example
+     * const result = await client.request<GetBlockCount>("getblockcount");
+     * const block = await client.request<GetBlockVerbosity1>("getblock", hash, 1);
+     */
     request<T extends RpcRequest>(endpoint: T['method'], ...params: T['params']): Promise<T['response']>;
 }

package/dist/rpcClient.js

@@ -9,6 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { getRandomId, validateAndConstructUrl } from "./utils/utils.js";
 import { RetryLimitExceededError } from "./utils/errors.js";
+/** RPC client for full BCHN node interaction via JSON-RPC. */
 export class BchnRpcClient {
     constructor(config) {
         var _a, _b, _c, _d;
@@ -25,6 +26,12 @@ export class BchnRpcClient {
         this.logger = (_c = config.logger) !== null && _c !== void 0 ? _c : console;
         this.timeoutMs = (_d = config.timeoutMs) !== null && _d !== void 0 ? _d : 5000;
     }
+    /**
+     * Sends a typed RPC request to the BCHN node.
+     * @example
+     * const result = await client.request<GetBlockCount>("getblockcount");
+     * const block = await client.request<GetBlockVerbosity1>("getblock", hash, 1);
+     */
     request(endpoint, ...params) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mr-zwets/bchn-api-wrapper",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "a Typescript wrapper for interacting with the Bitcoin Cash Node (BCHN) API ",
   "type": "module",
   "main": "dist/index.js",
@@ -11,12 +11,10 @@
   },
   "license": "ISC",
   "devDependencies": {
-    "@types/node": "^22.7.7",
-    "cross-env": "^7.0.3",
-    "msw": "^2.5.1",
-    "tsc": "^2.0.4",
-    "typescript": "^5.6.3",
-    "vitest": "^2.1.3"
+    "@types/node": "^24.10.4",
+    "msw": "^2.12.4",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.16"
   },
   "directories": {
     "test": "test"
@@ -36,5 +34,6 @@
   "bugs": {
     "url": "https://github.com/mr-zwets/bchn-api-wrapper/issues"
   },
-  "homepage": "https://github.com/mr-zwets/bchn-api-wrapper#readme"
+  "homepage": "https://github.com/mr-zwets/bchn-api-wrapper#readme",
+  "packageManager": "pnpm@10.12.1"
 }