Gridcoin-RPC - Promise based nodejs RPC library

in utopian-io •  11 days ago

Gridcoin-RPC

GitHub: https://github.com/gridcat/gridcoin-rpc
NPM: https://www.npmjs.com/package/gridcoin-rpc

Hello everyone. I'd like to introduce to you the project I've be up to during the holidays.
This is zero dependency promise based nodejs wrapper for communication with Gridcoin daemon (wallet actually).

The aim of this project is to provide javascript interface to the Gridcoin wallet and (which is most important) provide nice in-code documentation for all the possible commands.

This is my first TypeScript attempt so I really need some help here from the community such a code review etc.

Technology Stack

We use TypeScript here. CircleCI as a CI tool.
Semantic-release is used for the automated deployments.
We use Conventional Commits.

Roadmap

  • Add and test ssl support
  • Add automated functional tests (against the live daemon instance)
  • Provide build for browsers
  • Keep improving documentation
  • Set up automated functional tests

How to contribute

  1. Fork the repo
  2. Clone it and install dependencies
    git clone https://github.com/YOUR-USERNAME/gridcoin-rpc
    npm install
  3. Make and commit your changes. Make sure the commands npm run build and npm run test:prod are working. Keep in mind we use Conventional Commits so either use defined format either just use npm run commit command so it will provide nice wizard for the commit format. All commits messages will be used to generate changelog. Please keep updating JSDOC comments as it will be used for documentation. Please do not update package version as it is done automatically with semantic release.
  4. Finally send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). Make sure all of your commits are atomic (one feature per commit).


P.S. I hope someone may find this project to be useful :-)

Authors get paid when people like you upvote their post.
If you enjoyed what you read here, create your account today and start earning FREE STEEM!
Sort Order:  

Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.

To view those questions and the relevant answers related to your post, click here.


Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]

·

Thank you for your review, @helo! Keep up the good work!

Great project. Unfortunately I don't know js, so can't help.

Congratulations @gridcat! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :

You received more than 50 upvotes. Your next target is to reach 100 upvotes.

Click here to view your Board
If you no longer want to receive notifications, reply to this comment with the word STOP

Support SteemitBoard's project! Vote for its witness and get one more award!

Hi @gridcat!

Your post was upvoted by @steem-ua, new Steem dApp, using UserAuthority for algorithmic post curation!
Your post is eligible for our upvote, thanks to our collaboration with @utopian-io!
Feel free to join our @steem-ua Discord server

Lol.
Reviewer actually earned with my code 6 times more than I did.

·

My upvote improved it a little :)

·
·

Yup it did :) Thank you