@mr-zwets/bchn-api-wrapper 1.0.1

package/src/interfaces/rpcInterfaces/control.ts

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

package/src/interfaces/rpcInterfaces/generating.ts

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

package/src/interfaces/rpcInterfaces/index.ts

@@ -0,0 +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';
+export * from './zmq.js'

package/src/interfaces/rpcInterfaces/mining.ts

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

package/src/interfaces/rpcInterfaces/network.ts

@@ -0,0 +1,195 @@
+/* --- Network Commands --- */
+// progress 14/14
+
+export interface AddNode {
+  method: 'addnode';
+  params: [
+    node: string,
+    command: 'add' | 'remove' | 'onetry'
+  ];
+  response: null;
+}
+
+export interface ClearBanned {
+  method: 'clearbanned';
+  params: [
+    manual?: boolean,
+    automatic?: boolean
+  ];
+  response: null;
+}
+
+export interface DisconnectNode {
+  method: 'disconnectnode';
+  params: [
+    address?: string,
+    nodeid?: number
+  ];
+  response: null;
+}
+
+export interface GetAddedNodeInfo {
+  method: 'getaddednodeinfo';
+  params: [
+    node?: string
+  ];
+  response: {
+    addednode: string;
+    connected: boolean;
+    addresses?: {
+      address: string;
+      connected: string;
+    }[];
+  }[];
+}
+
+export interface GetConnectionCount {
+  method: 'getconnectioncount';
+  params: [];
+  response: number
+}
+
+export interface GetExcessiveBlock {
+  method: 'getexcessiveblock';
+  params: [];
+  response: number;
+}
+
+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;
+    };
+  };
+}
+
+export interface GetNetworkInfo {
+  method: 'getnetworkinfo';
+  params: [];
+  response: {
+    version: number;
+    subversion: string;
+    protocolversion: number;
+    localservices: string;
+    localrelay: boolean;
+    timeoffset: number;
+    connections: 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;
+  }
+}
+
+export interface GetNodeAddresses {
+  method: 'getnodeaddresses';
+  params: [
+    count?: number
+  ];
+  response: {
+    time: number;
+    services: number;
+    address: string;
+    port: number;
+  }[];
+}
+
+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;
+    bytessent_per_msg: {
+      [msg: string]: number;
+    };
+    bytesrecv_per_msg: {
+      [msg: string]: number;
+    };
+  }[];
+}
+
+export interface ListBanned {
+  method: 'listbanned';
+  params: [];
+  response: {
+    address: string;
+    banned_until: number;
+    ban_created: number;
+    ban_reason: string;
+  }[];
+}
+
+export interface Ping {
+  method: 'ping';
+  params: [];
+  response: null;
+}
+
+export interface SetBan {
+  method: 'setban';
+  params: [
+    subnet: string,
+    command: 'add' | 'remove',
+    bantime?: number,
+    absolute?: boolean
+  ];
+  response: null;
+}
+
+export interface SetNetworkActive {
+  method: 'setnetworkactive';
+  params: [
+    state: boolean
+  ];
+  response: null;
+}