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

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

@@ -1,3 +1,4 @@
+/** Returns memory usage information. */
 export interface GetMemoryInfo {
     method: 'getmemoryinfo';
     params: [
@@ -14,6 +15,7 @@ export interface GetMemoryInfo {
         };
     };
 }
+/** Returns details about the RPC server. */
 export interface GetRpcInfo {
     method: 'getrpcinfo';
     params: [];
@@ -25,6 +27,7 @@ export interface GetRpcInfo {
         logpath: string;
     };
 }
+/** Returns help text for RPC commands. */
 export interface Help {
     method: 'help';
     params: [
@@ -32,6 +35,7 @@ export interface Help {
     ];
     response: string;
 }
+/** Gets or sets logging categories. */
 export interface Logging {
     method: 'logging';
     params: [
@@ -42,11 +46,13 @@ export interface Logging {
         [category: string]: boolean;
     };
 }
+/** Stops the BCHN server. */
 export interface Stop {
     method: 'stop';
     params: [];
     response: string;
 }
+/** Returns server uptime in seconds. */
 export interface Uptime {
     method: 'uptime';
     params: [];

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

@@ -1,3 +1,4 @@
+/** Mines blocks to the wallet (regtest only). */
 export interface Generate {
     method: 'generate';
     params: [
@@ -6,6 +7,7 @@ export interface Generate {
     ];
     response: string[];
 }
+/** Mines blocks to a specified address (regtest only). */
 export interface GenerateToAddress {
     method: 'generatetoaddress';
     params: [

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

@@ -1,3 +1,4 @@
+/** Returns a block template for mining. */
 export interface GetBlockTemplate {
     method: 'getblocktemplate';
     params: {
@@ -35,6 +36,7 @@ export interface GetBlockTemplate {
         height: number;
     };
 }
+/** Returns a lightweight block template (for mining pools). */
 export interface GetBlockTemplateLight {
     method: 'getblocktemplatelight';
     params: [
@@ -68,6 +70,7 @@ export interface GetBlockTemplateLight {
         height: number;
     };
 }
+/** Returns mining-related information. */
 export interface GetMiningInfo {
     method: 'getmininginfo';
     params: [];
@@ -83,6 +86,7 @@ export interface GetMiningInfo {
         warnings: string;
     };
 }
+/** Returns estimated network hash rate. */
 export interface GetNetworkHashps {
     method: 'getnetworkhashps';
     params: [
@@ -91,6 +95,7 @@ export interface GetNetworkHashps {
     ];
     response: number;
 }
+/** Modifies a mempool transaction's priority. */
 export interface PrioritiseTransaction {
     method: 'prioritisetransaction';
     params: [
@@ -99,6 +104,7 @@ export interface PrioritiseTransaction {
     ];
     response: true;
 }
+/** Submits a mined block to the network. */
 export interface SubmitBlock {
     method: 'submitblock';
     params: [
@@ -107,6 +113,7 @@ export interface SubmitBlock {
     ];
     response: {};
 }
+/** Submits a lightweight block (for mining pools). */
 export interface SubmitBlockLight {
     method: 'submitblocklight';
     params: [
@@ -115,6 +122,7 @@ export interface SubmitBlockLight {
     ];
     response: {};
 }
+/** Submits a block header for validation. */
 export interface SubmitHeader {
     method: 'submitheader';
     params: [
@@ -122,6 +130,7 @@ export interface SubmitHeader {
     ];
     response: {};
 }
+/** Validates a block template without mining. */
 export interface ValidateBlockTemplate {
     method: 'validateblocktemplate';
     params: [

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

@@ -1,3 +1,4 @@
+/** Adds or removes a node from the addnode list. */
 export interface AddNode {
     method: 'addnode';
     params: [
@@ -6,6 +7,7 @@ export interface AddNode {
     ];
     response: null;
 }
+/** Clears all banned IPs. */
 export interface ClearBanned {
     method: 'clearbanned';
     params: [
@@ -14,6 +16,7 @@ export interface ClearBanned {
     ];
     response: null;
 }
+/** Disconnects a node by address or node ID. */
 export interface DisconnectNode {
     method: 'disconnectnode';
     params: [
@@ -22,6 +25,7 @@ export interface DisconnectNode {
     ];
     response: null;
 }
+/** Returns info about manually added nodes. */
 export interface GetAddedNodeInfo {
     method: 'getaddednodeinfo';
     params: [
@@ -36,16 +40,19 @@ export interface GetAddedNodeInfo {
         }[];
     }[];
 }
+/** Returns the number of connections to other nodes. */
 export interface GetConnectionCount {
     method: 'getconnectioncount';
     params: [];
     response: number;
 }
+/** Returns the excessive block size setting. */
 export interface GetExcessiveBlock {
     method: 'getexcessiveblock';
     params: [];
     response: number;
 }
+/** Returns network traffic statistics. */
 export interface GetNetTotals {
     method: 'getnettotals';
     params: [];
@@ -63,6 +70,7 @@ export interface GetNetTotals {
         };
     };
 }
+/** Returns network configuration and status. */
 export interface GetNetworkInfo {
     method: 'getnetworkinfo';
     params: [];
@@ -74,6 +82,8 @@ export interface GetNetworkInfo {
         localrelay: boolean;
         timeoffset: number;
         connections: number;
+        connections_in: number;
+        connections_out: number;
         networkactive: boolean;
         networks: {
             name: string;
@@ -92,6 +102,7 @@ export interface GetNetworkInfo {
         warnings: string;
     };
 }
+/** Returns known peer addresses from the address manager. */
 export interface GetNodeAddresses {
     method: 'getnodeaddresses';
     params: [
@@ -104,6 +115,7 @@ export interface GetNodeAddresses {
         port: number;
     }[];
 }
+/** Returns detailed info about each connected peer. */
 export interface GetPeerInfo {
     method: 'getpeerinfo';
     params: [];
@@ -137,6 +149,8 @@ export interface GetPeerInfo {
         addr_rate_limited: number;
         whitelisted: boolean;
         minfeefilter: number;
+        bip152_hb_to: boolean;
+        bip152_hb_from: boolean;
         bytessent_per_msg: {
             [msg: string]: number;
         };
@@ -145,6 +159,7 @@ export interface GetPeerInfo {
         };
     }[];
 }
+/** Returns list of banned IPs/subnets. */
 export interface ListBanned {
     method: 'listbanned';
     params: [];
@@ -155,11 +170,13 @@ export interface ListBanned {
         ban_reason: string;
     }[];
 }
+/** Pings all connected nodes to measure latency. */
 export interface Ping {
     method: 'ping';
     params: [];
     response: null;
 }
+/** Bans or unbans a node by subnet. */
 export interface SetBan {
     method: 'setban';
     params: [
@@ -170,6 +187,7 @@ export interface SetBan {
     ];
     response: null;
 }
+/** Enables or disables all P2P network activity. */
 export interface SetNetworkActive {
     method: 'setnetworkactive';
     params: [

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

@@ -1,4 +1,5 @@
 import type { TokenData, Transaction, TransactionInput, TransactionOutput } from "../interfaces.js";
+/** Combines multiple PSBTs into one. */
 export interface CombinePsbt {
     method: 'decoderawtransaction';
     params: [
@@ -6,6 +7,7 @@ export interface CombinePsbt {
     ];
     response: string;
 }
+/** Combines multiple raw transactions into one. */
 export interface CombineRawTransaction {
     method: 'combinerawtransaction';
     params: [
@@ -13,6 +15,7 @@ export interface CombineRawTransaction {
     ];
     response: string;
 }
+/** Converts a raw transaction to PSBT format. */
 export interface ConvertToPsbt {
     method: 'converttopsbt';
     params: [
@@ -21,6 +24,7 @@ export interface ConvertToPsbt {
     ];
     response: string;
 }
+/** Creates an unsigned PSBT. */
 export interface CreatePsbt {
     method: 'createpsbt';
     params: [
@@ -41,6 +45,7 @@ export interface CreatePsbt {
     ];
     response: string;
 }
+/** Creates an unsigned raw transaction. */
 export interface CreateRawTransaction {
     method: 'createrawtransaction';
     params: [
@@ -61,6 +66,7 @@ export interface CreateRawTransaction {
     ];
     response: string;
 }
+/** Decodes a PSBT to inspect its contents. */
 export interface DecodePsbt {
     method: 'decodepsbt';
     params: [
@@ -74,6 +80,7 @@ export interface DecodePsbt {
         fee?: number;
     };
 }
+/** PSBT input structure. */
 interface PsbtInput {
     utxo?: {
         amount: number;
@@ -95,21 +102,25 @@ interface PsbtInput {
     };
     unknown?: Record<string, string>;
 }
+/** PSBT output structure. */
 interface PsbtOutput {
     redeem_script?: RedeemScript;
     bip32_derivs?: Bip32Derivation[];
     unknown?: Record<string, string>;
 }
+/** Redeem script in PSBT. */
 interface RedeemScript {
     asm: string;
     hex: string;
     type: string;
 }
+/** BIP32 derivation path info. */
 interface Bip32Derivation {
     pubkey: string;
     master_fingerprint: string;
     path: string;
 }
+/** Decodes a raw transaction hex string. */
 export interface DecodeRawTransaction {
     method: 'decoderawtransaction';
     params: [
@@ -117,6 +128,7 @@ export interface DecodeRawTransaction {
     ];
     response: Transaction;
 }
+/** Decodes a script hex string. */
 export interface DecodeScript {
     method: 'decodescript';
     params: [
@@ -130,6 +142,7 @@ export interface DecodeScript {
         p2sh: string;
     };
 }
+/** Finalizes a PSBT, extracting the raw transaction if complete. */
 export interface FinalizePsbt {
     method: 'finalizepsbt';
     params: [
@@ -142,6 +155,7 @@ export interface FinalizePsbt {
         complete: boolean;
     };
 }
+/** Adds inputs to a raw transaction to meet output value. */
 export interface FundRawTransaction {
     method: 'fundrawtransaction';
     params: [
@@ -170,6 +184,7 @@ interface GetRawTransactionBase {
         blockhash?: string
     ];
 }
+/** Verbosity 0: Returns raw transaction as hex string. */
 export interface GetRawTransactionVerbosity0 extends GetRawTransactionBase {
     params: [
         txid: string,
@@ -178,6 +193,7 @@ export interface GetRawTransactionVerbosity0 extends GetRawTransactionBase {
     ];
     response: string;
 }
+/** Verbosity 1: Returns decoded transaction with basic info. */
 export interface GetRawTransactionVerbosity1 extends GetRawTransactionBase {
     params: [
         txid: string,
@@ -200,6 +216,7 @@ export interface GetRawTransactionVerbosity1 extends GetRawTransactionBase {
         in_active_chain?: boolean;
     };
 }
+/** Verbosity 2: Returns decoded transaction with input values and fee. */
 export interface GetRawTransactionVerbosity2 extends GetRawTransactionBase {
     params: [
         txid: string,
@@ -223,6 +240,7 @@ export interface GetRawTransactionVerbosity2 extends GetRawTransactionBase {
         fee?: number;
     };
 }
+/** Transaction input with previous output value (verbosity 2). */
 interface TransactionInputVerbosity2 extends TransactionInput {
     value?: number;
     scriptPubKey?: {
@@ -233,6 +251,7 @@ interface TransactionInputVerbosity2 extends TransactionInput {
     };
     tokenData?: TokenData;
 }
+/** Broadcasts a signed raw transaction. */
 export interface SendRawTransaction {
     method: 'sendrawtransaction';
     params: [
@@ -241,6 +260,7 @@ export interface SendRawTransaction {
     ];
     response: string;
 }
+/** Signs a raw transaction with provided private keys. */
 export interface SignRawTransactionWithKey {
     method: 'signrawtransactionwithkey';
     params: [
@@ -268,6 +288,7 @@ export interface SignRawTransactionWithKey {
         }[];
     };
 }
+/** Tests if raw transactions would be accepted to mempool. */
 export interface TestMempoolAccept {
     method: 'testmempoolaccept';
     params: [

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

@@ -1,3 +1,4 @@
+/** Creates a multisig address (without adding to wallet). */
 export interface CreateMultisig {
     method: 'createmultisig';
     params: [
@@ -9,11 +10,13 @@ export interface CreateMultisig {
         redeemScript: string;
     };
 }
+/** Returns estimated fee rate in BCH/kB. */
 export interface EstimateFee {
     method: 'estimatefee';
     params: [];
     response: number;
 }
+/** Signs a message with a private key (returns base64 signature). */
 export interface SignMessageWithPrivKey {
     method: 'signmessagewithprivkey';
     params: [
@@ -22,6 +25,7 @@ export interface SignMessageWithPrivKey {
     ];
     response: string;
 }
+/** Validates a Bitcoin Cash address. */
 export interface ValidateAddress {
     method: 'validateaddress';
     params: [string];
@@ -33,6 +37,7 @@ export interface ValidateAddress {
         istokenaware: boolean;
     };
 }
+/** Verifies a signed message. */
 export interface VerifyMessage {
     method: 'verifymessage';
     params: [