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

package/src/interfaces/rpcInterfaces/control.ts

@@ -1,62 +1,68 @@
-/* --- Control Commands --- */
-// progress 6/6
-
-export interface GetMemoryInfo {
-  method: 'getmemoryinfo';
-  params: [
-    mode?: 'stats' | 'mallocinfo'
-  ];
-  response: {
-    locked: {
-      used: number;
-      free: number;
-      total: number;
-      locked: number;
-      chunks_used: number;
-      chunks_free: number;
-    };
-  };
-}
-
-export interface GetRpcInfo {
-  method: 'getrpcinfo';
-  params: [];
-  response: {
-    active_commands: {
-      method: string;
-      duration: number;
-    }[];
-    logpath: string;
-  };
-}
-
-export interface Help {
-  method: 'help';
-  params: [
-    command?: string
-  ];
-  response: string;
-}
-
-export interface Logging {
-  method: 'logging';
-  params: [
-    include_category?: string[],
-    exclude_category?: string[]
-  ];
-  response: {
-    [category: string]: boolean;
-  };
-}
-
-export interface Stop {
-  method: 'stop';
-  params: [];
-  response: string;
-}
-
-export interface Uptime {
-  method: 'uptime';
-  params: [];
-  response: number;
-}
+/* --- Control Commands --- */
+// progress 6/6
+
+/** Returns memory usage information. */
+export interface GetMemoryInfo {
+  method: 'getmemoryinfo';
+  params: [
+    mode?: 'stats' | 'mallocinfo'
+  ];
+  response: {
+    locked: {
+      used: number;
+      free: number;
+      total: number;
+      locked: number;
+      chunks_used: number;
+      chunks_free: number;
+    };
+  };
+}
+
+/** Returns details about the RPC server. */
+export interface GetRpcInfo {
+  method: 'getrpcinfo';
+  params: [];
+  response: {
+    active_commands: {
+      method: string;
+      duration: number;
+    }[];
+    logpath: string;
+  };
+}
+
+/** Returns help text for RPC commands. */
+export interface Help {
+  method: 'help';
+  params: [
+    command?: string
+  ];
+  response: string;
+}
+
+/** Gets or sets logging categories. */
+export interface Logging {
+  method: 'logging';
+  params: [
+    include_category?: string[],
+    exclude_category?: string[]
+  ];
+  response: {
+    [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: [];
+  response: number;
+}

package/src/interfaces/rpcInterfaces/generating.ts

@@ -1,21 +1,23 @@
-/* --- Generating Commands --- */
-// progress 2/2
-
-export interface Generate {
-  method: 'generate';
-  params: [
-    nblocks: number,
-    maxtries?: number,
-  ];
-  response: string[];
-}
-
-export interface GenerateToAddress {
-  method: 'generatetoaddress';
-  params: [
-    nblocks: number,
-    address: string,
-    maxtries?: number,
-  ];
-  response: string[];
-}
+/* --- Generating Commands --- */
+// progress 2/2
+
+/** Mines blocks to the wallet (regtest only). */
+export interface Generate {
+  method: 'generate';
+  params: [
+    nblocks: number,
+    maxtries?: number,
+  ];
+  response: string[];
+}
+
+/** Mines blocks to a specified address (regtest only). */
+export interface GenerateToAddress {
+  method: 'generatetoaddress';
+  params: [
+    nblocks: number,
+    address: string,
+    maxtries?: number,
+  ];
+  response: string[];
+}

package/src/interfaces/rpcInterfaces/index.ts

@@ -1,14 +1,14 @@
-// For the full list of commands see the documentation on
-// https://docs.bitcoincashnode.org/doc/json-rpc/
-
-// Total progress 136/136 (100%)
-
-export * from './blockchain.js';
-export * from './control.js';
-export * from './generating.js';
-export * from './mining.js';
-export * from './network.js';
-export * from './rawtransactions.js';
-export * from './util.js';
-export * from './wallet.js';
+// For the full list of commands see the documentation on
+// https://docs.bitcoincashnode.org/doc/json-rpc/
+
+// Total progress 136/136 (100%)
+
+export * from './blockchain.js';
+export * from './control.js';
+export * from './generating.js';
+export * from './mining.js';
+export * from './network.js';
+export * from './rawtransactions.js';
+export * from './util.js';
+export * from './wallet.js';
 export * from './zmq.js'

package/src/interfaces/rpcInterfaces/mining.ts

@@ -1,143 +1,151 @@
-/* --- Mining Commands --- */
-// progress 9/9
-
-export interface GetBlockTemplate {
-  method: 'getblocktemplate';
-  params: {
-    mode?: 'template' | 'proposal';
-    capabilities?: ('longpoll' | 'coinbasetxn' | 'coinbasevalue' | 'proposal' | 'serverlist' | 'workid')[];
-    longpollid?: string;
-    checkvalidity?: boolean;
-    ignorecache?: boolean;
-  };
-  response: {
-    version: number;
-    previousblockhash: string;
-    transactions: {
-      data: string;
-      txid: string;
-      hash: string;
-      depends: number[];
-      fee: number;
-      sigops: number;
-      required: boolean;
-    }[];
-    coinbaseaux: {
-      flags: string;
-    };
-    coinbasevalue: number;
-    coinbasetxn?: object;
-    target: string;
-    mintime: number;
-    mutable: string[];
-    noncerange: string;
-    sigoplimit: number;
-    sizelimit: number;
-    curtime: number;
-    bits: string;
-    height: number;
-  }
-}
-
-export interface GetBlockTemplateLight {
-  method: 'getblocktemplatelight';
-  params: [
-    {
-      mode?: 'template' | 'proposal';
-      capabilities?: ('longpoll' | 'coinbasetxn' | 'coinbasevalue' | 'proposal' | 'serverlist' | 'workid')[];
-      longpollid?: string;
-      checkvalidity?: boolean;
-      ignorecache?: boolean;
-    },
-    additional_txs?: string[]
-  ];
-  response: {
-    version: number;
-    previousblockhash: string;
-    job_id: string;
-    merkle: string[];
-    coinbaseaux: {
-      flags: string;
-    };
-    coinbasevalue: number;
-    coinbasetxn: object;
-    target: string;
-    mintime: number;
-    mutable: string[];
-    noncerange: string;
-    sigoplimit: number;
-    sizelimit: number;
-    curtime: number;
-    bits: string;
-    height: number;
-  };
-}
-
-
-export interface GetMiningInfo {
-  method: 'getmininginfo';
-  params: [];
-  response: {
-    blocks: number;
-    currentblocksize: number;
-    currentblocktx: number;
-    difficulty: number;
-    networkhashps: number;
-    miningblocksizelimit: number;
-    pooledtx: number;
-    chain: string;
-    warnings: string;
-  }
-}
-
-export interface GetNetworkHashps {
-  method: 'getnetworkhashps';
-  params: [
-    nblocks?: number,
-    height?: number
-  ];
-  response: number
-}
-
-export interface PrioritiseTransaction {
-  method: 'prioritisetransaction';
-  params: [
-    txid: string,
-    fee_delta: number
-  ];
-  response: true
-}
-
-export interface SubmitBlock {
-  method: 'submitblock';
-  params: [
-    hexdata: string,
-    dummy?: string
-  ];
-  response: {}
-}
-
-export interface SubmitBlockLight {
-  method: 'submitblocklight';
-  params: [
-    hexdata: string,
-    job_id: string
-  ];
-  response: {}
-}
-
-export interface SubmitHeader {
-  method: 'submitheader';
-  params: [
-    hexdata: string
-  ];
-  response: {}
-}
-
-export interface ValidateBlockTemplate {
-  method: 'validateblocktemplate';
-  params: [
-    hexdata: string
-  ];
-  response: true
-}
+/* --- Mining Commands --- */
+// progress 9/9
+
+/** Returns a block template for mining. */
+export interface GetBlockTemplate {
+  method: 'getblocktemplate';
+  params: {
+    mode?: 'template' | 'proposal';
+    capabilities?: ('longpoll' | 'coinbasetxn' | 'coinbasevalue' | 'proposal' | 'serverlist' | 'workid')[];
+    longpollid?: string;
+    checkvalidity?: boolean;
+    ignorecache?: boolean;
+  };
+  response: {
+    version: number;
+    previousblockhash: string;
+    transactions: {
+      data: string;
+      txid: string;
+      hash: string;
+      depends: number[];
+      fee: number;
+      sigops: number;
+      required: boolean;
+    }[];
+    coinbaseaux: {
+      flags: string;
+    };
+    coinbasevalue: number;
+    coinbasetxn?: object;
+    target: string;
+    mintime: number;
+    mutable: string[];
+    noncerange: string;
+    sigoplimit: number;
+    sizelimit: number;
+    curtime: number;
+    bits: string;
+    height: number;
+  }
+}
+
+/** Returns a lightweight block template (for mining pools). */
+export interface GetBlockTemplateLight {
+  method: 'getblocktemplatelight';
+  params: [
+    {
+      mode?: 'template' | 'proposal';
+      capabilities?: ('longpoll' | 'coinbasetxn' | 'coinbasevalue' | 'proposal' | 'serverlist' | 'workid')[];
+      longpollid?: string;
+      checkvalidity?: boolean;
+      ignorecache?: boolean;
+    },
+    additional_txs?: string[]
+  ];
+  response: {
+    version: number;
+    previousblockhash: string;
+    job_id: string;
+    merkle: string[];
+    coinbaseaux: {
+      flags: string;
+    };
+    coinbasevalue: number;
+    coinbasetxn: object;
+    target: string;
+    mintime: number;
+    mutable: string[];
+    noncerange: string;
+    sigoplimit: number;
+    sizelimit: number;
+    curtime: number;
+    bits: string;
+    height: number;
+  };
+}
+
+/** Returns mining-related information. */
+export interface GetMiningInfo {
+  method: 'getmininginfo';
+  params: [];
+  response: {
+    blocks: number;
+    currentblocksize: number;
+    currentblocktx: number;
+    difficulty: number;
+    networkhashps: number;
+    miningblocksizelimit: number;
+    pooledtx: number;
+    chain: string;
+    warnings: string;
+  }
+}
+
+/** Returns estimated network hash rate. */
+export interface GetNetworkHashps {
+  method: 'getnetworkhashps';
+  params: [
+    nblocks?: number,
+    height?: number
+  ];
+  response: number
+}
+
+/** Modifies a mempool transaction's priority. */
+export interface PrioritiseTransaction {
+  method: 'prioritisetransaction';
+  params: [
+    txid: string,
+    fee_delta: number
+  ];
+  response: true
+}
+
+/** Submits a mined block to the network. */
+export interface SubmitBlock {
+  method: 'submitblock';
+  params: [
+    hexdata: string,
+    dummy?: string
+  ];
+  response: {}
+}
+
+/** Submits a lightweight block (for mining pools). */
+export interface SubmitBlockLight {
+  method: 'submitblocklight';
+  params: [
+    hexdata: string,
+    job_id: string
+  ];
+  response: {}
+}
+
+/** Submits a block header for validation. */
+export interface SubmitHeader {
+  method: 'submitheader';
+  params: [
+    hexdata: string
+  ];
+  response: {}
+}
+
+/** Validates a block template without mining. */
+export interface ValidateBlockTemplate {
+  method: 'validateblocktemplate';
+  params: [
+    hexdata: string
+  ];
+  response: true
+}