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

package/dist/src/interfaces/rpcInterfaces/blockchain.js

@@ -0,0 +1,3 @@
+/* --- Blockchain Commands --- */
+// progress 33/33
+export {};

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

@@ -0,0 +1,60 @@
+/** 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/dist/src/interfaces/rpcInterfaces/control.js

@@ -0,0 +1,3 @@
+/* --- Control Commands --- */
+// progress 6/6
+export {};

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

@@ -0,0 +1,19 @@
+/** 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/dist/src/interfaces/rpcInterfaces/generating.js

@@ -0,0 +1,3 @@
+/* --- Generating Commands --- */
+// progress 2/2
+export {};

package/dist/src/interfaces/rpcInterfaces/index.d.ts

@@ -0,0 +1,9 @@
+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/index.ts → dist/src/interfaces/rpcInterfaces/index.js}

@@ -1,14 +1,12 @@
-// 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'
+// 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/dist/src/interfaces/rpcInterfaces/mining.d.ts

@@ -0,0 +1,140 @@
+/** 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;
+}

package/dist/src/interfaces/rpcInterfaces/mining.js

@@ -0,0 +1,3 @@
+/* --- Mining Commands --- */
+// progress 9/9
+export {};

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

@@ -0,0 +1,197 @@
+/** Adds or removes a node from the addnode list. */
+export interface AddNode {
+    method: 'addnode';
+    params: [
+        node: string,
+        command: 'add' | 'remove' | 'onetry'
+    ];
+    response: null;
+}
+/** Clears all banned IPs. */
+export interface ClearBanned {
+    method: 'clearbanned';
+    params: [
+        manual?: boolean,
+        automatic?: boolean
+    ];
+    response: null;
+}
+/** Disconnects a node by address or node ID. */
+export interface DisconnectNode {
+    method: 'disconnectnode';
+    params: [
+        address?: string,
+        nodeid?: number
+    ];
+    response: null;
+}
+/** Returns info about manually added nodes. */
+export interface GetAddedNodeInfo {
+    method: 'getaddednodeinfo';
+    params: [
+        node?: string
+    ];
+    response: {
+        addednode: string;
+        connected: boolean;
+        addresses?: {
+            address: string;
+            connected: string;
+        }[];
+    }[];
+}
+/** 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: [];
+    response: {
+        totalbytesrecv: number;
+        totalbytessent: number;
+        timemillis: number;
+        uploadtarget: {
+            timeframe: number;
+            target: number;
+            target_reached: boolean;
+            serve_historical_blocks: boolean;
+            bytes_left_in_cycle: number;
+            time_left_in_cycle: number;
+        };
+    };
+}
+/** Returns network configuration and status. */
+export interface GetNetworkInfo {
+    method: 'getnetworkinfo';
+    params: [];
+    response: {
+        version: number;
+        subversion: string;
+        protocolversion: number;
+        localservices: string;
+        localrelay: boolean;
+        timeoffset: number;
+        connections: number;
+        connections_in: number;
+        connections_out: number;
+        networkactive: boolean;
+        networks: {
+            name: string;
+            limited: boolean;
+            reachable: boolean;
+            proxy: string;
+            proxy_randomize_credentials: boolean;
+        }[];
+        relayfee: number;
+        excessutxocharge: number;
+        localaddresses: {
+            address: string;
+            port: number;
+            score: number;
+        }[];
+        warnings: string;
+    };
+}
+/** Returns known peer addresses from the address manager. */
+export interface GetNodeAddresses {
+    method: 'getnodeaddresses';
+    params: [
+        count?: number
+    ];
+    response: {
+        time: number;
+        services: number;
+        address: string;
+        port: number;
+    }[];
+}
+/** Returns detailed info about each connected peer. */
+export interface GetPeerInfo {
+    method: 'getpeerinfo';
+    params: [];
+    response: {
+        id: number;
+        addr: string;
+        addrbind: string;
+        addrlocal: string;
+        mapped_as: string;
+        services: string;
+        relaytxes: boolean;
+        lastsend: number;
+        lastrecv: number;
+        bytessent: number;
+        bytesrecv: number;
+        conntime: number;
+        timeoffset: number;
+        pingtime: number;
+        minping: number;
+        pingwait: number;
+        version: number;
+        subver: string;
+        inbound: boolean;
+        addnode: boolean;
+        startingheight: number;
+        banscore: number;
+        synced_headers: number;
+        synced_blocks: number;
+        inflight: number[];
+        addr_processed: number;
+        addr_rate_limited: number;
+        whitelisted: boolean;
+        minfeefilter: number;
+        bip152_hb_to: boolean;
+        bip152_hb_from: boolean;
+        bytessent_per_msg: {
+            [msg: string]: number;
+        };
+        bytesrecv_per_msg: {
+            [msg: string]: number;
+        };
+    }[];
+}
+/** Returns list of banned IPs/subnets. */
+export interface ListBanned {
+    method: 'listbanned';
+    params: [];
+    response: {
+        address: string;
+        banned_until: number;
+        ban_created: number;
+        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: [
+        subnet: string,
+        command: 'add' | 'remove',
+        bantime?: number,
+        absolute?: boolean
+    ];
+    response: null;
+}
+/** Enables or disables all P2P network activity. */
+export interface SetNetworkActive {
+    method: 'setnetworkactive';
+    params: [
+        state: boolean
+    ];
+    response: null;
+}

package/dist/src/interfaces/rpcInterfaces/network.js

@@ -0,0 +1,3 @@
+/* --- Network Commands --- */
+// progress 14/14
+export {};