gridcat/gridcoin-rpc

JSON RPC gridcoin client running on promises

gridcoin-rpc – Promise based Gridcoin RPC client

TS library for the interactions with gridcoin RPC api

This library is intended to be the simple proxy for those who want to use JS/TS to tinker with Gridcoin RPC library. Library won't do validation by itself, it relies on the RPC validation. It will just help you with a typings.

Installation

npm install gridcoin-rpc

Usage

const { GridcoinRPC } = require('gridcoin-rpc');

const rpc = new GridcoinRPC({
  port: 6553,
  host: '127.0.0.1',
  username: 'username',
  password: 'very-strong-password',
});

async main = () => {
  // Get wallet info
  try {
    const walletInfo = await rpc.getWalletInfo();
    console.log(JSON.stringify(res, null, 2))
  } catch (e) {
    console.log(err.message)
  }
}

main();


// {
//   "walletversion": 60000,
//   "balance": 121.12304127,
//   "newmint": 0,
//   "stake": 0,
//   "keypoololdest": 1508531912,
//   "keypoolsize": 101,
//   "unlocked_until": 0
// }

Documentation

API documentation

Donate

GRC: SJVaQcJriv7N8Py8eWjNUtWPTPBtDZashD

Follow me

keybase

steemit

gridcoin-rpc's Issues

Unable to import due to camelcase-keys

Importing [email protected] from an ESM script fails with this error, but [email protected] works correctly.

/home/benn/code/barney/node_modules/gridcoin-rpc/dist/RPCBase.js:16
const camelcase_keys_1 = __importDefault(require("camelcase-keys"));
                                         ^

Error [ERR_REQUIRE_ESM]: require() of ES Module /home/benn/code/barney/node_modules/camelcase-keys/index.js from /home/benn/code/barney/node_modules/gridcoin-rpc/dist/RPCBase.js not supported.
Instead change the require of index.js in /home/benn/code/barney/node_modules/gridcoin-rpc/dist/RPCBase.js to a dynamic import() which is available in all CommonJS modules.
    at Object.<anonymous> (/home/benn/code/barney/node_modules/gridcoin-rpc/dist/RPCBase.js:16:42)
    at Object.<anonymous> (/home/benn/code/barney/node_modules/gridcoin-rpc/dist/RPC/Developer.js:13:19)
    at Object.<anonymous> (/home/benn/code/barney/node_modules/gridcoin-rpc/dist/GridcoinRPC.js:5:21)
    at async file:///home/benn/code/barney/bin/barney.mjs:7:25 {
  code: 'ERR_REQUIRE_ESM'
}

Node.js v20.6.1

It looks like [email protected] moved away from commonjs but typescript is still trying to require() it. I think your tsconfig.json should set "module": "node16" as recommended by the typescript handbook. As far as I can tell, this will automatically detect each module type and emit the appropriate require() or import.